Class TaikoRuleset

osu!taiko ruleset.

Hierarchy

Ruleset
- TaikoRuleset

Index

Constructors

constructor

Accessors

id

Methods

Constructors

constructor

new TaikoRuleset(): TaikoRuleset

Inherited from Ruleset.constructor
Returns TaikoRuleset

Accessors

id

get id(): number

Overrides Ruleset.id
- Defined in src/TaikoRuleset.ts:29
osu!taiko ruleset ID.

Returns number

Methods

applyToBeatmap

applyToBeatmap(beatmap: IBeatmap): TaikoBeatmap

Overrides Ruleset.applyToBeatmap
- Defined in src/TaikoRuleset.ts:38
Applies osu!taiko ruleset to a beatmap.

Parameters
- beatmap: IBeatmap
  
  The beatmap.
Returns TaikoBeatmap
A new osu!taiko beatmap with applied ruleset.

applyToBeatmapWithMods

applyToBeatmapWithMods(beatmap: IBeatmap, mods?: TaikoModCombination): TaikoBeatmap

Overrides Ruleset.applyToBeatmapWithMods
- Defined in src/TaikoRuleset.ts:48
Applies osu!taiko ruleset and mods to a beatmap.

Parameters
- beatmap: IBeatmap
  
  The beatmap.
- Optional mods: TaikoModCombination
  
  osu!taiko mod combination.
Returns TaikoBeatmap
A new osu!taiko beatmap with applied mods.

createDifficultyCalculator

createDifficultyCalculator(beatmap: IBeatmap): TaikoDifficultyCalculator

Overrides Ruleset.createDifficultyCalculator
- Defined in src/TaikoRuleset.ts:95
Parameters
- beatmap: IBeatmap
  
  The beatmap for which the calculation will be done.
Returns TaikoDifficultyCalculator
A new osu!taiko difficulty calculator.

createModCombination

createModCombination(input?: string | number): TaikoModCombination

Overrides Ruleset.createModCombination
- Defined in src/TaikoRuleset.ts:66
Creates a new mod combination by converting legacy mod bitwise.

Parameters
- Optional input: string | number
  
  Mod bitwise or acronyms.
Returns TaikoModCombination
A new mod combination.

createPerformanceCalculator

createPerformanceCalculator(attributes?: TaikoDifficultyAttributes, score?: IScoreInfo): TaikoPerformanceCalculator

Overrides Ruleset.createPerformanceCalculator
- Defined in src/TaikoRuleset.ts:104
Parameters
- Optional attributes: TaikoDifficultyAttributes
  
  The difficulty attributes.
- Optional score: IScoreInfo
  
  Score information.
Returns TaikoPerformanceCalculator
A new osu!taiko performance calculator.

resetMods

resetMods(beatmap: IBeatmap): TaikoBeatmap

Overrides Ruleset.resetMods
- Defined in src/TaikoRuleset.ts:57
Resets a mod combination from a beatmap.

Parameters
- beatmap: IBeatmap
  
  The beatmap.
Returns TaikoBeatmap
A new beatmap with no mods.