remoteExecCall

1.50

Hover & click on the images for description

Description

Description:

Asks server to execute a command remotely by calling it. In SP, it executes the command locally (the same restrictions apply both to SP and MP). For more information about the usage, security features and advanced jip techniques check the remote execution dedicated section. Template:note

Groups:

Uncategorised

Syntax

Syntax:

params remoteExecCall [functionName, targets, JIP]

Parameters:

params (Optional): Anything - parameters passed to the function

[functionName, targets, JIP]: Array

functionName: String - function or command name.
While any function can be used, only commands and functions defined in CfgRemoteExec will be executed.

targets (Optional): [default: 0 = 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 remoteExecCall was called from. When 2, it will be executed by server only. When negative ids are supplied, PCs with matching ids will be excluded from the list.

Object - function will be executed only where unit is local.

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 (Optional): String or Boolean - If true, function generates a unique ID for the message and the message itself is added to the JIP queue and executed for every JIP. If a non-empty string is given, it is treated a custom ID of the message and the message itself is added to the JIP queue overriding any remoteExecCall message with the same ID. Otherwise, no ID is generated and no message is placed into the JIP queue. [default: false]

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" remoteExecCall ["hint"];

Example 2:

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

Example 3:

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

Example 4:

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

Example 5:

// 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" remoteExecCall ["hint", -2, "some_JIP_ID"];

Example 6:

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

Example 7:

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

Example 8:

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

Example 9:

// Object obj will have its ammo set to 1 where it is local [obj,[primaryWeapon obj, 1]] remoteExecCall ["setAmmo", obj];

Example 10:

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

Additional Information

See also:

remoteExecBIS_fnc_MP Remote Execution

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

Posted on July 16, 2015 - 09:17 (UTC)

Killzone Kid

Removal of persistent call must be in the following format <no argument> remoteExecCall [<empty string>, <JIP id>]. For example: remoteExecCall ["", "5:8"];