remoteExecCall: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
[[Category:Scripting_Commands_Arma_3]]
[[Category:Scripting_Commands_Arma_3]]
[[Category:Arma_3:_New_Scripting_Commands_List]]
[[Category:Arma_3:_New_Scripting_Commands_List]]
[[Category:Broken Scripting Commands|{{uc:{{PAGENAME}}}}]]
{{Command|= Comments
{{Command|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 9: Line 10:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Asks server to execute a command remotely by [[call]]ing it. |= Description
| Asks server to execute a command remotely by [[call]]ing it.
{{warning|This command is currently broken and its behaviour in MP is undefined. Use [[addMagazine]] <array> for now, it takes global argument and has global effect too.}}  |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 19:30, 29 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 calling it.
This command is currently broken and its behaviour in MP is undefined. Use addMagazine <array> for now, it takes global argument and has global effect too.
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 name or command name. While any function can be used, only commands defined in CfgRemoteExecCommands are supported.
target (Optional): [default: 0]
Number - the function will be executed only on client with the given dpnid (owner ID). When 0, the function will be executed on each client including the one where remoteExecCall was originated 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]
Return Value:
String or Nothing - In case of error nil is returned, otherwise String. 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:
"hello" remoteExecCall ["hint"]; // runs hint "hello" on each connected client
Example 2:
"hello" remoteExecCall ["hint", 0]; // runs hint "hello" on each connected client
Example 3:
"hello" remoteExecCall ["hint", 3]; // runs hint "hello" on first connected client
Example 4:
"hello" remoteExecCall ["hint", -2]; // runs hint "hello" everywhere but server
Example 5:
myJipID = "hello" remoteExecCall ["hint", -2, "IamUnique"]; // runs hint "hello" everywhere but server, JIPs the message and return e.g. "3_1" as a unique JIP id
Example 6:
remoteExecCall ["someFuncWithNoArgs"]; // runs "someFuncWithNoArgs" on each connected client
Example 7:
remoteExecCall ["", "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 8:
{player setAmmo [primaryWeapon player, 1];} remoteExecCall ["bis_fnc_call", 0]; // all clients will have their ammo set to 1 for their current weapon
Example 9:
myJipID = "hello" remoteExecCall ["", 0]; if (isNil "myJipID") then { hint "empty function name is not allowed"; };

Additional Information

See also:
remoteExecBIS_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]]