summaryrefslogtreecommitdiff
path: root/src/SMAPI/Events/MenuEvents.cs
blob: e36cb4988c25858949bcd0af838d8d1464b24243 (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
#if !SMAPI_3_0_STRICT
using System;
using StardewModdingAPI.Framework;
using StardewModdingAPI.Framework.Events;

namespace StardewModdingAPI.Events
{
    /// <summary>Events raised when a game menu is opened or closed (including internal menus like the title screen).</summary>
    [Obsolete("Use " + nameof(Mod.Helper) + "." + nameof(IModHelper.Events) + " instead. See https://smapi.io/3.0 for more info.")]
    public static class MenuEvents
    {
        /*********
        ** 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 menu is opened or replaced with another menu. This event is not invoked when a menu is closed.</summary>
        public static event EventHandler<EventArgsClickableMenuChanged> MenuChanged
        {
            add
            {
                MenuEvents.DeprecationManager.WarnForOldEvents();
                MenuEvents.EventManager.Legacy_MenuChanged.Add(value);
            }
            remove => MenuEvents.EventManager.Legacy_MenuChanged.Remove(value);
        }

        /// <summary>Raised after a game menu is closed.</summary>
        public static event EventHandler<EventArgsClickableMenuClosed> MenuClosed
        {
            add
            {
                MenuEvents.DeprecationManager.WarnForOldEvents();
                MenuEvents.EventManager.Legacy_MenuClosed.Add(value);
            }
            remove => MenuEvents.EventManager.Legacy_MenuClosed.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)
        {
            MenuEvents.EventManager = eventManager;
            MenuEvents.DeprecationManager = deprecationManager;
        }
    }
}
#endif