StardewValley
/
SMAPI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #723 from spacechase0/event-priority 

Implement event priority attribute
This commit is contained in:
Jesse Plamondon-Willard 2020-06-15 21:34:46 -04:00 committed by GitHub
parent ff7b9a0251 02e7318d2b
commit e759332135
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 194 additions and 139 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/SMAPI/Events/EventPriority.cs Normal file
View File

@ -0,0 +1,15 @@
namespace StardewModdingAPI.Events
{
/// <summary>The event priorities for method handlers.</summary>
public enum EventPriority
{
/// <summary>Low priority.</summary>
Low = -1000,
/// <summary>The default priority.</summary>
Normal = 0,
/// <summary>High priority.</summary>
High = 1000
}
}

26
src/SMAPI/Events/EventPriorityAttribute.cs Normal file
View File

@ -0,0 +1,26 @@
using System;
namespace StardewModdingAPI.Events
{
/// <summary>An attribute which specifies the priority for an event handler.</summary>
[AttributeUsage(AttributeTargets.Method)]
public class EventPriorityAttribute : Attribute
{
/*********
** Accessors
*********/
/// <summary>The event handler priority, relative to other handlers across all mods registered for this event.</summary>
internal EventPriority Priority { get; }
/*********
** Public methods
*********/
/// <summary>Construct an instance.</summary>
/// <param name="priority">The event handler priority, relative to other handlers across all mods registered for this event. Higher-priority handlers are notified before lower-priority handlers.</param>
public EventPriorityAttribute(EventPriority priority)
{
this.Priority = priority;
}
}
}

5
src/SMAPI/Framework/Events/EventManager.cs
View File

