|
|
| (122 intermediate revisions by 10 users not shown) |
| Line 1: |
Line 1: |
| [[Category:Scripting_Commands_Arma_3]]
| | {{RV|type=command |
| [[Category:Arma_3:_New_Scripting_Commands_List]]
| |
| [[Category:Broken Scripting Commands|{{uc:{{PAGENAME}}}}]]
| |
| {{Command|= Comments | |
| ____________________________________________________________________________________________
| |
|
| |
|
| | arma3 |= Game name | | |game1= arma3 |
| |1.50|= Game version
| | |version1= 1.50 |
|
| |
|
| ____________________________________________________________________________________________
| | |gr1= Multiplayer |
|
| |
|
| | Asks server to execute a command remotely by [[call]]ing it. In SP, it executes the command locally (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. | | |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]]. |
| | {{Feature|important| |
| | 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}}).}} |
|
| |
|
| {{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
| |
| ____________________________________________________________________________________________
| |
|
| |
|
| | params [[remoteExecCall]] [functionName, targets, JIP] |= Syntax | | |p1= see [[remoteExec]] |
|
| |
|
| | |r1= see [[remoteExec]] |
|
| |
|
| |p1= '''params''': [[Anything]] | | |x1= <sqf> |
| :for [[function]]: optional parameters passed to the function
| | ["hello"] remoteExec ["hint"]; // runs unscheduled |
| :for command:<code>command params;</code><code>params '''remoteExecCall''' ["command", targets, jip];</code>or<code>params1 command params2;</code><code>[params1, params2] '''remoteExecCall''' ["command", targets, jip];</code>
| | ["hello"] remoteExecCall ["hint"]; // no difference at all |
| |=
| | </sqf> |
| |p2= '''[functionName, targets, JIP]''': [[Array]]|=
| |
| |p3= '''functionName''': [[String]] - function or command name. <br/>
| |
| While any function can be used, only commands and functions defined in [[CfgRemoteExec]] will be executed.
| |
| |=
| |
| |p4= '''targets''' (Optional): [default: 0 = 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 [[remoteExecCall]] was called 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.
| |
| |=
| |
| |p5= ''' 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] (see also Example 7 on how to remove previously set function from JIP queue)|=
| |
| |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. |=
| |
|
| |
|
| | [[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
| | |x2= <sqf> |
| ____________________________________________________________________________________________
| | ["my message"] remoteExec ["BIS_fnc_infoText"]; // correct |
|
| | ["my message"] remoteExecCall ["BIS_fnc_infoText"]; // wrong - BIS_fnc_infoText needs a scheduled environment, see its spawn need |
| |x1= <code>// runs hint "hello" on each connected client
| | </sqf> |
| "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> |=
| |
|
| |
|
| ____________________________________________________________________________________________
| | |x3= <sqf> |
| | remoteExecCall ["fnc1"]; |
| | call fnc2; // fnc1 may or may not be executed after fnc2 |
|
| |
|
| | [[remoteExec]], [[BIS_fnc_MP]] [[Arma_3_Remote_Execution|Remote Execution]] |= See also
| | call fnc1; |
| | call fnc2; // fnc2 will be executed after fnc1 |
| | </sqf> |
|
| |
|
| | |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 -->
| | {{GameCategory|arma3|Remote Execution}} |
| <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 passed to BattlEye is formatted the same way as the following example's output:
| |
| <code>[[format]] ["%1 %2", functionName, [[str]] params]</code>
| |
| </dd>
| |
| </dl>
| |
| <!-- DISCONTINUE Notes -->
| |
