summaryrefslogtreecommitdiff
path: root/src/SMAPI/Framework/Events/ModGameLoopEvents.cs
blob: 0177c22ec19205d4fbfa02a99e5b4fc3561775a1 (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
121
using System;
using StardewModdingAPI.Events;

namespace StardewModdingAPI.Framework.Events
{
    /// <summary>Events linked to the game's update loop. The update loop runs roughly ≈60 times/second to run game logic like state changes, action handling, etc. These can be useful, but you should consider more semantic events like <see cref="IInputEvents"/> if possible.</summary>
    internal class ModGameLoopEvents : ModEventsBase, IGameLoopEvents
    {
        /*********
        ** Accessors
        *********/
        /// <summary>Raised after the game is launched, right before the first update tick.</summary>
        public event EventHandler<GameLaunchedEventArgs> GameLaunched
        {
            add => this.EventManager.GameLaunched.Add(value);
            remove => this.EventManager.GameLaunched.Remove(value);
        }

        /// <summary>Raised before the game performs its overall update tick (≈60 times per second).</summary>
        public event EventHandler<UpdateTickingEventArgs> UpdateTicking
        {
            add => this.EventManager.UpdateTicking.Add(value);
            remove => this.EventManager.UpdateTicking.Remove(value);
        }

        /// <summary>Raised after the game performs its overall update tick (≈60 times per second).</summary>
        public event EventHandler<UpdateTickedEventArgs> UpdateTicked
        {
            add => this.EventManager.UpdateTicked.Add(value);
            remove => this.EventManager.UpdateTicked.Remove(value);
        }

        /// <summary>Raised once per second before the game state is updated.</summary>
        public event EventHandler<OneSecondUpdateTickingEventArgs> OneSecondUpdateTicking
        {
            add => this.EventManager.OneSecondUpdateTicking.Add(value);
            remove => this.EventManager.OneSecondUpdateTicking.Remove(value);
        }

        /// <summary>Raised once per second after the game state is updated.</summary>
        public event EventHandler<OneSecondUpdateTickedEventArgs> OneSecondUpdateTicked
        {
            add => this.EventManager.OneSecondUpdateTicked.Add(value);
            remove => this.EventManager.OneSecondUpdateTicked.Remove(value);
        }

        /// <summary>Raised before the game creates a new save file.</summary>
        public event EventHandler<SaveCreatingEventArgs> SaveCreating
        {
            add => this.EventManager.SaveCreating.Add(value);
            remove => this.EventManager.SaveCreating.Remove(value);
        }

        /// <summary>Raised after the game finishes creating the save file.</summary>
        public event EventHandler<SaveCreatedEventArgs> SaveCreated
        {
            add => this.EventManager.SaveCreated.Add(value);
            remove => this.EventManager.SaveCreated.Remove(value);
        }

        /// <summary>Raised before the game begins writes data to the save file.</summary>
        public event EventHandler<SavingEventArgs> Saving
        {
            add => this.EventManager.Saving.Add(value);
            remove => this.EventManager.Saving.Remove(value);
        }

        /// <summary>Raised after the game finishes writing data to the save file.</summary>
        public event EventHandler<SavedEventArgs> Saved
        {
            add => this.EventManager.Saved.Add(value);
            remove => this.EventManager.Saved.Remove(value);
        }

        /// <summary>Raised after the player loads a save slot and the world is initialised.</summary>
        public event EventHandler<SaveLoadedEventArgs> SaveLoaded
        {
            add => this.EventManager.SaveLoaded.Add(value);
            remove => this.EventManager.SaveLoaded.Remove(value);
        }

        /// <summary>Raised after the game begins a new day (including when the player loads a save).</summary>
        public event EventHandler<DayStartedEventArgs> DayStarted
        {
            add => this.EventManager.DayStarted.Add(value);
            remove => this.EventManager.DayStarted.Remove(value);
        }

        /// <summary>Raised before the game ends the current day. This happens before it starts setting up the next day and before <see cref="IGameLoopEvents.Saving"/>.</summary>
        public event EventHandler<DayEndingEventArgs> DayEnding
        {
            add => this.EventManager.DayEnding.Add(value);
            remove => this.EventManager.DayEnding.Remove(value);
        }

        /// <summary>Raised after the in-game clock time changes.</summary>
        public event EventHandler<TimeChangedEventArgs> TimeChanged
        {

            add => this.EventManager.TimeChanged.Add(value);
            remove => this.EventManager.TimeChanged.Remove(value);
        }

        /// <summary>Raised after the game returns to the title screen.</summary>
        public event EventHandler<ReturnedToTitleEventArgs> ReturnedToTitle
        {
            add => this.EventManager.ReturnedToTitle.Add(value);
            remove => this.EventManager.ReturnedToTitle.Remove(value);
        }


        /*********
        ** Public methods
        *********/
        /// <summary>Construct an instance.</summary>
        /// <param name="mod">The mod which uses this instance.</param>
        /// <param name="eventManager">The underlying event manager.</param>
        internal ModGameLoopEvents(IModMetadata mod, EventManager eventManager)
            : base(mod, eventManager) { }
    }
}