From ec64455573557c1da2e61b019a034c933d8a7f8e Mon Sep 17 00:00:00 2001 From: Damnae Date: Fri, 10 Feb 2017 10:24:31 +0100 Subject: [PATCH] Add xml-doc. --- .../Objects/Drawables/Connections/FollowPointConnection.cs | 7 +++++++ .../Objects/Drawables/Connections/HitObjectConnection.cs | 6 ++++++ 2 files changed, 13 insertions(+) diff --git a/osu.Game.Modes.Osu/Objects/Drawables/Connections/FollowPointConnection.cs b/osu.Game.Modes.Osu/Objects/Drawables/Connections/FollowPointConnection.cs index 78c875d874..60ae997a77 100644 --- a/osu.Game.Modes.Osu/Objects/Drawables/Connections/FollowPointConnection.cs +++ b/osu.Game.Modes.Osu/Objects/Drawables/Connections/FollowPointConnection.cs @@ -12,7 +12,14 @@ namespace osu.Game.Modes.Osu.Objects.Drawables { public class FollowPointConnection : HitObjectConnection { + /// + /// Determines how much space there is between points. + /// public int PointDistance = 32; + + /// + /// Follow points to the next hitobject start appearing for this many milliseconds before an hitobject's end time. + /// public int PreEmpt = 800; public override void AddConnections(IEnumerable drawableHitObjects, int startIndex = 0, int endIndex = -1) diff --git a/osu.Game.Modes.Osu/Objects/Drawables/Connections/HitObjectConnection.cs b/osu.Game.Modes.Osu/Objects/Drawables/Connections/HitObjectConnection.cs index d8c91f23df..3ef4b4aa29 100644 --- a/osu.Game.Modes.Osu/Objects/Drawables/Connections/HitObjectConnection.cs +++ b/osu.Game.Modes.Osu/Objects/Drawables/Connections/HitObjectConnection.cs @@ -9,6 +9,12 @@ namespace osu.Game.Modes.Osu.Objects.Drawables.Connections { public abstract class HitObjectConnection : Container { + /// + /// Create drawables inside this container, connecting hitobjects visually, for example with follow points. + /// + /// The drawables hit objects to create connections for + /// Start index into the drawableHitObjects enumeration. + /// End index into the drawableHitObjects enumeration. Use -1 to draw connections until the end. public abstract void AddConnections(IEnumerable drawableHitObjects, int startIndex = 0, int endIndex = -1); } }