summaryrefslogtreecommitdiff
path: root/src/SMAPI/Events/IModEvents.cs
blob: 76da7751f57f1156af012dd9086775eeab9ebab8 (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
namespace StardewModdingAPI.Events
{
    /// <summary>Manages access to events raised by SMAPI.</summary>
    public interface IModEvents
    {
        /// <summary>Events related to UI and drawing to the screen.</summary>
        IDisplayEvents Display { get; }

        /// <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="Input"/> if possible.</summary>
        IGameLoopEvents GameLoop { get; }

        /// <summary>Events raised when the player provides input using a controller, keyboard, or mouse.</summary>
        IInputEvents Input { get; }

        /// <summary>Events raised when the player data changes.</summary>
        IPlayerEvents Player { get; }

        /// <summary>Events raised when something changes in the world.</summary>
        IWorldEvents World { get; }

        /// <summary>Events serving specialised edge cases that shouldn't be used by most mods.</summary>
        ISpecialisedEvents Specialised { get; }
    }
}