remoteExec: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "Category:Scripting_Commands_Arma_3 Category:Arma_3:_New_Scripting_Commands_List {{Command|= Comments __________________________________________________________________...")
 
No edit summary
Line 4: Line 4:
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| arma3dev |= Game name
 
|1.46|= Game version
|1.46|= Game version


Line 15: Line 14:
| [[remoteExec]] unit|= Syntax
| [[remoteExec]] unit|= Syntax


|p1= funcName: [[String]] |= Parameter 1
|p1= '''functionName''': [[String]] - function name. While any function can be used, only commands defined in ''[[CfgRemoteExecCommands]]'' are supported. |=
|p2= [params,targets,id]: [[Array]] |= Parameter 2
|p2= '''target''': - Optional. [default: 0]
|p3= params: [[Array]] - a list of parameters passed to function funcName |= Parameter 3
: [[Object]] - function will be executed only where unit is local [default: everyone]
|p4= targets: [[Number]], [[String]], [[Side]], [[Object]], [[Group]] or an [[Array]] of any of them |= Parameter 4
: [[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.
|p5= - Number: function will be executed only on client with the given ID. When negative, it will be executed everywhere except on client with the ID. ID stands for ID returned by [[owner]] |= Parameter 5
: [[Side]] - the function will be executed only on clients where the player is on the specified side
|p6= - String: the function will be executed only where unit defined by the variable is local |= Parameter 6
: [[Group]] - the function will be executed only on clients where the player is in the specified group
|p7= - Object: the function will be executed only where unit is local |= Parameter 7
: [[Array]] - array of any of types listed above
|p8= - Group: the function will be executed only on players who are members of the group|= Parameter 8
|=
|p9= - Side: the function will be executed on all players of the given side |= Parameter 9
|p3= '''JIP_id''': [[String]] - Optional. If set, it is used as an unique identifier of this remoteExec call in the JIP queue. [default: ""] |=


| [[Nothing]] |= Return value
| [[Nothing]] |= Return value
Line 31: Line 30:
|x2= <code>"hint" [[remoteExec]] ["hello", 3]; // runs hint "hello" on first connected client </code> |= Example 2
|x2= <code>"hint" [[remoteExec]] ["hello", 3]; // runs hint "hello" on first connected client </code> |= Example 2
|x3= <code>"hint" [[remoteExec]] ["hello", -2]; // runs hint "hello" everywhere but server </code> |= Example 3
|x3= <code>"hint" [[remoteExec]] ["hello", -2]; // runs hint "hello" everywhere but server </code> |= Example 3
|x4= <code>"hint" [[remoteExec]] ["hello", -2, "IamUnique"];
// runs hint "hello" everywhere but server and puts the message into the JIP queue.
// Everytime new players connects, "hello" message will be displayed for them </code> |= Example 4


____________________________________________________________________________________________
____________________________________________________________________________________________

Revision as of 09:58, 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:
remoteExec unit
Parameters:
functionName: String - function name. While any function can be used, only commands defined in CfgRemoteExecCommands are supported.
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
JIP_id: String - Optional. If set, it is used as an unique identifier of this remoteExec call in the JIP queue. [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:
"hint" remoteExec ["hello", -2, "IamUnique"]; // runs hint "hello" everywhere but server and puts the message into the JIP queue. // Everytime new players connects, "hello" message will be displayed for them

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


Retrieved from "https://community.bistudio.com/wiki?title=remoteExec&oldid=89555"