@ -177,15 +177,14 @@ namespace StardewModdingAPI.Framework.Events
** Public methods
*********/
/// <summary>Construct an instance.</summary>
/// <param name="monitor">Writes messages to the log.</param>
/// <param name="modRegistry">The mod registry with which to identify mods.</param>
/// <param name="performanceMonitor">Tracks performance metrics.</param>
public EventManager(IMonitor monitor, ModRegistry modRegistry, PerformanceMonitor performanceMonitor)
public EventManager(ModRegistry modRegistry, PerformanceMonitor performanceMonitor)
{
// create shortcut initializers
ManagedEvent<TEventArgs> ManageEventOf<TEventArgs>(string typeName, string eventName, bool isPerformanceCritical = false)
{
return new ManagedEvent<TEventArgs>($"{typeName}.{eventName}", monitor, modRegistry, performanceMonitor, isPerformanceCritical);
return new ManagedEvent<TEventArgs>($"{typeName}.{eventName}", modRegistry, performanceMonitor, isPerformanceCritical);
}
// init events (new)

139
src/SMAPI/Framework/Events/ManagedEvent.cs
View File

@ -1,6 +1,8 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using StardewModdingAPI.Events;
using StardewModdingAPI.Framework.PerformanceMonitoring;
namespace StardewModdingAPI.Framework.Events
@ -12,24 +14,24 @@ namespace StardewModdingAPI.Framework.Events
/*********
** Fields
*********/
/// <summary>The underlying event.</summary>
private event EventHandler<TEventArgs> Event;
/// <summary>Writes messages to the log.</summary>
private readonly IMonitor Monitor;
/// <summary>The underlying event handlers.</summary>
private readonly List<ManagedEventHandler<TEventArgs>> EventHandlers = new List<ManagedEventHandler<TEventArgs>>();
/// <summary>The mod registry with which to identify mods.</summary>
protected readonly ModRegistry ModRegistry;
/// <summary>The display names for the mods which added each delegate.</summary>
private readonly IDictionary<EventHandler<TEventArgs>, IModMetadata> SourceMods = new Dictionary<EventHandler<TEventArgs>, IModMetadata>();
/// <summary>The cached invocation list.</summary>
private EventHandler<TEventArgs>[] CachedInvocationList;
/// <summary>Tracks performance metrics.</summary>
private readonly PerformanceMonitor PerformanceMonitor;
/// <summary>The total number of event handlers registered for this events, regardless of whether they're still registered.</summary>
private int RegistrationIndex;
/// <summary>Whether any registered event handlers have a custom priority value.</summary>
private bool HasCustomPriorities;
/// <summary>Whether event handlers should be sorted before the next invocation.</summary>
private bool NeedsSort;
/*********
** Accessors
@ -46,14 +48,12 @@ namespace StardewModdingAPI.Framework.Events
*********/
/// <summary>Construct an instance.</summary>
/// <param name="eventName">A human-readable name for the event.</param>
/// <param name="monitor">Writes messages to the log.</param>
/// <param name="modRegistry">The mod registry with which to identify mods.</param>
/// <param name="performanceMonitor">Tracks performance metrics.</param>
/// <param name="isPerformanceCritical">Whether the event is typically called at least once per second.</param>
public ManagedEvent(string eventName, IMonitor monitor, ModRegistry modRegistry, PerformanceMonitor performanceMonitor, bool isPerformanceCritical = false)
public ManagedEvent(string eventName, ModRegistry modRegistry, PerformanceMonitor performanceMonitor, bool isPerformanceCritical = false)
{
this.EventName = eventName;
this.Monitor = monitor;
this.ModRegistry = modRegistry;
this.PerformanceMonitor = performanceMonitor;
this.IsPerformanceCritical = isPerformanceCritical;
@ -62,14 +62,7 @@ namespace StardewModdingAPI.Framework.Events
/// <summary>Get whether anything is listening to the event.</summary>
public bool HasListeners()
{
return this.CachedInvocationList?.Length > 0;
}
/// <summary>Add an event handler.</summary>
/// <param name="handler">The event handler.</param>
public void Add(EventHandler<TEventArgs> handler)
{
this.Add(handler, this.ModRegistry.GetFromStack());
return this.EventHandlers.Count > 0;
}
/// <summary>Add an event handler.</summary>
@ -77,33 +70,52 @@ namespace StardewModdingAPI.Framework.Events
/// <param name="mod">The mod which added the event handler.</param>
public void Add(EventHandler<TEventArgs> handler, IModMetadata mod)
{
this.Event += handler;
this.AddTracking(mod, handler, this.Event?.GetInvocationList().Cast<EventHandler<TEventArgs>>());
EventPriority priority = handler.Method.GetCustomAttribute<EventPriorityAttribute>()?.Priority ?? EventPriority.Normal;
var managedHandler = new ManagedEventHandler<TEventArgs>(handler, this.RegistrationIndex++, priority, mod);
this.EventHandlers.Add(managedHandler);
this.HasCustomPriorities = this.HasCustomPriorities || managedHandler.HasCustomPriority();
if (this.HasCustomPriorities)
this.NeedsSort = true;
}
/// <summary>Remove an event handler.</summary>
/// <param name="handler">The event handler.</param>
public void Remove(EventHandler<TEventArgs> handler)
{
this.Event -= handler;
this.RemoveTracking(handler, this.Event?.GetInvocationList().Cast<EventHandler<TEventArgs>>());
this.EventHandlers.RemoveAll(p => p.Handler == handler);
this.HasCustomPriorities = this.HasCustomPriorities && this.EventHandlers.Any(p => p.HasCustomPriority());
}
/// <summary>Raise the event and notify all handlers.</summary>
/// <param name="args">The event arguments to pass.</param>
public void Raise(TEventArgs args)
/// <param name="match">A lambda which returns true if the event should be raised for the given mod.</param>
public void Raise(TEventArgs args, Func<IModMetadata, bool> match = null)
{
if (this.Event == null)
// skip if no handlers
if (this.EventHandlers.Count == 0)
return;
// sort event handlers by priority
// (This is done here to avoid repeatedly sorting when handlers are added/removed.)
if (this.NeedsSort)
{
this.NeedsSort = false;
this.EventHandlers.Sort();
}
// raise event
this.PerformanceMonitor.Track(this.EventName, () =>
{
foreach (EventHandler<TEventArgs> handler in this.CachedInvocationList)
foreach (ManagedEventHandler<TEventArgs> handler in this.EventHandlers)
{
if (match != null && !match(handler.SourceMod))
continue;
try
{
this.PerformanceMonitor.Track(this.EventName, this.GetModNameForPerformanceCounters(handler), () => handler.Invoke(null, args));
this.PerformanceMonitor.Track(this.EventName, this.GetModNameForPerformanceCounters(handler), () => handler.Handler.Invoke(null, args));
}
catch (Exception ex)
{
@ -113,86 +125,27 @@ namespace StardewModdingAPI.Framework.Events
});
}
/// <summary>Raise the event and notify all handlers.</summary>
/// <param name="args">The event arguments to pass.</param>
/// <param name="match">A lambda which returns true if the event should be raised for the given mod.</param>
public void RaiseForMods(TEventArgs args, Func<IModMetadata, bool> match)
{
if (this.Event == null)
return;
foreach (EventHandler<TEventArgs> handler in this.CachedInvocationList)
{
if (match(this.GetSourceMod(handler)))
{
try
{
handler.Invoke(null, args);
}
catch (Exception ex)
{
this.LogError(handler, ex);
}
}
}
}
/*********
** Private methods
*********/
/// <summary>Get the mod name for a given event handler to display in performance monitoring reports.</summary>
/// <param name="handler">The event handler.</param>
private string GetModNameForPerformanceCounters(EventHandler<TEventArgs> handler)
private string GetModNameForPerformanceCounters(ManagedEventHandler<TEventArgs> handler)
{
IModMetadata mod = this.GetSourceMod(handler);
if (mod == null)
return Constants.GamePerformanceCounterName;
IModMetadata mod = handler.SourceMod;
return mod.HasManifest()
? mod.Manifest.UniqueID
: mod.DisplayName;
}
/// <summary>Track an event handler.</summary>
/// <param name="mod">The mod which added the handler.</param>
/// <param name="handler">The event handler.</param>
/// <param name="invocationList">The updated event invocation list.</param>
protected void AddTracking(IModMetadata mod, EventHandler<TEventArgs> handler, IEnumerable<EventHandler<TEventArgs>> invocationList)
{
this.SourceMods[handler] = mod;
this.CachedInvocationList = invocationList?.ToArray() ?? new EventHandler<TEventArgs>[0];
}
/// <summary>Remove tracking for an event handler.</summary>
/// <param name="handler">The event handler.</param>
/// <param name="invocationList">The updated event invocation list.</param>
protected void RemoveTracking(EventHandler<TEventArgs> handler, IEnumerable<EventHandler<TEventArgs>> invocationList)
{
this.CachedInvocationList = invocationList?.ToArray() ?? new EventHandler<TEventArgs>[0];
if (!this.CachedInvocationList.Contains(handler)) // don't remove if there's still a reference to the removed handler (e.g. it was added twice and removed once)
this.SourceMods.Remove(handler);
}
/// <summary>Get the mod which registered the given event handler, if available.</summary>
/// <param name="handler">The event handler.</param>
protected IModMetadata GetSourceMod(EventHandler<TEventArgs> handler)
{
return this.SourceMods.TryGetValue(handler, out IModMetadata mod)
? mod
: null;
}
/// <summary>Log an exception from an event handler.</summary>
/// <param name="handler">The event handler instance.</param>
/// <param name="ex">The exception that was raised.</param>
protected void LogError(EventHandler<TEventArgs> handler, Exception ex)
protected void LogError(ManagedEventHandler<TEventArgs> handler, Exception ex)
{
IModMetadata mod = this.GetSourceMod(handler);
if (mod != null)
mod.LogAsMod($"This mod failed in the {this.EventName} event. Technical details: \n{ex.GetLogSummary()}", LogLevel.Error);
else
this.Monitor.Log($"A mod failed in the {this.EventName} event. Technical details: \n{ex.GetLogSummary()}", LogLevel.Error);
handler.SourceMod.LogAsMod($"This mod failed in the {this.EventName} event. Technical details: \n{ex.GetLogSummary()}", LogLevel.Error);
}
}
}

62
src/SMAPI/Framework/Events/ManagedEventHandler.cs Normal file
View File

@ -0,0 +1,62 @@
using System;
using StardewModdingAPI.Events;
namespace StardewModdingAPI.Framework.Events
{
/// <summary>An event handler wrapper which tracks metadata about an event handler.</summary>
/// <typeparam name="TEventArgs">The event arguments type.</typeparam>
internal class ManagedEventHandler<TEventArgs> : IComparable
{
/*********
** Accessors
*********/
/// <summary>The event handler method.</summary>
public EventHandler<TEventArgs> Handler { get; }
/// <summary>The order in which the event handler was registered, relative to other handlers for this event.</summary>
public int RegistrationOrder { get; }
/// <summary>The event handler priority, relative to other handlers for this event.</summary>
public EventPriority Priority { get; }
/// <summary>The mod which registered the handler.</summary>
public IModMetadata SourceMod { get; set; }
/*********
** Accessors
*********/
/// <summary>Construct an instance.</summary>
/// <param name="handler">The event handler method.</param>
/// <param name="registrationOrder">The order in which the event handler was registered, relative to other handlers for this event.</param>
/// <param name="priority">The event handler priority, relative to other handlers for this event.</param>
/// <param name="sourceMod">The mod which registered the handler.</param>
public ManagedEventHandler(EventHandler<TEventArgs> handler, int registrationOrder, EventPriority priority, IModMetadata sourceMod)
{
this.Handler = handler;
this.RegistrationOrder = registrationOrder;
this.Priority = priority;
this.SourceMod = sourceMod;
}
/// <summary>Get whether the event handler has a custom priority value.</summary>
public bool HasCustomPriority()
{
return this.Priority != EventPriority.Normal;
}
/// <summary>Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.</summary>
/// <param name="obj">An object to compare with this instance.</param>
/// <exception cref="T:System.ArgumentException"><paramref name="obj" /> is not the same type as this instance.</exception>
public int CompareTo(object obj)
{
if (!(obj is ManagedEventHandler<TEventArgs> other))
throw new ArgumentException("Can't compare to an unrelated object type.");
int priorityCompare = this.Priority.CompareTo(other.Priority);
return priorityCompare != 0
? priorityCompare
: this.RegistrationOrder.CompareTo(other.RegistrationOrder);
}
}
}

20
src/SMAPI/Framework/Events/ModDisplayEvents.cs
View File

@ -13,70 +13,70 @@ namespace StardewModdingAPI.Framework.Events
/// <summary>Raised after a game menu is opened, closed, or replaced.</summary>
public event EventHandler<MenuChangedEventArgs> MenuChanged
{
add => this.EventManager.MenuChanged.Add(value);
add => this.EventManager.MenuChanged.Add(value, this.Mod);
remove => this.EventManager.MenuChanged.Remove(value);
}
/// <summary>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.</summary>
public event EventHandler<RenderingEventArgs> Rendering
{
add => this.EventManager.Rendering.Add(value);
add => this.EventManager.Rendering.Add(value, this.Mod);
remove => this.EventManager.Rendering.Remove(value);
}
/// <summary>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).</summary>
public event EventHandler<RenderedEventArgs> Rendered
{
add => this.EventManager.Rendered.Add(value);
add => this.EventManager.Rendered.Add(value, this.Mod);
remove => this.EventManager.Rendered.Remove(value);
}
/// <summary>Raised before the game world is drawn to the screen. This event isn't useful for drawing to the screen, since the game will draw over it.</summary>
public event EventHandler<RenderingWorldEventArgs> RenderingWorld
{
add => this.EventManager.RenderingWorld.Add(value);
add => this.EventManager.RenderingWorld.Add(value, this.Mod);
remove => this.EventManager.RenderingWorld.Remove(value);
}
/// <summary>Raised after the game world is drawn to the sprite patch, before it's rendered to the screen. Content drawn to the sprite batch at this point will be drawn over the world, but under any active menu, HUD elements, or cursor.</summary>
public event EventHandler<RenderedWorldEventArgs> RenderedWorld
{
add => this.EventManager.RenderedWorld.Add(value);
add => this.EventManager.RenderedWorld.Add(value, this.Mod);
remove => this.EventManager.RenderedWorld.Remove(value);
}
/// <summary>When a menu is open (<see cref="Game1.activeClickableMenu"/> isn't null), raised before that menu is drawn to the screen. This includes the game's internal menus like the title screen. Content drawn to the sprite batch at this point will appear under the menu.</summary>
public event EventHandler<RenderingActiveMenuEventArgs> RenderingActiveMenu
{
add => this.EventManager.RenderingActiveMenu.Add(value);
add => this.EventManager.RenderingActiveMenu.Add(value, this.Mod);
remove => this.EventManager.RenderingActiveMenu.Remove(value);
}
/// <summary>When a menu is open (<see cref="Game1.activeClickableMenu"/> isn't null), raised after that menu is drawn to the sprite batch but before it's rendered to the screen. Content drawn to the sprite batch at this point will appear over the menu and menu cursor.</summary>
public event EventHandler<RenderedActiveMenuEventArgs> RenderedActiveMenu
{
add => this.EventManager.RenderedActiveMenu.Add(value);
add => this.EventManager.RenderedActiveMenu.Add(value, this.Mod);
remove => this.EventManager.RenderedActiveMenu.Remove(value);
}
/// <summary>Raised before drawing the HUD (item toolbar, clock, etc) to the screen. The vanilla HUD may be hidden at this point (e.g. because a menu is open). Content drawn to the sprite batch at this point will appear under the HUD.</summary>
public event EventHandler<RenderingHudEventArgs> RenderingHud
{
add => this.EventManager.RenderingHud.Add(value);
add => this.EventManager.RenderingHud.Add(value, this.Mod);
remove => this.EventManager.RenderingHud.Remove(value);
}
/// <summary>Raised after drawing the HUD (item toolbar, clock, etc) to the sprite batch, but before it's rendered to the screen. The vanilla HUD may be hidden at this point (e.g. because a menu is open). Content drawn to the sprite batch at this point will appear over the HUD.</summary>
public event EventHandler<RenderedHudEventArgs> RenderedHud
{
add => this.EventManager.RenderedHud.Add(value);
add => this.EventManager.RenderedHud.Add(value, this.Mod);
remove => this.EventManager.RenderedHud.Remove(value);
}
/// <summary>Raised after the game window is resized.</summary>
public event EventHandler<WindowResizedEventArgs> WindowResized
{
add => this.EventManager.WindowResized.Add(value);
add => this.EventManager.WindowResized.Add(value, this.Mod);
remove => this.EventManager.WindowResized.Remove(value);
}

28
src/SMAPI/Framework/Events/ModGameLoopEvents.cs
View File

@ -12,84 +12,84 @@ namespace StardewModdingAPI.Framework.Events
/// <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);
add => this.EventManager.GameLaunched.Add(value, this.Mod);
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);
add => this.EventManager.UpdateTicking.Add(value, this.Mod);
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);
add => this.EventManager.UpdateTicked.Add(value, this.Mod);
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);
add => this.EventManager.OneSecondUpdateTicking.Add(value, this.Mod);
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);
add => this.EventManager.OneSecondUpdateTicked.Add(value, this.Mod);
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);
add => this.EventManager.SaveCreating.Add(value, this.Mod);
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);
add => this.EventManager.SaveCreated.Add(value, this.Mod);
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);
add => this.EventManager.Saving.Add(value, this.Mod);
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);
add => this.EventManager.Saved.Add(value, this.Mod);
remove => this.EventManager.Saved.Remove(value);
}
/// <summary>Raised after the player loads a save slot and the world is initialized.</summary>
public event EventHandler<SaveLoadedEventArgs> SaveLoaded
{
add => this.EventManager.SaveLoaded.Add(value);
add => this.EventManager.SaveLoaded.Add(value, this.Mod);
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);
add => this.EventManager.DayStarted.Add(value, this.Mod);
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);
add => this.EventManager.DayEnding.Add(value, this.Mod);
remove => this.EventManager.DayEnding.Remove(value);
}
@ -97,14 +97,14 @@ namespace StardewModdingAPI.Framework.Events
public event EventHandler<TimeChangedEventArgs> TimeChanged
{
add => this.EventManager.TimeChanged.Add(value);
add => this.EventManager.TimeChanged.Add(value, this.Mod);
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);
add => this.EventManager.ReturnedToTitle.Add(value, this.Mod);
remove => this.EventManager.ReturnedToTitle.Remove(value);
}

