remoteExec - Revision history

Lou Montana: Some wiki formatting

2025-01-17T21:17:19Z

Some wiki formatting

← Older revision		Revision as of 23:17, 17 January 2025
Line 67:		Line 67:


	<!-- ~~Don't~~ place links within strings in these examples. -->		<!-- Do not place links within strings in these examples. -->


	\|x1= How to write [[remoteExec]]/[[remoteExecCall]]:		\|x1= How to write [[remoteExec]]/[[remoteExecCall]] with arguments - note the colours:
	<code style="display: block">{{Color\|darkorange\|hint}} {{Color\|teal\|"Hello"}};		<code style="display: block">{{Color\|darkorange\|hint}} {{Color\|teal\|"Hello"}};
	{{cc\|becomes}}		{{cc\|becomes}}
Line 84:		Line 84:
	[{{Color\|darkred\|["", "BLACK OUT"]}}] remoteExec ["{{Color\|darkorange\|cutRsc}}"]; {{cc\|double brackets are needed as the unary command takes an array}}</code>		[{{Color\|darkred\|["", "BLACK OUT"]}}] remoteExec ["{{Color\|darkorange\|cutRsc}}"]; {{cc\|double brackets are needed as the unary command takes an array}}</code>

	<code style="display: block">		<code style="display: block">{{cc\|functions, however, do not need double squared brackets}}
	{{cc\|functions, however, do not need double squared brackets}}
	{{Color\|teal\|["line 1", "line 2"]}} spawn {{Color\|darkorange\|BIS_fnc_infoText}};		{{Color\|teal\|["line 1", "line 2"]}} spawn {{Color\|darkorange\|BIS_fnc_infoText}};
	{{cc\|becomes}}		{{cc\|becomes}}
Line 93:		Line 92:
	\|x2= send an order to specific machines:		\|x2= send an order to specific machines:
	<sqf>		<sqf>
			"message" remoteExec ["hint"]; // sends a hint message to everyone
	"message" remoteExec ["hint", 0]; // sends a hint message to everyone, identical to "message" remoteExec ["hint"]		"message" remoteExec ["hint", 0]; // sends a hint message to everyone, identical to "message" remoteExec ["hint"]
	"message" remoteExec ["hint", -2]; // sends a hint message to everybody but the server (also not hosted server)		"message" remoteExec ["hint", -2]; // sends a hint message to everybody but the server (also not hosted server)
Line 129:		Line 129:
	\|x5= A tricky example: executing <sqf inline>player setAmmo [primaryWeapon player, 1];</sqf> (on machines where the player is in MyGroup):		\|x5= A tricky example: executing <sqf inline>player setAmmo [primaryWeapon player, 1];</sqf> (on machines where the player is in MyGroup):
	<sqf>		<sqf>
	[player, [primaryWeapon player, 1]] remoteExec ["setAmmo", MyGroup]; // WRONG: the local player object is used here!		[player, [primaryWeapon player, 1]] remoteExec ["setAmmo", MyGroup]; // WRONG: the local player object is used here!
	[{ player setAmmo [primaryWeapon player, 1]; }] remoteExec ["call", MyGroup]; // CORRECT: the remote player object is used here		[{ player setAmmo [primaryWeapon player, 1]; }] remoteExec ["call", MyGroup]; // CORRECT: the remote player object is used here
	</sqf>		</sqf>

Line 142:		Line 142:
	["message"] remoteExec ["hint"]; // the (dedicated) server will automatically ditch hint usage due to it not having an interface		["message"] remoteExec ["hint"]; // the (dedicated) server will automatically ditch hint usage due to it not having an interface

	private _allPlayersTarget = [0, -2] select isDedicated; // caching the result for multiple usages makes it worthy - think of {{Link\|Arma 3: ~~Headless_Client~~\|headless clients}} as well		private _allPlayersTarget = [0, -2] select isDedicated; // caching the result for multiple usages makes it worthy - think of {{Link\|Arma 3: Headless Client\|headless clients}} as well
	["message 1"] remoteExec ["hint", _allPlayersTarget];		["message 1"] remoteExec ["hint", _allPlayersTarget];
	["message 2"] remoteExec ["hint", _allPlayersTarget];		["message 2"] remoteExec ["hint", _allPlayersTarget];
