remoteExecCall
Jump to navigation
Jump to search
Description
- Description:
- Asks server to execute given scripted function or script command. The environment chosen for the execution is as follows:
- Scripted function - unscheduled environment (suspension is NOT allowed).
- Script command - unscheduled environment (suspension is NOT allowed).
Template:note - Groups:
- Uncategorised
Syntax
- Syntax:
- params remoteExecCall [functionName, targets, JIP]
- Parameters:
- params: Anything
Example for scripted function:// <params> call fnc_someScriptedFunction; <params> remoteExecCall ["fnc_someScriptedFunction", targets, JIP];
Example for script command:// someScriptCommand <params>; <params> remoteExecCall ["someScriptCommand", targets, JIP];
// <params1> someScriptCommand <params2>; [<params1>, <params2>] remoteExecCall ["someScriptCommand", targets, JIP];
- [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 only by server. When negative, it will be executed everywhere except for machines with the given client ID. Use -2 to target everyone except the server.
- Object - the function will be executed only where unit is local
- String - the function will be executed only where object or group defined by the variable with passed name 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. In order to execute the function where group is local pass owner of the group as param:
_myGroup remoteExecCall ["deleteGroup", groupOwner _myGroup]; - Array - array of any of types listed above.
- 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] (see also Example 7 on how to remove previously set function from JIP queue)
- Object or Group or netId - The persistent execution of the given remoteExecCall statement will be attached to the given Object or Group, passed directly by reference or by their netId: _netId = "this is my car" remoteExecCall ["hint", 0, car]; or _netId = "this is my car" remoteExecCall ["hint", 0, netId car];Upon success, the command will return netId of the used Object or Group or netId. When Object or Group is deleted and becomes objNull or grpNull, the persistent remoteExecCall statement is automatically removed from JIP queue. Manual removal of the JIP statement could be done by passing either Object, Group or netId as usual:remoteExecCall ["", car]; or remoteExecCall ["", netId car];When JIP param is String in format "Number:Number", it will be tested first whether or not this is the valid netId of an existing Object or Group, and if not it will be used just like normal JIP String, if yes, it will be linked to the Object or Group. In order to avoid some unexpected behaviour, it is recommended that you do not use "Number:Number" JIP format for non Object or Group related persistent calls
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"];
- Posted on December 29, 2015 - 20:31 (UTC)
- AgentRev
-
remoteExec and remoteExecCall are currently filtered by BattlEye's remoteexec.txt, the string passed to BattlEye is formatted the same way as the following example's output:
format ["%1 %2", functionName, str params]