summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/Events/EventArgsControllerButtonPressed.cs
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <github@jplamondonw.com>2016-10-31 14:48:23 -0400
committerJesse Plamondon-Willard <github@jplamondonw.com>2016-10-31 14:48:23 -0400
commit7fe85119219c17d459fd5a373916dafff7b4e2a2 (patch)
tree85e17035489dbeeb1ea5d44d18b7e868cfb93754 /src/StardewModdingAPI/Events/EventArgsControllerButtonPressed.cs
parentd9adaf73869ce768686301ef30687a5fc18048a0 (diff)
downloadSMAPI-7fe85119219c17d459fd5a373916dafff7b4e2a2.tar.gz
SMAPI-7fe85119219c17d459fd5a373916dafff7b4e2a2.tar.bz2
SMAPI-7fe85119219c17d459fd5a373916dafff7b4e2a2.zip
document & format event code
Diffstat (limited to 'src/StardewModdingAPI/Events/EventArgsControllerButtonPressed.cs')
-rw-r--r--src/StardewModdingAPI/Events/EventArgsControllerButtonPressed.cs28
1 files changed, 21 insertions, 7 deletions
diff --git a/src/StardewModdingAPI/Events/EventArgsControllerButtonPressed.cs b/src/StardewModdingAPI/Events/EventArgsControllerButtonPressed.cs
index b51a8a5b..87c96678 100644
--- a/src/StardewModdingAPI/Events/EventArgsControllerButtonPressed.cs
+++ b/src/StardewModdingAPI/Events/EventArgsControllerButtonPressed.cs
@@ -4,15 +4,29 @@ using Microsoft.Xna.Framework.Input;
namespace StardewModdingAPI.Events
{
+ /// <summary>Event arguments for a <see cref="ControlEvents.ControllerButtonPressed"/> event.</summary>
public class EventArgsControllerButtonPressed : EventArgs
{
- public EventArgsControllerButtonPressed(PlayerIndex playerIndex, Buttons buttonPressed)
- {
- PlayerIndex = playerIndex;
- ButtonPressed = buttonPressed;
- }
-
+ /*********
+ ** 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 ButtonPressed { 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 pressed.</param>
+ public EventArgsControllerButtonPressed(PlayerIndex playerIndex, Buttons button)
+ {
+ this.PlayerIndex = playerIndex;
+ this.ButtonPressed = button;
+ }
}
-} \ No newline at end of file
+}