remoteExec: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 12: Line 12:
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[remoteExec]] unit|= Syntax
| [functionName] [[remoteExec]] [parms, targets, jipID]; |= Syntax


|p1= '''functionName''': [[String]] - function name. While any function can be used, only commands defined in ''[[CfgRemoteExecCommands]]'' are supported. |=
|p1= '''functionName''': [[String]] - function name. While any function can be used, only commands defined in ''[[CfgRemoteExecCommands]]'' are supported. |=
|p2= '''target''': - Optional. [default: 0]
|p2= '''params''': [[Array]] - parameters passed to the function
|p3= '''targets''': - Optional. [default: 0]
: [[Object]] - function will be executed only where unit is local [default: everyone]
: [[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.
: [[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
: [[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
: [[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
: [[Array]] - array of any of types listed above|=
|=
|p4= '''JIP_id''': [[String]] - Optional. If set, it is used as an unique identifier of this remoteExec call in the JIP queue. It is recommended to keep this as short as possible. [default: ""] |=
|p3= '''JIP_id''': [[String]] - Optional. If set, it is used as an unique identifier of this remoteExec call in the JIP queue. It is recommended to keep this as short as possible. [default: ""] |=


| [[Nothing]] |= Return value
| [[Nothing]] |= Return value
Line 36: Line 36:
// removes the message identified by "IamUnique" ID from the JIP queue.
// removes the message identified by "IamUnique" ID from the JIP queue.
// Therefore, for newly connected clients hint "hello" won't be displayed anymore </code> |= Example 5
// Therefore, for newly connected clients hint "hello" won't be displayed anymore </code> |= Example 5
|x4= <code>"setAmmo" [[remoteExec]] [[player, [currentWeapon player, 1]], 0]; // all clients will have their ammo set to 1 for their current weapon


____________________________________________________________________________________________
____________________________________________________________________________________________

Revision as of 15:24, 26 May 2015


-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.
Groups:
Uncategorised

Syntax

Syntax:
[functionName] remoteExec [parms, targets, jipID];
Parameters:
functionName: String - function name. While any function can be used, only commands defined in CfgRemoteExecCommands 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_id: String - Optional. If set, it is used as an unique identifier of this remoteExec call in the JIP queue. It is recommended to keep this as short as possible. [default: ""]
Return Value:
Nothing

Examples

Example 1:
"hint" remoteExec ["hello", 0]; // runs hint "hello" on each connected client
Example 2:
"hint" remoteExec ["hello", 3]; // runs hint "hello" on first connected client
Example 3:
"hint" remoteExec ["hello", -2]; // runs hint "hello" everywhere but server
Example 4:
"setAmmo" remoteExec [[player, [currentWeapon player, 1]], 0]; // all clients will have their ammo set to 1 for their current weapon ____________________________________________________________________________________________
Example 5:
"" remoteExec ["IamUnique"]; // removes the message identified by "IamUnique" ID from the JIP queue. // Therefore, for newly connected clients hint "hello" won't be displayed anymore

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]]