translators
8,456
edits
Changes
Jump to navigation
Jump to search
Line 3:
Line 3: − ==Mod APIs==+ − ===Events=== Line 24:
Line 23: − Here are the available events:+ − <ul>+ − <li id="content-events">+ − '''<tt>ContentEvents</tt>''' are raised when the game loads content from its XNB files or changes locale.+ Line 38:
Line 37: − </li> − <li id="control-events">+ − '''<tt>ControlEvents</tt>''' are raised when the player uses a controller, keyboard, or mouse. They're raised before the game handles the input, so it's possible to selectively prevent the game from responding to it. (That's beyond the scope of this guide, but it involves overwriting <tt>Game1.oldKBState</tt>, <tt>Game1.oldMouseState</tt>, and <tt>Game1.oldPadState</tt>.)+ Line 59:
Line 57: − </li> − <li id="game-events">+ − '''<tt>GameEvents</tt>''' are raised when the game changes state.+ Line 84:
Line 81: − </li> − <li id="graphics-events">+ − '''<tt>GraphicsEvents</tt>''' are raised during the game's draw loop, when the game is rendering content to the window.+ Line 101:
Line 97: − </li> − <li id="location-events">+ − '''<tt>LocationEvents</tt>''' are raised when the player transitions between game locations, a location is added or removed, or the objects in the current location change.+ Line 116:
Line 111: − </li> − <li id="control-events">+ − '''<tt>MenuEvents</tt>''' are raised when a game menu is opened or closed (including internal menus like the title screen).+ Line 129:
Line 123: − </li> − <li id="mine-events">+ − '''<tt>MineEvents</tt>''' are raised when something happens in [[The Mines]].+ Line 140:
Line 133: − </li> − <li id="player-events">+ − '''<tt>PlayerEvents</tt>''' are raised when the player data changes.+ Line 153:
Line 145: − </li> − <li id="save-events">+ − '''<tt>SaveEvents</tt>''' are raised when the player saves or loads the game.+ Line 170:
Line 161: − </li> − <li id="time-events">+ − '''<tt>TimeEvents</tt>''' are raised when the in-game date or time changes.+ Line 189:
Line 179: − </li> − </ul> +
split events into its own section, break list into subsections
SMAPI simplifies mod development by providing APIs and events you can use, which are documented below. See [[Modding:Creating a SMAPI mod]] for a guide to creating a new SMAPI mod.
SMAPI simplifies mod development by providing APIs and events you can use, which are documented below. See [[Modding:Creating a SMAPI mod]] for a guide to creating a new SMAPI mod.
==Events==
SMAPI publishes several C# events that tell you when something happens. For example, if you want to do something after the player loads their save, you can add this to your <tt>Entry</tt> method:
SMAPI publishes several C# events that tell you when something happens. For example, if you want to do something after the player loads their save, you can add this to your <tt>Entry</tt> method:
</source>
</source>
The available events are documented below.
===Content events===
<tt>ContentEvents</tt> are raised when the game loads content from its XNB files or changes locale.
{| class="wikitable"
{| class="wikitable"
|-
|-
| AfterLocaleChanged || Raised after the content language changes.
| AfterLocaleChanged || Raised after the content language changes.
|}
|}
===Control events===
<tt>ControlEvents</tt> are raised when the player uses a controller, keyboard, or mouse. They're raised before the game handles the input, so it's possible to selectively prevent the game from responding to it. (That's beyond the scope of this guide, but it involves overwriting <tt>Game1.oldKBState</tt>, <tt>Game1.oldMouseState</tt>, and <tt>Game1.oldPadState</tt>.)
Most of these events are split into two variants, <tt>XPressed</tt> and <tt>XReleased</tt>. The <tt>Pressed</tt> variant is raised when the player presses the button (holding the button down only triggers the event once), and the <tt>Released</tt> variant is raised when they release it.
Most of these events are split into two variants, <tt>XPressed</tt> and <tt>XReleased</tt>. The <tt>Pressed</tt> variant is raised when the player presses the button (holding the button down only triggers the event once), and the <tt>Released</tt> variant is raised when they release it.
| MouseChanged || Raised after the game's <tt>MouseState</tt> changed. That happens when the player moves the mouse, scrolls the mouse wheel, or presses/releases a button.
| MouseChanged || Raised after the game's <tt>MouseState</tt> changed. That happens when the player moves the mouse, scrolls the mouse wheel, or presses/releases a button.
|}
|}
===Game events===
<tt>GameEvents</tt> are raised when the game changes state.
{| class="wikitable"
{| class="wikitable"
| OneSecondTick || Raised every 60th tick (≈once per second).
| OneSecondTick || Raised every 60th tick (≈once per second).
|}
|}
===Graphics events===
<tt>GraphicsEvents</tt> are raised during the game's draw loop, when the game is rendering content to the window.
{| class="wikitable"
{| class="wikitable"
| Resize || Raised after the game window is resized.
| Resize || Raised after the game window is resized.
|}
|}
===Location events===
<tt>LocationEvents</tt> are raised when the player transitions between game locations, a location is added or removed, or the objects in the current location change.
{| class="wikitable"
{| class="wikitable"
| LocationsChanged || Raised after a game location is added or removed. Handlers are passed the new list of locations as an argument.
| LocationsChanged || Raised after a game location is added or removed. Handlers are passed the new list of locations as an argument.
|}
|}
===Menu events===
<tt>MenuEvents</tt> are raised when a game menu is opened or closed (including internal menus like the title screen).
{| class="wikitable"
{| class="wikitable"
| MenuClosed || Raised after a game menu is closed. Handlers are given the previous menu.
| MenuClosed || Raised after a game menu is closed. Handlers are given the previous menu.
|}
|}
===Mine events===
<tt>MineEvents</tt> are raised when something happens in [[The Mines]].
{| class="wikitable"
{| class="wikitable"
| MineLevelChanged || Raised after the player warps to a new level of the mine. Handlers are passed the previous and new mine level as arguments.
| MineLevelChanged || Raised after the player warps to a new level of the mine. Handlers are passed the previous and new mine level as arguments.
|}
|}
===Player events===
<tt>PlayerEvents</tt> are raised when the player data changes.
{| class="wikitable"
{| class="wikitable"
| LeveledUp || Raised after the player levels up a skill. This happens as soon as they level up, not when the game notifies the player after their character goes to bed.
| LeveledUp || Raised after the player levels up a skill. This happens as soon as they level up, not when the game notifies the player after their character goes to bed.
|}
|}
===Save events===
<tt>SaveEvents</tt> are raised when the player saves or loads the game.
{| class="wikitable"
{| class="wikitable"
| AfterReturnToTitle || Raised after the player exits to the title screen.
| AfterReturnToTitle || Raised after the player exits to the title screen.
|}
|}
===Time events===
<tt>TimeEvents</tt> are raised when the in-game date or time changes.
{| class="wikitable"
{| class="wikitable"
| YearOfGameChanged || Raised after the year changes.
| YearOfGameChanged || Raised after the year changes.
|}
|}
==Mod APIs==
===Configuration===
===Configuration===
You can let users configure your mod through a <tt>config.json</tt> file. SMAPI will automatically create the file and take care of reading, normalising, and updating it.
You can let users configure your mod through a <tt>config.json</tt> file. SMAPI will automatically create the file and take care of reading, normalising, and updating it.