translators
8,404
edits
Changes
Jump to navigation
Jump to search
Line 3:
Line 3: − + − A [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/events/ C# event] is the way that SMAPI notifies mods when something happens. You can add any number of ''event handlers'' (methods to call) when an event is raised. Event handlers are usually added in your <tt>Entry</tt> method, though you can add and remove them anytime.+ + + + + + − + − + + + + − public class ModEntry : Mod+ Line 25:
Line 33: − + − + − + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + − + Line 49:
Line 189: − + − + − + − + − + − + Line 62:
Line 202: − + − + Line 69:
Line 209: − + − + − + Line 80:
Line 220: − + − + Line 87:
Line 227: − + − + − + Line 96:
Line 236: − + − + − + Line 105:
Line 245: − + − + − + Line 114:
Line 254: − + − + − + Line 123:
Line 263: − + − + − + Line 134:
Line 274: − + − + − + + + + + + + + + + + + + + − + − + − + + + + + + + + + + + + + + − + Line 161:
Line 327: − + − + − + − + − + − + − + − + Line 178:
Line 344: − + − + − + − + − + − + − + − + + + − + − + Line 216:
Line 384: − + − + − + − + Line 232:
Line 400: − + Line 238:
Line 406: + + + + + + + + + + + + + + + + + + + + + + + − + − + − + − + − + − + − + − + − + Line 266:
Line 457: − + − + Line 279:
Line 470: − + − + − + − + − + − + − + Line 305:
Line 496: − + − + − + + + + + + + + + + + + Line 316:
Line 518: − + − + − + − + − + − + − + − + − + Line 337:
Line 539: − + − + Line 344:
Line 546: − + − + Line 357:
Line 559: − + − + − + − + − + − + − + − + − + − + − + Line 382:
Line 584: − + − + − + − + − + − + − + − + − + − + Line 407:
Line 609: − + − + − + − + − + − + − + − + Line 426:
Line 628: − + Line 437:
Line 639: − + − + − + − + − Line 451:
Line 652: − + − + − + − + − + − + − + − + − + − + + + + + + + + + + + + + + + + + + + + + + + + + + Line 474:
Line 700: − + − + − + − + − + − + − + − + − + − + + + + + + + + + + + + + + + + + + + + + + + Line 498:
Line 746: − + − + − + − + − + − + − + − + − + − + Line 521:
Line 769: − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + Line 597:
Line 845: − + − + − + − + − + − + − + − + − + + + + + − + + − + − + − + Line 624:
Line 877: − + − + − + − + − + − + − + − + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
remove {{SMAPI upcoming|4.0.0}}
SMAPI provides several C# events which let your mod respond when something happens (like when the player places an object) or run code periodically (like once per update tick).
SMAPI provides several C# events which let your mod respond when something happens (like when the player places an object) or run code periodically (like once per update tick).
==Intro==
==FAQs==
===What are events?===
Events let you run code when something happens. You can add any number of ''event handlers'' (methods to call) when an ''event'' (what happened) is raised. You can think of events and handlers as a ''when..then'' statement:
<pre>
WHEN the save is loaded, <-- event
THEN run my code <-- event handler
</pre>
For example, let's say you want to print a message when each day starts. First you would choose the appropriate event from the list below (<tt>[[#GameLoop.DayStarted|GameLoop.DayStarted]]</tt>), then add an event handler, and do something in your method code:
See [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/events/ ''Events'' in the C# programming guide] for more info.
<source lang="c#">
===How do I use them?===
Event handlers are usually added in your <samp>Entry</samp> method, though you can add and remove them anytime. For example, let's say you want to print a message when each day starts. First you would choose the appropriate event from the list below (<samp>[[#GameLoop.DayStarted|GameLoop.DayStarted]]</samp>), then add an event handler, and do something in your method code:
<syntaxhighlight lang="c#">
/// <summary>The main entry point for the mod.</summary>
/// <summary>The main entry point for the mod.</summary>
internal sealed class ModEntry : Mod
{
{
/**********
/**********
/// <param name="sender">The event sender.</param>
/// <param name="sender">The event sender.</param>
/// <param name="e">The event arguments.</param>
/// <param name="e">The event arguments.</param>
private void OnDayStarted(object sender, DayStartedEventArgs e)
private void OnDayStarted(object? sender, DayStartedEventArgs e)
{
{
this.Monitor.Log("A new day dawns!");
this.Monitor.Log("A new day dawns!", LogLevel.Info);
}
}
}
}
</source>
</syntaxhighlight>
Tip: you don't need to memorise the method arguments. In Visual Studio, type <code>helper.Events.GameLoop.SaveLoaded +=</code> and press {{key|TAB}} to auto-create a method. (There doesn't seem to be an equivalent feature in MonoDevelop.)
Tip: you don't need to memorise the method arguments. In Visual Studio, type <code>helper.Events.GameLoop.SaveLoaded +=</code> and press {{key|TAB}} to auto-create a method. (There doesn't seem to be an equivalent feature in MonoDevelop.)
<samp>sender</samp> is part of the C# event pattern, and is unused by SMAPI.
===How do events fit into the game?===
Events are raised on each game tick (when the game updates its state and renders to the screen), which is 60 times per second. An event may be raised multiple times (''e.g.,'' if the player pressed two keys simultaneously), but most events won't be raised 60 times per second (''e.g.,'' players are unlikely to be pressing 60 buttons per second).
Your event handlers are run ''synchronously'': the game is paused and no other mod's code will run simultaneously, so there's no risk of conflicting changes. Since code runs very quickly, players won't notice any delay unless your code is unusually slow. That said, when using frequent events like <samp>UpdateTicked</samp> or <samp>Rendered</samp>, you should cache expensive operations (like loading an asset) instead of repeating them in each tick to avoid impacting performance.
===What if a mod changes what the event was raised for?===
Events are raised based on a snapshot of the game state. That's usually ''but not necessarily'' the current game state.
For example, consider this case:
# The <samp>GameMenu</samp> opens.
# SMAPI raises the <samp>MenuChanged</samp> event, which mods A and B listen to.
# Mod A receives the event and closes the menu.
# Mod B receives the event.
Each mod is still handling the <samp>MenuChanged</samp> event for the opened menu, even though the first mod closed it. SMAPI will raise a new <samp>MenuChanged</samp> event for the closed menu on the next tick.
This rarely affects mods, but it's something to keep in mind if you need the current state (''e.g.,'' check <samp>Game1.activeClickableMenu</samp> instead of <samp>e.NewMenu</samp>).
==Events==
==Events==
The available events are documented below.
The available events are documented below.
===Content===
<samp>this.Helper.Events.Content</samp> has events related to assets loaded from the content pipeline.
{| class="wikitable"
|-
! event
! summary
{{/event
|group = Content
|name = AssetRequested
|desc = Raised when an asset is being requested from the content pipeline. The asset isn't necessarily being loaded yet (''e.g.'' the game may be checking if it exists).
You can register the changes you want to apply using the event arguments below; they'll be applied when the asset is actually loaded. See the [[Modding:Modder Guide/APIs/Content|content API]] for more info.
If the asset is requested multiple times in the same tick (e.g. once to check if it exists and once to load it), SMAPI might only raise the event once and reuse the cached result.
|arg name 1 = <samp>e.Name</samp>
|arg type 1 = <samp>IAssetName</samp>
|arg desc 1 = The name of the asset being requested, including the locale code if any (like the <samp>.fr-FR</samp> in <samp>Data/Bundles.fr-FR</samp>). This includes utility methods to parse the value, like <code>e.Name.IsEquivalentTo("Portraits/Abigail")</code> (which handles any differences in formatting for you).
|arg name 2 = <samp>e.NameWithoutLocale</samp>
|arg type 2 = <samp>IAssetName</samp>
|arg desc 2 = Equivalent to <samp>e.Name</samp> but without the locale code (if any). For example, if <samp>e.Name</samp> is <samp>Data/Bundles.fr-FR</samp>, this field will contain <samp>Data/Bundles</samp>.
|arg name 3 = <samp>e.LoadFrom(...)</samp>
|arg type 3 = ''method''
|arg desc 3 = Call this method to provide the initial instance for the asset, instead of trying to load it from the game's <samp>Content</samp> folder. For example:
<syntaxhighlight lang="c#">
e.LoadFrom(() => this.Helper.Content.Load<Texture2D>("assets/portraits.png"), AssetLoadPriority.Medium);
</syntaxhighlight>
Usage notes:
* The asset doesn't need to exist in the game's <samp>Content</samp> folder. If any mod loads the asset, the game will see it as an existing asset as if it was in that folder.
* Each asset can logically only have one initial instance. If multiple loads apply at the same time, SMAPI will raise an error and ignore all of them. If you're making changes to the existing asset instead of replacing it, you should use the <samp>Edit</samp> method instead to avoid those limitations and improve mod compatibility.
|arg name 4 = <samp>e.LoadFromModFile<T>(...)</samp>
|arg type 4 = ''method''
|arg desc 4 = Call this method to provide the initial instance for the asset by loading a file from your mod folder. For example:
<syntaxhighlight lang="c#">
e.LoadFromModFile<Texture2D>("assets/portraits.png", AssetLoadPriority.Medium);
</syntaxhighlight>
See usage notes on <samp>e.LoadFrom</samp>.
|arg name 5 = <samp>e.Edit(...)</samp>
|arg type 5 = ''method''
|arg desc 5 = Call this method to apply edits to the asset after it's loaded. For example:
<syntaxhighlight lang="c#">
e.Edit(asset =>
{
Texture2D ribbon = this.Helper.Content.Load<Texture2D>("assets/ribbon.png");
asset.AsImage().PatchImage(source: overlay, patchMode: PatchMode.Overlay);
});
</syntaxhighlight>
Usage notes:
* Editing an asset which doesn't exist has no effect. This is applied after the asset is loaded from the game's <samp>Content</samp> folder, or from any mod's <samp>LoadFrom</samp> or <samp>LoadFromModFile</samp>.
* You can apply any number of edits to the asset. Each edit will be applied on top of the previous one (i.e. it'll see the merged asset from all previous edits as its input).
}}
{{/event
|group = Content
|name = AssetsInvalidated
|desc = Raised after one or more assets were [[Modding:Modder Guide/APIs/Content#Cache invalidation|invalidated from the content cache]] by a mod, so they'll be reloaded next time they're requested. If the assets will be reloaded or propagated automatically, this event is raised before that happens.
Next time the asset is loaded (including for asset propagation), the [[#Content.AssetRequested|<samp>AssetRequested</samp>]] event will be raised again.
|arg name 1 = <samp>e.Names</samp>
|arg type 1 = <samp>IReadOnlySet<IAssetName></samp>
|arg desc 1 = The asset names that were invalidated, including the locale code if any (like the <samp>.fr-FR</samp> in <samp>Data/Bundles.fr-FR</samp>). These include utility methods to parse the values, like <code>name.IsEquivalentTo("Portraits/Abigail")</code> (which handles any differences in formatting for you).
|arg name 2 = <samp>e.NamesWithoutLocale</samp>
|arg type 2 = <samp>IReadOnlySet<IAssetName></samp>
|arg desc 2 = Equivalent to <samp>e.Names</samp> but without the locale code (if any). For example, if <samp>e.Names</samp> contains <samp>Data/Bundles.fr-FR</samp>, this field will contain <samp>Data/Bundles</samp>.
}}
{{/event
|group = Content
|name = AssetReady
|desc = Raised after an asset is loaded by the content pipeline, after any mod edits specified via [[#Content.AssetRequested|<samp>AssetRequested</samp>]] have been applied.
This event is only raised if something requested the asset from the content pipeline. Invalidating an asset from the content cache won't necessarily reload it automatically.
|arg name 1 = <samp>e.Name</samp>
|arg type 1 = <samp>IAssetName</samp>
|arg desc 1 = The name of the asset that was loaded, including the locale code if any (like the <samp>.fr-FR</samp> in <samp>Data/Bundles.fr-FR</samp>). This includes utility methods to parse the value, like <code>e.Name.IsEquivalentTo("Portraits/Abigail")</code> (which handles any differences in formatting for you).
|arg name 2 = <samp>e.NameWithoutLocale</samp>
|arg type 2 = <samp>IAssetName</samp>
|arg desc 2 = Equivalent to <samp>e.Name</samp> but without the locale code (if any). For example, if <samp>e.Name</samp> is <samp>Data/Bundles.fr-FR</samp>, this field will contain <samp>Data/Bundles</samp>.
}}
{{/event
|group = Content
|name = LocaleChanged
|desc = Raised after the game language changes. For non-English players, this may be raised during startup when the game switches to the previously selected language.
|arg name 1 = <samp>e.OldLanguage</samp>
|arg type 1 = <samp>LanguageCode</samp>
|arg desc 1 = The previous value for the game's language enum. For a custom language, this is always <samp>LanguageCode.mod</samp>.
|arg name 2 = <samp>e.OldLocale</samp>
|arg type 2 = <samp>string</samp>
|arg desc 2 = The previous value for the locale code. This is the locale code as it appears in asset names, like <samp>fr-FR</samp> in <samp>Maps/springobjects.fr-FR</samp>. The locale code for English is an empty string.
|arg name 3 = <samp>e.NewLanguage</samp>
|arg type 3 = <samp>LanguageCode</samp>
|arg desc 3 = The new value for the game's language enum. See notes on <samp>OldLanguage</samp>.
|arg name 4 = <samp>e.NewLocale</samp>
|arg type 4 = <samp>string</samp>
|arg desc 4 = The previous value for the locale code. See notes on <samp>OldLocale</samp>.
}}
|}
===Display===
===Display===
<tt>this.Helper.Events.Display</tt> has events linked to UI and drawing to the screen.
<samp>this.Helper.Events.Display</samp> has events linked to UI and drawing to the screen.
{| class="wikitable"
{| class="wikitable"
|desc = Raised after a game menu is opened, closed, or replaced.
|desc = Raised after a game menu is opened, closed, or replaced.
|arg name 2 = <tt>e.OldMenu</tt>
|arg name 2 = <samp>e.OldMenu</samp>
|arg type 2 = <tt>IClickableMenu</tt>
|arg type 2 = <samp>IClickableMenu</samp>
|arg desc 2 = The old menu instance (or <tt>null</tt> if none).
|arg desc 2 = The old menu instance (or <samp>null</samp> if none).
|arg name 1 = <tt>e.NewMenu</tt>
|arg name 1 = <samp>e.NewMenu</samp>
|arg type 1 = <tt>IClickableMenu</tt>
|arg type 1 = <samp>IClickableMenu</samp>
|arg desc 1 = The new menu instance (or <tt>null</tt> if none).
|arg desc 1 = The new menu instance (or <samp>null</samp> if none).
}}
}}
{{/event
{{/event
|desc = 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.
|desc = 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.
|arg name 1 = <tt>e.SpriteBatch</tt>
|arg name 1 = <samp>e.SpriteBatch</samp>
|arg type 1 = <tt>SpriteBatch</tt>
|arg type 1 = <samp>SpriteBatch</samp>
|arg desc 1 = The sprite batch being drawn. Add anything you want to appear on-screen to this sprite batch.
|arg desc 1 = The sprite batch being drawn. Add anything you want to appear on-screen to this sprite batch.
}}
}}
|group = Display
|group = Display
|name = Rendered
|name = Rendered
|desc = 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).
|desc = Raised after the game draws to the sprite batch 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).
|arg name 1 = <tt>e.SpriteBatch</tt>
|arg name 1 = <samp>e.SpriteBatch</samp>
|arg type 1 = <tt>SpriteBatch</tt>
|arg type 1 = <samp>SpriteBatch</samp>
|arg desc 1 = The sprite batch being drawn. Add anything you want to appear on-screen to this sprite batch.
|arg desc 1 = The sprite batch being drawn. Add anything you want to appear on-screen to this sprite batch.
}}
}}
|desc = 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.
|desc = 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.
|arg name 1 = <tt>e.SpriteBatch</tt>
|arg name 1 = <samp>e.SpriteBatch</samp>
|arg type 1 = <tt>SpriteBatch</tt>
|arg type 1 = <samp>SpriteBatch</samp>
|arg desc 1 = The sprite batch being drawn. Add anything you want to appear on-screen to this sprite batch.
|arg desc 1 = The sprite batch being drawn. Add anything you want to appear on-screen to this sprite batch.
}}
}}
|group = Display
|group = Display
|name = RenderedWorld
|name = RenderedWorld
|desc = 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.
|desc = Raised after the game world is drawn to the sprite batch, 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.
|arg name 1 = <tt>e.SpriteBatch</tt>
|arg name 1 = <samp>e.SpriteBatch</samp>
|arg type 1 = <tt>SpriteBatch</tt>
|arg type 1 = <samp>SpriteBatch</samp>
|arg desc 1 = The sprite batch being drawn. Add anything you want to appear on-screen to this sprite batch.
|arg desc 1 = The sprite batch being drawn. Add anything you want to appear on-screen to this sprite batch.
}}
}}
|group = Display
|group = Display
|name = RenderingActiveMenu
|name = RenderingActiveMenu
|desc = When a menu is open (<tt>Game1.activeClickableMenu != null</tt>), 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.
|desc = When a menu is open (<samp>Game1.activeClickableMenu != null</samp>), 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.
|arg name 1 = <tt>e.SpriteBatch</tt>
|arg name 1 = <samp>e.SpriteBatch</samp>
|arg type 1 = <tt>SpriteBatch</tt>
|arg type 1 = <samp>SpriteBatch</samp>
|arg desc 1 = The sprite batch being drawn. Add anything you want to appear on-screen to this sprite batch.
|arg desc 1 = The sprite batch being drawn. Add anything you want to appear on-screen to this sprite batch.
}}
}}
|group = Display
|group = Display
|name = RenderedActiveMenu
|name = RenderedActiveMenu
|desc = When a menu is open (<tt>Game1.activeClickableMenu != null</tt>), 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.
|desc = When a menu is open (<samp>Game1.activeClickableMenu != null</samp>), 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.
|arg name 1 = <tt>e.SpriteBatch</tt>
|arg name 1 = <samp>e.SpriteBatch</samp>
|arg type 1 = <tt>SpriteBatch</tt>
|arg type 1 = <samp>SpriteBatch</samp>
|arg desc 1 = The sprite batch being drawn. Add anything you want to appear on-screen to this sprite batch.
|arg desc 1 = The sprite batch being drawn. Add anything you want to appear on-screen to this sprite batch.
}}
}}
|group = Display
|group = Display
|name = RenderingHud
|name = RenderingHud
|desc = 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.
|desc = 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.
|arg name 1 = <tt>e.SpriteBatch</tt>
|arg name 1 = <samp>e.SpriteBatch</samp>
|arg type 1 = <tt>SpriteBatch</tt>
|arg type 1 = <samp>SpriteBatch</samp>
|arg desc 1 = The sprite batch being drawn. Add anything you want to appear on-screen to this sprite batch.
|arg desc 1 = The sprite batch being drawn. Add anything you want to appear on-screen to this sprite batch.
}}
}}
|group = Display
|group = Display
|name = RenderedHud
|name = RenderedHud
|desc = 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.
|desc = 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.
|arg name 1 = <tt>e.SpriteBatch</tt>
|arg name 1 = <samp>e.SpriteBatch</samp>
|arg type 1 = <tt>SpriteBatch</tt>
|arg type 1 = <samp>SpriteBatch</samp>
|arg desc 1 = The sprite batch being drawn. Add anything you want to appear on-screen to this sprite batch.
|arg desc 1 = The sprite batch being drawn. Add anything you want to appear on-screen to this sprite batch.
}}
}}
|desc = Raised after the game window is resized.
|desc = Raised after the game window is resized.
|arg name 1 = <tt>e.OldSize</tt>
|arg name 1 = <samp>e.OldSize</samp>
|arg type 1 = <tt>Point</tt>
|arg type 1 = <samp>Point</samp>
|arg desc 1 = The previous window width (<tt>e.OldSize.X</tt>) and height (<tt>e.OldSize.Y</tt>).
|arg desc 1 = The previous window width (<samp>e.OldSize.X</samp>) and height (<samp>e.OldSize.Y</samp>).
|arg name 2 = <samp>e.NewSize</samp>
|arg type 2 = <samp>Point</samp>
|arg desc 2 = The new window width (<samp>e.NewSize.X</samp>) and height (<samp>e.NewSize.Y</samp>).
}}
{{/event
|group = Display
|name = RenderingStep
|desc = ''(Specialized)'' Raised before the game draws a specific step in the rendering cycle. This gives more granular control over render logic, but is more vulnerable to changes in game updates. Consider using one of the other render events if possible.
|arg name 1 = <samp>e.SpriteBatch</samp>
|arg type 1 = <samp>SpriteBatch</samp>
|arg desc 1 = The sprite batch being drawn. Add anything you want to appear on-screen to this sprite batch.
|arg name 2 = <tt>e.NewSize</tt>
|arg name 2 = <samp>e.Step</samp>
|arg type 2 = <tt>Point</tt>
|arg type 2 = <samp>RenderSteps</samp>
|arg desc 2 = The new window width (<tt>e.NewSize.X</tt>) and height (<tt>e.NewSize.Y</tt>).
|arg desc 2 = The step being rendered in the draw cycle.
}}
{{/event
|group = Display
|name = RenderedStep
|desc = ''(Specialized)'' Raised after the game draws a specific step in the rendering cycle. This gives more granular control over render logic, but is more vulnerable to changes in game updates. Consider using one of the other render events if possible.
|arg name 1 = <samp>e.SpriteBatch</samp>
|arg type 1 = <samp>SpriteBatch</samp>
|arg desc 1 = The sprite batch being drawn. Add anything you want to appear on-screen to this sprite batch.
|arg name 2 = <samp>e.Step</samp>
|arg type 2 = <samp>RenderSteps</samp>
|arg desc 2 = The step being rendered in the draw cycle.
}}
}}
|}
|}
===Game loop===
===Game loop===
<tt>this.Helper.Events.GameLoop</tt> has 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 are often useful, but you should consider semantic events like <tt>Input</tt> where applicable.
<samp>this.Helper.Events.GameLoop</samp> has 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 are often useful, but you should consider semantic events like <samp>Input</samp> where applicable.
{| class="wikitable"
{| class="wikitable"
|desc = Raised before/after the game state is updated (≈60 times per second).
|desc = Raised before/after the game state is updated (≈60 times per second).
|arg name 1 = <tt>e.Ticks</tt>
|arg name 1 = <samp>e.Ticks</samp>
|arg type 1 = <tt>int</tt>
|arg type 1 = <samp>int</samp>
|arg desc 1 = The number of ticks elapsed since the game started, including the current tick.
|arg desc 1 = The number of ticks elapsed since the game started, including the current tick.
|arg name 2 = <tt>e.IsOneSecond</tt>
|arg name 2 = <samp>e.IsOneSecond</samp>
|arg type 2 = <tt>bool</tt>
|arg type 2 = <samp>bool</samp>
|arg desc 2 = Whether <tt>e.TicksElapsed</tt> is a multiple of 60, which happens approximately once per second.
|arg desc 2 = Whether <samp>e.TicksElapsed</samp> is a multiple of 60, which happens approximately once per second.
|arg name 3 = <tt>e.IsMultipleOf(int number)</tt>
|arg name 3 = <samp>e.IsMultipleOf(int number)</samp>
|arg type 3 = ''method'' returns <tt>bool</tt>
|arg type 3 = ''method'' returns <samp>bool</samp>
|arg desc 3 = Whether <tt>e.TicksElapsed</tt> is a multiple of the given number. This is mainly useful if you want to run logic intermittently (e.g. <code>e.IsMultipleOf(30)</code> for every half-second).
|arg desc 3 = Whether <samp>e.TicksElapsed</samp> is a multiple of the given number. This is mainly useful if you want to run logic intermittently (''e.g.,'' <code>e.IsMultipleOf(30)</code> for every half-second).
}}
}}
{{/event
{{/event
|desc = Raised before/after the game state is updated, once per second.
|desc = Raised before/after the game state is updated, once per second.
|arg name 1 = <tt>e.Ticks</tt>
|arg name 1 = <samp>e.Ticks</samp>
|arg type 1 = <tt>int</tt>
|arg type 1 = <samp>int</samp>
|arg desc 1 = The number of ticks elapsed since the game started, including the current tick.
|arg desc 1 = The number of ticks elapsed since the game started, including the current tick.
|arg name 3 = <tt>e.IsMultipleOf(int number)</tt>
|arg name 3 = <samp>e.IsMultipleOf(int number)</samp>
|arg type 3 = ''method'' returns <tt>bool</tt>
|arg type 3 = ''method'' returns <samp>bool</samp>
|arg desc 3 = Whether <tt>e.TicksElapsed</tt> is a multiple of the given number. This is mainly useful if you want to run logic intermittently (e.g. <code>e.IsMultipleOf(120)</code> for every two seconds).
|arg desc 3 = Whether <samp>e.TicksElapsed</samp> is a multiple of the given number. This is mainly useful if you want to run logic intermittently (''e.g.,'' <code>e.IsMultipleOf(120)</code> for every two seconds).
}}
}}
{{/event
{{/event
|group = GameLoop
|group = GameLoop
|name = SaveCreating, SaveCreated
|name = SaveCreating, SaveCreated
|desc = Raised before/after the game creates the save file (after the new-game intro). The save won't be written until all mods have finished handling this event. This is a somewhat specialised event, since the world isn't fully initialised at this point; in most cases you should use [[#GameLoop.DayStarted|<tt>DayStarted</tt>]], [[#GameLoop.Saving|<tt>Saving</tt>]], [[#GameLoop.Saved|<tt>Saved</tt>]] instead.
|desc = Raised before/after the game creates the save file (after the new-game intro). The save won't be written until all mods have finished handling this event. This is a somewhat specialised event, since the world isn't fully initialised at this point; in most cases you should use [[#GameLoop.DayStarted|<samp>DayStarted</samp>]], [[#GameLoop.Saving|<samp>Saving</samp>]], or [[#GameLoop.Saved|<samp>Saved</samp>]] instead.
}}
}}
{{/event
{{/event
|group = GameLoop
|group = GameLoop
|name = Saving, Saved
|name = Saving, Saved
|desc = Raised before/after the game writes data to save file (except [[#GameLoop.SaveCreating|the initial save creation]]). The save won't be written until all mods have finished handling this event.
|desc = Raised before/after the game writes data to save file (except [[#GameLoop.SaveCreating|the initial save creation]]). The save won't be written until all mods have finished handling this event. This is also raised for farmhands in multiplayer.
}}
}}
{{/event
{{/event
|group = GameLoop
|group = GameLoop
|name = SaveLoaded
|name = SaveLoaded
|desc = Raised before/after the game reads data from a save file and initialises the world (including when day one starts on a new save). This event is not raised after saving; if you want to do something at the start of each day, see [[#GameLoop.DayStarted|<tt>DayStarted</tt>]] instead. <tt>[[Modding:Modder Guide/APIs/Utilities#Context|Context.IsWorldReady]]</tt> is guaranteed to be true at this point.
|desc = Raised after loading a save (including the first day after creating a new save), or connecting to a multiplayer world. This happens right before <samp>DayStarted</samp>; at this point the save file is read and <samp>[[Modding:Modder Guide/APIs/Utilities#Context|Context.IsWorldReady]]</samp> is true.
This event isn't raised after saving; if you want to do something at the start of each day, see [[#GameLoop.DayStarted|<samp>DayStarted</samp>]] instead.
}}
}}
{{/event
{{/event
|group = GameLoop
|group = GameLoop
|name = DayStarted
|name = DayStarted
|desc = Raised after a new in-game day starts. Everything has already been initialised at this point. (To run code before the game sets up the day, see [[#GameLoop.DayEnding|<tt>DayEnding</tt>]] instead.)
|desc = Raised after a new in-game day starts, or after connecting to a multiplayer world. Everything has already been initialised at this point. (To run code before the game sets up the day, see [[#GameLoop.DayEnding|<samp>DayEnding</samp>]] instead.)
}}
}}
{{/event
{{/event
|group = GameLoop
|group = GameLoop
|name = DayEnding
|name = DayEnding
|desc = Raised before the game ends the current day. This happens before it starts setting up the next day and before [[#GameLoop.Saving|<tt>Saving</tt>]].
|desc = Raised before the game ends the current day. This happens before it starts setting up the next day and before [[#GameLoop.Saving|<samp>Saving</samp>]].
}}
}}
{{/event
{{/event
|desc = Raised after the in-game clock time changes, which happens in intervals of ten in-game minutes.
|desc = Raised after the in-game clock time changes, which happens in intervals of ten in-game minutes.
|arg name 1 = <tt>e.OldTime</tt>
|arg name 1 = <samp>e.OldTime</samp>
|arg type 1 = <tt>int</tt>
|arg type 1 = <samp>int</samp>
|arg desc 1 = The previous time of day in 24-hour notation (like 1600 for 4pm). The clock time resets when the player sleeps, so 2am (before sleeping) is 2600.
|arg desc 1 = The previous time of day in 24-hour notation (like 1600 for 4pm). The clock time resets when the player sleeps, so 2am (before sleeping) is 2600.
|arg name 2 = <tt>e.NewTime</tt>
|arg name 2 = <samp>e.NewTime</samp>
|arg type 2 = <tt>int</tt>
|arg type 2 = <samp>int</samp>
|arg desc 2 = The current time of day in 24-hour notation (like 1600 for 4pm). The clock time resets when the player sleeps, so 2am (before sleeping) is 2600.
|arg desc 2 = The current time of day in 24-hour notation (like 1600 for 4pm). The clock time resets when the player sleeps, so 2am (before sleeping) is 2600.
}}
}}
===Input===
===Input===
<tt>this.Helper.Events.Input</tt> has events raised when the player uses a controller, keyboard, or mouse in some way. They can be used with the [[../Input|input API]] to access more info or suppress input.
<samp>this.Helper.Events.Input</samp> has events raised when the player uses a controller, keyboard, or mouse in some way. They can be used with the [[../Input|input API]] to access more info or suppress input.
{| class="wikitable"
{| class="wikitable"
! event
! event
! summary
! summary
{{/event
|group = Input
|name = ButtonsChanged
|desc = Raised after the player pressed/released any buttons on the keyboard, mouse, or controller. This includes mouse clicks. If the player pressed/released multiple keys at once, this is only raised once.
|arg name 1 = <samp>e.Pressed</samp>
|arg type 1 = [[Modding:Modder Guide/APIs/Input#SButton|<samp>SButton[]</samp>]]
|arg desc 1 = The buttons that were pressed since the previous tick.
|arg name 2 = <samp>e.Held</samp>
|arg type 2 = [[Modding:Modder Guide/APIs/Input#SButton|<samp>SButton[]</samp>]]
|arg desc 2 = The buttons that were held since the previous tick.
|arg name 3 = <samp>e.Released</samp>
|arg type 3 = [[Modding:Modder Guide/APIs/Input#SButton|<samp>SButton[]</samp>]]
|arg desc 3 = The buttons that were released since the previous tick.
|arg name 4 = <samp>e.Cursor</samp>
|arg type 4 = [[Modding:Modder Guide/APIs/Input#Check cursor position|<samp>ICursorPosition</samp>]]
|arg desc 4 = The cursor position and grab tile.
'''Note:''' mods won't receive input sent to the chatbox.
}}
{{/event
{{/event
|group = Input
|group = Input
|name = ButtonPressed, ButtonReleased
|name = ButtonPressed, ButtonReleased
|desc = Raised after the player pressed/released a keyboard, mouse, or controller button. This includes mouse clicks.
|desc = Raised after the player pressed/released a keyboard, mouse, or controller button. This includes mouse clicks. If the player pressed/released multiple keys at once, this is raised for each button pressed.
|arg name 1 = <tt>e.Button</tt>
|arg name 1 = <samp>e.Button</samp>
|arg type 1 = [[Modding:Modder Guide/APIs/Input#SButton|<tt>SButton</tt>]]
|arg type 1 = [[Modding:Modder Guide/APIs/Input#SButton|<samp>SButton</samp>]]
|arg desc 1 = The button pressed or released.
|arg desc 1 = The button pressed or released.
|arg name 2 = <tt>e.Cursor</tt>
|arg name 2 = <samp>e.Cursor</samp>
|arg type 2 = [[Modding:Modder Guide/APIs/Input#Check cursor position|<tt>ICursorPosition</tt>]]
|arg type 2 = [[Modding:Modder Guide/APIs/Input#Check cursor position|<samp>ICursorPosition</samp>]]
|arg desc 2 = The cursor position and grab tile.
|arg desc 2 = The cursor position and grab tile.
|arg name 3 = <tt>e.IsDown</tt>
|arg name 3 = <samp>e.IsDown</samp>
|arg type 3 = ''method'' returns <tt>bool</tt>
|arg type 3 = ''method'' returns <samp>bool</samp>
|arg desc 3 = Indicates whether a given button is currently pressed.
|arg desc 3 = Indicates whether a given button is currently pressed.
|arg name 4 = <tt>e.IsSuppressed</tt>
|arg name 4 = <samp>e.IsSuppressed</samp>
|arg type 4 = ''method'' returns <tt>bool</tt>
|arg type 4 = ''method'' returns <samp>bool</samp>
|arg desc 4 = A method which indicates whether a given button was suppressed by a mod, so the game itself won't see it.
|arg desc 4 = A method which indicates whether a given button was suppressed by a mod, so the game itself won't see it.
|desc = Raised after the player moves the in-game cursor.
|desc = Raised after the player moves the in-game cursor.
|arg name 1 = <tt>e.OldPosition</tt>
|arg name 1 = <samp>e.OldPosition</samp>
|arg type 1 = [[Modding:Modder Guide/APIs/Input#Check cursor position|ICursorPosition]]
|arg type 1 = [[Modding:Modder Guide/APIs/Input#Check cursor position|ICursorPosition]]
|arg desc 1 = The previous cursor position and grab tile.
|arg desc 1 = The previous cursor position and grab tile.
|arg name 2 = <tt>e.NewPosition</tt>
|arg name 2 = <samp>e.NewPosition</samp>
|arg type 2 = [[Modding:Modder Guide/APIs/Input#Check cursor position|ICursorPosition]]
|arg type 2 = [[Modding:Modder Guide/APIs/Input#Check cursor position|ICursorPosition]]
|arg desc 2 = The current cursor position and grab tile.
|arg desc 2 = The current cursor position and grab tile.
|desc = Raised after the player scrolls the mouse wheel.
|desc = Raised after the player scrolls the mouse wheel.
|arg name 1 = <tt>e.Position</tt>
|arg name 1 = <samp>e.Position</samp>
|arg type 1 = [[Modding:Modder Guide/APIs/Input#Check cursor position|ICursorPosition]]
|arg type 1 = [[Modding:Modder Guide/APIs/Input#Check cursor position|ICursorPosition]]
|arg desc 1 = The current cursor position and grab tile.
|arg desc 1 = The current cursor position and grab tile.
|arg name 2 = <tt>e.Delta</tt>
|arg name 2 = <samp>e.Delta</samp>
|arg type 2 = <tt>int</tt>
|arg type 2 = <samp>int</samp>
|arg desc 2 = The amount by which the mouse wheel was scrolled since the last update.
|arg desc 2 = The amount by which the mouse wheel was scrolled since the last update.
|arg name 3 = <tt>e.OldValue</tt><br /><tt>e.NewValue</tt>
|arg name 3 = <samp>e.OldValue</samp><br /><samp>e.NewValue</samp>
|arg type 3 = <tt>int</tt>
|arg type 3 = <samp>int</samp>
|arg desc 3 = The previous and current scroll value, cumulative since the game started. Mods should generally use <tt>e.Delta</tt> instead.
|arg desc 3 = The previous and current scroll value, cumulative since the game started. Mods should generally use <samp>e.Delta</samp> instead.
}}
}}
|}
|}
===Multiplayer===
===Multiplayer===
<tt>this.Helper.Events.Multiplayer</tt> has events raised for multiplayer messages and connections.
<samp>this.Helper.Events.Multiplayer</samp> has events raised for multiplayer messages and connections.
{| class="wikitable"
{| class="wikitable"
|desc = Raised after the mod context for a player is received. The event is raised for any player (whether host or farmhand), including when the connecting player doesn't have SMAPI installed. This is the earliest point where messages can be sent to the player via SMAPI.
|desc = Raised after the mod context for a player is received. The event is raised for any player (whether host or farmhand), including when the connecting player doesn't have SMAPI installed. This is the earliest point where messages can be sent to the player via SMAPI.
This happens immediately before the game approves the connection, so the player doesn't exist in the game yet. When connecting to the host, contextual fields like <tt>Game1.IsMasterGame</tt> or <tt>Context.IsMultiplayer</tt> may not be set yet; you can check <tt>e.Peer.IsHost</tt> to know whether the current player is a farmhand, since the host context will always be received first. Assuming another mod doesn't block the connection, the connection will be approved on the next tick.
This happens immediately before the game approves the connection, so the player doesn't exist in the game yet. When connecting to the host, contextual fields like <samp>Game1.IsMasterGame</samp> or <samp>Context.IsMultiplayer</samp> may not be set yet; you can check <samp>e.Peer.IsHost</samp> to know whether the current player is a farmhand, since the host context will always be received first. Assuming another mod doesn't block the connection, the connection will be approved on the next tick.
|arg name 1 = <tt>e.Peer</tt>
|arg name 1 = <samp>e.Peer</samp>
|arg type 1 = <tt>IMultiplayerPeer</tt>
|arg type 1 = <samp>IMultiplayerPeer</samp>
|arg desc 1 = The peer whose context was received (see [[Modding:Modder Guide/APIs/Multiplayer#Get connected player info|Multiplayer#Get connected player info]]).
|arg desc 1 = The peer whose context was received (see [[Modding:Modder Guide/APIs/Multiplayer#Get connected player info|Multiplayer#Get connected player info]]).
}}
{{/event
|group = Multiplayer
|name = PeerConnected
|desc = Raised after a connection from another player is approved by the game. The event is raised for any player (whether host or farmhand), including when the connecting player doesn't have SMAPI installed. This happens after <samp>PeerContextReceived</samp>.
The player is connected to the game at this point, so methods like <samp>Game1.server.kick</samp> will work.
|arg name 1 = <samp>e.Peer</samp>
|arg type 1 = <samp>IMultiplayerPeer</samp>
|arg desc 1 = The peer who connected (see [[Modding:Modder Guide/APIs/Multiplayer#Get connected player info|Multiplayer#Get connected player info]]).
}}
}}
{{/event
{{/event
|desc = Raised after [[Modding:Modder Guide/APIs/Multiplayer#Send messages|a mod message]] is received over the network.
|desc = Raised after [[Modding:Modder Guide/APIs/Multiplayer#Send messages|a mod message]] is received over the network.
|arg name 1 = <tt>e.FromPlayerID</tt>
|arg name 1 = <samp>e.FromPlayerID</samp>
|arg type 1 = <tt>long</tt>
|arg type 1 = <samp>long</samp>
|arg desc 1 = The unique ID of the player from whose computer the message was sent.
|arg desc 1 = The unique ID of the player from whose computer the message was sent.
|arg name 2 = <tt>e.FromModID</tt>
|arg name 2 = <samp>e.FromModID</samp>
|arg type 2 = <tt>string</tt>
|arg type 2 = <samp>string</samp>
|arg desc 2 = The unique ID of the mod which sent the message.
|arg desc 2 = The unique ID of the mod which sent the message.
|arg name 3 = <tt>e.Type</tt>
|arg name 3 = <samp>e.Type</samp>
|arg type 3 = <tt>string</tt>
|arg type 3 = <samp>string</samp>
|arg desc 3 = A message type which you can use to decide whether it's the one you want to handle. This isn't necessarily globally unique, so you should also check the <tt>FromModID</tt> field.
|arg desc 3 = A message type which you can use to decide whether it's the one you want to handle. This isn't necessarily globally unique, so you should also check the <samp>FromModID</samp> field.
|arg name 4 = <tt>e.ReadAs<TModel>()</tt>
|arg name 4 = <samp>e.ReadAs<TModel>()</samp>
|arg type 4 = ''method'' returns <tt>TModel</tt>
|arg type 4 = ''method'' returns <samp>TModel</samp>
|arg desc 4 = Read the underlying message data into the given model type (like <code>e.ReadAs<MyMessageClass>()</code> or <code>e.ReadAs<string>()</code>). This will return a new instance each time.
|arg desc 4 = Read the underlying message data into the given model type (like <code>e.ReadAs<MyMessageClass>()</code> or <code>e.ReadAs<string>()</code>). This will return a new instance each time.
}}
}}
|desc = Raised after the connection to a player is severed.
|desc = Raised after the connection to a player is severed.
|arg name 1 = <tt>e.Peer</tt>
|arg name 1 = <samp>e.Peer</samp>
|arg type 1 = <tt>IMultiplayerPeer</tt>
|arg type 1 = <samp>IMultiplayerPeer</samp>
|arg desc 1 = The peer whose connection was severed (see [[Modding:Modder Guide/APIs/Multiplayer#Get connected player info|Multiplayer#Get connected player info]]).
|arg desc 1 = The peer whose connection was severed (see [[Modding:Modder Guide/APIs/Multiplayer#Get connected player info|Multiplayer#Get connected player info]]).
}}
}}
===Player===
===Player===
<tt>this.Helper.Events.Player</tt> has events raised when the player data changes.
<samp>this.Helper.Events.Player</samp> has events raised when the player data changes.
'''Currently these events are only raised for the current player. That will likely change in a future version, so make sure to check <tt>e.IsLocalPlayer</tt> if you only want to handle the current player.'''
'''Currently these events are only raised for the current player. That will likely change in a future version, so make sure to check <samp>e.IsLocalPlayer</samp> if you only want to handle the current player.'''
{| class="wikitable"
{| class="wikitable"
|desc = Raised after items are added or removed from the player inventory.
|desc = Raised after items are added or removed from the player inventory.
|arg name 1 = <tt>e.Player</tt>
|arg name 1 = <samp>e.Player</samp>
|arg type 1 = <tt>Farmer</tt>
|arg type 1 = <samp>Farmer</samp>
|arg desc 1 = The player whose inventory changed.
|arg desc 1 = The player whose inventory changed.
|arg name 2 = <tt>e.Added</tt>
|arg name 2 = <samp>e.Added</samp>
|arg type 2 = <tt>IEnumerable<Item></tt>
|arg type 2 = <samp>IEnumerable<Item></samp>
|arg desc 2 = The added item stacks.
|arg desc 2 = The added item stacks.
|arg name 3 = <tt>e.Removed</tt>
|arg name 3 = <samp>e.Removed</samp>
|arg type 3 = <tt>IEnumerable<Item></tt>
|arg type 3 = <samp>IEnumerable<Item></samp>
|arg desc 3 = The removed item stacks.
|arg desc 3 = The removed item stacks.
|arg name 4 = <tt>e.QuantityChanged</tt>
|arg name 4 = <samp>e.QuantityChanged</samp>
|arg type 4 = <tt>IEnumerable<ItemStackSizeChange></tt>
|arg type 4 = <samp>IEnumerable<ItemStackSizeChange></samp>
|arg desc 4 = The item stacks whose quantity changed. Each <tt>ItemStackSizeChange</tt> instance includes <tt>Item</tt> (the affected item stack), <tt>OldSize</tt> (the previous stack size), and <tt>NewSize</tt> (the new stack size).
|arg desc 4 = The item stacks whose quantity changed. Each <samp>ItemStackSizeChange</samp> instance includes <samp>Item</samp> (the affected item stack), <samp>OldSize</samp> (the previous stack size), and <samp>NewSize</samp> (the new stack size).
|arg name 5 = <tt>e.IsLocalPlayer</tt>
|arg name 5 = <samp>e.IsLocalPlayer</samp>
|arg type 5 = <tt>bool</tt>
|arg type 5 = <samp>bool</samp>
|arg desc 5 = Whether the affected player is the local one.
|arg desc 5 = Whether the affected player is the local one.
}}
}}
|desc = Raised after a player's skill level changes. When the player levels up normally, this is raised immediately (not when the game notifies the player after they go to bed).
|desc = Raised after a player's skill level changes. When the player levels up normally, this is raised immediately (not when the game notifies the player after they go to bed).
|arg name 1 = <tt>e.Player</tt>
|arg name 1 = <samp>e.Player</samp>
|arg type 1 = <tt>Farmer</tt>
|arg type 1 = <samp>Farmer</samp>
|arg desc 1 = The player whose skill level changed.
|arg desc 1 = The player whose skill level changed.
|arg name 2 = <tt>Skill</tt>
|arg name 2 = <samp>e.Skill</samp>
|arg type 2 = <tt>SkillType</tt>
|arg type 2 = <samp>SkillType</samp>
|arg desc 2 = The skill whose level changed. This is a constant like <code>SkillType.Combat</code>, which can be converted to the game's internal skill ID using <code>(int)e.Skill</code>.
|arg desc 2 = The skill whose level changed. This is a constant like <code>SkillType.Combat</code>, which can be converted to the game's internal skill ID using <code>(int)e.Skill</code>.
|arg name 3 = <tt>OldLevel</tt>
|arg name 3 = <samp>e.OldLevel</samp>
|arg type 3 = <tt>int</tt>
|arg type 3 = <samp>int</samp>
|arg desc 3 = The player's previous level for that skill.
|arg desc 3 = The player's previous level for that skill.
|arg name 4 = <tt>NewLevel</tt>
|arg name 4 = <samp>e.NewLevel</samp>
|arg type 4 = <tt>int</tt>
|arg type 4 = <samp>int</samp>
|arg desc 4 = The player's new level for that skill.
|arg desc 4 = The player's new level for that skill.
|arg name 5 = <tt>e.IsLocalPlayer</tt>
|arg name 5 = <samp>e.IsLocalPlayer</samp>
|arg type 5 = <tt>bool</tt>
|arg type 5 = <samp>bool</samp>
|arg desc 5 = Whether the affected player is the local one.
|arg desc 5 = Whether the affected player is the local one.
}}
}}
|desc = Raised after the current player moves to a new location.
|desc = Raised after the current player moves to a new location.
|arg name 1 = <tt>e.Player</tt>
|arg name 1 = <samp>e.Player</samp>
|arg type 1 = <tt>Farmer</tt>
|arg type 1 = <samp>Farmer</samp>
|arg desc 1 = The player who warped to a new location.
|arg desc 1 = The player who warped to a new location.
|arg name 2 = <tt>OldLocation</tt>
|arg name 2 = <samp>e.OldLocation</samp>
|arg type 2 = <tt>GameLocation</tt>
|arg type 2 = <samp>GameLocation</samp>
|arg desc 2 = The player's previous location.
|arg desc 2 = The player's previous location.
|arg name 3 = <tt>NewLocation</tt>
|arg name 3 = <samp>e.NewLocation</samp>
|arg type 3 = <tt>GameLocation</tt>
|arg type 3 = <samp>GameLocation</samp>
|arg desc 3 = The player's new location.
|arg desc 3 = The player's new location.
|arg name 4 = <tt>e.IsLocalPlayer</tt>
|arg name 4 = <samp>e.IsLocalPlayer</samp>
|arg type 4 = <tt>bool</tt>
|arg type 4 = <samp>bool</samp>
|arg desc 4 = Whether the affected player is the local one.
|arg desc 4 = Whether the affected player is the local one.
}}
}}
===World===
===World===
<tt>this.Helper.Events.World</tt> has events raised when the in-game world changes in some way.
<samp>this.Helper.Events.World</samp> has events raised when the in-game world changes in some way.
{| class="wikitable"
{| class="wikitable"
|desc = Raised after a game location is added or removed (including building interiors).
|desc = Raised after a game location is added or removed (including building interiors).
|arg name 1 = <tt>e.Added</tt>
|arg name 1 = <samp>e.Added</samp>
|arg type 1 = <tt>IEnumerable<GameLocation></tt>
|arg type 1 = <samp>IEnumerable<GameLocation></samp>
|arg desc 1 = A list of locations added since the last update tick.
|arg desc 1 = A list of locations added since the last update tick.
|arg name 2 = <tt>e.Removed</tt>
|arg name 2 = <samp>e.Removed</samp>
|arg type 2 = <tt>IEnumerable<GameLocation></tt>
|arg type 2 = <samp>IEnumerable<GameLocation></samp>
|arg desc 2 = A list of locations removed since the last update tick.
|arg desc 2 = A list of locations removed since the last update tick.
}}
}}
{{/event
{{/event
|group = World
|group = World
|desc = Raised after buildings are added/removed in any location.
|desc = Raised after buildings are added/removed in any location.
This event isn't raised for buildings already present when a location is added. If you need to handle those too, use [[#World.LocationListChanged|<tt>LocationListChanged</tt>]] and check <tt>e.Added.OfType<BuildableGameLocation>()</tt> → <tt>buildings</tt>.
This event isn't raised for buildings already present when a location is added. If you need to handle those too, use [[#World.LocationListChanged|<samp>LocationListChanged</samp>]] and check <samp>e.Added.OfType<BuildableGameLocation>()</samp> → <samp>buildings</samp>.
|arg name 1 = <tt>e.Location</tt>
|arg name 1 = <samp>e.Location</samp>
|arg type 1 = <tt>GameLocation</tt>
|arg type 1 = <samp>GameLocation</samp>
|arg desc 1 = The location which changed.
|arg desc 1 = The location which changed.
|arg name 2 = <tt>e.Added</tt>
|arg name 2 = <samp>e.Added</samp>
|arg type 2 = <tt>IEnumerable<Building></tt>
|arg type 2 = <samp>IEnumerable<Building></samp>
|arg desc 2 = A list of buildings added since the last update tick.
|arg desc 2 = A list of buildings added since the last update tick.
|arg name 3 = <tt>e.Removed</tt>
|arg name 3 = <samp>e.Removed</samp>
|arg type 3 = <tt>IEnumerable<Building></tt>
|arg type 3 = <samp>IEnumerable<Building></samp>
|arg desc 3 = A list of buildings removed since the last update tick.
|arg desc 3 = A list of buildings removed since the last update tick.
|arg name 4 = <tt>e.IsCurrentLocation</tt>
|arg name 4 = <samp>e.IsCurrentLocation</samp>
|arg type 4 = <tt>bool</tt>
|arg type 4 = <samp>bool</samp>
|arg desc 4 = Whether <tt>e.Location</tt> is the location containing the local player.
|arg desc 4 = Whether <samp>e.Location</samp> is the location containing the local player.
}}
{{/event
|group = World
|name = ChestInventoryChanged
|desc = Raised after items are added or removed from a chest's inventory.
|arg name 1 = <samp>e.Chest</samp>
|arg type 1 = <samp>Chest</samp>
|arg desc 1 = The chest whose inventory changed.
|arg name 2 = <samp>e.Location</samp>
|arg type 2 = <samp>Location</samp>
|arg desc 2 = The location containing the chest.
|arg name 3 = <samp>e.Added</samp>
|arg type 3 = <samp>IEnumerable<Item></samp>
|arg desc 3 = The added item stacks.
|arg name 4 = <samp>e.Removed</samp>
|arg type 4 = <samp>IEnumerable<Item></samp>
|arg desc 4 = The removed item stacks.
|arg name 5 = <samp>e.QuantityChanged</samp>
|arg type 5 = <samp>IEnumerable<ItemStackSizeChange></samp>
|arg desc 5 = The item stacks whose quantity changed. Each <samp>ItemStackSizeChange</samp> instance includes <samp>Item</samp> (the affected item stack), <samp>OldSize</samp> (the previous stack size), and <samp>NewSize</samp> (the new stack size).
}}
}}
{{/event
{{/event
|desc = Raised after debris is added/removed in any location (including dropped or spawned floating items).
|desc = Raised after debris is added/removed in any location (including dropped or spawned floating items).
This event isn't raised for debris already present when a location is added. If you need to handle those too, use [[#World.LocationListChanged|<tt>LocationListChanged</tt>]] and check <tt>e.Added</tt> → <tt>debris</tt>.
This event isn't raised for debris already present when a location is added. If you need to handle those too, use [[#World.LocationListChanged|<samp>LocationListChanged</samp>]] and check <samp>e.Added</samp> → <samp>debris</samp>.
|arg name 1 = <tt>e.Location</tt>
|arg name 1 = <samp>e.Location</samp>
|arg type 1 = <tt>GameLocation</tt>
|arg type 1 = <samp>GameLocation</samp>
|arg desc 1 = The location which changed.
|arg desc 1 = The location which changed.
|arg name 2 = <tt>e.Added</tt>
|arg name 2 = <samp>e.Added</samp>
|arg type 2 = <tt>IEnumerable<Debris></tt>
|arg type 2 = <samp>IEnumerable<Debris></samp>
|arg desc 2 = A list of debris added since the last update tick.
|arg desc 2 = A list of debris added since the last update tick.
|arg name 3 = <tt>e.Removed</tt>
|arg name 3 = <samp>e.Removed</samp>
|arg type 3 = <tt>IEnumerable<Debris></tt>
|arg type 3 = <samp>IEnumerable<Debris></samp>
|arg desc 3 = A list of debris removed since the last update tick.
|arg desc 3 = A list of debris removed since the last update tick.
|arg name 4 = <tt>e.IsCurrentLocation</tt>
|arg name 4 = <samp>e.IsCurrentLocation</samp>
|arg type 4 = <tt>bool</tt>
|arg type 4 = <samp>bool</samp>
|arg desc 4 = Whether <tt>e.Location</tt> is the location containing the local player.
|arg desc 4 = Whether <samp>e.Location</samp> is the location containing the local player.
}}
{{/event
|group = World
|name = FurnitureListChanged
|desc = Raised after furniture are added/removed in any location.
This event isn't raised for furniture already present when a location is added. If you need to handle those too, use [[#World.LocationListChanged|<samp>LocationListChanged</samp>]] and check <samp>e.Added</samp> → <samp>furniture</samp>.
|arg name 1 = <samp>e.Location</samp>
|arg type 1 = <samp>GameLocation</samp>
|arg desc 1 = The location which changed.
|arg name 2 = <samp>e.Added</samp>
|arg type 2 = <samp>IEnumerable<Furniture></samp>
|arg desc 2 = A list of furniture added since the last update tick.
|arg name 3 = <samp>e.Removed</samp>
|arg type 3 = <samp>IEnumerable<Furniture></samp>
|arg desc 3 = A list of furniture removed since the last update tick.
|arg name 4 = <samp>e.IsCurrentLocation</samp>
|arg type 4 = <samp>bool</samp>
|arg desc 4 = Whether <samp>e.Location</samp> is the location containing the local player.
}}
}}
{{/event
{{/event
|desc = Raised after large terrain features (like bushes) are added/removed in any location.
|desc = Raised after large terrain features (like bushes) are added/removed in any location.
This event isn't raised for large terrain features already present when a location is added. If you need to handle those too, use [[#World.LocationListChanged|<tt>LocationListChanged</tt>]] and check <tt>e.Added</tt> → <tt>largeTerrainFeatures</tt>.
This event isn't raised for large terrain features already present when a location is added. If you need to handle those too, use [[#World.LocationListChanged|<samp>LocationListChanged</samp>]] and check <samp>e.Added</samp> → <samp>largeTerrainFeatures</samp>.
|arg name 1 = <tt>e.Location</tt>
|arg name 1 = <samp>e.Location</samp>
|arg type 1 = <tt>GameLocation</tt>
|arg type 1 = <samp>GameLocation</samp>
|arg desc 1 = The location which changed.
|arg desc 1 = The location which changed.
|arg name 2 = <tt>e.Added</tt>
|arg name 2 = <samp>e.Added</samp>
|arg type 2 = <tt>IEnumerable<LargeTerrainFeature></tt>
|arg type 2 = <samp>IEnumerable<LargeTerrainFeature></samp>
|arg desc 2 = A list of large terrain features added since the last update tick.
|arg desc 2 = A list of large terrain features added since the last update tick.
|arg name 3 = <tt>e.Removed</tt>
|arg name 3 = <samp>e.Removed</samp>
|arg type 3 = <tt>IEnumerable<LargeTerrainFeature></tt>
|arg type 3 = <samp>IEnumerable<LargeTerrainFeature></samp>
|arg desc 3 = A list of large terrain features removed since the last update tick.
|arg desc 3 = A list of large terrain features removed since the last update tick.
|arg name 4 = <tt>e.IsCurrentLocation</tt>
|arg name 4 = <samp>e.IsCurrentLocation</samp>
|arg type 4 = <tt>bool</tt>
|arg type 4 = <samp>bool</samp>
|arg desc 4 = Whether <tt>e.Location</tt> is the location containing the local player.
|arg desc 4 = Whether <samp>e.Location</samp> is the location containing the local player.
}}
}}
{{/event
{{/event
|desc = Raised after NPCs are added/removed in any location (including villagers, horses, Junimos, monsters, and pets).
|desc = Raised after NPCs are added/removed in any location (including villagers, horses, Junimos, monsters, and pets).
This event isn't raised for characters already present when a location is added. If you need to handle those too, use [[#World.LocationListChanged|<tt>LocationListChanged</tt>]] and check <tt>e.Added</tt> → <tt>characters</tt>.
This event isn't raised for characters already present when a location is added. If you need to handle those too, use [[#World.LocationListChanged|<samp>LocationListChanged</samp>]] and check <samp>e.Added</samp> → <samp>characters</samp>.
|arg name 1 = <tt>e.Location</tt>
|arg name 1 = <samp>e.Location</samp>
|arg type 1 = <tt>GameLocation</tt>
|arg type 1 = <samp>GameLocation</samp>
|arg desc 1 = The location which changed.
|arg desc 1 = The location which changed.
|arg name 2 = <tt>e.Added</tt>
|arg name 2 = <samp>e.Added</samp>
|arg type 2 = <tt>IEnumerable<NPC></tt>
|arg type 2 = <samp>IEnumerable<NPC></samp>
|arg desc 2 = A list of NPCs added since the last update tick.
|arg desc 2 = A list of NPCs added since the last update tick.
|arg name 3 = <tt>e.Removed</tt>
|arg name 3 = <samp>e.Removed</samp>
|arg type 3 = <tt>IEnumerable<NPC></tt>
|arg type 3 = <samp>IEnumerable<NPC></samp>
|arg desc 3 = A list of NPCs removed since the last update tick.
|arg desc 3 = A list of NPCs removed since the last update tick.
|arg name 4 = <tt>e.IsCurrentLocation</tt>
|arg name 4 = <samp>e.IsCurrentLocation</samp>
|arg type 4 = <tt>bool</tt>
|arg type 4 = <samp>bool</samp>
|arg desc 4 = Whether <tt>e.Location</tt> is the location containing the local player.
|arg desc 4 = Whether <samp>e.Location</samp> is the location containing the local player.
}}
}}
{{/event
{{/event
|group = World
|group = World
|name = ObjectListChanged
|name = ObjectListChanged
|desc = Raised after objects are added/removed in any location (including machines, furniture, fences, etc). For floating items, see <tt>DebrisListChanged</tt>.
|desc = Raised after objects are added/removed in any location (including machines, fences, etc). This doesn't apply for floating items (see <samp>DebrisListChanged</samp>) or furniture (see <samp>FurnitureListChanged</samp>).
This event isn't raised for objects already present when a location is added. If you need to handle those too, use [[#World.LocationListChanged|<tt>LocationListChanged</tt>]] and check <tt>e.Added</tt> → <tt>objects</tt>.
This event isn't raised for objects already present when a location is added. If you need to handle those too, use [[#World.LocationListChanged|<samp>LocationListChanged</samp>]] and check <samp>e.Added</samp> → <samp>objects</samp>.
|arg name 1 = <tt>e.Location</tt>
|arg name 1 = <samp>e.Location</samp>
|arg type 1 = <tt>GameLocation</tt>
|arg type 1 = <samp>GameLocation</samp>
|arg desc 1 = The location which changed.
|arg desc 1 = The location which changed.
|arg name 2 = <tt>e.Added</tt>
|arg name 2 = <samp>e.Added</samp>
|arg type 2 = <tt>IEnumerable<KeyValuePair<Vector2, Object>></tt>
|arg type 2 = <samp>IEnumerable<KeyValuePair<Vector2, Object>></samp>
|arg desc 2 = A list of [[Modding:Modder Guide/Game Fundamentals#Tiles|tile coordinate]] + object pairs added since the last update tick.
|arg desc 2 = A list of [[Modding:Modder Guide/Game Fundamentals#Tiles|tile coordinate]] + object pairs added since the last update tick.
|arg name 3 = <tt>e.Removed</tt>
|arg name 3 = <samp>e.Removed</samp>
|arg type 3 = <tt>IEnumerable<KeyValuePair<Vector2, Object>></tt>
|arg type 3 = <samp>IEnumerable<KeyValuePair<Vector2, Object>></samp>
|arg desc 3 = A list of [[Modding:Modder Guide/Game Fundamentals#Tiles|tile coordinate]] + object pairs removed since the last update tick.
|arg desc 3 = A list of [[Modding:Modder Guide/Game Fundamentals#Tiles|tile coordinate]] + object pairs removed since the last update tick.
|arg name 4 = <tt>e.IsCurrentLocation</tt>
|arg name 4 = <samp>e.IsCurrentLocation</samp>
|arg type 4 = <tt>bool</tt>
|arg type 4 = <samp>bool</samp>
|arg desc 4 = Whether <tt>e.Location</tt> is the location containing the local player.
|arg desc 4 = Whether <samp>e.Location</samp> is the location containing the local player.
}}
}}
{{/event
{{/event
|group = World
|group = World
|name = TerrainFeatureListChanged
|name = TerrainFeatureListChanged
|desc = Raised after terrain features are added/removed in any location (including trees, hoed dirt, and flooring). For bushes, see <tt>LargeTerrainFeatureListChanged</tt>.
|desc = Raised after terrain features are added/removed in any location (including trees, hoed dirt, and flooring). For bushes, see <samp>LargeTerrainFeatureListChanged</samp>.
This event isn't raised for terrain features already present when a location is added. If you need to handle those too, use [[#World.LocationListChanged|<tt>LocationListChanged</tt>]] and check <tt>e.Added</tt> → <tt>terrainFeatures</tt>.
This event isn't raised for terrain features already present when a location is added. If you need to handle those too, use [[#World.LocationListChanged|<samp>LocationListChanged</samp>]] and check <samp>e.Added</samp> → <samp>terrainFeatures</samp>.
|arg name 1 = <tt>e.Location</tt>
|arg name 1 = <samp>e.Location</samp>
|arg type 1 = <tt>GameLocation</tt>
|arg type 1 = <samp>GameLocation</samp>
|arg desc 1 = The location which changed.
|arg desc 1 = The location which changed.
|arg name 2 = <tt>e.Added</tt>
|arg name 2 = <samp>e.Added</samp>
|arg type 2 = <tt>IEnumerable<KeyValuePair<Vector2, TerrainFeature>></tt>
|arg type 2 = <samp>IEnumerable<KeyValuePair<Vector2, TerrainFeature>></samp>
|arg desc 2 = A list of [[Modding:Modder Guide/Game Fundamentals#Tiles|tile coordinate]] + terrain feature pairs added since the last update tick.
|arg desc 2 = A list of [[Modding:Modder Guide/Game Fundamentals#Tiles|tile coordinate]] + terrain feature pairs added since the last update tick.
|arg name 3 = <tt>e.Removed</tt>
|arg name 3 = <samp>e.Removed</samp>
|arg type 3 = <tt>IEnumerable<KeyValuePair<Vector2, TerrainFeature>></tt>
|arg type 3 = <samp>IEnumerable<KeyValuePair<Vector2, TerrainFeature>></samp>
|arg desc 3 = A list of [[Modding:Modder Guide/Game Fundamentals#Tiles|tile coordinate]] + terrain feature pairs removed since the last update tick.
|arg desc 3 = A list of [[Modding:Modder Guide/Game Fundamentals#Tiles|tile coordinate]] + terrain feature pairs removed since the last update tick.
|arg name 4 = <tt>e.IsCurrentLocation</tt>
|arg name 4 = <samp>e.IsCurrentLocation</samp>
|arg type 4 = <tt>bool</tt>
|arg type 4 = <samp>bool</samp>
|arg desc 4 = Whether <tt>e.Location</tt> is the location containing the local player.
|arg desc 4 = Whether <samp>e.Location</samp> is the location containing the local player.
}}
}}
|}
|}
===Specialised===
===Specialised===
<tt>this.Helper.Events.Specialised</tt> has events for specialised edge cases. These shouldn't be used by most mods.
<samp>this.Helper.Events.Specialised</samp> has events for specialised edge cases. These shouldn't be used by most mods.
{| class="wikitable"
{| class="wikitable"
|group = Specialised
|group = Specialised
|name = LoadStageChanged
|name = LoadStageChanged
|desc = Raised when the low-level stage in the game's loading process has changed, 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 the [[#Game loop|game loop events]] instead.
|desc = Raised when the low-level stage in the game's loading process has changed, 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 the [[#Game loop|game loop events]] instead.
|arg name 1 = <tt>e.NewStage</tt>
|arg name 1 = <samp>e.NewStage</samp>
|arg type 1 = <tt>LoadStage</tt>
|arg type 1 = <samp>LoadStage</samp>
|arg desc 1 = The new load stage. The possible values are...
|arg desc 1 = The new load stage. The possible values are...
* <code>None</code>: a save is not loaded or loading. (For example, the player is on the title screen.)
* <code>None</code>: a save is not loaded or loading. (For example, the player is on the title screen.)
* <code>CreatedBasicInfo</code>: the game is creating a new save slot, and has initialised the basic save info.
* When creating a new save slot:
* <code>CreatedLocations</code>: the game is creating a new save slot, and has initialised the in-game locations.
** <code>CreatedBasicInfo</code>: the game has initialised the basic save info.
* <code>CreatedSaveFile</code>: the game is creating a new save slot, and has created the physical save files.
** <code>CreatedInitialLocations</code>: the game has added the location instances, but hasn't fully initialized them yet.
* <code>SaveParsed</code>: the game is loading a save slot, and has read the raw save data into <tt>StardewValley.SaveGame.loaded</tt>. Not applicable when connecting to a multiplayer host. This is equivalent to <tt>StardewValley.SaveGame.getLoadEnumerator</tt> value 20.
** <code>CreatedLocations</code>: the game has initialised the in-game locations.
* <code>SaveLoadedBasicInfo</code>: the game is loading a save slot, and has applied the basic save info (including player data). Not applicable when connecting to a multiplayer host. Note that some basic info (like daily luck) is not initialised at this point. This is equivalent to <tt>StardewValley.SaveGame.getLoadEnumerator</tt> value 36.
** <code>CreatedSaveFile</code>: the game has created the physical save files.
* <code>SaveLoadedLocations</code>: the game is loading a save slot, and has applied the in-game location data. Not applicable when connecting to a multiplayer host. This is equivalent to <tt>StardewValley.SaveGame.getLoadEnumerator</tt> value 50.
* When loading an existing save slot:
** <code>SaveParsed</code>: the game has read the raw save data into <samp>StardewValley.SaveGame.loaded</samp>. Not applicable when connecting to a multiplayer host. This is equivalent to <samp>StardewValley.SaveGame.getLoadEnumerator</samp> value 20.
** <code>SaveLoadedBasicInfo</code>: the game has applied the basic save info (including player data). Not applicable when connecting to a multiplayer host. Note that some basic info (like daily luck) is not initialised at this point. This is equivalent to <samp>StardewValley.SaveGame.getLoadEnumerator</samp> value 36.
** <code>SaveAddedLocations</code>: the game has added the location instances to the game, but hasn't restored their save data yet.
** <code>SaveLoadedLocations</code>: the game has restored the in-game location data. Not applicable when connecting to a multiplayer host. This is equivalent to <samp>StardewValley.SaveGame.getLoadEnumerator</samp> value 50.
* <code>Preloaded</code>: the final metadata has been loaded from the save file. This happens before the game applies problem fixes, checks for achievements, starts music, etc. Not applicable when connecting to a multiplayer host.
* <code>Preloaded</code>: the final metadata has been loaded from the save file. This happens before the game applies problem fixes, checks for achievements, starts music, etc. Not applicable when connecting to a multiplayer host.
* <code>Loaded</code>: the save is fully loaded, but the world may not be fully initialised yet.
* <code>Loaded</code>: the save is fully loaded, but the world may not be fully initialised yet.
* <code>Ready</code>: the save is fully loaded, the world has been initialised, and [[Modding:Modder Guide/APIs/Utilities#Context|<tt>Context.IsWorldReady</tt>]] is now true.
* <code>Ready</code>: the save is fully loaded, the world has been initialised, and [[Modding:Modder Guide/APIs/Utilities#Context|<samp>Context.IsWorldReady</samp>]] is now true.
* <code>ReturningToTitle</code>: The game is exiting the loaded save and returning to the title screen. This happens before it returns to title; the stage ''after'' it returns to title is <code>None</code>.
|arg name 2 = <tt>e.OldStage</tt>
|arg name 2 = <samp>e.OldStage</samp>
|arg type 2 = <tt>LoadStage</tt>
|arg type 2 = <samp>LoadStage</samp>
|arg desc 2 = The previous load stage. See comments for <tt>e.NewStage</tt>.
|arg desc 2 = The previous load stage. See comments for <samp>e.NewStage</samp>.
}}
}}
{{/event
{{/event
|arg name 1 = <tt>e.Ticks</tt>
|arg name 1 = <samp>e.Ticks</samp>
|arg type 1 = <tt>int</tt>
|arg type 1 = <samp>int</samp>
|arg desc 1 = The number of ticks elapsed since the game started, including the current tick.
|arg desc 1 = The number of ticks elapsed since the game started, including the current tick.
|arg name 2 = <tt>e.IsOneSecond</tt>
|arg name 2 = <samp>e.IsOneSecond</samp>
|arg type 2 = <tt>bool</tt>
|arg type 2 = <samp>bool</samp>
|arg desc 2 = Whether <tt>e.TicksElapsed</tt> is a multiple of 60, which happens approximately once per second.
|arg desc 2 = Whether <samp>e.TicksElapsed</samp> is a multiple of 60, which happens approximately once per second.
|arg name 3 = <tt>e.IsMultipleOf(int number)</tt>
|arg name 3 = <samp>e.IsMultipleOf(int number)</samp>
|arg type 3 = ''method'' returns <tt>bool</tt>
|arg type 3 = ''method'' returns <samp>bool</samp>
|arg desc 3 = Whether <tt>e.TicksElapsed</tt> is a multiple of the given number. This is mainly useful if you want to run logic intermittently (e.g. <code>e.IsMultipleOf(30)</code> for every half-second).
|arg desc 3 = Whether <samp>e.TicksElapsed</samp> is a multiple of the given number. This is mainly useful if you want to run logic intermittently (''e.g.,'' <code>e.IsMultipleOf(30)</code> for every half-second).
}}
}}
|}
|}
==Advanced==
===Change monitoring===
You may want to handle a change that doesn't have its own event (''e.g.,'' an NPC's heart event ends, a letter is added to the mailbox, etc). You can usually do that by handling a general event like [[#GameLoop.UpdateTicked|<samp>UpdateTicked</samp>]], and detecting when the value(s) you're watching changed. For example, here's a complete mod which logs a message when an in-game event ends:
<syntaxhighlight lang="c#">
/// <summary>The main entry point for the mod.</summary>
internal sealed class ModEntry : Mod
{
/*********
** Fields
*********/
/// <summary>The in-game event detected on the last update tick.</summary>
private Event LastEvent;
/*********
** Public methods
*********/
/// <summary>The mod entry point, called after the mod is first loaded.</summary>
/// <param name="helper">Provides simplified APIs for writing mods.</param>
public override void Entry(IModHelper helper)
{
helper.Events.GameLoop.UpdateTicked += this.OnUpdateTicked;
}
/*********
** Private methods
*********/
/// <summary>The method invoked when the game updates its state.</summary>
/// <param name="sender">The event sender.</param>
/// <param name="e">The event arguments.</param>
private void OnUpdateTicked(object sender, EventArgs e)
{
if (this.LastEvent != null && Game1.CurrentEvent == null)
this.Monitor.Log($"Event {this.LastEvent.id} just ended!");
this.LastEvent = Game1.CurrentEvent;
}
}
</syntaxhighlight>
===Custom priority===
SMAPI calls event handlers in the same order they're registered by default, so the first event handler registered is the first to receive the event each time. This isn't always predictable, since it depends on mod load order and when each mod registers their handlers. This order is also an implementation detail, so it's not guaranteed.
If you need more control over the order, you can specify an event priority using the <code>[EventPriority]</code> attribute: <samp>Low</samp> (after most handlers), <samp>Default</samp>, <samp>High</samp> (before most handlers), or a custom value (''e.g.,'' <samp>High + 1</samp> is higher priority than <samp>High</samp>). '''You should only do this if strictly needed'''; depending on event handler order between mods is fragile (''e.g.,'' the other mod might change its priority too).
<syntaxhighlight lang="c#">
/// <summary>The main entry point for the mod.</summary>
internal sealed class ModEntry : Mod
{
/*********
** Public methods
*********/
/// <summary>The mod entry point, called after the mod is first loaded.</summary>
/// <param name="helper">Provides simplified APIs for writing mods.</param>
public override void Entry(IModHelper helper)
{
helper.Events.GameLoop.UpdateTicked += this.OnUpdateTicked;
}
/*********
** Private methods
*********/
/// <summary>The method invoked when the game updates its state.</summary>
/// <param name="sender">The event sender.</param>
/// <param name="e">The event arguments.</param>
[EventPriority(EventPriority.High)]
private void OnUpdateTicked(object sender, EventArgs e)
{
this.Monitor.Log("Update!");
}
}
</syntaxhighlight>
[[zh:模组:制作指南/APIs/Events]]