h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2024-11-11 14:17:26 +08:00
Code Issues Releases Wiki Activity

expand xmldoc

Browse Source
This commit is contained in:
OliBomby 2023-08-19 19:39:29 +02:00
parent 0a55830c16
commit 56b1062c2f
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
osu.Game/Rulesets/Objects/SliderPath.cs
View File

@ -198,8 +198,16 @@ namespace osu.Game.Rulesets.Objects
}
/// <summary>
/// Returns the progress values at which segments of the path end.
/// Returns the progress values at which (control point) segments of the path end.
/// Ranges from 0 (beginning of the path) to 1 (end of the path) to infinity (beyond the end of the path).
/// </summary>
/// <example>In case <see cref="Distance"/> is less than <see cref="CalculatedDistance"/>,
/// the last segment ends after the end of the path, hence it returns a value greater than 1.
/// <para/>
/// In case <see cref="Distance"/> is greater than <see cref="CalculatedDistance"/>,
/// the last segment ends before the end of the path, hence it returns a value less than 1.</example>
/// <remarks><see cref="PositionAt"/> truncates the progression values to [0,1],
/// so you can't use this method to retrieve the positions of segment ends beyond the end of the path.</remarks>
public IEnumerable<double> GetSegmentEnds()
{
ensureValid();