Modding:Modder Guide/APIs/Multiplayer - Revision history

imported>Margotbean: ru link

2026-01-07T18:54:44Z

ru link

← Older revision		Revision as of 18:54, 7 January 2026
Line 213:		Line 213:
	* [[Modding:Modder Guide/APIs/Events#Multiplayer\|Multiplayer events]]		* [[Modding:Modder Guide/APIs/Events#Multiplayer\|Multiplayer events]]

	[[ru:Модификации:Руководство мододела/API/~~Multiplayer~~]]		[[ru:Модификации:Руководство мододела/API/Мультиплеер]]
	[[zh:模组:制作指南/APIs/Multiplayer]]		[[zh:模组:制作指南/APIs/Multiplayer]]

imported>Sunbeam135: /* See also */

2026-01-02T13:09:16Z

imported>VulpesLucida: zh link

2025-01-05T14:31:37Z

zh link

← Older revision		Revision as of 14:31, 5 January 2025
Line 212:		Line 212:
	==See also==		==See also==
	* [[Modding:Modder Guide/APIs/Events#Multiplayer\|Multiplayer events]]		* [[Modding:Modder Guide/APIs/Events#Multiplayer\|Multiplayer events]]

			[[zh:模组:制作指南/APIs/Multiplayer]]

imported>Margotbean: Text replacement - "''e.g.''," to "''e.g.,''"

2021-11-08T00:40:07Z

Text replacement - "''e.g.''," to "''e.g.,''"

← Older revision		Revision as of 00:40, 8 November 2021
Line 96:		Line 96:

	===Send messages===		===Send messages===
	You can send a message to mods on all connected computers (including the current one) using the <samp>SendMessage</samp> method. The destination can range from very narrow (''e.g.'', one mod on one connected computer) to very broad (all mods on all computers). The message won't be sent back to the mod instance that sent it, but it can be sent to the same mod on other computers.		You can send a message to mods on all connected computers (including the current one) using the <samp>SendMessage</samp> method. The destination can range from very narrow (''e.g.,'' one mod on one connected computer) to very broad (all mods on all computers). The message won't be sent back to the mod instance that sent it, but it can be sent to the same mod on other computers.

	When sending a message, you must specify three things:		When sending a message, you must specify three things:
Line 137:		Line 137:

	==Per-screen data==		==Per-screen data==
	[[Multiplayer\|Split-screen multiplayer]] swaps the entire game state between each player, so each mod runs across every player. For example, with four local players the [[Modding:Modder Guide/APIs/Events#GameLoop.UpdateTicked\|<samp>UpdateTicked</samp>]] event would be raised four times per tick. The game manages its own state automatically (''e.g.'', <samp>Game1.activeClickableMenu</samp>), but if your mod stores info in its own fields you may need to handle those yourself.		[[Multiplayer\|Split-screen multiplayer]] swaps the entire game state between each player, so each mod runs across every player. For example, with four local players the [[Modding:Modder Guide/APIs/Events#GameLoop.UpdateTicked\|<samp>UpdateTicked</samp>]] event would be raised four times per tick. The game manages its own state automatically (''e.g.,'' <samp>Game1.activeClickableMenu</samp>), but if your mod stores info in its own fields you may need to handle those yourself.

	SMAPI provides <code>PerScreen<T></code> to make that easy. You use it by creating '''readonly''' fields for your values (which can be any value from <samp>int</samp> to entire class instances):		SMAPI provides <code>PerScreen<T></code> to make that easy. You use it by creating '''readonly''' fields for your values (which can be any value from <samp>int</samp> to entire class instances):

imported>Margotbean: Text replacement - "(e.g. " to "(''e.g.'', "

2021-11-07T23:41:36Z

Text replacement - "(e.g. " to "(''e.g.'', "

← Older revision		Revision as of 23:41, 7 November 2021
Line 96:		Line 96:

	===Send messages===		===Send messages===
	You can send a message to mods on all connected computers (including the current one) using the <samp>SendMessage</samp> method. The destination can range from very narrow (e.g. one mod on one connected computer) to very broad (all mods on all computers). The message won't be sent back to the mod instance that sent it, but it can be sent to the same mod on other computers.		You can send a message to mods on all connected computers (including the current one) using the <samp>SendMessage</samp> method. The destination can range from very narrow (''e.g.'', one mod on one connected computer) to very broad (all mods on all computers). The message won't be sent back to the mod instance that sent it, but it can be sent to the same mod on other computers.

	When sending a message, you must specify three things:		When sending a message, you must specify three things:
Line 137:		Line 137:

	==Per-screen data==		==Per-screen data==
	[[Multiplayer\|Split-screen multiplayer]] swaps the entire game state between each player, so each mod runs across every player. For example, with four local players the [[Modding:Modder Guide/APIs/Events#GameLoop.UpdateTicked\|<samp>UpdateTicked</samp>]] event would be raised four times per tick. The game manages its own state automatically (e.g. <samp>Game1.activeClickableMenu</samp>), but if your mod stores info in its own fields you may need to handle those yourself.		[[Multiplayer\|Split-screen multiplayer]] swaps the entire game state between each player, so each mod runs across every player. For example, with four local players the [[Modding:Modder Guide/APIs/Events#GameLoop.UpdateTicked\|<samp>UpdateTicked</samp>]] event would be raised four times per tick. The game manages its own state automatically (''e.g.'', <samp>Game1.activeClickableMenu</samp>), but if your mod stores info in its own fields you may need to handle those yourself.

	SMAPI provides <code>PerScreen<T></code> to make that easy. You use it by creating '''readonly''' fields for your values (which can be any value from <samp>int</samp> to entire class instances):		SMAPI provides <code>PerScreen<T></code> to make that easy. You use it by creating '''readonly''' fields for your values (which can be any value from <samp>int</samp> to entire class instances):

imported>Margotbean: Text replacement - "tt>" to "samp>"

2021-11-04T18:48:03Z

Text replacement - "tt>" to "samp>"

← Older revision		Revision as of 18:48, 4 November 2021
Line 22:		Line 22:

	===Get connected player info===		===Get connected player info===
	You can see basic info about other players connected to the same server using the <tt>GetConnectedPlayer(playerID)</tt> and <tt>GetConnectedPlayers()</tt> methods. This is available immediately when the player connects (before the game even approves the connection). Most of the information is only available for players who are running SMAPI too. You can access these fields for each player:		You can see basic info about other players connected to the same server using the <samp>GetConnectedPlayer(playerID)</samp> and <samp>GetConnectedPlayers()</samp> methods. This is available immediately when the player connects (before the game even approves the connection). Most of the information is only available for players who are running SMAPI too. You can access these fields for each player:
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
Line 29:		Line 29:
	! description		! description
	\|-		\|-
	\| <tt>PlayerID</tt>		\| <samp>PlayerID</samp>
	\| <tt>long</tt>		\| <samp>long</samp>
	\| The player's unique multiplayer ID, which you can pass to game methods and fields that expect a unique player ID.		\| The player's unique multiplayer ID, which you can pass to game methods and fields that expect a unique player ID.
	\|-		\|-
	\| <tt>IsHost</tt>		\| <samp>IsHost</samp>
	\| <tt>bool</tt>		\| <samp>bool</samp>
	\| True if this player is hosting the server; false if they're a farmhand.		\| True if this player is hosting the server; false if they're a farmhand.
	\|-		\|-
	\| <tt>IsSplitScreen</tt>		\| <samp>IsSplitScreen</samp>
	\| <tt>bool</tt>		\| <samp>bool</samp>
	\| True if the player is running on the same computer in split-screen mode.		\| True if the player is running on the same computer in split-screen mode.
	\|-		\|-
	\| <tt>HasSmapi</tt>		\| <samp>HasSmapi</samp>
	\| <tt>bool</tt>		\| <samp>bool</samp>
	\| Whether this player has SMAPI installed.		\| Whether this player has SMAPI installed.
	\|-		\|-
	\| <tt>Platform</tt>		\| <samp>Platform</samp>
	\| <tt>GamePlatform</tt>		\| <samp>GamePlatform</samp>
	\| (Requires SMAPI.) The player's operating system as a <tt>GamePlatform</tt> enum (one of <tt>Linux</tt>, <tt>Mac</tt>, or <tt>Windows</tt>).		\| (Requires SMAPI.) The player's operating system as a <samp>GamePlatform</samp> enum (one of <samp>Linux</samp>, <samp>Mac</samp>, or <samp>Windows</samp>).
	\|-		\|-
	\| <tt>GameVersion</tt>		\| <samp>GameVersion</samp>
	\| <tt>ISemanticVersion</tt>		\| <samp>ISemanticVersion</samp>
	\| (Requires SMAPI.) The version of the game they have installed (like {{#tag:tt\|{{version\|link=0}}}}).		\| (Requires SMAPI.) The version of the game they have installed (like {{#tag:tt\|{{version\|link=0}}}}).
	\|-		\|-
	\| <tt>ApiVersion</tt>		\| <samp>ApiVersion</samp>
	\| <tt>ISemanticVersion</tt>		\| <samp>ISemanticVersion</samp>
	\| (Requires SMAPI.) The version of SMAPI they have installed (like <tt>2.11</tt>).		\| (Requires SMAPI.) The version of SMAPI they have installed (like <samp>2.11</samp>).
	\|-		\|-
	\| <tt>Mods</tt>		\| <samp>Mods</samp>
	\| <tt>IEnumerable<IMultiplayerPeerMod></tt>		\| <samp>IEnumerable<IMultiplayerPeerMod></samp>
	\| (Requires SMAPI.) The mods they have installed. Each mod includes the name, unique ID, and version. This is null if the other player doesn't have SMAPI, or an empty list if they have SMAPI but no mods.		\| (Requires SMAPI.) The mods they have installed. Each mod includes the name, unique ID, and version. This is null if the other player doesn't have SMAPI, or an empty list if they have SMAPI but no mods.
	\|-		\|-
	\| <tt>ScreenID</tt>		\| <samp>ScreenID</samp>
	\| <tt>int?</tt>		\| <samp>int?</samp>
	\| The player's screen ID in split-screen mode, if <tt>IsSplitScreen</tt> is true.		\| The player's screen ID in split-screen mode, if <samp>IsSplitScreen</samp> is true.
	\|-		\|-
	\| <tt>GetMod(id)</tt>		\| <samp>GetMod(id)</samp>
	\| ''method'' returns <tt>IMultiplayerPeerMod</tt>		\| ''method'' returns <samp>IMultiplayerPeerMod</samp>
	\| (Requires SMAPI.) A method which returns the mod with the given mod ID using the same case-insensitivity rules as SMAPI, if available. For example, this can be used to check if a mod is installed: <code>if (peer.GetMod("Pathoschild.ContentPatcher") != null)</code>.		\| (Requires SMAPI.) A method which returns the mod with the given mod ID using the same case-insensitivity rules as SMAPI, if available. For example, this can be used to check if a mod is installed: <code>if (peer.GetMod("Pathoschild.ContentPatcher") != null)</code>.
	\|}		\|}
Line 96:		Line 96:

	===Send messages===		===Send messages===
	You can send a message to mods on all connected computers (including the current one) using the <tt>SendMessage</tt> method. The destination can range from very narrow (e.g. one mod on one connected computer) to very broad (all mods on all computers). The message won't be sent back to the mod instance that sent it, but it can be sent to the same mod on other computers.		You can send a message to mods on all connected computers (including the current one) using the <samp>SendMessage</samp> method. The destination can range from very narrow (e.g. one mod on one connected computer) to very broad (all mods on all computers). The message won't be sent back to the mod instance that sent it, but it can be sent to the same mod on other computers.

	When sending a message, you must specify three things:		When sending a message, you must specify three things:
Line 116:		Line 116:

	===Receive messages===		===Receive messages===
	You can receive messages by listening to the <tt>helper.Events.Multiplayer.ModMessageReceived</tt> [[Modding:Modder Guide/APIs/Events\|event]]. The event arguments specify who sent the message, and let you read the message into a matching data model.		You can receive messages by listening to the <samp>helper.Events.Multiplayer.ModMessageReceived</samp> [[Modding:Modder Guide/APIs/Events\|event]]. The event arguments specify who sent the message, and let you read the message into a matching data model.

	For example:		For example:
Line 137:		Line 137:

	==Per-screen data==		==Per-screen data==
	[[Multiplayer\|Split-screen multiplayer]] swaps the entire game state between each player, so each mod runs across every player. For example, with four local players the [[Modding:Modder Guide/APIs/Events#GameLoop.UpdateTicked\|<tt>UpdateTicked</tt>]] event would be raised four times per tick. The game manages its own state automatically (e.g. <tt>Game1.activeClickableMenu</tt>), but if your mod stores info in its own fields you may need to handle those yourself.		[[Multiplayer\|Split-screen multiplayer]] swaps the entire game state between each player, so each mod runs across every player. For example, with four local players the [[Modding:Modder Guide/APIs/Events#GameLoop.UpdateTicked\|<samp>UpdateTicked</samp>]] event would be raised four times per tick. The game manages its own state automatically (e.g. <samp>Game1.activeClickableMenu</samp>), but if your mod stores info in its own fields you may need to handle those yourself.

	SMAPI provides <code>PerScreen<T></code> to make that easy. You use it by creating '''readonly''' fields for your values (which can be any value from <tt>int</tt> to entire class instances):		SMAPI provides <code>PerScreen<T></code> to make that easy. You use it by creating '''readonly''' fields for your values (which can be any value from <samp>int</samp> to entire class instances):
	<syntaxhighlight lang="C#">		<syntaxhighlight lang="C#">
	private readonly PerScreen<int> LastPlayerId = new PerScreen<int>(); // defaults to 0		private readonly PerScreen<int> LastPlayerId = new PerScreen<int>(); // defaults to 0
Line 208:		Line 208:
	</syntaxhighlight>		</syntaxhighlight>

	'''Tip:''' you should almost always mark a per-screen field <code>readonly</code>. Overwriting the entire field (instead of setting the <tt>Value</tt> property) will clear the data for all players, instead of setting it for the current one.		'''Tip:''' you should almost always mark a per-screen field <code>readonly</code>. Overwriting the entire field (instead of setting the <samp>Value</samp> property) will clear the data for all players, instead of setting it for the current one.

	==See also==		==See also==
	* [[Modding:Modder Guide/APIs/Events#Multiplayer\|Multiplayer events]]		* [[Modding:Modder Guide/APIs/Events#Multiplayer\|Multiplayer events]]

imported>Pathoschild: /* Send messages */ simplify a bit

2021-09-29T16:43:46Z

Send messages: simplify a bit

← Older revision		Revision as of 16:43, 29 September 2021
Line 99:		Line 99:

	When sending a message, you must specify three things:		When sending a message, you must specify three things:
	* ~~A data model, which contains the~~ data you want to send. This can be a simple value (like a number or string), or a class instance. When using a class instance with custom constructors, make sure it has a default constructor too.		* The data you want to send. This can be a simple value (like a number or string), or a class instance. When using a class instance with custom constructors, make sure it has a default constructor too.
	* A message type, so the destination mods can know which message it is. This doesn't need to be globally unique, since mods should check the originating mod ID.		* A message type, so the destination mods can know which message it is. This doesn't need to be globally unique, since mods should check the originating mod ID.
	* Who should receive the message. You can specify any combination of player IDs and/or mod IDs. By default, the message is sent to all mods and players.		* Who should receive the message. You can specify any combination of player IDs and/or mod IDs. By default, the message is sent to all mods and players.

imported>Pathoschild: /* Get connected player info */ update for SMAPI 3.9, clarify Mods value when other player doesn't have SMAPI

2021-02-25T15:34:14Z

Get connected player info: update for SMAPI 3.9, clarify Mods value when other player doesn't have SMAPI

← Older revision		Revision as of 15:34, 25 February 2021
Line 39:		Line 39:
	\| <tt>IsSplitScreen</tt>		\| <tt>IsSplitScreen</tt>
	\| <tt>bool</tt>		\| <tt>bool</tt>
	~~\| {{SMAPI upcoming\|3.9~~\|True if the player is running on the same computer in split-screen mode.}}		\| True if the player is running on the same computer in split-screen mode.
	\|-		\|-
	\| <tt>HasSmapi</tt>		\| <tt>HasSmapi</tt>
Line 59:		Line 59:
	\| <tt>Mods</tt>		\| <tt>Mods</tt>
	\| <tt>IEnumerable<IMultiplayerPeerMod></tt>		\| <tt>IEnumerable<IMultiplayerPeerMod></tt>
	\| (Requires SMAPI.) The mods they have installed. Each mod includes the name, unique ID, and version.		\| (Requires SMAPI.) The mods they have installed. Each mod includes the name, unique ID, and version. This is null if the other player doesn't have SMAPI, or an empty list if they have SMAPI but no mods.
	\|-		\|-
	\| <tt>ScreenID</tt>		\| <tt>ScreenID</tt>
	\| <tt>int?</tt>		\| <tt>int?</tt>
	~~\| {{SMAPI upcoming\|3.9~~\|The player's screen ID in split-screen mode, if <tt>IsSplitScreen</tt> is true.}}		\| The player's screen ID in split-screen mode, if <tt>IsSplitScreen</tt> is true.
	\|-		\|-
	\| <tt>GetMod(id)</tt>		\| <tt>GetMod(id)</tt>

imported>RetroEdit: Replace deprecated tags with tags

2021-02-19T18:26:49Z

Replace deprecated <source> tags with <syntaxhighlight> tags

← Older revision		Revision as of 18:26, 19 February 2021
Line 7:		Line 7:
	===Get new ID===		===Get new ID===
	In some cases the game expects a 'multiplayer ID' value, which is a unique 64-bit number. This is mainly intended for cases where the game expects a multiplayer ID for data sync, such as when creating farm animals:		In some cases the game expects a 'multiplayer ID' value, which is a unique 64-bit number. This is mainly intended for cases where the game expects a multiplayer ID for data sync, such as when creating farm animals:
	<~~source~~ lang="c#">		<syntaxhighlight lang="c#">
	int animalID = this.Helper.Multiplayer.GetNewID();		int animalID = this.Helper.Multiplayer.GetNewID();
	var animal = new FarmAnimal("Cow", animalID, ownerID);		var animal = new FarmAnimal("Cow", animalID, ownerID);
	</~~source~~>		</syntaxhighlight>

	===Get active locations===		===Get active locations===
	In multiplayer mode, the game doesn't sync all locations to other players. Each farmhand will receive data for their current location, the farm, farmhouse, and farm buildings. You can get a list of the locations being sync'd:		In multiplayer mode, the game doesn't sync all locations to other players. Each farmhand will receive data for their current location, the farm, farmhouse, and farm buildings. You can get a list of the locations being sync'd:
	<~~source~~ lang="C#">		<syntaxhighlight lang="C#">
	foreach (GameLocation location in this.Helper.Multiplayer.GetActiveLocations())		foreach (GameLocation location in this.Helper.Multiplayer.GetActiveLocations())
	{		{
	// do stuff		// do stuff
	}		}
	</~~source~~>		</syntaxhighlight>

	===Get connected player info===		===Get connected player info===
Line 71:		Line 71:

	For example, this will log information about the currently connected players:		For example, this will log information about the currently connected players:
	<~~source~~ lang="C#">		<syntaxhighlight lang="C#">
	foreach (IMultiplayerPeer peer in this.Helper.Multiplayer.GetConnectedPlayers())		foreach (IMultiplayerPeer peer in this.Helper.Multiplayer.GetConnectedPlayers())
	{		{
Line 85:		Line 85:
	}		}
	}		}
	</~~source~~>		</syntaxhighlight>

	'''Note:''' players whose connections haven't been approved by the game yet are returned too. Although you can send/receive messages through SMAPI's APIs, the game itself may not know about them yet. If you only want players who are fully connected, you can do something like this instead:		'''Note:''' players whose connections haven't been approved by the game yet are returned too. Although you can send/receive messages through SMAPI's APIs, the game itself may not know about them yet. If you only want players who are fully connected, you can do something like this instead:
	<~~source~~ lang="C#">		<syntaxhighlight lang="C#">
	foreach (Farmer farmer in Game1.getOnlineFarmers())		foreach (Farmer farmer in Game1.getOnlineFarmers())
	{		{
	IMultiplayerPeer peer = this.Helper.Multiplayer.GetConnectedPlayer(farmer.UniqueMultiplayerID);		IMultiplayerPeer peer = this.Helper.Multiplayer.GetConnectedPlayer(farmer.UniqueMultiplayerID);
	}		}
	</~~source~~>		</syntaxhighlight>

	===Send messages===		===Send messages===
Line 104:		Line 104:

	For example:		For example:
	<~~source~~ lang="C#">		<syntaxhighlight lang="C#">
	// broadcast a message to all mods on all computers		// broadcast a message to all mods on all computers
	MyMessage message = new MyMessage(...); // create your own class with the data to send		MyMessage message = new MyMessage(...); // create your own class with the data to send
	this.Helper.Multiplayer.SendMessage(message, "MyMessageType");		this.Helper.Multiplayer.SendMessage(message, "MyMessageType");
	</~~source~~>		</syntaxhighlight>
	<~~source~~ lang="C#">		<syntaxhighlight lang="C#">
	// send a message to a specific mod on all computers		// send a message to a specific mod on all computers
	MyMessage message = new MyMessage(...);		MyMessage message = new MyMessage(...);
	this.Helper.Multiplayer.SendMessage(message, "MyMessageType", modIDs: new[] { this.ModManifest.UniqueID });		this.Helper.Multiplayer.SendMessage(message, "MyMessageType", modIDs: new[] { this.ModManifest.UniqueID });
	</~~source~~>		</syntaxhighlight>

	===Receive messages===		===Receive messages===
Line 120:		Line 120:
	For example:		For example:

	<~~source~~ lang="C#">		<syntaxhighlight lang="C#">
	public override void Entry(IModHelper helper)		public override void Entry(IModHelper helper)
	{		{
Line 134:		Line 134:
	}		}
	}		}
	</~~source~~>		</syntaxhighlight>

	==Per-screen data==		==Per-screen data==
Line 140:		Line 140:

	SMAPI provides <code>PerScreen<T></code> to make that easy. You use it by creating '''readonly''' fields for your values (which can be any value from <tt>int</tt> to entire class instances):		SMAPI provides <code>PerScreen<T></code> to make that easy. You use it by creating '''readonly''' fields for your values (which can be any value from <tt>int</tt> to entire class instances):
	<~~source~~ lang="C#">		<syntaxhighlight lang="C#">
	private readonly PerScreen<int> LastPlayerId = new PerScreen<int>(); // defaults to 0		private readonly PerScreen<int> LastPlayerId = new PerScreen<int>(); // defaults to 0
	private readonly PerScreen<SButton> LastButtonPressed = new PerScreen<SButton>(createNewState: () => SButton.None); // defaults to the given value		private readonly PerScreen<SButton> LastButtonPressed = new PerScreen<SButton>(createNewState: () => SButton.None); // defaults to the given value
	</~~source~~>		</syntaxhighlight>

	Then you can just use its properties and methods:		Then you can just use its properties and methods:
Line 168:		Line 168:
	For example, this mod plays a simple game: the main player presses a key, and farmhands need to guess which key was pressed.		For example, this mod plays a simple game: the main player presses a key, and farmhands need to guess which key was pressed.

	<~~source~~ lang="C#">		<syntaxhighlight lang="C#">
	internal class ModEntry : Mod		internal class ModEntry : Mod
	{		{
Line 206:		Line 206:
	}		}
	}		}
	</~~source~~>		</syntaxhighlight>

	'''Tip:''' you should almost always mark a per-screen field <code>readonly</code>. Overwriting the entire field (instead of setting the <tt>Value</tt> property) will clear the data for all players, instead of setting it for the current one.		'''Tip:''' you should almost always mark a per-screen field <code>readonly</code>. Overwriting the entire field (instead of setting the <tt>Value</tt> property) will clear the data for all players, instead of setting it for the current one.

imported>Pathoschild: /* Per-screen data */ expand info + example, add new features in SMAPI 3.9

2021-01-23T02:59:53Z

Per-screen data: expand info + example, add new features in SMAPI 3.9

@@ Line 139: / Line 139: @@
 [[Multiplayer|Split-screen multiplayer]] swaps the entire game state between each player, so each mod runs across every player. For example, with four local players the [[Modding:Modder Guide/APIs/Events#GameLoop.UpdateTicked|<tt>UpdateTicked</tt>]] event would be raised four times per tick. The game manages its own state automatically (e.g. <tt>Game1.activeClickableMenu</tt>), but if your mod stores info in its own fields you may need to handle those yourself.
-That can be tricky, so SMAPI provides <code>PerScreen&lt;T&gt;</code> to take care of it. A <code>PerScreen&lt;T&gt;</code> field manages a separate value for each local screen.
+SMAPI provides <code>PerScreen&lt;T&gt;</code> to make that easy. You use it by creating '''readonly''' fields for your values (which can be any value from <tt>int</tt> to entire class instances):
-For example, this mod would keep track of the last button pressed by each player:
+Then you can just use its properties and methods:
 <source lang="C#">
@@ Line 147: / Line 172: @@
+{
      private readonly PerScreen<SButton> LastButtonPressed = new PerScreen<SButton>();
+    private readonly PerScreen<int> Score = new PerScreen<int>();
      public override void Entry(IModHelper helper)
@@ Line 156: / Line 181: @@
      private void OnButtonPressed(object sender, ButtonPressedEventArgs e)
+     {
-         this.LastButtonPressed.Value = e.Button;
+         // main player changes key
+     }
+}
 </source>

← Older revision		Revision as of 13:09, 2 January 2026
Line 213:		Line 213:
	* [[Modding:Modder Guide/APIs/Events#Multiplayer\|Multiplayer events]]		* [[Modding:Modder Guide/APIs/Events#Multiplayer\|Multiplayer events]]

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