Class ModCombination`Abstract`

A mod combination.

Constructors

constructor

new ModCombination(input?): ModCombination
Parameters
- Optional input: string | number
Returns ModCombination
- Defined in src/Mods/ModCombination.ts:17

Accessors

acronyms

get acronyms(): string[]
The list of all mod acronyms.

Returns string[]
- Defined in src/Mods/ModCombination.ts:101

all

get all(): IMod[]
The list of all mods of this combination.

Returns IMod[]
- Defined in src/Mods/ModCombination.ts:51

beatmapMods

get beatmapMods(): IApplicableToBeatmap[]
The list of mods that are applicable to the beatmap.

Returns IApplicableToBeatmap[]
- Defined in src/Mods/ModCombination.ts:58

bitwise

get bitwise(): number
Bitwise value of the mod combination.

Returns number
- Defined in src/Mods/ModCombination.ts:108

converterMods

get converterMods(): IApplicableToConverter[]
The list of mods that are applicable to the beatmap converter.

Returns IApplicableToConverter[]
- Defined in src/Mods/ModCombination.ts:85

difficultyMods

get difficultyMods(): IApplicableToDifficulty[]
The list of mods that are applicable to the beatmap difficulty.

Returns IApplicableToDifficulty[]
- Defined in src/Mods/ModCombination.ts:76

hitObjectMods

get hitObjectMods(): IApplicableToHitObjects[]
The list of mods that are applicable to the beatmap hit objects.

Returns IApplicableToHitObjects[]
- Defined in src/Mods/ModCombination.ts:67

incompatibles

get incompatibles(): number
Bitwise value of all mods incompatible with this mod combination.

Returns number
- Defined in src/Mods/ModCombination.ts:141

isRanked

get isRanked(): boolean
Whether the mod combination is ranked.

Returns boolean
- Defined in src/Mods/ModCombination.ts:134

`Abstract` mode

get mode(): number
Returns number
- Defined in src/Mods/ModCombination.ts:15

multiplier

get multiplier(): number
Score multiplier of the mod combination.

Returns number
- Defined in src/Mods/ModCombination.ts:127

names

get names(): string[]
The list of all mod names.

Returns string[]
- Defined in src/Mods/ModCombination.ts:94

Methods

any

any(Mod): boolean
Parameters
- Mod: (new () => IMod)
  Target mod class.
  - - new (): IMod
    - Returns IMod
Returns boolean
If this mod combination has the target mod.
- Defined in src/Mods/ModCombination.ts:159

beatmapModAt

beatmapModAt(input): IApplicableToBeatmap
Finds a mod that is applicable to the beatmap by bitwise value or acronyms.
Parameters
- input: string | number
  The bitwise value or acronyms.
Returns IApplicableToBeatmap
First found mod. Otherwise returns null.
- Defined in src/Mods/ModCombination.ts:180

beatmapModsAt

beatmapModsAt(input): IApplicableToBeatmap[]
Finds all mods that are applicable to the beatmap by bitwise value or acronyms.
Parameters
- input: string | number
  The bitwise value or acronyms.
Returns IApplicableToBeatmap[]
The list of all found mods.
- Defined in src/Mods/ModCombination.ts:168

clone

clone(): this
Creates a new copy of this mod combination.

Returns this
- Defined in src/Mods/ModCombination.ts:326

converterModAt

converterModAt(input): IApplicableToConverter
Finds a mod that is applicable to the beatmap converter by bitwise value or acronyms.
Parameters
- input: string | number
  The bitwise value or acronyms.
Returns IApplicableToConverter
First found mod. Otherwise returns null.
- Defined in src/Mods/ModCombination.ts:249

converterModsAt

converterModsAt(input): IApplicableToConverter[]
Finds all mods that are applicable to the beatmap converter by bitwise value or acronyms.
Parameters
- input: string | number
  The bitwise value or acronyms.
Returns IApplicableToConverter[]
The list of all found mods.
- Defined in src/Mods/ModCombination.ts:237

difficultyModAt

difficultyModAt(input): IApplicableToDifficulty
Finds a mod that is applicable to the beatmap difficulty by bitwise value or acronyms.
Parameters
- input: string | number
  The bitwise value or acronyms.
Returns IApplicableToDifficulty
First found mod. Otherwise returns null.
- Defined in src/Mods/ModCombination.ts:226

difficultyModsAt

difficultyModsAt(input): IApplicableToDifficulty[]
Finds all mods that are applicable to the beatmap difficulty by bitwise value or acronyms.
Parameters
- input: string | number
  The bitwise value or acronyms.
Returns IApplicableToDifficulty[]
The list of all found mods.
- Defined in src/Mods/ModCombination.ts:214

equals

equals(other): boolean
Wheter the mods are equal or not.
Parameters
- other: ModCombination
  The other mod combination.
Returns boolean
- Defined in src/Mods/ModCombination.ts:336

has

has(input): boolean
Parameters
- input: string | number
  The bitwise value or acronyms.
Returns boolean
If the mod combination contain all of the mods from this bitwise or acronyms.
- Defined in src/Mods/ModCombination.ts:149

hitObjectModAt

hitObjectModAt(input): IApplicableToHitObjects
Finds a mod that is applicable to the beatmap hit objects by bitwise value or acronyms.
Parameters
- input: string | number
  The bitwise value or acronyms.
Returns IApplicableToHitObjects
First found mod. Otherwise returns null.
- Defined in src/Mods/ModCombination.ts:203

hitObjectModsAt

hitObjectModsAt(input): IApplicableToHitObjects[]
Finds all mods that are applicable to the beatmap hit objects by bitwise value or acronyms.
Parameters
- input: string | number
  The bitwise value or acronyms.
Returns IApplicableToHitObjects[]
The list of all found mods.
- Defined in src/Mods/ModCombination.ts:191

modAt

modAt(input): IMod
Finds a mod by bitwise value or acronyms.
Parameters
- input: string | number
  The bitwise value or acronyms.
Returns IMod
First found mod. Otherwise returns null.
- Defined in src/Mods/ModCombination.ts:271

modsAt

modsAt(input): IMod[]
Finds mods by bitwise value or acronyms.
Parameters
- input: string | number
  The bitwise value or acronyms.
Returns IMod[]
The list of all found mods.
- Defined in src/Mods/ModCombination.ts:260

toBitwise

toBitwise(input): number
Converts mod acronyms to a bitwise value.
Parameters
- input: unknown
  The mod acronyms.
Returns number
The bitwise value.
- Defined in src/Mods/ModCombination.ts:298

toJSON

toJSON(): string
Converts this mod combination to a string.

Returns string
Formatted mod combination that can be converted to JSON.
- Defined in src/Mods/ModCombination.ts:289

toString

toString(): string
Converts this mod combination to a string.

Returns string
Stringified mod combination.
- Defined in src/Mods/ModCombination.ts:281