Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IBeatmapCalculationOptions

Options for beatmap calculation.

Hierarchy

Index

Properties

accuracy?: number[]

List of accuracy for all game modes.

approachRate?: number

Custom approach rate for the target beatmap in range [0-11].

attributes?: IBeatmapAttributes

Missing beatmap attributes that are required to simulate scores. This is used only for osu!catch which requires the number of fruits and droplets.

beatmapId?: string | number

ID of the target beatmap.

beatmapInfo?: IBeatmapInfo | IJsonableBeatmapInfo

Precalculated beatmap information.

bpm?: number

Custom BPM for the target beatmap in range [60-10000]. Can exceed clockrate limits.

cacheFiles?: boolean

Should files be cached on a disk after calculation?

default

true

circleSize?: number

Custom circle size for the target beatmap in range [0-11].

clockRate?: number

Custom clock rate for the target beatmap in range [0.25-3].

Precalculated difficulty attributes.

fileURL?: string

Custom file URL of the target beatmap.

hash?: string

Hash of the target beatmap. Used to validate beatmap files. If wasn't specified then file will not be validated.

lockApproachRate?: boolean

Prevents scaling of approach rate from difficulty adjusting mods.

default

false

lockCircleSize?: boolean

Prevents scaling of circle size from difficulty adjusting mods.

default

false

lockOverallDifficulty?: boolean

Prevents scaling of overall difficulty from difficulty adjusting mods.

default

false

lockStats?: boolean

Prevents scaling of stats from difficulty adjusting mods. Use lockApproachRate, lockOverallDifficulty or lockCircleSize

deprecated

Since 3.2.0

default

false

mods?: string | number

Mod combination or bitwise.

overallDifficulty?: number

Custom overall difficulty for the target beatmap in range [0-11].

ruleset?: IRuleset

Custom ruleset instance (for non-supported rulesets).

rulesetId?: GameMode

Ruleset ID.

savePath?: string

Path to the beatmap file save location.

default

"./cache"

strains?: boolean

Whether to output strain peaks or not.

totalHits?: number

Total hits for gradual beatmap difficulty calculation. If it differs from the hit object count of a full beatmap then it will force difficulty calculation.