8
src/SMAPI/Framework/Events/ModInputEvents.cs
View File

@ -12,28 +12,28 @@ namespace StardewModdingAPI.Framework.Events
/// <summary>Raised after the player presses a button on the keyboard, controller, or mouse.</summary>
public event EventHandler<ButtonPressedEventArgs> ButtonPressed
{
add => this.EventManager.ButtonPressed.Add(value);
add => this.EventManager.ButtonPressed.Add(value, this.Mod);
remove => this.EventManager.ButtonPressed.Remove(value);
}
/// <summary>Raised after the player releases a button on the keyboard, controller, or mouse.</summary>
public event EventHandler<ButtonReleasedEventArgs> ButtonReleased
{
add => this.EventManager.ButtonReleased.Add(value);
add => this.EventManager.ButtonReleased.Add(value, this.Mod);
remove => this.EventManager.ButtonReleased.Remove(value);
}
/// <summary>Raised after the player moves the in-game cursor.</summary>
public event EventHandler<CursorMovedEventArgs> CursorMoved
{
add => this.EventManager.CursorMoved.Add(value);
add => this.EventManager.CursorMoved.Add(value, this.Mod);
remove => this.EventManager.CursorMoved.Remove(value);
}
/// <summary>Raised after the player scrolls the mouse wheel.</summary>
public event EventHandler<MouseWheelScrolledEventArgs> MouseWheelScrolled
{
add => this.EventManager.MouseWheelScrolled.Add(value);
add => this.EventManager.MouseWheelScrolled.Add(value, this.Mod);
remove => this.EventManager.MouseWheelScrolled.Remove(value);
}

