Interface IBeatmapResults

Provides information about the game that just ended. Used in IBeatmapEnd.

Namespace: MouseDance.Runtime
Assembly: MouseDance.Runtime.dll
Syntax
public interface IBeatmapResults

Properties

HitObjects

Read-only list of all hit objects used in the song's beatmap.

Declaration
IReadOnlyList<HitObject> HitObjects { get; }
Property Value
Type Description
IReadOnlyList<OsuParsers.Beatmaps.Objects.HitObject>

PlayerWin

Did the player win?

Declaration
bool PlayerWin { get; }
Property Value
Type Description
Boolean

Score

Player's current score.

Declaration
long Score { get; }
Property Value
Type Description
Int64

Methods

GetHitAccuracy(Int32)

How close to the Hit Object's time did the player get when they pressed on a Hit Object.

Declaration
float GetHitAccuracy(int hitObjectIdx)
Parameters
Type Name Description
Int32 hitObjectIdx

Index of the Hit Object we are checking.
Returns
Type Description
Single

Normalized value indicating if user pressed Hit Object within correct time window. -1.0 to +1.0 is a hit. Any value outside that (lesser than -1.0 or greater than +1.0) means miss (negative for too early, positive for too late). 0.0 means user pressed exactly at Hit Object time.

GetSliderPercentComplete(Int32)

How many Slider Parts did user collect for the given Slider (in percentage)?

Declaration
float GetSliderPercentComplete(int sliderIdx)
Parameters
Type Name Description
Int32 sliderIdx

Index of the Slider we are checking.
Returns
Type Description
Single

Value within 0.0 to 1.0. 1.0 means 100% all collected. 0.5 means 50%, etc. -1 if the Slider was missed or if index specified is not for a Slider at all.

WasHit(Int32)

Did the player successfully press the hit object with the specified index? Index value corresponds to the list in HitObjects.

Declaration
bool WasHit(int hitObjectIdx)
Parameters
Type Name Description
Int32 hitObjectIdx

Index of the Hit Object we are checking.
Returns
Type Description
Boolean