diff --git a/osu.Game/Rulesets/Objects/Drawables/DrawableHitObject.cs b/osu.Game/Rulesets/Objects/Drawables/DrawableHitObject.cs index 4f7ec4c29e..17533f4ca0 100644 --- a/osu.Game/Rulesets/Objects/Drawables/DrawableHitObject.cs +++ b/osu.Game/Rulesets/Objects/Drawables/DrawableHitObject.cs @@ -47,7 +47,7 @@ public abstract class DrawableHitObject : SkinReloadableDrawable, IHasAccentColo public event Action OnResultReset; /// - /// Whether a visible judgement should be displayed when this representation is hit. + /// Whether a visual indicator should be displayed when a scoring result occurs. /// public virtual bool DisplayResult => true; @@ -219,10 +219,10 @@ protected void ApplyResult(Action application) } /// - /// Processes this , checking if any judgements have occurred. + /// Processes this , checking if a scoring result has occurred. /// /// Whether the user triggered this process. - /// Whether a judgement has occurred from this or any nested s. + /// Whether a scoring result has occurred from this or any nested . protected bool UpdateResult(bool userTriggered) { judgementOccurred = false; @@ -243,12 +243,14 @@ protected bool UpdateResult(bool userTriggered) } /// - /// Checks if any judgements have occurred for this . This method must construct - /// all s and notify of them through . + /// Checks if a scoring result has occurred for this . /// + /// + /// If a scoring result has occurred, this method must invoke to update the result and notify responders. + /// /// Whether the user triggered this check. - /// The offset from the end time at which this check occurred. A > 0 - /// implies that this check occurred after the end time of . + /// The offset from the end time of the at which this check occurred. + /// A > 0 implies that this check occurred after the end time of the . protected virtual void CheckForResult(bool userTriggered, double timeOffset) { } diff --git a/osu.Game/Rulesets/Objects/HitObject.cs b/osu.Game/Rulesets/Objects/HitObject.cs index a9cf23f924..eee690474b 100644 --- a/osu.Game/Rulesets/Objects/HitObject.cs +++ b/osu.Game/Rulesets/Objects/HitObject.cs @@ -63,6 +63,12 @@ public List Samples [JsonIgnore] public IReadOnlyList NestedHitObjects => nestedHitObjects.Value; + /// + /// The judgement information provided by this . + /// + /// + /// Only populated after is invoked. + /// public Judgement Judgement { get; private set; } ///