using System;
using System.Diagnostics.CodeAnalysis;
using StardewModdingAPI.Framework;
#pragma warning disable 618 // Suppress obsolete-symbol errors in this file. Since several events are marked obsolete, this produces unnecessary warnings.
namespace StardewModdingAPI.Events
{
/// Events raised when the game changes state.
public static class GameEvents
{
/*********
** Properties
*********/
#if !SMAPI_2_0
/// Manages deprecation warnings.
private static DeprecationManager DeprecationManager;
/// The backing field for .
[SuppressMessage("ReSharper", "InconsistentNaming")]
private static event EventHandler _Initialize;
/// The backing field for .
[SuppressMessage("ReSharper", "InconsistentNaming")]
private static event EventHandler _LoadContent;
/// The backing field for .
[SuppressMessage("ReSharper", "InconsistentNaming")]
private static event EventHandler _GameLoaded;
/// The backing field for .
[SuppressMessage("ReSharper", "InconsistentNaming")]
private static event EventHandler _FirstUpdateTick;
#endif
/*********
** Events
*********/
/// Raised during launch after configuring XNA or MonoGame. The game window hasn't been opened by this point. Called after .
internal static event EventHandler InitializeInternal;
/// Raised during launch after configuring Stardew Valley, loading it into memory, and opening the game window. The window is still blank by this point.
internal static event EventHandler GameLoadedInternal;
#if !SMAPI_2_0
/// Raised during launch after configuring XNA or MonoGame. The game window hasn't been opened by this point. Called after .
[Obsolete("The " + nameof(Mod) + "." + nameof(Mod.Entry) + " method is now called after the " + nameof(GameEvents.Initialize) + " event, so any contained logic can be done directly in " + nameof(Mod.Entry) + ".")]
public static event EventHandler Initialize
{
add
{
GameEvents.DeprecationManager.Warn($"{nameof(GameEvents)}.{nameof(GameEvents.Initialize)}", "1.10", DeprecationLevel.PendingRemoval);
GameEvents._Initialize += value;
}
remove => GameEvents._Initialize -= value;
}
/// Raised before XNA loads or reloads graphics resources. Called during .
[Obsolete("The " + nameof(Mod) + "." + nameof(Mod.Entry) + " method is now called after the " + nameof(GameEvents.LoadContent) + " event, so any contained logic can be done directly in " + nameof(Mod.Entry) + ".")]
public static event EventHandler LoadContent
{
add
{
GameEvents.DeprecationManager.Warn($"{nameof(GameEvents)}.{nameof(GameEvents.LoadContent)}", "1.10", DeprecationLevel.PendingRemoval);
GameEvents._LoadContent += value;
}
remove => GameEvents._LoadContent -= value;
}
/// Raised during launch after configuring Stardew Valley, loading it into memory, and opening the game window. The window is still blank by this point.
[Obsolete("The " + nameof(Mod) + "." + nameof(Mod.Entry) + " method is now called after the game loads, so any contained logic can be done directly in " + nameof(Mod.Entry) + ".")]
public static event EventHandler GameLoaded
{
add
{
GameEvents.DeprecationManager.Warn($"{nameof(GameEvents)}.{nameof(GameEvents.GameLoaded)}", "1.12", DeprecationLevel.PendingRemoval);
GameEvents._GameLoaded += value;
}
remove => GameEvents._GameLoaded -= value;
}
/// Raised during the first game update tick.
[Obsolete("The " + nameof(Mod) + "." + nameof(Mod.Entry) + " method is now called after the game loads, so any contained logic can be done directly in " + nameof(Mod.Entry) + ".")]
public static event EventHandler FirstUpdateTick
{
add
{
GameEvents.DeprecationManager.Warn($"{nameof(GameEvents)}.{nameof(GameEvents.FirstUpdateTick)}", "1.12", DeprecationLevel.PendingRemoval);
GameEvents._FirstUpdateTick += value;
}
remove => GameEvents._FirstUpdateTick -= value;
}
#endif
/// Raised when the game updates its state (≈60 times per second).
public static event EventHandler UpdateTick;
/// Raised every other tick (≈30 times per second).
public static event EventHandler SecondUpdateTick;
/// Raised every fourth tick (≈15 times per second).
public static event EventHandler FourthUpdateTick;
/// Raised every eighth tick (≈8 times per second).
public static event EventHandler EighthUpdateTick;
/// Raised every 15th tick (≈4 times per second).
public static event EventHandler QuarterSecondTick;
/// Raised every 30th tick (≈twice per second).
public static event EventHandler HalfSecondTick;
/// Raised every 60th tick (≈once per second).
public static event EventHandler OneSecondTick;
/*********
** Internal methods
*********/
#if !SMAPI_2_0
/// Injects types required for backwards compatibility.
/// Manages deprecation warnings.
internal static void Shim(DeprecationManager deprecationManager)
{
GameEvents.DeprecationManager = deprecationManager;
}
#endif
/// Raise an event.
/// Encapsulates logging and monitoring.
internal static void InvokeInitialize(IMonitor monitor)
{
monitor.SafelyRaisePlainEvent($"{nameof(GameEvents)}.{nameof(GameEvents.InitializeInternal)}", GameEvents.InitializeInternal?.GetInvocationList());
#if !SMAPI_2_0
monitor.SafelyRaisePlainEvent($"{nameof(GameEvents)}.{nameof(GameEvents.Initialize)}", GameEvents._Initialize?.GetInvocationList());
#endif
}
#if !SMAPI_2_0
/// Raise a event.
/// Encapsulates logging and monitoring.
internal static void InvokeLoadContent(IMonitor monitor)
{
monitor.SafelyRaisePlainEvent($"{nameof(GameEvents)}.{nameof(GameEvents.LoadContent)}", GameEvents._LoadContent?.GetInvocationList());
}
#endif
/// Raise a event.
/// Encapsulates monitoring and logging.
internal static void InvokeGameLoaded(IMonitor monitor)
{
monitor.SafelyRaisePlainEvent($"{nameof(GameEvents)}.{nameof(GameEvents.GameLoadedInternal)}", GameEvents.GameLoadedInternal?.GetInvocationList());
#if !SMAPI_2_0
monitor.SafelyRaisePlainEvent($"{nameof(GameEvents)}.{nameof(GameEvents.GameLoaded)}", GameEvents._GameLoaded?.GetInvocationList());
#endif
}
#if !SMAPI_2_0
/// Raise a event.
/// Encapsulates monitoring and logging.
internal static void InvokeFirstUpdateTick(IMonitor monitor)
{
monitor.SafelyRaisePlainEvent($"{nameof(GameEvents)}.{nameof(GameEvents.FirstUpdateTick)}", GameEvents._FirstUpdateTick?.GetInvocationList());
}
#endif
/// Raise an event.
/// Encapsulates logging and monitoring.
internal static void InvokeUpdateTick(IMonitor monitor)
{
monitor.SafelyRaisePlainEvent($"{nameof(GameEvents)}.{nameof(GameEvents.UpdateTick)}", GameEvents.UpdateTick?.GetInvocationList());
}
/// Raise a event.
/// Encapsulates monitoring and logging.
internal static void InvokeSecondUpdateTick(IMonitor monitor)
{
monitor.SafelyRaisePlainEvent($"{nameof(GameEvents)}.{nameof(GameEvents.SecondUpdateTick)}", GameEvents.SecondUpdateTick?.GetInvocationList());
}
/// Raise a event.
/// Encapsulates monitoring and logging.
internal static void InvokeFourthUpdateTick(IMonitor monitor)
{
monitor.SafelyRaisePlainEvent($"{nameof(GameEvents)}.{nameof(GameEvents.FourthUpdateTick)}", GameEvents.FourthUpdateTick?.GetInvocationList());
}
/// Raise a event.
/// Encapsulates monitoring and logging.
internal static void InvokeEighthUpdateTick(IMonitor monitor)
{
monitor.SafelyRaisePlainEvent($"{nameof(GameEvents)}.{nameof(GameEvents.EighthUpdateTick)}", GameEvents.EighthUpdateTick?.GetInvocationList());
}
/// Raise a event.
/// Encapsulates monitoring and logging.
internal static void InvokeQuarterSecondTick(IMonitor monitor)
{
monitor.SafelyRaisePlainEvent($"{nameof(GameEvents)}.{nameof(GameEvents.QuarterSecondTick)}", GameEvents.QuarterSecondTick?.GetInvocationList());
}
/// Raise a event.
/// Encapsulates monitoring and logging.
internal static void InvokeHalfSecondTick(IMonitor monitor)
{
monitor.SafelyRaisePlainEvent($"{nameof(GameEvents)}.{nameof(GameEvents.HalfSecondTick)}", GameEvents.HalfSecondTick?.GetInvocationList());
}
/// Raise a event.
/// Encapsulates monitoring and logging.
internal static void InvokeOneSecondTick(IMonitor monitor)
{
monitor.SafelyRaisePlainEvent($"{nameof(GameEvents)}.{nameof(GameEvents.OneSecondTick)}", GameEvents.OneSecondTick?.GetInvocationList());
}
}
}