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

Improve xmldoc

Browse Source
This commit is contained in:
Bartłomiej Dach 2021-06-14 21:51:32 +02:00
parent 84ec378be1
commit cb1e2e3d97
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
osu.Game/Rulesets/UI/Scrolling/ScrollingHitObjectContainer.cs
View File

@ -25,8 +25,12 @@ namespace osu.Game.Rulesets.UI.Scrolling
private Direction scrollingAxis => direction.Value == ScrollingDirection.Left || direction.Value == ScrollingDirection.Right ? Direction.Horizontal : Direction.Vertical;
/// <summary>
/// Whether the scrolling direction is the positive-to-negative direction in the local coordinate.
/// The scrolling axis is inverted if objects temporally farther in the future have a smaller position value across the scrolling axis.
/// </summary>
/// <example>
/// <see cref="ScrollingDirection.Down"/> is inverted, because given two objects, one of which is at the current time and one of which is 1000ms in the future,
/// in the current time instant the future object is spatially above the current object, and therefore has a smaller value of the Y coordinate of its position.
/// </example>
private bool axisInverted => direction.Value == ScrollingDirection.Down || direction.Value == ScrollingDirection.Right;
/// <summary>
@ -58,7 +62,7 @@ namespace osu.Game.Rulesets.UI.Scrolling
}
/// <summary>
/// Given a position at <paramref name="currentTime"/>, return the time of the object corresponding the position.
/// Given a position at <paramref name="currentTime"/>, return the time of the object corresponding to the position.
/// </summary>
/// <remarks>
/// If there are multiple valid time values, one arbitrary time is returned.