Line 192:		Line 192:
	params ["_networkId"];		params ["_networkId"];
	private _userInfo = getUserInfo _networkId;		private _userInfo = getUserInfo _networkId;
	if !(_userInfo select 7) exitWith {}; // not a HC		if !(_userInfo select 7) exitWith {}; // not a HC

	if (TO_ALL_PLAYERS isEqualType 0) then // number to array conversion		if (TO_ALL_PLAYERS isEqualType 0) then // number to array conversion

Sa-Matra at 08:33, 19 September 2024

2024-09-19T08:33:05Z

← Older revision		Revision as of 10:33, 19 September 2024
Line 260:		Line 260:
	</sqf>		</sqf>
	Will display a hint for every client. This is especially useful for when the server is running a mod that is not required by clients.		Will display a hint for every client. This is especially useful for when the server is running a mod that is not required by clients.
			}}

			{{Note
			\|user= Sa-Matra
			\|timestamp= 20240919083305
			\|text= It is not possible to use two negative owners to exclude two clients, you'll end up REing all clients:
			<sqf>args remoteExec ["func", [-2, -3]]; // Doesn't work, gonna execute on every client</sqf>
	}}		}}

Killzone Kid at 13:24, 14 July 2024

2024-07-14T13:24:07Z

← Older revision		Revision as of 15:24, 14 July 2024
Line 51:		Line 51:
	\|r1=		\|r1=
	* [[nil]] - In case of error.		* [[nil]] - In case of error.
	* [[String]] - In case of success.		* [[String]] - In case of success (see [[remoteExecutedJIPID]]).
	** If the '''JIP''' parameter was [[false]] or an empty string, the return value is "".		** If the '''JIP''' parameter was [[false]] or an empty string, the return value is "".
	** If the '''JIP''' parameter was [[true]] or a custom JIP ID, the JIP ID is returned.		** If the '''JIP''' parameter was [[true]] or a custom JIP ID, the JIP ID is returned.

Killzone Kid at 13:22, 14 July 2024

2024-07-14T13:22:10Z

← Older revision		Revision as of 15:22, 14 July 2024
Line 220:		Line 220:
	</sqf>		</sqf>

	\|seealso= [[Multiplayer Scripting]] [[remoteExecCall]] [[remoteExecutedOwner]] [[isRemoteExecuted]] [[isRemoteExecutedJIP]] [[Arma 3: Remote Execution]] [[canSuspend]] [[BIS_fnc_MP]]		\|seealso= [[Multiplayer Scripting]] [[remoteExecCall]] [[remoteExecutedOwner]] [[isRemoteExecuted]] [[isRemoteExecutedJIP]] [[Arma 3: Remote Execution]] [[canSuspend]] [[BIS_fnc_MP]] [[remoteExecutedJIPID]]
	}}		}}

Killzone Kid at 11:30, 14 July 2024

2024-07-14T11:30:53Z

