h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2024-11-06 12:17:46 +08:00
Code Issues Releases Wiki Activity

Add some xmldocs

Browse Source
This commit is contained in:
smoogipoo 2020-08-27 21:15:05 +09:00
parent 6f93df0b9d
commit 7a5292936e
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
osu.Game.Rulesets.Mania/UI/OrderedHitPolicy.cs
View File

@ -11,6 +11,9 @@ using osu.Game.Rulesets.UI;
namespace osu.Game.Rulesets.Mania.UI namespace osu.Game.Rulesets.Mania.UI
{ {
/// <summary>
/// Ensures that only the most recent <see cref="HitObject"/> is hittable, affectionately known as "note lock".
/// </summary>
public class OrderedHitPolicy public class OrderedHitPolicy
{ {
private readonly HitObjectContainer hitObjectContainer; private readonly HitObjectContainer hitObjectContainer;
@ -20,6 +23,15 @@ namespace osu.Game.Rulesets.Mania.UI
this.hitObjectContainer = hitObjectContainer; this.hitObjectContainer = hitObjectContainer;
} }
/// <summary>
/// Determines whether a <see cref="DrawableHitObject"/> can be hit at a point in time.
/// </summary>
/// <remarks>
/// Only the most recent <see cref="DrawableHitObject"/> can be hit, a previous hitobject's window cannot extend past the next one.
/// </remarks>
/// <param name="hitObject">The <see cref="DrawableHitObject"/> to check.</param>
/// <param name="time">The time to check.</param>
/// <returns>Whether <paramref name="hitObject"/> can be hit at the given <paramref name="time"/>.</returns>
public bool IsHittable(DrawableHitObject hitObject, double time) public bool IsHittable(DrawableHitObject hitObject, double time)
{ {
var nextObject = hitObjectContainer.AliveObjects.GetNext(hitObject); var nextObject = hitObjectContainer.AliveObjects.GetNext(hitObject);