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

Improve documentation of InputTrigger

Browse Source
This commit is contained in:
Bartłomiej Dach 2023-03-07 21:22:59 +01:00
parent f711915e5f
commit 98f40b2679
No known key found for this signature in database
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
osu.Game/Screens/Play/HUD/InputTrigger.cs
View File

@ -1,7 +1,6 @@
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence. // Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text. // See the LICENCE file in the repository root for full licence text.
using System;
using osu.Framework.Graphics; using osu.Framework.Graphics;
namespace osu.Game.Screens.Play.HUD namespace osu.Game.Screens.Play.HUD
@ -11,8 +10,20 @@ namespace osu.Game.Screens.Play.HUD
/// </summary> /// </summary>
public abstract partial class InputTrigger : Component public abstract partial class InputTrigger : Component
{ {
public event Action<bool>? OnActivate; /// <summary>
public event Action<bool>? OnDeactivate; /// Callback to invoke when the associated input has been activated.
/// </summary>
/// <param name="forwardPlayback">Whether gameplay is progressing in the forward direction time-wise.</param>
public delegate void OnActivateCallback(bool forwardPlayback);
/// <summary>
/// Callback to invoke when the associated input has been deactivated.
/// </summary>
/// <param name="forwardPlayback">Whether gameplay is progressing in the forward direction time-wise.</param>
public delegate void OnDeactivateCallback(bool forwardPlayback);
public event OnActivateCallback? OnActivate;
public event OnDeactivateCallback? OnDeactivate;
protected InputTrigger(string name) protected InputTrigger(string name)
{ {