sim1222/osukey
1
1
Fork 0
mirror of https://github.com/osukey/osukey.git synced 2025-07-01 08:20:00 +09:00
Code Issues Packages Projects Releases Wiki Activity

More xmldocs to hitobject/drawablehitobject

Browse Source
This commit is contained in:
smoogipoo
2018-08-06 10:55:38 +09:00
parent 5fd4ed2f4e
commit b35817c877
4 changed files with 32 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -67,6 +67,9 @@ namespace osu.Game.Rulesets.Objects.Drawables
/// </summary>
public bool Judged => Result?.HasResult ?? true;
/// <summary>
/// The scoring result of this <see cref="DrawableHitObject"/>.
/// </summary>
public readonly JudgementResult Result;
private bool judgementOccurred;
@ -177,9 +180,10 @@ namespace osu.Game.Rulesets.Objects.Drawables
}
/// <summary>
/// Notifies that a new judgement has occurred for this <see cref="DrawableHitObject"/>.
/// Applies the <see cref="Result"/> of this <see cref="DrawableHitObject"/>, notifying responders such as
/// the <see cref="ScoreProcessor"/> of the <see cref="JudgementResult"/>.
/// </summary>
/// <param name="judgement">The <see cref="Judgement"/>.</param>
/// <param name="application">The callback that applies changes to the <see cref="JudgementResult"/>.</param>
protected void ApplyResult(Action<JudgementResult> application)
{
application?.Invoke(Result);
@ -240,6 +244,10 @@ namespace osu.Game.Rulesets.Objects.Drawables
{
}
/// <summary>
/// Creates the <see cref="JudgementResult"/> that represents the scoring result for this <see cref="DrawableHitObject"/>.
/// </summary>
/// <param name="judgement">The <see cref="Judgement"/> that provides the scoring information.</param>
protected virtual JudgementResult CreateJudgementResult(Judgement judgement) => new JudgementResult(judgement);
}