summaryrefslogtreecommitdiff
path: root/src/SMAPI/Events/GraphicsEvents.cs
blob: 24a16a2980a1fee9c2e5d8d454ecc7c8e2e8e962 (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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
#if !SMAPI_3_0_STRICT
using System;
using StardewModdingAPI.Framework;
using StardewModdingAPI.Framework.Events;

namespace StardewModdingAPI.Events
{
    /// <summary>Events raised during the game's draw loop, when the game is rendering content to the window.</summary>
    [Obsolete("Use " + nameof(Mod.Helper) + "." + nameof(IModHelper.Events) + " instead. See https://smapi.io/3.0 for more info.")]
    public static class GraphicsEvents
    {
        /*********
        ** Fields
        *********/
        /// <summary>The core event manager.</summary>
        private static EventManager EventManager;


        /*********
        ** Events
        *********/
        /// <summary>Raised after the game window is resized.</summary>
        public static event EventHandler Resize
        {
            add
            {
                SCore.DeprecationManager.WarnForOldEvents();
                GraphicsEvents.EventManager.Legacy_Resize.Add(value);
            }
            remove => GraphicsEvents.EventManager.Legacy_Resize.Remove(value);
        }

        /****
        ** Main render events
        ****/
        /// <summary>Raised before drawing the world to the screen.</summary>
        public static event EventHandler OnPreRenderEvent
        {
            add
            {
                SCore.DeprecationManager.WarnForOldEvents();
                GraphicsEvents.EventManager.Legacy_OnPreRenderEvent.Add(value);
            }
            remove => GraphicsEvents.EventManager.Legacy_OnPreRenderEvent.Remove(value);
        }

        /// <summary>Raised after drawing the world to the screen.</summary>
        public static event EventHandler OnPostRenderEvent
        {
            add
            {
                SCore.DeprecationManager.WarnForOldEvents();
                GraphicsEvents.EventManager.Legacy_OnPostRenderEvent.Add(value);
            }
            remove => GraphicsEvents.EventManager.Legacy_OnPostRenderEvent.Remove(value);
        }

        /****
        ** HUD events
        ****/
        /// <summary>Raised before drawing the HUD (item toolbar, clock, etc) to the screen. The HUD is available at this point, but not necessarily visible. (For example, the event is raised even if a menu is open.)</summary>
        public static event EventHandler OnPreRenderHudEvent
        {
            add
            {
                SCore.DeprecationManager.WarnForOldEvents();
                GraphicsEvents.EventManager.Legacy_OnPreRenderHudEvent.Add(value);
            }
            remove => GraphicsEvents.EventManager.Legacy_OnPreRenderHudEvent.Remove(value);
        }

        /// <summary>Raised after drawing the HUD (item toolbar, clock, etc) to the screen. The HUD is available at this point, but not necessarily visible. (For example, the event is raised even if a menu is open.)</summary>
        public static event EventHandler OnPostRenderHudEvent
        {
            add
            {
                SCore.DeprecationManager.WarnForOldEvents();
                GraphicsEvents.EventManager.Legacy_OnPostRenderHudEvent.Add(value);
            }
            remove => GraphicsEvents.EventManager.Legacy_OnPostRenderHudEvent.Remove(value);
        }

        /****
        ** GUI events
        ****/
        /// <summary>Raised before drawing a menu to the screen during a draw loop. This includes the game's internal menus like the title screen.</summary>
        public static event EventHandler OnPreRenderGuiEvent
        {
            add
            {
                SCore.DeprecationManager.WarnForOldEvents();
                GraphicsEvents.EventManager.Legacy_OnPreRenderGuiEvent.Add(value);
            }
            remove => GraphicsEvents.EventManager.Legacy_OnPreRenderGuiEvent.Remove(value);
        }

        /// <summary>Raised after drawing a menu to the screen during a draw loop. This includes the game's internal menus like the title screen.</summary>
        public static event EventHandler OnPostRenderGuiEvent
        {
            add
            {
                SCore.DeprecationManager.WarnForOldEvents();
                GraphicsEvents.EventManager.Legacy_OnPostRenderGuiEvent.Add(value);
            }
            remove => GraphicsEvents.EventManager.Legacy_OnPostRenderGuiEvent.Remove(value);
        }


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