diff --git a/osu.Game/Rulesets/Objects/SliderPath.cs b/osu.Game/Rulesets/Objects/SliderPath.cs
index b81ccbe1e1..66acbeed68 100644
--- a/osu.Game/Rulesets/Objects/SliderPath.cs
+++ b/osu.Game/Rulesets/Objects/SliderPath.cs
@@ -12,13 +12,33 @@ namespace osu.Game.Rulesets.Objects
{
public readonly struct SliderPath
{
+ ///
+ /// The control points of the path.
+ ///
public readonly ReadOnlyMemory ControlPoints;
+
+ ///
+ /// The type of path.
+ ///
public readonly PathType Type;
+
+ ///
+ /// The user-set distance of the path. If non-null, will match this value,
+ /// and the path will be shortened/lengthened to match this length.
+ ///
public readonly double? ExpectedDistance;
private readonly List calculatedPath;
private readonly List cumulativeLength;
+ ///
+ /// Creates a new .
+ ///
+ /// The type of path.
+ /// The control points of the path.
+ /// A user-set distance of the path that may be shorter or longer than the true distance between all
+ /// . The path will be shortened/lengthened to match this length.
+ /// If null, the path will use the true distance between all .
public SliderPath(PathType type, Vector2[] controlPoints, double? expectedDistance = null)
{
ControlPoints = controlPoints;
@@ -32,6 +52,9 @@ namespace osu.Game.Rulesets.Objects
calculateCumulativeLength();
}
+ ///
+ /// The distance of the path after lengthening/shortening to account for .
+ ///
public double Distance => cumulativeLength.Count == 0 ? 0 : cumulativeLength[cumulativeLength.Count - 1];
///