getWPPos: Difference between revisions

Latest revision as of 17:34, 5 December 2025

Hover & click on the images for description

Description:: Returns the position of a selected waypoint of a given group. Waypoints include only those which were placed in the mission editor.
Alias:: waypointPosition
Groups:: Waypoints

Syntax:: getWPPos [groupOrUnit, index]
Parameters:: groupOrUnit: Group or Object - the group (or unit) of which to select a waypoint
: index: Number - 0 equals the starting position of the group.
The number used in this and other waypoint commands is one more than the one displayed in the waypoint window in the editor: e.g if the editor labeled a waypoint "0:MOVE" then it can be accessed using getWPPos [grp, 1]
Return Value:: Array format Position3D - the returned position equals [0,0,0] if the selected waypoint does not exist.

Example 1:: [_group1, 1] setWPPos [200,600,0]; _pos = getWPPos [_group1, 1]; // returns [200, 600, 0]

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord.
Only post proven facts here! Add Note

@@ Line 35: / Line 35: @@
 |p2= index: [[Number]] - 0 equals the starting position of the group.<br>
-The number used in this and other waypoint commands is ''one more'' than the one displayed in the waypoint window in the editor. (i.e. if the editor labeled a WP {{hl|"0:MOVE"}} the you would have to use {{hl|getWPPos [grp,1]}} to access this particular WP)
+The number used in this and other waypoint commands is ''one more'' than the one displayed in the waypoint window in the editor: e.g if the editor labeled a waypoint {{hl|"0:MOVE"}} then it can be accessed using <sqf inline>getWPPos [grp, 1]</sqf>
-|r1= [[Array]] format [[Position#Introduction|Position3D]] - the returned position equals [0,0,0] if the selected waypoint doesn't exist.
+|r1= [[Array]] format [[Position#Introduction|Position3D]] - the returned position equals [0,0,0] if the selected waypoint does not exist.
 |x1= <sqf>