summaryrefslogtreecommitdiff
path: root/src/SMAPI/Events/LocationEvents.cs
blob: 3ed091365174c77f916761a42040b515d7f8d475 (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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
using System;
using StardewModdingAPI.Framework.Events;

namespace StardewModdingAPI.Events
{
    /// <summary>Events raised when the player transitions between game locations, a location is added or removed, or the objects in the current location change.</summary>
    public static class LocationEvents
    {
        /*********
        ** Properties
        *********/
        /// <summary>The core event manager.</summary>
        private static EventManager EventManager;


        /*********
        ** Events
        *********/
        /// <summary>Raised after the player warps to a new location.</summary>
        public static event EventHandler<EventArgsCurrentLocationChanged> CurrentLocationChanged
        {
            add => LocationEvents.EventManager.Location_CurrentLocationChanged.Add(value);
            remove => LocationEvents.EventManager.Location_CurrentLocationChanged.Remove(value);
        }

        /// <summary>Raised after a game location is added or removed.</summary>
        public static event EventHandler<EventArgsGameLocationsChanged> LocationsChanged
        {
            add => LocationEvents.EventManager.Location_LocationsChanged.Add(value);
            remove => LocationEvents.EventManager.Location_LocationsChanged.Remove(value);
        }

        /// <summary>Raised after the list of objects in the current location changes (e.g. an object is added or removed).</summary>
        [Obsolete("Use " + nameof(LocationEvents) + "." + nameof(LocationEvents.ObjectsChanged) + " instead")]
        public static event EventHandler<EventArgsLocationObjectsChanged> LocationObjectsChanged
        {
            add => LocationEvents.EventManager.Location_LocationObjectsChanged.Add(value);
            remove => LocationEvents.EventManager.Location_LocationObjectsChanged.Remove(value);
        }

        /// <summary>Raised after the list of objects in a location changes (e.g. an object is added or removed).</summary>
        public static event EventHandler<EventArgsLocationObjectsChanged> ObjectsChanged
        {
            add => LocationEvents.EventManager.Location_ObjectsChanged.Add(value);
            remove => LocationEvents.EventManager.Location_ObjectsChanged.Remove(value);
        }


        /*********
        ** Public methods
        *********/
        /// <summary>Initialise the events.</summary>
        /// <param name="eventManager">The core event manager.</param>
        internal static void Init(EventManager eventManager)
        {
            LocationEvents.EventManager = eventManager;
        }
    }
}