1
0
mirror of https://github.com/ppy/osu.git synced 2024-12-14 20:22:55 +08:00

Add xml-doc.

This commit is contained in:
Damnae 2017-02-10 10:24:31 +01:00
parent 6f37c02868
commit ec64455573
2 changed files with 13 additions and 0 deletions

View File

@ -12,7 +12,14 @@ namespace osu.Game.Modes.Osu.Objects.Drawables
{
public class FollowPointConnection : HitObjectConnection
{
/// <summary>
/// Determines how much space there is between points.
/// </summary>
public int PointDistance = 32;
/// <summary>
/// Follow points to the next hitobject start appearing for this many milliseconds before an hitobject's end time.
/// </summary>
public int PreEmpt = 800;
public override void AddConnections(IEnumerable<DrawableHitObject> drawableHitObjects, int startIndex = 0, int endIndex = -1)

View File

@ -9,6 +9,12 @@ namespace osu.Game.Modes.Osu.Objects.Drawables.Connections
{
public abstract class HitObjectConnection : Container
{
/// <summary>
/// Create drawables inside this container, connecting hitobjects visually, for example with follow points.
/// </summary>
/// <param name="drawableHitObjects">The drawables hit objects to create connections for</param>
/// <param name="startIndex">Start index into the drawableHitObjects enumeration.</param>
/// <param name="endIndex">End index into the drawableHitObjects enumeration. Use -1 to draw connections until the end.</param>
public abstract void AddConnections(IEnumerable<DrawableHitObject> drawableHitObjects, int startIndex = 0, int endIndex = -1);
}
}