diff options
author | Jesse Plamondon-Willard <github@jplamondonw.com> | 2016-10-31 14:48:23 -0400 |
---|---|---|
committer | Jesse Plamondon-Willard <github@jplamondonw.com> | 2016-10-31 14:48:23 -0400 |
commit | 7fe85119219c17d459fd5a373916dafff7b4e2a2 (patch) | |
tree | 85e17035489dbeeb1ea5d44d18b7e868cfb93754 /src/StardewModdingAPI/Events/EventArgsControllerButtonReleased.cs | |
parent | d9adaf73869ce768686301ef30687a5fc18048a0 (diff) | |
download | SMAPI-7fe85119219c17d459fd5a373916dafff7b4e2a2.tar.gz SMAPI-7fe85119219c17d459fd5a373916dafff7b4e2a2.tar.bz2 SMAPI-7fe85119219c17d459fd5a373916dafff7b4e2a2.zip |
document & format event code
Diffstat (limited to 'src/StardewModdingAPI/Events/EventArgsControllerButtonReleased.cs')
-rw-r--r-- | src/StardewModdingAPI/Events/EventArgsControllerButtonReleased.cs | 28 |
1 files changed, 21 insertions, 7 deletions
diff --git a/src/StardewModdingAPI/Events/EventArgsControllerButtonReleased.cs b/src/StardewModdingAPI/Events/EventArgsControllerButtonReleased.cs index 0164b8d6..cb53b545 100644 --- a/src/StardewModdingAPI/Events/EventArgsControllerButtonReleased.cs +++ b/src/StardewModdingAPI/Events/EventArgsControllerButtonReleased.cs @@ -4,15 +4,29 @@ using Microsoft.Xna.Framework.Input; namespace StardewModdingAPI.Events { + /// <summary>Event arguments for a <see cref="ControlEvents.ControllerButtonReleased"/> event.</summary> public class EventArgsControllerButtonReleased : EventArgs { - public EventArgsControllerButtonReleased(PlayerIndex playerIndex, Buttons buttonReleased) - { - PlayerIndex = playerIndex; - ButtonReleased = buttonReleased; - } - + /********* + ** Accessors + *********/ + /// <summary>The player who pressed the button.</summary> public PlayerIndex PlayerIndex { get; private set; } + + /// <summary>The controller button that was pressed.</summary> public Buttons ButtonReleased { get; private set; } + + + /********* + ** Public methods + *********/ + /// <summary>Construct an instance.</summary> + /// <param name="playerIndex">The player who pressed the button.</param> + /// <param name="button">The controller button that was released.</param> + public EventArgsControllerButtonReleased(PlayerIndex playerIndex, Buttons button) + { + this.PlayerIndex = playerIndex; + this.ButtonReleased = button; + } } -}
\ No newline at end of file +} |