summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/Events/EventArgsCurrentLocationChanged.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/EventArgsCurrentLocationChanged.cs
parentd9adaf73869ce768686301ef30687a5fc18048a0 (diff)
downloadSMAPI-7fe85119219c17d459fd5a373916dafff7b4e2a2.tar.gz
SMAPI-7fe85119219c17d459fd5a373916dafff7b4e2a2.tar.bz2
SMAPI-7fe85119219c17d459fd5a373916dafff7b4e2a2.zip
document & format event code
Diffstat (limited to 'src/StardewModdingAPI/Events/EventArgsCurrentLocationChanged.cs')
-rw-r--r--src/StardewModdingAPI/Events/EventArgsCurrentLocationChanged.cs26
1 files changed, 20 insertions, 6 deletions
diff --git a/src/StardewModdingAPI/Events/EventArgsCurrentLocationChanged.cs b/src/StardewModdingAPI/Events/EventArgsCurrentLocationChanged.cs
index 53ed1551..443429aa 100644
--- a/src/StardewModdingAPI/Events/EventArgsCurrentLocationChanged.cs
+++ b/src/StardewModdingAPI/Events/EventArgsCurrentLocationChanged.cs
@@ -3,15 +3,29 @@ using StardewValley;
namespace StardewModdingAPI.Events
{
+ /// <summary>Event arguments for a <see cref="LocationEvents.CurrentLocationChanged"/> event.</summary>
public class EventArgsCurrentLocationChanged : EventArgs
{
+ /*********
+ ** Accessors
+ *********/
+ /// <summary>The player's previous location.</summary>
+ public GameLocation NewLocation { get; private set; }
+
+ /// <summary>The player's current location.</summary>
+ public GameLocation PriorLocation { get; private set; }
+
+
+ /*********
+ ** Public methods
+ *********/
+ /// <summary>Construct an instance.</summary>
+ /// <param name="priorLocation">The player's previous location.</param>
+ /// <param name="newLocation">The player's current location.</param>
public EventArgsCurrentLocationChanged(GameLocation priorLocation, GameLocation newLocation)
{
- NewLocation = newLocation;
- PriorLocation = priorLocation;
+ this.NewLocation = newLocation;
+ this.PriorLocation = priorLocation;
}
-
- public GameLocation NewLocation { get; private set; }
- public GameLocation PriorLocation { get; private set; }
}
-} \ No newline at end of file
+}