summaryrefslogtreecommitdiff
path: root/src/SMAPI/Events/LocationEvents.cs
blob: 4aad53879de7dc39c019b6fecd8d8dd45428f5db (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
60
61
62
63
64
65
66
67
68
69
70
using System;
using StardewModdingAPI.Framework;
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>
    [Obsolete("Use " + nameof(Mod.Helper) + "." + nameof(IModHelper.Events) + " instead. See https://smapi.io/3.0 for more info.")]
    public static class LocationEvents
    {
        /*********
        ** Properties
        *********/
        /// <summary>The core event manager.</summary>
        private static EventManager EventManager;

        /// <summary>Manages deprecation warnings.</summary>
        private static DeprecationManager DeprecationManager;


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

        /// <summary>Raised after buildings are added or removed in a location.</summary>
        public static event EventHandler<EventArgsLocationBuildingsChanged> BuildingsChanged
        {
            add
            {
                LocationEvents.DeprecationManager.WarnForOldEvents();
                LocationEvents.EventManager.Legacy_BuildingsChanged.Add(value);
            }
            remove => LocationEvents.EventManager.Legacy_BuildingsChanged.Remove(value);
        }

        /// <summary>Raised after objects are added or removed in a location.</summary>
        public static event EventHandler<EventArgsLocationObjectsChanged> ObjectsChanged
        {
            add
            {
                LocationEvents.DeprecationManager.WarnForOldEvents();
                LocationEvents.EventManager.Legacy_ObjectsChanged.Add(value);
            }
            remove => LocationEvents.EventManager.Legacy_ObjectsChanged.Remove(value);
        }


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