Class HitObjectSet

All prefabs needed by HitObjectManager to spawn Hit Objects and effects, grouped for easy reference.

Inheritance

Object

Object

ScriptableObject

HitObjectSet

LeftRightClickHitObjectSet

MyHitObjectSet

Namespace: MouseDance.Runtime

Assembly: MouseDance.Runtime.dll

Syntax

[CreateAssetMenu(fileName = "HitObjectSet", menuName = "MouseDance/HitObjectSet")]
public class HitObjectSet : ScriptableObject

Fields

HitCirclePrefab

Declaration

[Header("Hit Objects")]
[Tooltip("Master-copy of the Hit Circle prefab that will be spawned and pooled.")]
public HitCircle HitCirclePrefab

Field Value

Type	Description
HitCircle

SdfCurvePrefab

Declaration

[Header("SDF Curve")]
[Tooltip("Master-copy of the SDF Curve prefab that will be spawned and pooled. Used by Sliders.")]
public SDFCurve SdfCurvePrefab

Field Value

Type	Description
SDFCurve

SliderBallPrefab

Declaration

[Tooltip("Master-copy of the Slider Ball prefab. Used by Sliders.")]
public SliderBall SliderBallPrefab

Field Value

Type	Description
SliderBall

SliderPrefab

Declaration

[Tooltip("Master-copy of the Slider prefab that will be spawned and pooled.")]
public Slider SliderPrefab

Field Value

Type	Description
Slider

SliderTickPrefab

Declaration

[Tooltip("Master-copy of the Slider Tick prefab that will be spawned and pooled. Used by Sliders.")]
public SliderTick SliderTickPrefab

Field Value

Type	Description
SliderTick

Methods

GetHitCirclePrefab(Int32, Int32, Int32, HitCircle, Beatmap)

Determine what Hit Circle Prefab should be given for this type of Hit Circle.

Declaration

public virtual (string, HitCircle) GetHitCirclePrefab(int idx, int comboCounter, int comboColourIdx, HitCircle hitCircle, Beatmap beatmap)

Parameters

Type	Name	Description
Int32	idx	Index position of the Hit Circle in the entire Beatmap. Starts at 0.
Int32	comboCounter	Number to be displayed on the Hit Circle.
Int32	comboColourIdx	What index of colour this Hit Circle is given. Starts at 0.
OsuParsers.Beatmaps.Objects.HitCircle	hitCircle	Extra info about the Hit Circle.
OsuParsers.Beatmaps.Beatmap	beatmap	Data on the entire Beatmap.

Returns

Type	Description
(T1, T2)<String, HitCircle>	string: Unique Id for the prefab type given. HitCircle: The prefab master-copy to be instantiated.

GetSliderBallPrefab(String)

Declaration

public virtual SliderBall GetSliderBallPrefab(string poolId)

Parameters

Type	Name	Description
String	poolId

Returns

Type	Description
SliderBall

GetSliderPrefab(Int32, Int32, Int32, Slider, Beatmap)

Determine what Slider Prefab should be given for this type of Slider.

Declaration

public virtual (string, Slider) GetSliderPrefab(int idx, int comboCounter, int comboColourIdx, Slider slider, Beatmap beatmap)

Parameters

Type	Name	Description
Int32	idx	Index position of the Slider in the entire Beatmap. Starts at 0.
Int32	comboCounter	Number to be displayed on the Slider.
Int32	comboColourIdx	What index of colour this Slider is given. Starts at 0.
OsuParsers.Beatmaps.Objects.Slider	slider	Extra info about the Slider.
OsuParsers.Beatmaps.Beatmap	beatmap	Data on the entire Beatmap.

Returns

Type	Description
(T1, T2)<String, Slider>	string: Unique Id for the prefab type given. HitCircle: The prefab master-copy to be instantiated.