summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/Entities/SPlayer.cs
blob: d464cded83c0b3827a8571d4fdd937b3ff4a1063 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
using System;
using System.Collections.Generic;
using StardewValley;

namespace StardewModdingAPI.Entities
{
    /// <summary>
    ///     Static class for intergrating with the player
    /// </summary>
    public class SPlayer
    {
        /// <summary>
        /// Calls 'getAllFarmers' in Game1
        /// </summary>
        public static List<Farmer> AllFarmers => Game1.getAllFarmers();

        /// <summary>
        /// Do not use.
        /// </summary>
        [Obsolete("Use 'Player' instead.")]
        public static Farmer CurrentFarmer => Game1.player;

        /// <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;
    }
}