diff options
| author | Zoryn Aaron <zoryn4163@gmail.com> | 2016-03-27 01:09:09 -0400 |
|---|---|---|
| committer | Zoryn Aaron <zoryn4163@gmail.com> | 2016-03-27 01:09:09 -0400 |
| commit | 12bf4fd843be26f89b5fe3415aeec3055c54d786 (patch) | |
| tree | 9dd87794562d797ec8291fd00af0409b406467df /StardewModdingAPI/Entities/SPlayer.cs | |
| parent | 6f64d448f937a9a2abab4a75e81491410ddbf226 (diff) | |
| download | SMAPI-12bf4fd843be26f89b5fe3415aeec3055c54d786.tar.gz SMAPI-12bf4fd843be26f89b5fe3415aeec3055c54d786.tar.bz2 SMAPI-12bf4fd843be26f89b5fe3415aeec3055c54d786.zip | |
someone needs to generate xml doc info im not fuck that shit
Diffstat (limited to 'StardewModdingAPI/Entities/SPlayer.cs')
| -rw-r--r-- | StardewModdingAPI/Entities/SPlayer.cs | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/StardewModdingAPI/Entities/SPlayer.cs b/StardewModdingAPI/Entities/SPlayer.cs index c74ba461..d464cded 100644 --- a/StardewModdingAPI/Entities/SPlayer.cs +++ b/StardewModdingAPI/Entities/SPlayer.cs @@ -1,33 +1,33 @@ -using System.Collections.Generic;
-using StardewModdingAPI.Inheritance;
+using System;
+using System.Collections.Generic;
using StardewValley;
namespace StardewModdingAPI.Entities
{
- public static class SPlayer
+ /// <summary>
+ /// Static class for intergrating with the player
+ /// </summary>
+ public class SPlayer
{
- public static List<Farmer> AllFarmers
- {
- get
- {
- return SGame.getAllFarmers();
- }
- }
+ /// <summary>
+ /// Calls 'getAllFarmers' in Game1
+ /// </summary>
+ public static List<Farmer> AllFarmers => Game1.getAllFarmers();
- public static Farmer CurrentFarmer
- {
- get
- {
- return SGame.player;
- }
- }
+ /// <summary>
+ /// Do not use.
+ /// </summary>
+ [Obsolete("Use 'Player' instead.")]
+ public static Farmer CurrentFarmer => Game1.player;
- public static GameLocation CurrentFarmerLocation
- {
- get
- {
- return SGame.player.currentLocation;
- }
- }
+ /// <summary>
+ /// Gets the current player from Game1
+ /// </summary>
+ public static Farmer Player => Game1.player;
+
+ /// <summary>
+ /// Gets the player's current location from Game1
+ /// </summary>
+ public static GameLocation CurrentFarmerLocation => Player.currentLocation;
}
-}
+}
\ No newline at end of file |