1
0
mirror of https://github.com/ppy/osu.git synced 2024-12-15 14:02:55 +08:00

Add xmldocs

This commit is contained in:
Dan Balasescu 2024-02-07 03:47:36 +09:00
parent 2fc06f16b5
commit e2867986c5
No known key found for this signature in database

View File

@ -232,10 +232,24 @@ namespace osu.Game.Rulesets.Osu.Objects.Drawables
// IsHovered is used // IsHovered is used
public override bool HandlePositionalInput => true; public override bool HandlePositionalInput => true;
/// <summary>
/// Whether the hitobject can still be hit at the current point in time.
/// </summary>
public required Func<bool> CanBeHit { get; set; } public required Func<bool> CanBeHit { get; set; }
/// <summary>
/// An action that's invoked to perform the hit.
/// </summary>
public required Action Hit { get; set; } public required Action Hit { get; set; }
/// <summary>
/// The <see cref="OsuAction"/> with which the hit was attempted.
/// </summary>
public OsuAction? HitAction { get; private set; } public OsuAction? HitAction { get; private set; }
/// <summary>
/// The closest position to the hit receptor at the point where the hit was attempted.
/// </summary>
public Vector2? ClosestPressPosition { get; private set; } public Vector2? ClosestPressPosition { get; private set; }
public HitReceptor() public HitReceptor()
@ -290,6 +304,9 @@ namespace osu.Game.Rulesets.Osu.Objects.Drawables
{ {
} }
/// <summary>
/// Resets to a fresh state.
/// </summary>
public void Reset() public void Reset()
{ {
HitAction = null; HitAction = null;