← Older revision		Revision as of 13:30, 14 July 2024
Line 15:		Line 15:

	{{Feature\|important\|The direct execution of [[call]] or [[spawn]] via [[remoteExec]] (or [[remoteExecCall]]) should be avoided to prevent issues in cases where the remote execution of [[call]] or [[spawn]] is blocked by [[Arma 3: CfgRemoteExec\|CfgRemoteExec]]. It is instead recommended to create a function to be itself remote-executed.}}		{{Feature\|important\|The direct execution of [[call]] or [[spawn]] via [[remoteExec]] (or [[remoteExecCall]]) should be avoided to prevent issues in cases where the remote execution of [[call]] or [[spawn]] is blocked by [[Arma 3: CfgRemoteExec\|CfgRemoteExec]]. It is instead recommended to create a function to be itself remote-executed.}}

			{{Feature\|warning\|The order of persistent remote execution for JIP players is not guaranteed, i.e. the order in which multiple calls are added is not necessarily the order they will be executed for joining player.}}

	\|mp= Remote executions are queued and are therefore executed in the same order on remote clients (see {{Link\|#Example 8}}).		\|mp= Remote executions are queued and are therefore executed in the same order on remote clients (see {{Link\|#Example 8}}).

BrettMayson at 15:47, 29 March 2024

2024-03-29T15:47:46Z

← Older revision		Revision as of 17:47, 29 March 2024
Line 24:		Line 24:
	\|p2= '''order''': [[String]] - function or command name; while any function or command can be used here, only those allowed by [[Arma 3: CfgRemoteExec\|CfgRemoteExec]] will actually be executed		\|p2= '''order''': [[String]] - function or command name; while any function or command can be used here, only those allowed by [[Arma 3: CfgRemoteExec\|CfgRemoteExec]] will actually be executed

	\|p3= '''targets''' (Optional, default 0):		\|p3= '''targets''' - (Optional, default 0):
	* [[Number]] (See also [[Multiplayer Scripting#Machine network ID\|Machine network ID]]):		* [[Number]] (See also [[Multiplayer Scripting#Machine network ID\|Machine network ID]]):
	** '''0:''' the order will be executed globally, i.e. on the server and every connected client, including the machine where [[remoteExec]] originated		** '''0:''' the order will be executed globally, i.e. on the server and every connected client, including the machine where [[remoteExec]] originated
Line 36:		Line 36:
	* [[Array]] - array of any combination of the types listed above		* [[Array]] - array of any combination of the types listed above

	\|p4= '''JIP''' (Optional, default [[false]]):		\|p4= '''JIP''' - (Optional, default [[false]]):
	* [[Boolean]] - if [[true]], a unique JIP ID is generated and the [[remoteExec]] statement is added to the JIP queue from which it will be executed for every JIP		* [[Boolean]] - if [[true]], a unique JIP ID is generated and the [[remoteExec]] statement is added to the JIP queue from which it will be executed for every JIP
	* [[String]]:		* [[String]]:
Line 58:		Line 58:
	\|p21= '''functionName''': [[String]] - see the main syntax above for more details.		\|p21= '''functionName''': [[String]] - see the main syntax above for more details.

	\|p22= '''targets''' ~~(Optional, default 0)~~: [[Number]], [[Object]], [[String]], [[Side]], [[Group]] or [[Array]] - see the main syntax above for more details.		\|p22= '''targets''': [[Number]], [[Object]], [[String]], [[Side]], [[Group]] or [[Array]] - (Optional, default 0) see the main syntax above for more details.

	\|p23= '''JIP''' ~~(Optional, default [[false]])~~: [[Boolean]], [[String]], [[Object]], [[Group]] or [[netId]] - see the main syntax above for more details.		\|p23= '''JIP''': [[Boolean]], [[String]], [[Object]], [[Group]] or [[netId]] - (Optional, default [[false]]) see the main syntax above for more details.

	\|r2= [[nil]] or [[String]] - see the main syntax above for more details.		\|r2= [[nil]] or [[String]] - see the main syntax above for more details.

Lou Montana: Fix JIP object/group/netId info

2024-02-29T23:58:04Z

Fix JIP object/group/netId info

← Older revision		Revision as of 01:58, 1 March 2024
Line 42:		Line 42:
	** if the string is in format "[[Number]]:[[Number]]" (e.g. "0:0"), it is interpreted as a [[netId]] (see below)		** if the string is in format "[[Number]]:[[Number]]" (e.g. "0:0"), it is interpreted as a [[netId]] (see below)
	** else the string is treated as a custom JIP ID and the [[remoteExec]] statement is added to the JIP queue, replacing statements that have the same JIP ID		** else the string is treated as a custom JIP ID and the [[remoteExec]] statement is added to the JIP queue, replacing statements that have the same JIP ID
	* [[Object]], [[Group]] or [[netId]] - the persistent execution of the [[remoteExec]] statement is attached to the given object or group.<br>When the object / group is deleted, the [[remoteExec]] statement is automatically removed from the JIP queue		* [[Object]], [[Group]] or [[netId]] - the persistent execution of the [[remoteExec]] statement is attached to the given object or group, replacing any previous statement that has the same JIP ID.<br>When the object / group is deleted, the [[remoteExec]] statement is automatically removed from the JIP queue

	The '''JIP''' parameter can only be used if the '''targets''' parameter is 0 or a negative number.<br>		The '''JIP''' parameter can only be used if the '''targets''' parameter is 0 or a negative number.<br>

Lou Montana: Fix example

2023-12-14T23:45:40Z

Fix example

← Older revision		Revision as of 01:45, 15 December 2023
Line 162:		Line 162:
	\|x9= <!-- This example is referenced in the Syntax section. -->		\|x9= <!-- This example is referenced in the Syntax section. -->
	It is possible to create a "to all players" remote exec target variable:		It is possible to create a "to all players" remote exec target variable:
			<sqf>
			if (isServer) then
			{
			TO_ALL_PLAYERS = [0, -2] select isDedicated;
			publicVariable "TO_ALL_PLAYERS";
			};
			</sqf>
			<spoiler text="Show HC-compatible version">
			If {{Link\|Arma 3: Headless Client\|Headless Clients}} are involved:
	<sqf>		<sqf>
	if (isServer) then		if (isServer) then
Line 167:		Line 176:
	TO_ALL_PLAYERS = [0, -2] select isDedicated;		TO_ALL_PLAYERS = [0, -2] select isDedicated;

	~~// if {{Link\|Arma 3: Headless Client\|Headless Clients}} are planned~~
	private _allNegativeHCs = allPlayers apply { getPlayerID _x } select { _x != "-1" } // all valid playerIDs		private _allNegativeHCs = allPlayers apply { getPlayerID _x } select { _x != "-1" } // all valid playerIDs
	apply { getUserInfo _x } select { _x select 7 } // filter by HC		apply { getUserInfo _x } select { _x select 7 } // filter by HC
Line 176:		Line 184:
	TO_ALL_PLAYERS = [TO_ALL_PLAYERS] + _allNegativeHCs;		TO_ALL_PLAYERS = [TO_ALL_PLAYERS] + _allNegativeHCs;
	};		};
	~~// /if~~

	publicVariable "TO_ALL_PLAYERS";		publicVariable "TO_ALL_PLAYERS";

	~~// if HCs~~
	addMissionEventHandler ["OnUserConnected", {		addMissionEventHandler ["OnUserConnected", {
	params ["_networkId"];		params ["_networkId"];
Line 204:		Line 210:
	publicVariable "TO_ALL_PLAYERS";		publicVariable "TO_ALL_PLAYERS";
	}];		}];
	~~// /if~~
	};		};
	</sqf>		</sqf>
			</spoiler>
	<sqf>		<sqf>
	// client or server will always target the good machines		// client or server will always target the good machines

Lou Montana: Add example

2023-12-14T23:32:10Z

Add example

@@ Line 39: / Line 39: @@
 * [[Boolean]] - if [[true]], a unique JIP ID is generated and the [[remoteExec]] statement is added to the JIP queue from which it will be executed for every JIP
 * [[String]]:
-** ff the string is empty, it is interpreted as [[false]]
+** if the string is empty, it is interpreted as [[false]]
-** ff the string is in format "[[Number]]:[[Number]]" (e.g. "0:0"), it is interpreted as a [[netId]] (see below)
+** if the string is in format "[[Number]]:[[Number]]" (e.g. "0:0"), it is interpreted as a [[netId]] (see below)
 ** else the string is treated as a custom JIP ID and the [[remoteExec]] statement is added to the JIP queue, replacing statements that have the same JIP ID
 * [[Object]], [[Group]] or [[netId]] - the persistent execution of the [[remoteExec]] statement is attached to the given object or group.<br>When the object / group is deleted, the [[remoteExec]] statement is automatically removed from the JIP queue
@@ Line 127: / Line 127: @@
 |x5= A tricky example: executing <sqf inline>player setAmmo [primaryWeapon player, 1];</sqf> (on machines where the player is in MyGroup):
 <sqf>
-[player, [primaryWeapon player, 1]] remoteExec ["setAmmo", MyGroup];		// WRONG: the local player object is used here!
+[player, [primaryWeapon player, 1]] remoteExec ["setAmmo", MyGroup];			// WRONG: the local player object is used here!
-{ player setAmmo [primaryWeapon player, 1]; } remoteExec ["call", MyGroup];	// CORRECT: the remote player object is used here
+[{ player setAmmo [primaryWeapon player, 1]; }] remoteExec ["call", MyGroup];	// CORRECT: the remote player object is used here
 </sqf>
 |x6= '''[[Multiplayer Scripting]] "performance trick"'''<br>
-This <sqf inline>[0, -2] select isDedicated</sqf> check is worth it to avoid '''function''' server-side calculations only:
+This <sqf inline>[0, -2] select isDedicated</sqf> check is worth it to avoid '''function''' server-side calculations only. See also {{Link|#Example 9}} for an advanced solution.
 <sqf>
 ["message"] remoteExec ["BIS_fnc_infoText"];								// not ideal - the function will still run on the dedicated server for nothing
@@ Line 144: / Line 144: @@
 ["message 2"] remoteExec ["hint", _allPlayersTarget];
 </sqf>
 |x7= <!-- This example is referenced in the Description section. -->
@@ Line 157: / Line 158: @@
 // "Message 2"
 // in this exact order on clients
 </sqf>

.kju: added seeAlso

2023-12-13T16:14:54Z

added seeAlso

← Older revision		Revision as of 18:14, 13 December 2023
Line 159:		Line 159:
	</sqf>		</sqf>

	\|seealso= [[remoteExecCall]] [[remoteExecutedOwner]] [[isRemoteExecuted]] [[isRemoteExecutedJIP]] [[Arma 3: Remote Execution]] [[canSuspend]] [[BIS_fnc_MP]]		\|seealso= [[Multiplayer Scripting]] [[remoteExecCall]] [[remoteExecutedOwner]] [[isRemoteExecuted]] [[isRemoteExecutedJIP]] [[Arma 3: Remote Execution]] [[canSuspend]] [[BIS_fnc_MP]]
	}}		}}

← Older revision		Revision as of 13:30, 14 July 2024
Line 15:		Line 15:

	{{Feature\|important\|The direct execution of [[call]] or [[spawn]] via [[remoteExec]] (or [[remoteExecCall]]) should be avoided to prevent issues in cases where the remote execution of [[call]] or [[spawn]] is blocked by [[Arma 3: CfgRemoteExec\|CfgRemoteExec]]. It is instead recommended to create a function to be itself remote-executed.}}		{{Feature\|important\|The direct execution of [[call]] or [[spawn]] via [[remoteExec]] (or [[remoteExecCall]]) should be avoided to prevent issues in cases where the remote execution of [[call]] or [[spawn]] is blocked by [[Arma 3: CfgRemoteExec\|CfgRemoteExec]]. It is instead recommended to create a function to be itself remote-executed.}}

			{{Feature\|warning\|The order of persistent remote execution for JIP players is not guaranteed, i.e. the order in which multiple calls are added is not necessarily the order they will be executed for joining player.}}

	\|mp= Remote executions are queued and are therefore executed in the same order on remote clients (see {{Link\|#Example 8}}).		\|mp= Remote executions are queued and are therefore executed in the same order on remote clients (see {{Link\|#Example 8}}).