6
src/SMAPI/Framework/Events/ModMultiplayerEvents.cs
View File

@ -12,7 +12,7 @@ namespace StardewModdingAPI.Framework.Events
/// <summary>Raised after the mod context for a peer is received. This happens before the game approves the connection (<see cref="IMultiplayerEvents.PeerConnected"/>), so the player doesn't yet exist in the game. This is the earliest point where messages can be sent to the peer via SMAPI.</summary>
public event EventHandler<PeerContextReceivedEventArgs> PeerContextReceived
{
add => this.EventManager.PeerContextReceived.Add(value);
add => this.EventManager.PeerContextReceived.Add(value, this.Mod);
remove => this.EventManager.PeerContextReceived.Remove(value);
}
@ -26,14 +26,14 @@ namespace StardewModdingAPI.Framework.Events
/// <summary>Raised after a mod message is received over the network.</summary>
public event EventHandler<ModMessageReceivedEventArgs> ModMessageReceived
{
add => this.EventManager.ModMessageReceived.Add(value);
add => this.EventManager.ModMessageReceived.Add(value, this.Mod);
remove => this.EventManager.ModMessageReceived.Remove(value);
}
/// <summary>Raised after the connection with a peer is severed.</summary>
public event EventHandler<PeerDisconnectedEventArgs> PeerDisconnected
{
add => this.EventManager.PeerDisconnected.Add(value);
add => this.EventManager.PeerDisconnected.Add(value, this.Mod);
remove => this.EventManager.PeerDisconnected.Remove(value);
}

