remoteExec

-wrong parameter ("arma3dev") defined!-[[:Category:Introduced with arma3dev version 1.46|1.46]]

Hover & click on the images for description

Description

Description:

Asks server to execute a command remotely by spawning it.

⚠

Doesn't execute function on dedicated server

Groups:

Uncategorised

Syntax

Syntax:

[params] remoteExec [functionName, targets, jip];

Parameters:

functionName: String - function name. While any function can be used, only commands defined in CfgRemoteExecCommands and functions defined in CfgRemoteExecFunctions are supported.

params: Array - parameters passed to the function

targets: - Optional. [default: 0]

Object - function will be executed only where unit is local [default: everyone]

Number - the function will be executed only on client with the given owner ID. When 0, the function will be executed on each client including the one where remoteExec was called from. When 2, it will be executed only by server. When negative, it will be executed everywhere except for machines with with the given client ID.

Side - the function will be executed only on clients where the player is on the specified side

Group - the function will be executed only on clients where the player is in the specified group

Array - array of any of types listed above

JIP: String or Boolean - Optional [default: false]. If true, function generates an unique ID for the message and the message itself is added to the JIP queue. If a non-empty string, it is a custom ID of the message and the message iteself is added to the JIP queue overriding any remoteExec message with the same ID. Otherwise, no ID is generated and no message is placed into the JIP queue.

Note: JIP mostly makes sense for messages doing changes local to client (not directly synchronized over the network). Otherwise, after remoteExec is executed, depending on the contents of the global JIP queue there is a chance a new message could be added to it, unnecessary increasing the number of messages sent to any newly connected client. E.g. calling "..remoteExec ["setFuel"..]" is fine, however, calling "..remoteExec ["publicVariable",..]" is not.

Return Value:

Anything - Nil in case of error. String otherwise. If JIP is not requested this is an empty string. Otherwise this is an unique JIP ID. See the topic Function for more information.

Examples

Example 1:

// runs hint "hello" on each connected client "hello" remoteExec ["hint"];

Example 2:

// runs hint "hello" on each connected client "hello" remoteExec ["hint", 0];

Example 3:

// runs hint "hello" on first connected client "hello" remoteExec ["hint", 3];

Example 4:

// runs hint "hello" everywhere but server "hello" remoteExec ["hint", -2];

Example 5:

// runs hint "hello" everywhere but server, JIPs the message // and returns e.g. "3_1" as a unique JIP id myJipID = "hello" remoteExec ["hint", -2, true];

Example 6:

// runs hint "hello" everywhere but server, JIPs the message under ID "some_JIP_ID" // replacing any previous message with this ID in the JIP queue. "hello" remoteExec ["hint", -2, "some_JIP_ID"];

Example 7:

// runs "someFuncWithNoArgs" on each connected client remoteExec ["someFuncWithNoArgs"];

Example 8:

// removes a message identified by "IamUnique" from the JIP queue remoteExec ["", "IamUnique"];

Example 9:

// all clients will have their ammo set to 1 for their current weapon {player setAmmo [primaryWeapon player, 1];} remoteExec ["bis_fnc_call", 0];

Example 10:

myJipID = "hello" remoteExec ["", 0]; if (isNil "myJipID") then { hint "empty function name is not allowed"; };

Additional Information

See also:

remoteExecCall BIS_fnc_MP

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

[[Category:Introduced with arma3dev version 1.46]][[ Category: arma3dev: New Scripting Commands | REMOTEEXEC]][[ Category: arma3dev: Scripting Commands | REMOTEEXEC]]