setWaypointStatements: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game version" to "|Game version=")
m (Minor fixes)
Line 5: Line 5:


|1.00|Game version=
|1.00|Game version=
<!--
|arg= global |MPArguments=
|eff= global |MPEffects=
-->
____________________________________________________________________________________________
____________________________________________________________________________________________


| The waypoint is done only when the condition is fulfilled. When the waypoint is done, the statement expression is executed.
| The waypoint is done only when the condition is fulfilled. When the waypoint is done, the statement expression is executed.<br>
<br>
<br>
Within the Condition & Statement code string:
Within the Condition & Statement code string:
* [[this]] refers to the group leader
* [[Magic Variables#this_2|this]] refers to the group leader
* [[this#thisList|thisList]] refers to an array containing each unit in the group |DESCRIPTION=
* [[Magic Variables#thisList|thisList]] refers to the group's units |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| waypoint '''setWaypointStatements''' [condition, statement] |SYNTAX=
| waypoint [[setWaypointStatements]] [condition, statement] |SYNTAX=


|p1= waypoint: [[Array]] - format [[Waypoint]] |PARAMETER1=
|p1= waypoint: [[Array]] - format [[Waypoint]] |PARAMETER1=
|p2= [condition, statement]: [[Array]] |PARAMETER2=
|p2= [condition, statement]: [[Array]] |PARAMETER2=
|p3= condition: [[String]] |PARAMETER3=
|p3= condition: [[String]] |PARAMETER3=
|p4= statement: [[String]] |PARAMETER4=
|p4= statement: [[String]] |PARAMETER4=


Line 25: Line 32:
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>new_wp [[setWaypointStatements]] ["[[true]]", "[[hint]] 'hello'; [[hint]] 'goodbye<nowiki>'</nowiki>"];</code> |EXAMPLE1=
|x1= <code>_waypoint [[setWaypointStatements]] ["[[true]]", "[[hint]] 'hello'; [[hint]] 'goodbye'"];</code> |EXAMPLE1=


|x2= <code>new_wp [[setWaypointStatements]] ["[[true]]", "[[diag_log]] ['GroupLeader: ', [[this]]<nowiki>]</nowiki>; [[diag_log]] ['Units: ', [[this#thislist|thislist]]<nowiki>]</nowiki>"];</code> |EXAMPLE2=
|x2= <code>_waypoint [[setWaypointStatements]] ["[[true]]", "[[diag_log]] ['GroupLeader: ', [[this]]]; [[diag_log]] ['Units: ', [[Magic Variables#thisList|thislist]]]"];</code> |EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[waypoints]], [[deleteWaypoint]], [[copyWaypoints]], [[setCurrentWaypoint]], [[setWaypointBehaviour]], [[setWaypointCombatMode]], [[setWaypointCompletionRadius]], [[setWaypointDescription]], [[setWaypointFormation]], [[setWaypointHousePosition]], [[setWaypointPosition]], [[setWaypointScript]], [[setWaypointSpeed]], [[setWaypointTimeout]], [[setWaypointType]], [[setWaypointVisible]], [[waypointAttachVehicle]], [[waypointAttachedVehicle]], [[setWaypointLoiterRadius]], [[waypointLoiterRadius]], [[addWaypoint]], [[setWaypointLoiterType]], [[waypointSpeed]] |SEEALSO=
| [[:Category:Command Group: Waypoints|Waypoints commands]] |SEEALSO=
 
}}
}}


Line 42: Line 48:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|SETWAYPOINTSTATEMENTS]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP Elite |SETWAYPOINTSTATEMENTS]]
[[Category:Scripting Commands OFP Elite |{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|SETWAYPOINTSTATEMENTS]]
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Waypoints|SETWAYPOINTSTATEMENTS]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Waypoints|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
<!-- CONTINUE Notes -->
Line 56: Line 62:
<dd class="note">
<dd class="note">
Within the completion statement [[currentWaypoint]] will give the index of the waypoint being completed (as opposed to the following one).<br><br>
Within the completion statement [[currentWaypoint]] will give the index of the waypoint being completed (as opposed to the following one).<br><br>
This is particularly useful if you need a self deleting waypoint:<code>[[setWaypointStatements]] ["[[true]]","[[deleteWaypoint]] <nowiki>[</nowiki>[[group]] this, [[currentWaypoint]] ([[group]] this)]"]</code>
This is particularly useful if you need a self deleting waypoint:<code>_waypoint [[setWaypointStatements]] ["[[true]]","[[deleteWaypoint]] [<nowiki/>[[group]] this, [[currentWaypoint]] ([[group]] this)]"]</code>
</dd>
</dd>
</dl>
<!-- DISCONTINUE Notes -->


<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on May 9, 2017 - 16:35 (UTC)</dd>
<dd class="notedate">Posted on May 9, 2017 - 16:35 (UTC)</dd>
<dt class="note">[[User:RHfront|RHfront]]</dt>
<dt class="note">[[User:RHfront|RHfront]]</dt>
<dd class="note">
<dd class="note">
The condition block carries the same rules as functions which return a value. The return value must be of type Boolean. I can bypass the use of triggers in this manner. <br>
The condition block carries the same rules as functions which return a value.
<code>_wp setWaypointStatements [" ''code code code;'' '''_returnBool'''", "''onActivation block;''"];</code>
The return value must be a [[Boolean]].
One can bypass the use of triggers in this manner:
<code>_waypoint [[setWaypointStatements]] [" ''code code code;'' '''_returnBool'''", "''onActivation block;''"];</code>
</dd>
</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->
<!-- DISCONTINUE Notes -->

Revision as of 23:43, 13 September 2019

-wrong parameter ("Arma") defined!-1.00
Hover & click on the images for description

Description

Description:
The waypoint is done only when the condition is fulfilled. When the waypoint is done, the statement expression is executed.
Within the Condition & Statement code string:
  • this refers to the group leader
  • thisList refers to the group's units
Groups:
Uncategorised

Syntax

Syntax:
waypoint setWaypointStatements [condition, statement]
Parameters:
waypoint: Array - format Waypoint
[condition, statement]: Array
condition: String
statement: String
Return Value:
Nothing

Examples

Example 1:
_waypoint setWaypointStatements ["true", "hint 'hello'; hint 'goodbye'"];
Example 2:
_waypoint setWaypointStatements ["true", "diag_log ['GroupLeader: ', this]; diag_log ['Units: ', thislist]"];

Additional Information

See also:
Waypoints commands

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

Notes

Bottom Section

Posted on May 21, 2016 - 16:19 (UTC)
SilentSpike
Within the completion statement currentWaypoint will give the index of the waypoint being completed (as opposed to the following one).

This is particularly useful if you need a self deleting waypoint:_waypoint setWaypointStatements ["true","deleteWaypoint [group this, currentWaypoint (group this)]"]
Posted on May 9, 2017 - 16:35 (UTC)
RHfront
The condition block carries the same rules as functions which return a value. The return value must be a Boolean. One can bypass the use of triggers in this manner: _waypoint setWaypointStatements [" code code code; _returnBool", "onActivation block;"];