h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2024-09-21 21:27:24 +08:00
Code Issues Releases Wiki Activity

More xmldocs

Browse Source
This commit is contained in:
smoogipoo 2018-08-06 11:31:54 +09:00
parent 741ec0021e
commit 0d6a8a2bf5
2 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
osu.Game/Rulesets/Objects/Drawables/DrawableHitObject.cs
View File

@ -47,7 +47,7 @@ namespace osu.Game.Rulesets.Objects.Drawables
public event Action<DrawableHitObject, JudgementResult> OnResultReset; public event Action<DrawableHitObject, JudgementResult> OnResultReset;
/// <summary> /// <summary>
/// Whether a visible judgement should be displayed when this representation is hit. /// Whether a visual indicator should be displayed when a scoring result occurs.
/// </summary> /// </summary>
public virtual bool DisplayResult => true; public virtual bool DisplayResult => true;
@ -219,10 +219,10 @@ namespace osu.Game.Rulesets.Objects.Drawables
} }
/// <summary> /// <summary>
/// Processes this <see cref="DrawableHitObject"/>, checking if any judgements have occurred. /// Processes this <see cref="DrawableHitObject"/>, checking if a scoring result has occurred.
/// </summary> /// </summary>
/// <param name="userTriggered">Whether the user triggered this process.</param> /// <param name="userTriggered">Whether the user triggered this process.</param>
/// <returns>Whether a judgement has occurred from this <see cref="DrawableHitObject"/> or any nested <see cref="DrawableHitObject"/>s.</returns> /// <returns>Whether a scoring result has occurred from this <see cref="DrawableHitObject"/> or any nested <see cref="DrawableHitObject"/>.</returns>
protected bool UpdateResult(bool userTriggered) protected bool UpdateResult(bool userTriggered)
{ {
judgementOccurred = false; judgementOccurred = false;
@ -243,12 +243,14 @@ namespace osu.Game.Rulesets.Objects.Drawables
} }
/// <summary> /// <summary>
/// Checks if any judgements have occurred for this <see cref="DrawableHitObject"/>. This method must construct /// Checks if a scoring result has occurred for this <see cref="DrawableHitObject"/>.
/// all <see cref="Judgement"/>s and notify of them through <see cref="ApplyResult{T}"/>.
/// </summary> /// </summary>
/// <remarks>
/// If a scoring result has occurred, this method must invoke <see cref="ApplyResult"/> to update the result and notify responders.
/// </remarks>
/// <param name="userTriggered">Whether the user triggered this check.</param> /// <param name="userTriggered">Whether the user triggered this check.</param>
/// <param name="timeOffset">The offset from the <see cref="HitObject"/> end time at which this check occurred. A <paramref name="timeOffset"/> &gt; 0 /// <param name="timeOffset">The offset from the end time of the <see cref="HitObject"/> at which this check occurred.
/// implies that this check occurred after the end time of <see cref="HitObject"/>. </param> /// A <paramref name="timeOffset"/> &gt; 0 implies that this check occurred after the end time of the <see cref="HitObject"/>. </param>
protected virtual void CheckForResult(bool userTriggered, double timeOffset) protected virtual void CheckForResult(bool userTriggered, double timeOffset)
{ {
} }

6
osu.Game/Rulesets/Objects/HitObject.cs
View File

@ -63,6 +63,12 @@ namespace osu.Game.Rulesets.Objects
[JsonIgnore] [JsonIgnore]
public IReadOnlyList<HitObject> NestedHitObjects => nestedHitObjects.Value; public IReadOnlyList<HitObject> NestedHitObjects => nestedHitObjects.Value;
/// <summary>
/// The judgement information provided by this <see cref="HitObject"/>.
/// </summary>
/// <remarks>
/// Only populated after <see cref="ApplyDefaults"/> is invoked.
/// </remarks>
public Judgement Judgement { get; private set; } public Judgement Judgement { get; private set; }
/// <summary> /// <summary>