6
src/SMAPI/Framework/Events/ModPlayerEvents.cs
View File

@ -12,21 +12,21 @@ namespace StardewModdingAPI.Framework.Events
/// <summary>Raised after items are added or removed to a player's inventory. NOTE: this event is currently only raised for the local player.</summary>
public event EventHandler<InventoryChangedEventArgs> InventoryChanged
{
add => this.EventManager.InventoryChanged.Add(value);
add => this.EventManager.InventoryChanged.Add(value, this.Mod);
remove => this.EventManager.InventoryChanged.Remove(value);
}
/// <summary>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. NOTE: this event is currently only raised for the local player.</summary>
public event EventHandler<LevelChangedEventArgs> LevelChanged
{
add => this.EventManager.LevelChanged.Add(value);
add => this.EventManager.LevelChanged.Add(value, this.Mod);
remove => this.EventManager.LevelChanged.Remove(value);
}
/// <summary>Raised after a player warps to a new location. NOTE: this event is currently only raised for the local player.</summary>
public event EventHandler<WarpedEventArgs> Warped
{
add => this.EventManager.Warped.Add(value);
add => this.EventManager.Warped.Add(value, this.Mod);
remove => this.EventManager.Warped.Remove(value);
}

6
src/SMAPI/Framework/Events/ModSpecialisedEvents.cs
View File

