|
|
| (93 intermediate revisions by 9 users not shown) |
| Line 1: |
Line 1: |
| [[Category:Scripting_Commands_Arma_3]]
| | {{RV|type=command |
| [[Category:Arma_3:_New_Scripting_Commands_List]]
| |
| {{Command|= Comments | |
| ____________________________________________________________________________________________
| |
|
| |
|
| | arma3 |= Game name | | |game1= arma3 |
| |1.50|= Game version
| | |version1= 1.50 |
|
| |
|
| ____________________________________________________________________________________________
| | |gr1= Multiplayer |
|
| |
|
| | Asks server to execute given scripted function or script command on given target PC. The environment chosen for the execution is as follows:<br><br> | | |descr= [[Scheduler|Unscheduled]] version of [[remoteExec]]. The only difference between [[remoteExec]] and [[remoteExecCall]] is that [[remoteExecCall]] will run '''functions''' in [[Scheduler#Unscheduled Environment|unscheduled environment]]. |
| * Scripted function - ''unscheduled'' environment ([[canSuspend|suspension]] is NOT allowed).
| | {{Feature|important| |
| * Script command - ''unscheduled'' environment ([[canSuspend|suspension]] is NOT allowed). <br><br>
| | The "Call" in [[remoteExecCall]] only means that the remote execution will take place in [[Scheduler#Unscheduled Environment|unscheduled environment]] and does '''not''' mean it will happen right away (see {{Link|#Example 3}}).}} |
| [[remoteExecCall]] can also be used in SP (the same restrictions apply both to SP and MP). For more information about the usage, security features and advanced jip techniques check the [[Arma_3_Remote_Execution|remote execution]] dedicated section.<br><br> | |
|
| |
|
| {{note|
| | |s1= see [[remoteExec]] |
| While it is true that this function executes the desired scripted command/function by calling it, it does not mean [[remoteExecCall]] itself will be executed right away. Therefore, calling [[remoteExecCall]] is by no means a replacement for calling scripted commands/functions directly.<br/>
| |
| Example:<br/>
| |
| [[remoteExecCall]] ["func1"]; [[call]] func2; // func2 can be executed sooner than func1<br/>
| |
| [[call]] func1; [[call]] func2; // func2 will always execute after func1.
| |
| }}
| |
|
| |
|
| |= Description | | |p1= see [[remoteExec]] |
| ____________________________________________________________________________________________
| |
|
| |
|
| | params [[remoteExecCall]] [functionName, targets, JIP] |= Syntax | | |r1= see [[remoteExec]] |
|
| |
|
| | |x1= <sqf> |
| | ["hello"] remoteExec ["hint"]; // runs unscheduled |
| | ["hello"] remoteExecCall ["hint"]; // no difference at all |
| | </sqf> |
|
| |
|
| |p1= '''params''': [[Anything]] | | |x2= <sqf> |
| <br>Example for scripted function:
| | ["my message"] remoteExec ["BIS_fnc_infoText"]; // correct |
| <code>// <params> [[call]] fnc_someScriptedFunction; | | ["my message"] remoteExecCall ["BIS_fnc_infoText"]; // wrong - BIS_fnc_infoText needs a scheduled environment, see its spawn need |
| <params> [[remoteExecCall]] ["fnc_someScriptedFunction", targets, JIP];</code>
| | </sqf> |
| Examples for script commands of every kind:
| |
| <code>// someScriptCommand;
| |
| [] [[remoteExecCall]] ["someScriptCommand", targets, JIP];</code>
| |
| <code>// someScriptCommand <params>;
| |
| [<params>] [[remoteExecCall]] ["someScriptCommand", targets, JIP];</code>
| |
| <code>// <params1> someScriptCommand <params2>;
| |
| [<params1>, <params2>] [[remoteExecCall]] ["someScriptCommand", targets, JIP];</code>
| |
| |= Parameter 1
| |
| |p2= '''[functionName, targets, JIP]''': [[Array]]|= Parameter 2
| |
| |p3= '''functionName''': [[String]] - function or command name. <br/>
| |
| While any function can be used, only commands and functions defined in [[CfgRemoteExec]] will be executed.
| |
| |= Parameter 3
| |
| |p4= '''targets''' (Optional): [default: 0 = everyone]
| |
| * [[Number]] - Only 0 and 2 are special. When 0, the function or command will be executed globally, i.e. on the server and every connected client, including the one where [[remoteExecCall]] was originated. When 2, it will be executed only on the [[isServer|server]]. When 3, 4, 5...etc it will be executed on the client where [[clientOwner]] ID matches the given number. When number is negative, the effect is inverted. -2 means execute on every client but not the server. -12, for example, means execute on the server and every client, but not on the client where [[clientOwner]] ID is equal to 12.
| |
| * [[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: <br><tt>_myGroup [[remoteExecCall]] ["deleteGroup", [[groupOwner]] _myGroup];</tt>
| |
| * [[Array]] - array of any of types listed above.
| |
| |= Parameter 4
| |
| |p5= ''' JIP''' (Optional): [default: false]<br><br>
| |
| * [[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. (see also Example 7 on how to remove previously set function from JIP queue)<br><br>
| |
| * [[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]]: <tt>_netId = "this is my car" [[remoteExecCall]] ["hint", 0, car];</tt> or <tt>_netId = "this is my car" [[remoteExecCall]] ["hint", 0, [[netId]] car];</tt>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:<tt>[[remoteExecCall]] ["", car];</tt> or <tt>[[remoteExecCall]] ["", [[netId]] car];</tt>When JIP param is [[String]] in format "[[Number]]:[[Number]]", the string will be tested first whether or not it is the valid [[netId]] of an existing [[Object]] or [[Group]], and if not the execution will be aborted, if yes, that [[Object]] or [[Group]] will be used to set persistent execution.|= Parameter 5
| |
| |p6= Note: JIP mostly makes sense for messages doing changes local to client (not directly synchronized over the network). Otherwise, after remoteExec is executed, depending on the contents of the global JIP queue there is a chance a new message could be added to it, unnecessary increasing the number of messages sent to any newly connected client.
| |
| E.g. calling "..remoteExec ["setFuel"..]" is fine, however, calling "..remoteExec ["publicVariable",..]" is not. |= Parameter 6
| |
|
| |
|
| | [[Anything]] - Nil in case of error. [[String]] otherwise. If JIP is not requested this is an empty string, if JIP is requested, it is the JIP ID. See the topic [[Function#Return_Values|Function]] for more information. |= Return value | | |x3= <sqf> |
| | remoteExecCall ["fnc1"]; |
| | call fnc2; // fnc1 may or may not be executed after fnc2 |
|
| |
|
| _________________________________________________________________________________________________________________
| | call fnc1; |
| | | call fnc2; // fnc2 will be executed after fnc1 |
| |s2= [[remoteExecCall]] [functionName, targets, JIP] |= Syntax 2
| | </sqf> |
| | |
| |p21= '''[functionName, targets, JIP]''': [[Array]]|= Parameter 1
| |
| |p22= '''functionName''': [[String]] - function or command name. <br/>
| |
| While any function can be used, only commands and functions defined in [[CfgRemoteExec]] will be executed.
| |
| |= Parameter 2
| |
| |p23= '''targets''' (Optional): [default: 0 = everyone]
| |
| * [[Number]] - Only 0 and 2 are special. When 0, the function or command will be executed globally, i.e. on the server and every connected client, including the one where [[remoteExecCall]] was originated. When 2, it will be executed only on the [[isServer|server]]. When 3, 4, 5...etc it will be executed on the client where [[clientOwner]] ID matches the given number. When number is negative, the effect is inverted. -2 means execute on every client but not the server. -12, for example, means execute on the server and every client, but not on the client where [[clientOwner]] ID is equal to 12.
| |
| * [[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: <br><tt>_myGroup [[remoteExecCall]] ["deleteGroup", [[groupOwner]] _myGroup];</tt>
| |
| * [[Array]] - array of any of types listed above.
| |
| |= Parameter 3
| |
| |p24= ''' JIP''' (Optional): [default: false]<br><br>
| |
| * [[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. (see also Example 7 on how to remove previously set function from JIP queue)<br><br>
| |
| * [[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]]: <tt>_netId = "this is my car" [[remoteExecCall]] ["hint", 0, car];</tt> or <tt>_netId = "this is my car" [[remoteExecCall]] ["hint", 0, [[netId]] car];</tt>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:<tt>[[remoteExecCall]] ["", car];</tt> or <tt>[[remoteExecCall]] ["", [[netId]] car];</tt>When JIP param is [[String]] in format "[[Number]]:[[Number]]", the string will be tested first whether or not it is the valid [[netId]] of an existing [[Object]] or [[Group]], and if not the execution will be aborted, if yes, that [[Object]] or [[Group]] will be used to set persistent execution.|= Parameter 4
| |
| |p25= Note: JIP mostly makes sense for messages doing changes local to client (not directly synchronized over the network). Otherwise, after remoteExec is executed, depending on the contents of the global JIP queue there is a chance a new message could be added to it, unnecessary increasing the number of messages sent to any newly connected client.
| |
| E.g. calling "..remoteExec ["setFuel"..]" is fine, however, calling "..remoteExec ["publicVariable",..]" is not. |= Parameter 5
| |
| | |
| |r2= [[Anything]] - Nil in case of error. [[String]] otherwise. If JIP is not requested this is an empty string, if JIP is requested, it is the JIP ID. See the topic [[Function#Return_Values|Function]] for more information. |= Return value
| |
| ____________________________________________________________________________________________
| |
|
| |
| |x1= <code>// runs hint "hello" on each connected client
| |
| "hello" [[remoteExecCall]] ["[[hint]]"]; </code> |=
| |
| |x2= <code>// runs hint "hello" on first connected client
| |
| "hello" [[remoteExecCall]] ["[[hint]]", 3]; </code> |=
| |
| |x3= <code>// runs hint "hello" everywhere but server
| |
| "hello" [[remoteExecCall]] ["[[hint]]", -2]; </code> |=
| |
| |x4= <code>// 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]]]; </code> |=
| |
| |x5= <code>// 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"]; </code> |=
| |
| |x6= <code>// runs "someFuncWithNoArgs" on each connected client
| |
| [[remoteExecCall]] ["someFuncWithNoArgs"]; </code> |=
| |
| |x7= <code>// removes a message identified by "IamUnique" from the JIP queue
| |
| [[remoteExecCall]] ["", "IamUnique"]; </code> |=
| |
| |x8= <code>// all clients will have their ammo set to 1 for their current weapon
| |
| {[[player]] [[setAmmo]] <nowiki>[</nowiki>[[primaryWeapon]] [[player]], 1];} [[remoteExecCall]] ["[[BIS_fnc_call|bis_fnc_call]]", 0]; </code> |=
| |
| |x9= <code>// Object obj will have its ammo set to 1 where it is local
| |
| [obj,<nowiki>[</nowiki>[[primaryWeapon]] obj, 1]<nowiki>]</nowiki> [[remoteExecCall]] ["[[setAmmo]]", obj]; </code> |=
| |
| |x10= <code>myJipID = "hello" [[remoteExecCall]] ["", 0];
| |
| [[if]] ([[isNil]] "myJipID") [[then]] { [[hint]] "empty function name is not allowed"; }; </code> |=
| |
| | |
| ____________________________________________________________________________________________
| |
| | |
| | [[remoteExec]], [[isRemoteExecuted]], [[isRemoteExecutedJIP]], [[remoteExecutedOwner]], [[canSuspend]], [[BIS_fnc_MP]], [[Arma_3_Remote_Execution|Remote Execution]] |= See also
| |
|
| |
|
| | |seealso= [[remoteExec]] [[remoteExecutedOwner]] [[isRemoteExecuted]] [[isRemoteExecutedJIP]] [[Arma 3: Remote Execution]] [[canSuspend]] [[BIS_fnc_MP]] [[remoteExecutedJIPID]] |
| }} | | }} |
|
| |
|
| <!-- CONTINUE Notes -->
| |
|
| |
| <!-- DISCONTINUE Notes -->
| |
|
| |
| <!-- CONTINUE Notes -->
| |
| <dl class="command_description">
| |
| <dd class="notedate">Posted on July 16, 2015 - 09:17 (UTC)</dd>
| |
| <dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
| |
| <dd class="note">
| |
| Removal of persistent call must be in the following format <no argument> [[remoteExecCall]] [<empty string>, <JIP id>]. For example:
| |
| <code>[[remoteExecCall]] ["", "5:8"];</code>
| |
| </dd>
| |
| </dl>
| |
| <!-- DISCONTINUE Notes -->
| |
|
| |
| <!-- CONTINUE Notes -->
| |
| <dl class="command_description">
| |
| <dd class="notedate">Posted on December 29, 2015 - 20:31 (UTC)</dd>
| |
| <dt class="note">[[User:AgentRevolution|AgentRev]]</dt>
| |
| <dd class="note">
| |
| [[remoteExec]] and [[remoteExecCall]] are currently filtered by BattlEye's remoteexec.txt, the string analyzed by BE is formatted the same way as the following example's output:
| |
| <code>[[format]] ["%1 %2", functionName, [[str]] params]</code>
| |
| If [[CfgRemoteExec]] <tt>class Functions</tt> is set to <tt>mode = 1;</tt>, the following remoteexec.txt exclusion can be used to safely allow all whitelisted *_fnc_* functions taking an array as parameter to go through:
| |
| <code>!="\w+?_fnc_\w+? \[.*\]"</code>
| |
| Any attempt to exploit this exclusion using other RE methods like [[createUnit]] will run into "Error Missing ;" without any malicious code being executed. Mod makers should refrain from remote-executing raw commands from clients, as they require individual exclusions, and instead use *_fnc_* functions taking an array as parameter, which are covered by the above exclusion.
| |
| </dd>
| |
| </dl>
| |
| <!-- DISCONTINUE Notes -->
| |
|
| |
|
| <!-- CONTINUE Notes -->
| | {{GameCategory|arma3|Remote Execution}} |
| <dl class="command_description">
| |
| <dd class="notedate">Posted on May 10, 2017 - 20:13 (UTC)</dd>
| |
| <dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
| |
| <dd class="note">
| |
| To [[remoteExecCall]]:
| |
| <code>[[titleText]] ["Test Message", "PLAIN", 1];</code>
| |
| Use
| |
| <code><nowiki>[</nowiki>["Test Message", "PLAIN", 1]] [[remoteExecCall]] ["titleText"];</code>
| |
| </dd>
| |
| </dl>
| |
| <!-- DISCONTINUE Notes -->
| |
