h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2025-01-12 18:23:04 +08:00
Code Issues Releases Wiki Activity

Add doc comments to catch hit object X properties

Browse Source
This commit is contained in:
ekrctb 2020-12-14 11:15:49 +09:00
parent cd2db59900
commit 089f3bebf5
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
osu.Game.Rulesets.Catch/Objects/CatchHitObject.cs
View File

@ -19,6 +19,12 @@ namespace osu.Game.Rulesets.Catch.Objects
public readonly Bindable<float> OriginalXBindable = new Bindable<float>(); public readonly Bindable<float> OriginalXBindable = new Bindable<float>();
/// <summary>
/// The horizontal position of the hit object between 0 and <see cref="CatchPlayfield.WIDTH"/>.
/// </summary>
/// <remarks>
/// This value is the original value specified in the beatmap, not affected by beatmap processing.
/// </remarks>
public float OriginalX public float OriginalX
{ {
get => OriginalXBindable.Value; get => OriginalXBindable.Value;
@ -37,12 +43,15 @@ namespace osu.Game.Rulesets.Catch.Objects
public readonly Bindable<float> EffectiveXBindable = new Bindable<float>(); public readonly Bindable<float> EffectiveXBindable = new Bindable<float>();
/// <summary>
/// The effective horizontal position of the hit object between 0 and <see cref="CatchPlayfield.WIDTH"/>.
/// </summary>
public float EffectiveX => EffectiveXBindable.Value; public float EffectiveX => EffectiveXBindable.Value;
private float xOffset; private float xOffset;
/// <summary> /// <summary>
/// A random offset applied to <see cref="X"/>, set by the <see cref="CatchBeatmapProcessor"/>. /// A random offset applied to the horizontal value, set by the <see cref="CatchBeatmapProcessor"/>.
/// </summary> /// </summary>
internal float XOffset internal float XOffset
{ {