@ -12,21 +12,21 @@ namespace StardewModdingAPI.Framework.Events
/// <summary>Raised when the low-level stage in the game's loading process has changed. This is an advanced event for mods which need to run code at specific points in the loading process. The available stages or when they happen might change without warning in future versions (e.g. due to changes in the game's load process), so mods using this event are more likely to break or have bugs. Most mods should use <see cref="IGameLoopEvents"/> instead.</summary>
public event EventHandler<LoadStageChangedEventArgs> LoadStageChanged
{
add => this.EventManager.LoadStageChanged.Add(value);
add => this.EventManager.LoadStageChanged.Add(value, this.Mod);
remove => this.EventManager.LoadStageChanged.Remove(value);
}
/// <summary>Raised before the game state is updated (≈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 event will trigger a stability warning in the SMAPI console.</summary>
public event EventHandler<UnvalidatedUpdateTickingEventArgs> UnvalidatedUpdateTicking
{
add => this.EventManager.UnvalidatedUpdateTicking.Add(value);
add => this.EventManager.UnvalidatedUpdateTicking.Add(value, this.Mod);
remove => this.EventManager.UnvalidatedUpdateTicking.Remove(value);
}
/// <summary>Raised after the game state is updated (≈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 event will trigger a stability warning in the SMAPI console.</summary>
public event EventHandler<UnvalidatedUpdateTickedEventArgs> UnvalidatedUpdateTicked
{
add => this.EventManager.UnvalidatedUpdateTicked.Add(value);
add => this.EventManager.UnvalidatedUpdateTicked.Add(value, this.Mod);
remove => this.EventManager.UnvalidatedUpdateTicked.Remove(value);
}

