Multiplayer Scripting - Revision history

Lou Montana: /* JIP Synchronisation */ Fix icons

2025-12-31T22:33:57Z

JIP Synchronisation: Fix icons

← Older revision		Revision as of 00:33, 1 January 2026
Line 463:		Line 463:
	\|-		\|-
	\| time passed since mission start ([[time]] command)		\| time passed since mission start ([[time]] command)
	\| align="center" \| ''unknown''		\| align="center" \| {{Icon\|unknown}}
	\| align="center" \| ''unknown''		\| align="center" \| {{Icon\|unknown}}
	\| align="center" \| {{Icon\|checked}}		\| align="center" \| {{Icon\|checked}}
	\|-		\|-

Lou Montana: Text replacement - " ''via'' " to " via "

2025-02-21T10:44:05Z

Text replacement - " ''via'' " to " via "

← Older revision		Revision as of 12:44, 21 February 2025
Line 514:		Line 514:
	* The '''server''' initialises and works with '''variables'''		* The '''server''' initialises and works with '''variables'''
	* A connecting or connected '''player-client''' gets the mission data from the server		* A connecting or connected '''player-client''' gets the mission data from the server
	* Once an objective is reached, '''the server tells the players''' ''via'' [[remoteExec]]/[[remoteExecCall]], [[publicVariable]] or [[setVariable]]		* Once an objective is reached, '''the server tells the players''' via [[remoteExec]]/[[remoteExecCall]], [[publicVariable]] or [[setVariable]]
	* Players can get their client-side UI code triggered by the server		* Players can get their client-side UI code triggered by the server
	See {{Link\|#Different machines and how to target them\|this earlier chapter}} to know how to target specific machines.		See {{Link\|#Different machines and how to target them\|this earlier chapter}} to know how to target specific machines.

Lou Montana: Text replacement - "{{arma3}} v1.57" to "{{arma3}} v1.58"

2024-09-15T18:22:34Z

Text replacement - "{{arma3}} v1.57" to "{{arma3}} v1.58"

← Older revision		Revision as of 20:22, 15 September 2024
Line 353:		Line 353:
	* [[Arma 3: Mission Event Handlers#PlayerConnected\|"PlayerConnected" mission Event Handler]]		* [[Arma 3: Mission Event Handlers#PlayerConnected\|"PlayerConnected" mission Event Handler]]
	* [[Arma 3: Mission Event Handlers#PlayerDisconnected\|"PlayerDisconnected" mission Event Handler]]		* [[Arma 3: Mission Event Handlers#PlayerDisconnected\|"PlayerDisconnected" mission Event Handler]]
	{{Feature\|informative\|Before {{arma3}} v1.57, use [[BIS_fnc_addStackedEventHandler]] for [[onPlayerConnected]]/[[onPlayerDisconnected]].}}		{{Feature\|informative\|Before {{arma3}} v1.58, use [[BIS_fnc_addStackedEventHandler]] for [[onPlayerConnected]]/[[onPlayerDisconnected]].}}

Lou Montana: Text replacement - "server.cfg" to "server config"

2024-05-17T12:36:03Z

Text replacement - "server.cfg" to "server config"

← Older revision		Revision as of 14:36, 17 May 2024
Line 642:		Line 642:

	* [[Arma 3: Dedicated Server]]		* [[Arma 3: Dedicated Server]]
	* [[server~~.cfg~~]]		* [[Arma 3: Server Config File\|server config]]


	[[Category:Arma Scripting Tutorials]]		[[Category:Arma Scripting Tutorials]]

Lou Montana: Text replacement - "{{Feature | Warning | " to "{{Feature|warning|"

2024-05-16T20:46:21Z

Text replacement - "{{Feature | Warning | " to "{{Feature|warning|"

← Older revision		Revision as of 22:46, 16 May 2024
Line 22:		Line 22:

	{{Feature\|informative\|In Singleplayer, the game acts as a player-hosted server ([[isServer]] returns true).}}		{{Feature\|informative\|In Singleplayer, the game acts as a player-hosted server ([[isServer]] returns true).}}
	{{Feature \| ~~Warning~~ \| Some Multiplayer commands do '''not''' work in Singleplayer, such as [[netId]]!<br>		{{Feature\|warning\|Some Multiplayer commands do '''not''' work in Singleplayer, such as [[netId]]!<br>
	The other way around, some Singleplayer commands do not work in Multiplayer (e.g [[setAccTime]]).}}		The other way around, some Singleplayer commands do not work in Multiplayer (e.g [[setAccTime]]).}}

Line 265:		Line 265:

	Network IDs identify machines and network objects. They can be used to target proper machines with remote execution; see the {{Link\|#Remote Execution}} chapter for more information.		Network IDs identify machines and network objects. They can be used to target proper machines with remote execution; see the {{Link\|#Remote Execution}} chapter for more information.
	{{Feature \| ~~Warning~~ \| '''A machine ID''' ([[owner\|ownerID]]) is not to be confused with '''an object's network ID''' ([[netId]]).}}		{{Feature\|warning\|'''A machine ID''' ([[owner\|ownerID]]) is not to be confused with '''an object's network ID''' ([[netId]]).}}

	=== Machine network ID ===		=== Machine network ID ===
Line 487:		Line 487:
	\|}		\|}

	{{Feature \| ~~Warning~~ \| All the '''initialisation fields''' code get executed again for '''each and every JIP connecting player'''.<br>		{{Feature\|warning\|All the '''initialisation fields''' code get executed again for '''each and every JIP connecting player'''.<br>
	This means that code with global effect {{Icon\|globalEffect\|32}} (such as [[setDamage]]) '''WILL''' be re-executed (depending on locality)!}}		This means that code with global effect {{Icon\|globalEffect\|32}} (such as [[setDamage]]) '''WILL''' be re-executed (depending on locality)!}}

Lou Montana: Text replacement - "{{Feature | Informative | " to "{{Feature|informative|"

2024-05-16T20:41:48Z

Text replacement - "{{Feature | Informative | " to "{{Feature|informative|"

Lou Montana: Text replacement - "[[Arma 3 " to "[[Arma 3: "

2024-05-06T09:38:34Z

Text replacement - "[[Arma 3 " to "[[Arma 3: "

← Older revision		Revision as of 11:38, 6 May 2024
Line 502:		Line 502:
	== See also ==		== See also ==

	* [[Arma 3 Headless Client\|Headless Client]]		* [[Arma 3: Headless Client\|Headless Client]]
	* [[Initialisation Order]]		* [[Initialisation Order]]
	* [[Arma 3: Remote Execution]]		* [[Arma 3: Remote Execution]]
Line 522:		Line 522:
	The '''Server''' must be considered as the one ruler of the mission. He is the game's referee and all the decisions should come from it. All the values on the server should be considered as '''true'''.<br>		The '''Server''' must be considered as the one ruler of the mission. He is the game's referee and all the decisions should come from it. All the values on the server should be considered as '''true'''.<br>
	Consider the server as a powerful machine where you can put all the mission conditions and heavy scripting on.		Consider the server as a powerful machine where you can put all the mission conditions and heavy scripting on.
	In case of a very heavy mission, the server can be assisted by [[Arma 3 Headless Client\|Headless Clients]] (this involves a per-mission specific design).		In case of a very heavy mission, the server can be assisted by [[Arma 3: Headless Client\|Headless Clients]] (this involves a per-mission specific design).

	Server-side code must gather or wait all the variables (potentially from client-side scripts and [[publicVariableServer]]) and take and broadcast its decisions accordingly using [[publicVariable]].		Server-side code must gather or wait all the variables (potentially from client-side scripts and [[publicVariableServer]]) and take and broadcast its decisions accordingly using [[publicVariable]].
Line 559:		Line 559:
	** If you cannot figure out how to write your code, say what you want to do out loud or write it down in your language, then replace it by code little by little.		** If you cannot figure out how to write your code, say what you want to do out loud or write it down in your language, then replace it by code little by little.
	* Make it work		* Make it work
	** use the [[Arma 3 Startup Parameters#Developer Options\|-showScriptErrors]] startup parameter to see your code errors.		** use the [[Arma 3: Startup Parameters#Developer Options\|-showScriptErrors]] startup parameter to see your code errors.
	* Make it readable		* Make it readable
	** name your variables properly, as if you had to give it to someone that should get it without the need of explaining		** name your variables properly, as if you had to give it to someone that should get it without the need of explaining

Lou Montana: Fix table

2024-02-19T09:52:59Z

Fix table

← Older revision		Revision as of 11:52, 19 February 2024
Line 138:		Line 138:
	\|-		\|-
	\| <sqf>not hasInterface</sqf>		\| <sqf>not hasInterface</sqf>
			\| {{Icon\|checked}}
	\| {{Icon\|unchecked}}		\| {{Icon\|unchecked}}
	~~\| {{Icon\|checked}}~~
	\| {{Icon\|unchecked}}		\| {{Icon\|unchecked}}
	\| {{Icon\|checked}}		\| {{Icon\|checked}}

Lou Montana: Text replacement - ":Category:Eden Editor" to "Eden Editor"

2023-07-09T12:26:40Z

Text replacement - "Category:Eden Editor" to "Eden Editor"

← Older revision		Revision as of 14:26, 9 July 2023
Line 217:		Line 217:
	** terrain objects (buildings, vegetation, roads etc.) are local everywhere (<sqf inline>local nearestBuilding player</sqf> returns [[true]] on every client)		** terrain objects (buildings, vegetation, roads etc.) are local everywhere (<sqf inline>local nearestBuilding player</sqf> returns [[true]] on every client)
	** editor-placed objects and empty vehicles are local to the server		** editor-placed objects and empty vehicles are local to the server
	** editor-placed '''triggers''' are created on every machine unless specified otherwise ("Server Only" [[:Category:Eden Editor]] option ticked)		** editor-placed '''triggers''' are created on every machine unless specified otherwise ("Server Only" [[:Category:Eden Editor\|Eden Editor]] option ticked)
	** units created with [[createUnit]] will be local to the computer that issued the command		** units created with [[createUnit]] will be local to the computer that issued the command
	** objects and vehicles created with [[createVehicle]] will be local to the computer that issued the command		** objects and vehicles created with [[createVehicle]] will be local to the computer that issued the command

Lou Montana: Text replacement - "\[\[Eden( |_)Editor(\||\])" to "[[:Category:Eden Editor$2"

2023-07-09T12:21:11Z

Text replacement - "\[\[Eden( |_)Editor(\||\])" to "[[:Category:Eden Editor$2"

← Older revision		Revision as of 14:21, 9 July 2023
Line 217:		Line 217:
	** terrain objects (buildings, vegetation, roads etc.) are local everywhere (<sqf inline>local nearestBuilding player</sqf> returns [[true]] on every client)		** terrain objects (buildings, vegetation, roads etc.) are local everywhere (<sqf inline>local nearestBuilding player</sqf> returns [[true]] on every client)
	** editor-placed objects and empty vehicles are local to the server		** editor-placed objects and empty vehicles are local to the server
	** editor-placed '''triggers''' are created on every machine unless specified otherwise ("Server Only" [[Eden Editor]] option ticked)		** editor-placed '''triggers''' are created on every machine unless specified otherwise ("Server Only" [[:Category:Eden Editor]] option ticked)
	** units created with [[createUnit]] will be local to the computer that issued the command		** units created with [[createUnit]] will be local to the computer that issued the command
	** objects and vehicles created with [[createVehicle]] will be local to the computer that issued the command		** objects and vehicles created with [[createVehicle]] will be local to the computer that issued the command

← Older revision		Revision as of 20:22, 15 September 2024
Line 353:		Line 353:
	* [[Arma 3: Mission Event Handlers#PlayerConnected\|"PlayerConnected" mission Event Handler]]		* [[Arma 3: Mission Event Handlers#PlayerConnected\|"PlayerConnected" mission Event Handler]]
	* [[Arma 3: Mission Event Handlers#PlayerDisconnected\|"PlayerDisconnected" mission Event Handler]]		* [[Arma 3: Mission Event Handlers#PlayerDisconnected\|"PlayerDisconnected" mission Event Handler]]
	{{Feature\|informative\|Before {{arma3}} v1.57, use [[BIS_fnc_addStackedEventHandler]] for [[onPlayerConnected]]/[[onPlayerDisconnected]].}}		{{Feature\|informative\|Before {{arma3}} v1.58, use [[BIS_fnc_addStackedEventHandler]] for [[onPlayerConnected]]/[[onPlayerDisconnected]].}}

← Older revision		Revision as of 22:41, 16 May 2024
Line 21:		Line 21:
	<br>		<br>

	{{Feature \| ~~Informative~~ \| In Singleplayer, the game acts as a player-hosted server ([[isServer]] returns true).}}		{{Feature\|informative\|In Singleplayer, the game acts as a player-hosted server ([[isServer]] returns true).}}
	{{Feature \| Warning \| Some Multiplayer commands do '''not''' work in Singleplayer, such as [[netId]]!<br>		{{Feature \| Warning \| Some Multiplayer commands do '''not''' work in Singleplayer, such as [[netId]]!<br>
	The other way around, some Singleplayer commands do not work in Multiplayer (e.g [[setAccTime]]).}}		The other way around, some Singleplayer commands do not work in Multiplayer (e.g [[setAccTime]]).}}
Line 146:		Line 146:

	'''For an extended version for all games, click''' <spoiler>		'''For an extended version for all games, click''' <spoiler>
	{{Feature \| ~~Informative~~ \| Before {{GVI\|ofp\|1.99}} and the backport of [[isServer]], the server could be identified by placing a [[Game Logic]] in the editor (that would always remain local to the server), then using the following: <sqf inline>local myLogic</sqf>.}}		{{Feature\|informative\|Before {{GVI\|ofp\|1.99}} and the backport of [[isServer]], the server could be identified by placing a [[Game Logic]] in the editor (that would always remain local to the server), then using the following: <sqf inline>local myLogic</sqf>.}}

	{\| class="wikitable" style="line-height: normal; text-align: center"		{\| class="wikitable" style="line-height: normal; text-align: center"
Line 251:		Line 251:
	\| align="center" \| {{Icon\|localEffect\|32}}		\| align="center" \| {{Icon\|localEffect\|32}}
	\| Any unit (local or remote) can get its face changed, but the new face will not be propagated through the network. Only the local machine's player will see the effect of the command		\| Any unit (local or remote) can get its face changed, but the new face will not be propagated through the network. Only the local machine's player will see the effect of the command
	{{Feature \| ~~Informative~~ \| This command should ideally be '''executed on every machine''', for example with:		{{Feature\|informative\|This command should ideally be '''executed on every machine''', for example with:
	<sqf>[remoteUnit, "Miller"] remoteExec ["setFace", 0, true];</sqf>		<sqf>[remoteUnit, "Miller"] remoteExec ["setFace", 0, true];</sqf>
	See the {{Link\|#Remote Execution}} chapter for more information.}}		See the {{Link\|#Remote Execution}} chapter for more information.}}
Line 275:		Line 275:
	* To get the machine ID of a group's owner, use [[groupOwner]] ''object'' (MP only).		* To get the machine ID of a group's owner, use [[groupOwner]] ''object'' (MP only).

	{{Feature \| ~~Informative~~ \| '''0''' and '''1''' are special values:		{{Feature\|informative\|'''0''' and '''1''' are special values:
	* '''0''' means '''everyone''' (including the server)		* '''0''' means '''everyone''' (including the server)
	* '''1''' means '''current machine''' but '''{{Color\|darkred\|is not implemented}}''' and should '''not''' be used.}}		* '''1''' means '''current machine''' but '''{{Color\|darkred\|is not implemented}}''' and should '''not''' be used.}}
Line 353:		Line 353:
	* [[Arma 3: Mission Event Handlers#PlayerConnected\|"PlayerConnected" mission Event Handler]]		* [[Arma 3: Mission Event Handlers#PlayerConnected\|"PlayerConnected" mission Event Handler]]
	* [[Arma 3: Mission Event Handlers#PlayerDisconnected\|"PlayerDisconnected" mission Event Handler]]		* [[Arma 3: Mission Event Handlers#PlayerDisconnected\|"PlayerDisconnected" mission Event Handler]]
	{{Feature \| ~~Informative~~ \| Before {{arma3}} v1.57, use [[BIS_fnc_addStackedEventHandler]] for [[onPlayerConnected]]/[[onPlayerDisconnected]].}}		{{Feature\|informative\|Before {{arma3}} v1.57, use [[BIS_fnc_addStackedEventHandler]] for [[onPlayerConnected]]/[[onPlayerDisconnected]].}}


Line 527:		Line 527:

	Server-side code should ideally '''not''' make any reference to a [[player]] variable considering a server can potentially be '''dedicated''', unless you want to force this mission to be player-hosted (such as {{arma2}}'s campaign).		Server-side code should ideally '''not''' make any reference to a [[player]] variable considering a server can potentially be '''dedicated''', unless you want to force this mission to be player-hosted (such as {{arma2}}'s campaign).
	{{Feature \| ~~Informative~~ \| Use [[allPlayers]], [[BIS_fnc_listPlayers]], [[playableUnits]] (and [[switchableUnits]] for SP compatibility) to refer to players.}}		{{Feature\|informative\|Use [[allPlayers]], [[BIS_fnc_listPlayers]], [[playableUnits]] (and [[switchableUnits]] for SP compatibility) to refer to players.}}

	=== Client ===		=== Client ===