using System.Diagnostics.CodeAnalysis;
using Microsoft.Xna.Framework.Input;
using StardewModdingAPI.Events;
namespace StardewModdingAPI.Framework.Events
{
/// Manages SMAPI events.
[SuppressMessage("ReSharper", "InconsistentNaming", Justification = "Private fields are deliberately named to simplify organisation.")]
internal class EventManager
{
/*********
** Events (new)
*********/
/****
** Display
****/
/// Raised after a game menu is opened, closed, or replaced.
public readonly ManagedEvent MenuChanged;
/// Raised before the game draws anything to the screen in a draw tick, as soon as the sprite batch is opened. The sprite batch may be closed and reopened multiple times after this event is called, but it's only raised once per draw tick. This event isn't useful for drawing to the screen, since the game will draw over it.
public readonly ManagedEvent Rendering;
/// Raised after the game draws to the sprite patch in a draw tick, just before the final sprite batch is rendered to the screen. Since the game may open/close the sprite batch multiple times in a draw tick, the sprite batch may not contain everything being drawn and some things may already be rendered to the screen. Content drawn to the sprite batch at this point will be drawn over all vanilla content (including menus, HUD, and cursor).
public readonly ManagedEvent Rendered;
/// Raised before the game world is drawn to the screen.
public readonly ManagedEvent RenderingWorld;
/// Raised after the game world is drawn to the sprite patch, before it's rendered to the screen.
public readonly ManagedEvent RenderedWorld;
/// When a menu is open ( isn't null), raised before that menu is drawn to the screen.
public readonly ManagedEvent RenderingActiveMenu;
/// When a menu is open ( isn't null), raised after that menu is drawn to the sprite batch but before it's rendered to the screen.
public readonly ManagedEvent RenderedActiveMenu;
/// Raised before drawing the HUD (item toolbar, clock, etc) to the screen.
public readonly ManagedEvent RenderingHud;
/// Raised after drawing the HUD (item toolbar, clock, etc) to the sprite batch, but before it's rendered to the screen.
public readonly ManagedEvent RenderedHud;
/// Raised after the game window is resized.
public readonly ManagedEvent WindowResized;
/****
** Game loop
****/
/// Raised after the game is launched, right before the first update tick.
public readonly ManagedEvent GameLaunched;
/// Raised before the game performs its overall update tick (≈60 times per second).
public readonly ManagedEvent UpdateTicking;
/// Raised after the game performs its overall update tick (≈60 times per second).
public readonly ManagedEvent UpdateTicked;
/// Raised before the game creates the save file.
public readonly ManagedEvent SaveCreating;
/// Raised after the game finishes creating the save file.
public readonly ManagedEvent SaveCreated;
/// Raised before the game begins writes data to the save file (except the initial save creation).
public readonly ManagedEvent Saving;
/// Raised after the game finishes writing data to the save file (except the initial save creation).
public readonly ManagedEvent Saved;
/// Raised after the player loads a save slot.
public readonly ManagedEvent SaveLoaded;
/// Raised after the game begins a new day, including when loading a save.
public readonly ManagedEvent DayStarted;
/// Raised before the game ends the current day. This happens before it starts setting up the next day and before .
public readonly ManagedEvent DayEnding;
/// Raised after the in-game clock time changes.
public readonly ManagedEvent TimeChanged;
/// Raised after the game returns to the title screen.
public readonly ManagedEvent ReturnedToTitle;
/****
** Input
****/
/// Raised after the player presses a button on the keyboard, controller, or mouse.
public readonly ManagedEvent ButtonPressed;
/// Raised after the player released a button on the keyboard, controller, or mouse.
public readonly ManagedEvent ButtonReleased;
/// Raised after the player moves the in-game cursor.
public readonly ManagedEvent CursorMoved;
/// Raised after the player scrolls the mouse wheel.
public readonly ManagedEvent MouseWheelScrolled;
/****
** Player
****/
/// Raised after items are added or removed to a player's inventory.
public readonly ManagedEvent InventoryChanged;
/// Raised after a player skill level changes. This happens as soon as they level up, not when the game notifies the player after their character goes to bed.
public readonly ManagedEvent LevelChanged;
/// Raised after a player warps to a new location.
public readonly ManagedEvent Warped;
/****
** World
****/
/// Raised after a game location is added or removed.
public readonly ManagedEvent LocationListChanged;
/// Raised after buildings are added or removed in a location.
public readonly ManagedEvent BuildingListChanged;
/// Raised after debris are added or removed in a location.
public readonly ManagedEvent DebrisListChanged;
/// Raised after large terrain features (like bushes) are added or removed in a location.
public readonly ManagedEvent LargeTerrainFeatureListChanged;
/// Raised after NPCs are added or removed in a location.
public readonly ManagedEvent NpcListChanged;
/// Raised after objects are added or removed in a location.
public readonly ManagedEvent ObjectListChanged;
/// Raised after terrain features (like floors and trees) are added or removed in a location.
public readonly ManagedEvent TerrainFeatureListChanged;
/****
** Specialised
****/
/// Raised before the game performs its overall update tick (≈60 times per second). See notes on .
public readonly ManagedEvent UnvalidatedUpdateTicking;
/// Raised after the game performs its overall update tick (≈60 times per second). See notes on .
public readonly ManagedEvent UnvalidatedUpdateTicked;
/*********
** Events (old)
*********/
/****
** ContentEvents
****/
/// Raised after the content language changes.
public readonly ManagedEvent> Legacy_LocaleChanged;
/****
** ControlEvents
****/
/// Raised when the changes. That happens when the player presses or releases a key.
public readonly ManagedEvent Legacy_KeyboardChanged;
/// Raised after the player presses a keyboard key.
public readonly ManagedEvent Legacy_KeyPressed;
/// Raised after the player releases a keyboard key.
public readonly ManagedEvent Legacy_KeyReleased;
/// Raised when the changes. That happens when the player moves the mouse, scrolls the mouse wheel, or presses/releases a button.
public readonly ManagedEvent Legacy_MouseChanged;
/// The player pressed a controller button. This event isn't raised for trigger buttons.
public readonly ManagedEvent Legacy_ControllerButtonPressed;
/// The player released a controller button. This event isn't raised for trigger buttons.
public readonly ManagedEvent Legacy_ControllerButtonReleased;
/// The player pressed a controller trigger button.
public readonly ManagedEvent Legacy_ControllerTriggerPressed;
/// The player released a controller trigger button.
public readonly ManagedEvent Legacy_ControllerTriggerReleased;
/****
** GameEvents
****/
/// Raised once after the game initialises and all methods have been called.
public readonly ManagedEvent Legacy_FirstUpdateTick;
/// Raised when the game updates its state (≈60 times per second).
public readonly ManagedEvent Legacy_UpdateTick;
/// Raised every other tick (≈30 times per second).
public readonly ManagedEvent Legacy_SecondUpdateTick;
/// Raised every fourth tick (≈15 times per second).
public readonly ManagedEvent Legacy_FourthUpdateTick;
/// Raised every eighth tick (≈8 times per second).
public readonly ManagedEvent Legacy_EighthUpdateTick;
/// Raised every 15th tick (≈4 times per second).
public readonly ManagedEvent Legacy_QuarterSecondTick;
/// Raised every 30th tick (≈twice per second).
public readonly ManagedEvent Legacy_HalfSecondTick;
/// Raised every 60th tick (≈once per second).
public readonly ManagedEvent Legacy_OneSecondTick;
/****
** GraphicsEvents
****/
/// Raised after the game window is resized.
public readonly ManagedEvent Legacy_Resize;
/// Raised before drawing the world to the screen.
public readonly ManagedEvent Legacy_OnPreRenderEvent;
/// Raised after drawing the world to the screen.
public readonly ManagedEvent Legacy_OnPostRenderEvent;
/// 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.)
public readonly ManagedEvent Legacy_OnPreRenderHudEvent;
/// 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.)
public readonly ManagedEvent Legacy_OnPostRenderHudEvent;
/// Raised before drawing a menu to the screen during a draw loop. This includes the game's internal menus like the title screen.
public readonly ManagedEvent Legacy_OnPreRenderGuiEvent;
/// Raised after drawing a menu to the screen during a draw loop. This includes the game's internal menus like the title screen.
public readonly ManagedEvent Legacy_OnPostRenderGuiEvent;
/****
** InputEvents
****/
/// Raised after the player presses a button on the keyboard, controller, or mouse.
public readonly ManagedEvent Legacy_ButtonPressed;
/// Raised after the player releases a keyboard key on the keyboard, controller, or mouse.
public readonly ManagedEvent Legacy_ButtonReleased;
/****
** LocationEvents
****/
/// Raised after a game location is added or removed.
public readonly ManagedEvent Legacy_LocationsChanged;
/// Raised after buildings are added or removed in a location.
public readonly ManagedEvent Legacy_BuildingsChanged;
/// Raised after objects are added or removed in a location.
public readonly ManagedEvent Legacy_ObjectsChanged;
/****
** MenuEvents
****/
/// Raised after a game menu is opened or replaced with another menu. This event is not invoked when a menu is closed.
public readonly ManagedEvent Legacy_MenuChanged;
/// Raised after a game menu is closed.
public readonly ManagedEvent Legacy_MenuClosed;
/****
** MultiplayerEvents
****/
/// Raised before the game syncs changes from other players.
public readonly ManagedEvent Legacy_BeforeMainSync;
/// Raised after the game syncs changes from other players.
public readonly ManagedEvent Legacy_AfterMainSync;
/// Raised before the game broadcasts changes to other players.
public readonly ManagedEvent Legacy_BeforeMainBroadcast;
/// Raised after the game broadcasts changes to other players.
public readonly ManagedEvent Legacy_AfterMainBroadcast;
/****
** MineEvents
****/
/// Raised after the player warps to a new level of the mine.
public readonly ManagedEvent Legacy_MineLevelChanged;
/****
** PlayerEvents
****/
/// Raised after the player's inventory changes in any way (added or removed item, sorted, etc).
public readonly ManagedEvent Legacy_InventoryChanged;
/// Raised after the player levels up a skill. This happens as soon as they level up, not when the game notifies the player after their character goes to bed.
public readonly ManagedEvent Legacy_LeveledUp;
/// Raised after the player warps to a new location.
public readonly ManagedEvent Legacy_PlayerWarped;
/****
** SaveEvents
****/
/// Raised before the game creates the save file.
public readonly ManagedEvent Legacy_BeforeCreateSave;
/// Raised after the game finishes creating the save file.
public readonly ManagedEvent Legacy_AfterCreateSave;
/// Raised before the game begins writes data to the save file.
public readonly ManagedEvent Legacy_BeforeSave;
/// Raised after the game finishes writing data to the save file.
public readonly ManagedEvent Legacy_AfterSave;
/// Raised after the player loads a save slot.
public readonly ManagedEvent Legacy_AfterLoad;
/// Raised after the game returns to the title screen.
public readonly ManagedEvent Legacy_AfterReturnToTitle;
/****
** SpecialisedEvents
****/
/// Raised when the game updates its state (≈60 times per second), regardless of normal SMAPI validation. This event is not thread-safe and may be invoked while game logic is running asynchronously. Changes to game state in this method may crash the game or corrupt an in-progress save. Do not use this event unless you're fully aware of the context in which your code will be run. Mods using this method will trigger a stability warning in the SMAPI console.
public readonly ManagedEvent Legacy_UnvalidatedUpdateTick;
/****
** TimeEvents
****/
/// Raised after the game begins a new day, including when loading a save.
public readonly ManagedEvent Legacy_AfterDayStarted;
/// Raised after the in-game clock changes.
public readonly ManagedEvent Legacy_TimeOfDayChanged;
/*********
** Public methods
*********/
/// Construct an instance.
/// Writes messages to the log.
/// The mod registry with which to identify mods.
public EventManager(IMonitor monitor, ModRegistry modRegistry)
{
// create shortcut initialisers
ManagedEvent ManageEventOf(string typeName, string eventName) => new ManagedEvent($"{typeName}.{eventName}", monitor, modRegistry);
ManagedEvent ManageEvent(string typeName, string eventName) => new ManagedEvent($"{typeName}.{eventName}", monitor, modRegistry);
// init events (new)
this.MenuChanged = ManageEventOf(nameof(IModEvents.Display), nameof(IDisplayEvents.MenuChanged));
this.Rendering = ManageEventOf(nameof(IModEvents.Display), nameof(IDisplayEvents.Rendering));
this.Rendered = ManageEventOf(nameof(IModEvents.Display), nameof(IDisplayEvents.Rendered));
this.RenderingWorld = ManageEventOf(nameof(IModEvents.Display), nameof(IDisplayEvents.RenderingWorld));
this.RenderedWorld = ManageEventOf(nameof(IModEvents.Display), nameof(IDisplayEvents.RenderedWorld));
this.RenderingActiveMenu = ManageEventOf(nameof(IModEvents.Display), nameof(IDisplayEvents.RenderingActiveMenu));
this.RenderedActiveMenu = ManageEventOf(nameof(IModEvents.Display), nameof(IDisplayEvents.RenderedActiveMenu));
this.RenderingHud = ManageEventOf(nameof(IModEvents.Display), nameof(IDisplayEvents.RenderingHud));
this.RenderedHud = ManageEventOf(nameof(IModEvents.Display), nameof(IDisplayEvents.RenderedHud));
this.WindowResized = ManageEventOf(nameof(IModEvents.Display), nameof(IDisplayEvents.WindowResized));
this.GameLaunched = ManageEventOf(nameof(IModEvents.GameLoop), nameof(IGameLoopEvents.GameLaunched));
this.UpdateTicking = ManageEventOf(nameof(IModEvents.GameLoop), nameof(IGameLoopEvents.UpdateTicking));
this.UpdateTicked = ManageEventOf(nameof(IModEvents.GameLoop), nameof(IGameLoopEvents.UpdateTicked));
this.SaveCreating = ManageEventOf(nameof(IModEvents.GameLoop), nameof(IGameLoopEvents.SaveCreating));
this.SaveCreated = ManageEventOf(nameof(IModEvents.GameLoop), nameof(IGameLoopEvents.SaveCreated));
this.Saving = ManageEventOf(nameof(IModEvents.GameLoop), nameof(IGameLoopEvents.Saving));
this.Saved = ManageEventOf(nameof(IModEvents.GameLoop), nameof(IGameLoopEvents.Saved));
this.SaveLoaded = ManageEventOf(nameof(IModEvents.GameLoop), nameof(IGameLoopEvents.SaveLoaded));
this.DayStarted = ManageEventOf(nameof(IModEvents.GameLoop), nameof(IGameLoopEvents.DayStarted));
this.DayEnding = ManageEventOf(nameof(IModEvents.GameLoop), nameof(IGameLoopEvents.DayEnding));
this.TimeChanged = ManageEventOf(nameof(IModEvents.GameLoop), nameof(IGameLoopEvents.TimeChanged));
this.ReturnedToTitle = ManageEventOf(nameof(IModEvents.GameLoop), nameof(IGameLoopEvents.ReturnedToTitle));
this.ButtonPressed = ManageEventOf(nameof(IModEvents.Input), nameof(IInputEvents.ButtonPressed));
this.ButtonReleased = ManageEventOf(nameof(IModEvents.Input), nameof(IInputEvents.ButtonReleased));
this.CursorMoved = ManageEventOf(nameof(IModEvents.Input), nameof(IInputEvents.CursorMoved));
this.MouseWheelScrolled = ManageEventOf(nameof(IModEvents.Input), nameof(IInputEvents.MouseWheelScrolled));
this.InventoryChanged = ManageEventOf(nameof(IModEvents.Player), nameof(IPlayerEvents.InventoryChanged));
this.LevelChanged = ManageEventOf(nameof(IModEvents.Player), nameof(IPlayerEvents.LevelChanged));
this.Warped = ManageEventOf(nameof(IModEvents.Player), nameof(IPlayerEvents.Warped));
this.BuildingListChanged = ManageEventOf(nameof(IModEvents.World), nameof(IWorldEvents.LocationListChanged));
this.DebrisListChanged = ManageEventOf(nameof(IModEvents.World), nameof(IWorldEvents.DebrisListChanged));
this.LargeTerrainFeatureListChanged = ManageEventOf(nameof(IModEvents.World), nameof(IWorldEvents.LargeTerrainFeatureListChanged));
this.LocationListChanged = ManageEventOf(nameof(IModEvents.World), nameof(IWorldEvents.BuildingListChanged));
this.NpcListChanged = ManageEventOf(nameof(IModEvents.World), nameof(IWorldEvents.NpcListChanged));
this.ObjectListChanged = ManageEventOf(nameof(IModEvents.World), nameof(IWorldEvents.ObjectListChanged));
this.TerrainFeatureListChanged = ManageEventOf(nameof(IModEvents.World), nameof(IWorldEvents.TerrainFeatureListChanged));
this.UnvalidatedUpdateTicking = ManageEventOf(nameof(IModEvents.Specialised), nameof(ISpecialisedEvents.UnvalidatedUpdateTicking));
this.UnvalidatedUpdateTicked = ManageEventOf(nameof(IModEvents.Specialised), nameof(ISpecialisedEvents.UnvalidatedUpdateTicked));
// init events (old)
this.Legacy_LocaleChanged = ManageEventOf>(nameof(ContentEvents), nameof(ContentEvents.AfterLocaleChanged));
this.Legacy_ControllerButtonPressed = ManageEventOf(nameof(ControlEvents), nameof(ControlEvents.ControllerButtonPressed));
this.Legacy_ControllerButtonReleased = ManageEventOf(nameof(ControlEvents), nameof(ControlEvents.ControllerButtonReleased));
this.Legacy_ControllerTriggerPressed = ManageEventOf(nameof(ControlEvents), nameof(ControlEvents.ControllerTriggerPressed));
this.Legacy_ControllerTriggerReleased = ManageEventOf(nameof(ControlEvents), nameof(ControlEvents.ControllerTriggerReleased));
this.Legacy_KeyboardChanged = ManageEventOf(nameof(ControlEvents), nameof(ControlEvents.KeyboardChanged));
this.Legacy_KeyPressed = ManageEventOf(nameof(ControlEvents), nameof(ControlEvents.KeyPressed));
this.Legacy_KeyReleased = ManageEventOf(nameof(ControlEvents), nameof(ControlEvents.KeyReleased));
this.Legacy_MouseChanged = ManageEventOf(nameof(ControlEvents), nameof(ControlEvents.MouseChanged));
this.Legacy_FirstUpdateTick = ManageEvent(nameof(GameEvents), nameof(GameEvents.FirstUpdateTick));
this.Legacy_UpdateTick = ManageEvent(nameof(GameEvents), nameof(GameEvents.UpdateTick));
this.Legacy_SecondUpdateTick = ManageEvent(nameof(GameEvents), nameof(GameEvents.SecondUpdateTick));
this.Legacy_FourthUpdateTick = ManageEvent(nameof(GameEvents), nameof(GameEvents.FourthUpdateTick));
this.Legacy_EighthUpdateTick = ManageEvent(nameof(GameEvents), nameof(GameEvents.EighthUpdateTick));
this.Legacy_QuarterSecondTick = ManageEvent(nameof(GameEvents), nameof(GameEvents.QuarterSecondTick));
this.Legacy_HalfSecondTick = ManageEvent(nameof(GameEvents), nameof(GameEvents.HalfSecondTick));
this.Legacy_OneSecondTick = ManageEvent(nameof(GameEvents), nameof(GameEvents.OneSecondTick));
this.Legacy_Resize = ManageEvent(nameof(GraphicsEvents), nameof(GraphicsEvents.Resize));
this.Legacy_OnPreRenderEvent = ManageEvent(nameof(GraphicsEvents), nameof(GraphicsEvents.OnPreRenderEvent));
this.Legacy_OnPostRenderEvent = ManageEvent(nameof(GraphicsEvents), nameof(GraphicsEvents.OnPostRenderEvent));
this.Legacy_OnPreRenderHudEvent = ManageEvent(nameof(GraphicsEvents), nameof(GraphicsEvents.OnPreRenderHudEvent));
this.Legacy_OnPostRenderHudEvent = ManageEvent(nameof(GraphicsEvents), nameof(GraphicsEvents.OnPostRenderHudEvent));
this.Legacy_OnPreRenderGuiEvent = ManageEvent(nameof(GraphicsEvents), nameof(GraphicsEvents.OnPreRenderGuiEvent));
this.Legacy_OnPostRenderGuiEvent = ManageEvent(nameof(GraphicsEvents), nameof(GraphicsEvents.OnPostRenderGuiEvent));
this.Legacy_ButtonPressed = ManageEventOf(nameof(InputEvents), nameof(InputEvents.ButtonPressed));
this.Legacy_ButtonReleased = ManageEventOf(nameof(InputEvents), nameof(InputEvents.ButtonReleased));
this.Legacy_LocationsChanged = ManageEventOf(nameof(LocationEvents), nameof(LocationEvents.LocationsChanged));
this.Legacy_BuildingsChanged = ManageEventOf(nameof(LocationEvents), nameof(LocationEvents.BuildingsChanged));
this.Legacy_ObjectsChanged = ManageEventOf(nameof(LocationEvents), nameof(LocationEvents.ObjectsChanged));
this.Legacy_MenuChanged = ManageEventOf(nameof(MenuEvents), nameof(MenuEvents.MenuChanged));
this.Legacy_MenuClosed = ManageEventOf(nameof(MenuEvents), nameof(MenuEvents.MenuClosed));
this.Legacy_BeforeMainBroadcast = ManageEvent(nameof(MultiplayerEvents), nameof(MultiplayerEvents.BeforeMainBroadcast));
this.Legacy_AfterMainBroadcast = ManageEvent(nameof(MultiplayerEvents), nameof(MultiplayerEvents.AfterMainBroadcast));
this.Legacy_BeforeMainSync = ManageEvent(nameof(MultiplayerEvents), nameof(MultiplayerEvents.BeforeMainSync));
this.Legacy_AfterMainSync = ManageEvent(nameof(MultiplayerEvents), nameof(MultiplayerEvents.AfterMainSync));
this.Legacy_MineLevelChanged = ManageEventOf(nameof(MineEvents), nameof(MineEvents.MineLevelChanged));
this.Legacy_InventoryChanged = ManageEventOf(nameof(PlayerEvents), nameof(PlayerEvents.InventoryChanged));
this.Legacy_LeveledUp = ManageEventOf(nameof(PlayerEvents), nameof(PlayerEvents.LeveledUp));
this.Legacy_PlayerWarped = ManageEventOf(nameof(PlayerEvents), nameof(PlayerEvents.Warped));
this.Legacy_BeforeCreateSave = ManageEvent(nameof(SaveEvents), nameof(SaveEvents.BeforeCreate));
this.Legacy_AfterCreateSave = ManageEvent(nameof(SaveEvents), nameof(SaveEvents.AfterCreate));
this.Legacy_BeforeSave = ManageEvent(nameof(SaveEvents), nameof(SaveEvents.BeforeSave));
this.Legacy_AfterSave = ManageEvent(nameof(SaveEvents), nameof(SaveEvents.AfterSave));
this.Legacy_AfterLoad = ManageEvent(nameof(SaveEvents), nameof(SaveEvents.AfterLoad));
this.Legacy_AfterReturnToTitle = ManageEvent(nameof(SaveEvents), nameof(SaveEvents.AfterReturnToTitle));
this.Legacy_UnvalidatedUpdateTick = ManageEvent(nameof(SpecialisedEvents), nameof(SpecialisedEvents.UnvalidatedUpdateTick));
this.Legacy_AfterDayStarted = ManageEvent(nameof(TimeEvents), nameof(TimeEvents.AfterDayStarted));
this.Legacy_TimeOfDayChanged = ManageEventOf(nameof(TimeEvents), nameof(TimeEvents.TimeOfDayChanged));
}
}
}