8
src/SMAPI/Framework/Events/ModWorldEvents.cs
View File

@ -40,28 +40,28 @@ namespace StardewModdingAPI.Framework.Events
/// <summary>Raised after NPCs are added or removed in a location.</summary>
public event EventHandler<NpcListChangedEventArgs> NpcListChanged
{
add => this.EventManager.NpcListChanged.Add(value);
add => this.EventManager.NpcListChanged.Add(value, this.Mod);
remove => this.EventManager.NpcListChanged.Remove(value);
}
/// <summary>Raised after objects are added or removed in a location.</summary>
public event EventHandler<ObjectListChangedEventArgs> ObjectListChanged
{
add => this.EventManager.ObjectListChanged.Add(value);
add => this.EventManager.ObjectListChanged.Add(value, this.Mod);
remove => this.EventManager.ObjectListChanged.Remove(value);
}
/// <summary>Raised after items are added or removed from a chest.</summary>
public event EventHandler<ChestInventoryChangedEventArgs> ChestInventoryChanged
{
add => this.EventManager.ChestInventoryChanged.Add(value);
add => this.EventManager.ChestInventoryChanged.Add(value, this.Mod);
remove => this.EventManager.ChestInventoryChanged.Remove(value);
}
/// <summary>Raised after terrain features (like floors and trees) are added or removed in a location.</summary>
public event EventHandler<TerrainFeatureListChangedEventArgs> TerrainFeatureListChanged
{
add => this.EventManager.TerrainFeatureListChanged.Add(value);
add => this.EventManager.TerrainFeatureListChanged.Add(value, this.Mod);
remove => this.EventManager.TerrainFeatureListChanged.Remove(value);
}

2
src/SMAPI/Framework/SCore.cs
View File

@ -173,7 +173,7 @@ namespace StardewModdingAPI.Framework
this.MonitorForGame = this.GetSecondaryMonitor("game");
SCore.PerformanceMonitor = new PerformanceMonitor(this.Monitor);
this.EventManager = new EventManager(this.Monitor, this.ModRegistry, SCore.PerformanceMonitor);
this.EventManager = new EventManager(this.ModRegistry, SCore.PerformanceMonitor);
SCore.PerformanceMonitor.InitializePerformanceCounterCollections(this.EventManager);
SCore.DeprecationManager = new DeprecationManager(this.Monitor, this.ModRegistry);

2
src/SMAPI/Framework/SGame.cs
View File

@ -240,7 +240,7 @@ namespace StardewModdingAPI.Framework
modIDs.Remove(message.FromModID); // don't send a broadcast back to the sender
// raise events
this.Events.ModMessageReceived.RaiseForMods(new ModMessageReceivedEventArgs(message), mod => mod != null && modIDs.Contains(mod.Manifest.UniqueID));
this.Events.ModMessageReceived.Raise(new ModMessageReceivedEventArgs(message), mod => mod != null && modIDs.Contains(mod.Manifest.UniqueID));
}
/// <summary>A callback invoked when custom content is removed from the save data to avoid a crash.</summary>