@kionell/osu-pp-calculator

Functions

applyCustomCircleSize

applyCustomCircleSize(beatmap: IBeatmap, mods: ModCombination, stats: IBeatmapCustomStats): void

- Defined in Core/Utils/Stats.ts:37
Overwrites circle size of a beatmap with custom one.

Parameters
- beatmap: IBeatmap
  
  A beatmap.
- mods: ModCombination
  
  Mod combination.
- stats: IBeatmapCustomStats
  
  Custom difficulty stats.
Returns void

applyCustomStats

applyCustomStats(beatmap: IBeatmap, mods: ModCombination, stats: IBeatmapCustomStats): void

- Defined in Core/Utils/Stats.ts:61
Overwrites difficulty stats of a beatmap with custom difficulty stats.

Parameters
- beatmap: IBeatmap
  
  A beatmap.
- mods: ModCombination
  
  Mod combination.
- stats: IBeatmapCustomStats
  
  Custom difficulty stats.
Returns void

calculateDifficulty

calculateDifficulty(options: IDifficultyCalculationOptions): DifficultyAttributes

- Defined in Core/Attributes.ts:16
Calculates difficulty attributes by ID, custom file or IBeatmap object.

Parameters
- options: IDifficultyCalculationOptions
  
  Difficulty attributes request options.
Returns DifficultyAttributes
Calculated difficulty attributes.

calculatePerformance

calculatePerformance(options: IPerformanceCalculationOptions): PerformanceAttributes

- Defined in Core/Attributes.ts:40
Calculates difficulty attributes by ID, custom file or IBeatmap object.

Parameters
- options: IPerformanceCalculationOptions
  
  Difficulty attributes request options.
Returns PerformanceAttributes
Calculated difficulty attributes.

createBeatmapAttributes

createBeatmapAttributes(beatmap?: IBeatmap): IBeatmapAttributes

- Defined in Core/Utils/Beatmap.ts:58
Converts IBeatmap object to beatmap attributes.

Parameters
- Optional beatmap: IBeatmap
  
  IBeatmap object.
Returns IBeatmapAttributes
Converted beatmap attributes.

createBeatmapInfo

createBeatmapInfo(beatmap?: IBeatmap, hash?: string): IBeatmapInfo

- Defined in Core/Utils/Beatmap.ts:25
Converts IBeatmap object to beatmap information.

Parameters
- Optional beatmap: IBeatmap
  
  IBeatmap object.
- Optional hash: string
  
  Beatmap MD5 hash.
Returns IBeatmapInfo
Converted beatmap info.

createDifficultyCalculator

createDifficultyCalculator(beatmap: IBeatmap, ruleset: IRuleset): IExtendedDifficultyCalculator

- Defined in Core/ExtendedDifficultyCalculator.ts:104
Factory of extended difficulty calculators.

Parameters
- beatmap: IBeatmap
  
  IBeatmap object.
- ruleset: IRuleset
  
  Ruleset instance.
Returns IExtendedDifficultyCalculator
Instance of extended difficulty calculator.

downloadFile

downloadFile(path?: string, options?: IDownloadEntryOptions): Promise<DownloadResult>

- Defined in Core/Utils/Downloading.ts:17
Downloads an osu! file by ID or URL.

Parameters
- Optional path: string
  
  Path to the file save location.
- Optional options: IDownloadEntryOptions
  
  Download options.
Returns Promise<DownloadResult>
Download result.

generateHitStatistics

generateHitStatistics(options: IHitStatisticsInput): HitStatistics

- Defined in Core/Utils/HitStatistics.ts:15
Parameters
- options: IHitStatisticsInput
Returns HitStatistics

getMaxCombo

getMaxCombo(beatmap?: IBeatmap): number

- Defined in Core/Utils/Beatmap.ts:191
Tries to get max combo of a beatmap.

Parameters
- Optional beatmap: IBeatmap
  
  IBeatmap object.
Returns number
Max combo of a beatmap or 0.

getMods

getMods(beatmap?: IBeatmap): ModCombination | null

- Defined in Core/Utils/Beatmap.ts:200
Tries to get mod combination from IBeatmap object.

Parameters
- Optional beatmap: IBeatmap
  
  IBeatmap object.
Returns ModCombination | null
Mod combination or null.

getRulesetById

getRulesetById(rulesetId?: number): IRuleset

- Defined in Core/Utils/Ruleset.ts:33
Creates a new ruleset instance by its ID.

Parameters
- Optional rulesetId: number
  
  Ruleset ID.
Returns IRuleset
Ruleset instance.

getRulesetIdByName

getRulesetIdByName(rulesetName?: string): GameMode

- Defined in Core/Utils/Ruleset.ts:13
Converts ruleset name to ruleset ID.

Parameters
- Optional rulesetName: string
  
  Ruleset name.
Returns GameMode
Ruleset ID.

getTotalHits

getTotalHits(beatmap?: IBeatmap): number

- Defined in Core/Utils/Beatmap.ts:145
Calculates total hits of a beatmap.

Parameters
- Optional beatmap: IBeatmap
  
  IBeatmap object.
Returns number
Total hits of a beatmap or 0.

parseBeatmap

parseBeatmap(options: IBeatmapParsingOptions): Promise<BeatmapParsingResult>

- Defined in Core/Parsing.ts:25
Tries to parse beatmap by beatmap ID or custom file URL.

Parameters
- options: IBeatmapParsingOptions
  
  Beatmap parsing options.
Returns Promise<BeatmapParsingResult>
Parsed beatmap.

parseScore

parseScore(options: IScoreParsingOptions): Promise<ScoreParsingResult>

- Defined in Core/Parsing.ts:142
Downloads replay file and tries to parse a score from it. Returns null if parsing was not successful.

Parameters
- options: IScoreParsingOptions
  
  Score parsing options.
Returns Promise<ScoreParsingResult>
Parsed score.

toCombination

toCombination(input?: string | number, rulesetId?: number): ModCombination

- Defined in Core/Utils/Mods.ts:37
Converts unknown input to mod combination.

Parameters
- Optional input: string | number
  
  Original input.
- Optional rulesetId: number
  
  Target ruleset ID.
Returns ModCombination
Mod combination.

toDifficultyAttributes

toDifficultyAttributes(difficulty?: IDifficultyAttributes, rulesetId?: GameMode): DifficultyAttributes

- Defined in Core/Utils/Conversion.ts:16
Converts raw difficulty attributes to real difficulty attributes.

Parameters
- Optional difficulty: IDifficultyAttributes
  
  Raw difficulty attributes.
- Optional rulesetId: GameMode
Returns DifficultyAttributes
Difficulty attributes instance.

toDifficultyMods

toDifficultyMods(mods?: string | number, rulesetId?: number): ModCombination

- Defined in Core/Utils/Mods.ts:11
Filters mods from combination to get only difficulty mods.

Parameters
- Optional mods: string | number
  
  Original mods.
- Optional rulesetId: number
  
  Target ruleset ID.
Returns ModCombination
Difficulty mods.

toScoreInfo

toScoreInfo(data?: IScoreInfo | IJsonableScoreInfo): ScoreInfo

- Defined in Core/Utils/Conversion.ts:35
Converts score information object to score information instance.

Parameters
- Optional data: IScoreInfo | IJsonableScoreInfo
Returns ScoreInfo
Converted score information.