Modding:Modder Guide/APIs/Events - Revision history

imported>Margotbean: ru link

2026-01-07T19:00:47Z

ru link

← Older revision		Revision as of 19:00, 7 January 2026
Line 966:		Line 966:
	</syntaxhighlight>		</syntaxhighlight>

			[[ru:Модификации:Руководство мододела/API/События]]
	[[zh:模组:制作指南/APIs/Events]]		[[zh:模组:制作指南/APIs/Events]]

2025-10-25T20:30:14Z

Game loop: OneSecondUpdateTickedEventArgs

← Older revision		Revision as of 20:30, 25 October 2025
Line 342:		Line 342:
	\|group = GameLoop		\|group = GameLoop
	\|name = OneSecondUpdateTicking, OneSecondUpdateTicked		\|name = OneSecondUpdateTicking, OneSecondUpdateTicked
	\|desc = Raised before/after the game state is updated, once per second. EventArgs subtype is ~~UpdateTickedEventArgs~~		\|desc = Raised before/after the game state is updated, once per second. EventArgs subtype is OneSecondUpdateTickedEventArgs

	\|arg name 1 = <samp>e.Ticks</samp>		\|arg name 1 = <samp>e.Ticks</samp>

2025-10-25T20:27:38Z

Game loop: UpdateTickedEventArgs

← Older revision		Revision as of 20:27, 25 October 2025
Line 342:		Line 342:
	\|group = GameLoop		\|group = GameLoop
	\|name = OneSecondUpdateTicking, OneSecondUpdateTicked		\|name = OneSecondUpdateTicking, OneSecondUpdateTicked
	\|desc = Raised before/after the game state is updated, once per second.		\|desc = Raised before/after the game state is updated, once per second. EventArgs subtype is UpdateTickedEventArgs

	\|arg name 1 = <samp>e.Ticks</samp>		\|arg name 1 = <samp>e.Ticks</samp>

2025-06-08T16:13:51Z

Game loop: Clarify that SaveLoaded happens after the game's own day-start initialization process

← Older revision		Revision as of 16:13, 8 June 2025
Line 365:		Line 365:
	\|group = GameLoop		\|group = GameLoop
	\|name = SaveLoaded		\|name = SaveLoaded
	\|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.		\|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>, but after the game's own day-start initialization process; 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.		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.

2024-07-08T17:51:43Z

← Older revision		Revision as of 17:51, 8 July 2024
Line 173:		Line 173:
	\|arg name 4 = <samp>e.NewLocale</samp>		\|arg name 4 = <samp>e.NewLocale</samp>
	\|arg type 4 = <samp>string</samp>		\|arg type 4 = <samp>string</samp>
	\|arg desc 4 = The ~~previous~~ value for the locale code. See notes on <samp>OldLocale</samp>.		\|arg desc 4 = The new value for the locale code. See notes on <samp>OldLocale</samp>.
	}}		}}
	\|}		\|}

2024-04-06T18:05:52Z

remove {{SMAPI upcoming|4.0.0}}

← Older revision		Revision as of 18:05, 6 April 2024
Line 285:		Line 285:
	\|group = Display		\|group = Display
	\|name = RenderingStep		\|name = RenderingStep
	\|desc = ~~{{SMAPI upcoming\|4.0.0}}~~ ''(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.		\|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 name 1 = <samp>e.SpriteBatch</samp>
Line 298:		Line 298:
	\|group = Display		\|group = Display
	\|name = RenderedStep		\|name = RenderedStep
	\|desc = ~~{{SMAPI upcoming\|4.0.0}}~~ ''(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.		\|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 name 1 = <samp>e.SpriteBatch</samp>

2024-03-16T18:26:06Z

Display: + render step events in SMAPI 4.0.0

@@ Line 281: / Line 281: @@
   |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>).
 }}
 |}

2022-11-28T02:38:59Z

Advanced

← Older revision		Revision as of 02:38, 28 November 2022
Line 870:		Line 870:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	/// <summary>The main entry point for the mod.</summary>		/// <summary>The main entry point for the mod.</summary>
	~~public~~ class ModEntry : Mod		internal sealed class ModEntry : Mod
	{		{
	/*********		/*********
Line 913:		Line 913:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	/// <summary>The main entry point for the mod.</summary>		/// <summary>The main entry point for the mod.</summary>
	~~public~~ class ModEntry : Mod		internal sealed class ModEntry : Mod
	{		{
	/*********		/*********

2022-11-28T02:37:38Z

How do I use them?

← Older revision		Revision as of 02:37, 28 November 2022
Line 41:		Line 41:

	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?===		===How do events fit into the game?===

2022-11-28T02:36:43Z

How do I use them?: seal by default, also add nullability annotations.

← Older revision		Revision as of 02:36, 28 November 2022
Line 17:		Line 17:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	/// <summary>The main entry point for the mod.</summary>		/// <summary>The main entry point for the mod.</summary>
	~~public~~ class ModEntry : Mod		internal sealed class ModEntry : Mod
	{		{
	/**********		/**********
Line 33:		Line 33:
	/// <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!", LogLevel.Info);		this.Monitor.Log("A new day dawns!", LogLevel.Info);