From e2b510f3f0c09c039802c62dde531fa3d8a336db Mon Sep 17 00:00:00 2001 From: smoogipooo Date: Tue, 21 Mar 2017 18:16:14 +0900 Subject: [PATCH] Add comments. --- osu.Game.Modes.Taiko/UI/HitTarget.cs | 14 ++++++++++++++ osu.Game.Modes.Taiko/UI/InputDrum.cs | 16 ++++++++++++++-- osu.Game.Modes.Taiko/UI/JudgementText.cs | 6 ++++++ osu.Game.Modes.Taiko/UI/RingExplosion.cs | 6 ++++++ 4 files changed, 40 insertions(+), 2 deletions(-) diff --git a/osu.Game.Modes.Taiko/UI/HitTarget.cs b/osu.Game.Modes.Taiko/UI/HitTarget.cs index c7b60e871f..9f20e1da0c 100644 --- a/osu.Game.Modes.Taiko/UI/HitTarget.cs +++ b/osu.Game.Modes.Taiko/UI/HitTarget.cs @@ -10,10 +10,24 @@ using osu.Game.Modes.Taiko.Objects; namespace osu.Game.Modes.Taiko.UI { + /// + /// A component that is displayed at the hit position in the taiko playfield. + /// internal class HitTarget : Container { + /// + /// Diameter of normal hit object circles. + /// private const float normal_diameter = TaikoHitObject.CIRCLE_RADIUS * 2 * TaikoPlayfield.PLAYFIELD_SCALE; + + /// + /// Diameter of finisher hit object circles. + /// private const float finisher_diameter = normal_diameter * 1.5f; + + /// + /// The 1px inner border of the taiko playfield. + /// private const float border_offset = 1; public HitTarget() diff --git a/osu.Game.Modes.Taiko/UI/InputDrum.cs b/osu.Game.Modes.Taiko/UI/InputDrum.cs index 59ab579a63..607fd205bb 100644 --- a/osu.Game.Modes.Taiko/UI/InputDrum.cs +++ b/osu.Game.Modes.Taiko/UI/InputDrum.cs @@ -15,6 +15,9 @@ using System.Collections.Generic; namespace osu.Game.Modes.Taiko.UI { + /// + /// A component of the playfield that captures input and displays input as a drum. + /// internal class InputDrum : Container { public InputDrum() @@ -25,6 +28,8 @@ namespace osu.Game.Modes.Taiko.UI { new TaikoHalfDrum(false) { + Name = "Left Half", + Anchor = Anchor.Centre, Origin = Anchor.CentreRight, @@ -34,6 +39,8 @@ namespace osu.Game.Modes.Taiko.UI }, new TaikoHalfDrum(true) { + Name = "Right Half", + Anchor = Anchor.Centre, Origin = Anchor.CentreLeft, @@ -46,11 +53,16 @@ namespace osu.Game.Modes.Taiko.UI }; } + /// + /// A half-drum. Contains one centre and one rim hit. + /// private class TaikoHalfDrum : Container { /// - /// Keys[0] -> Inner key - /// Keys[0] -> Outer key + /// A list of keys which this half-drum accepts. + /// + /// [0] => Inner key, [1] => Outer key + /// /// public List Keys = new List(); diff --git a/osu.Game.Modes.Taiko/UI/JudgementText.cs b/osu.Game.Modes.Taiko/UI/JudgementText.cs index f7ccd4a5ec..a65e85e0af 100644 --- a/osu.Game.Modes.Taiko/UI/JudgementText.cs +++ b/osu.Game.Modes.Taiko/UI/JudgementText.cs @@ -14,8 +14,14 @@ using osu.Game.Graphics; namespace osu.Game.Modes.Taiko.UI { + /// + /// Text that is shown as judgement when a hit object is hit or missed. + /// public class JudgementText : Container { + /// + /// The Judgement to display. + /// public TaikoJudgementInfo Judgement; private Container textContainer; diff --git a/osu.Game.Modes.Taiko/UI/RingExplosion.cs b/osu.Game.Modes.Taiko/UI/RingExplosion.cs index e7dcda086d..e405fa0bfb 100644 --- a/osu.Game.Modes.Taiko/UI/RingExplosion.cs +++ b/osu.Game.Modes.Taiko/UI/RingExplosion.cs @@ -14,8 +14,14 @@ using osu.Game.Modes.Taiko.Objects; namespace osu.Game.Modes.Taiko.UI { + /// + /// A ring that explodes to indicate a judgement has occurred. + /// internal class RingExplosion : CircularContainer { + /// + /// The Judgement to display. + /// public TaikoJudgementInfo Judgement; private Box innerFill;