remoteExecCall: Difference between revisions
Jump to navigation
Jump to search
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
mNo edit summary |
No edit summary |
||
| Line 12: | Line 12: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[remoteExecCall]] | | [functionName] [[remoteExecCall]] [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= '''target''': - 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. | ||
| Line 22: | Line 23: | ||
: [[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: ""] |= | ||
| [[Nothing]] |= Return value | | [[Nothing]] |= Return value | ||
| Line 33: | Line 34: | ||
// runs hint "hello" everywhere but server and puts the message into the JIP queue. | // runs hint "hello" everywhere but server and puts the message into the JIP queue. | ||
// Everytime new players connect, "hello" message will be displayed for them </code> |= Example 4 | // Everytime new players connect, "hello" message will be displayed for them </code> |= Example 4 | ||
|x5= <code>"" [[ | |x5= <code>"" [[remoteExec]] ["IamUnique"]; | ||
// 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 | ||
|x6= <code>"setAmmo" [[remoteExec]] [[player, [currentWeapon player, 1]], 0]; | |||
// all clients will have their ammo set to 1 for their current weapon </code> |= Example 6 | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[ | | [[remoteExec]] [[BIS_fnc_MP]] |= See also | ||
}} | }} | ||
Revision as of 15:30, 26 May 2015
Description
- Description:
- Asks server to execute a command remotely by calling it.
- Groups:
- Uncategorised
Syntax
- Syntax:
- [functionName] remoteExecCall [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
- target: - 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
Examples
- Example 1:
"hint" remoteExecCall ["hello", 0]; // runs hint "hello" on each connected client- Example 2:
"hint" remoteExecCall ["hello", 3]; // runs hint "hello" on first connected client- Example 3:
"hint" remoteExecCall ["hello", -2]; // runs hint "hello" everywhere but server- Example 4:
"hint" remoteExecCall ["hello", -2, "IamUnique"]; // runs hint "hello" everywhere but server and puts the message into the JIP queue. // Everytime new players connect, "hello" message will be displayed for them- 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- Example 6:
"setAmmo" remoteExec [[player, [currentWeapon player, 1]], 0]; // all clients will have their ammo set to 1 for their current weapon
Additional Information
- See also:
- remoteExec 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 | REMOTEEXECCALL]][[ Category: arma3dev: Scripting Commands | REMOTEEXECCALL]]