summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/Events/EventArgsFarmerChanged.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/EventArgsFarmerChanged.cs
parentd9adaf73869ce768686301ef30687a5fc18048a0 (diff)
downloadSMAPI-7fe85119219c17d459fd5a373916dafff7b4e2a2.tar.gz
SMAPI-7fe85119219c17d459fd5a373916dafff7b4e2a2.tar.bz2
SMAPI-7fe85119219c17d459fd5a373916dafff7b4e2a2.zip
document & format event code
Diffstat (limited to 'src/StardewModdingAPI/Events/EventArgsFarmerChanged.cs')
-rw-r--r--src/StardewModdingAPI/Events/EventArgsFarmerChanged.cs26
1 files changed, 20 insertions, 6 deletions
diff --git a/src/StardewModdingAPI/Events/EventArgsFarmerChanged.cs b/src/StardewModdingAPI/Events/EventArgsFarmerChanged.cs
index 468d18ee..ba8794b7 100644
--- a/src/StardewModdingAPI/Events/EventArgsFarmerChanged.cs
+++ b/src/StardewModdingAPI/Events/EventArgsFarmerChanged.cs
@@ -3,15 +3,29 @@ using StardewValley;
namespace StardewModdingAPI.Events
{
+ /// <summary>Event arguments for a <see cref="PlayerEvents.FarmerChanged"/> event.</summary>
public class EventArgsFarmerChanged : EventArgs
{
+ /*********
+ ** Accessors
+ *********/
+ /// <summary>The previous player character.</summary>
+ public Farmer NewFarmer { get; }
+
+ /// <summary>The new player character.</summary>
+ public Farmer PriorFarmer { get; }
+
+
+ /*********
+ ** Public methods
+ *********/
+ /// <summary>Construct an instance.</summary>
+ /// <param name="priorFarmer">The previous player character.</param>
+ /// <param name="newFarmer">The new player character.</param>
public EventArgsFarmerChanged(Farmer priorFarmer, Farmer newFarmer)
{
- NewFarmer = NewFarmer;
- PriorFarmer = PriorFarmer;
+ this.NewFarmer = NewFarmer;
+ this.PriorFarmer = PriorFarmer;
}
-
- public Farmer NewFarmer { get; }
- public Farmer PriorFarmer { get; }
}
-} \ No newline at end of file
+}