Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IScoreCalculationOptions

Options for score calculation.

Hierarchy

Index

Properties

accuracy?: number

Target score accuracy.

approachRate?: number

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

attributes?: IBeatmapAttributes

Missing beatmap attributes for score simulation.

beatmapId?: number

Beatmap ID of this score.

bpm?: number

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

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].

count100?: number

Target score 100's.

count300?: number

Target score 300's.

count50?: number

Target score 50's.

countGeki?: number

Target score geki hits (not used right now).

countKatu?: number

Target score katu hits.

countMiss?: number

Target score misses.

Precalculated difficulty attributes.

fileURL?: string

Custom beatmap file URL of this score.

fix?: boolean

Should this score be unchoked or not?

default

false

hash?: string

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

lifeBar?: boolean

Output replay life bar if replay file is present?

default

false

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

maxCombo?: number

Target max combo of a score.

mods?: string | number

Mod combination or bitwise.

default

"NM"

overallDifficulty?: number

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

percentCombo?: number

Target percent of max combo of a score.

replayURL?: string

Custom replay file URL.

ruleset?: IRuleset

Custom ruleset instance.

rulesetId?: GameMode

Ruleset ID.

savePath?: string

Path to the replay file save location.

default

"./cache"

scoreInfo?: IScoreInfo | IJsonableScoreInfo

Target score.

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.

totalScore?: number

Target total score.