getWPPos: Difference between revisions

Latest revision as of 15:50, 8 November 2023

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. (i.e. if the editor labeled a WP "0:MOVE" the you would have to use getWPPos [grp,1] to access this particular WP)
Return Value:: Array format Position3D - the returned position equals [0,0,0] if the selected waypoint doesn't 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 or on the Forums.
Only post proven facts here! Add Note

@@ Line 25: / Line 25: @@
 |gr1= Waypoints
+|alias= [[waypointPosition]]
 |descr= Returns the position of a selected waypoint of a given group. Waypoints include only those which were placed in the mission editor.
-|s1= [[getWPPos]] [group, index]
+|s1= [[getWPPos]] [groupOrUnit, index]
-|p1= group: [[Group]] - the group/unit, of which you want to select a waypoint
+|p1= groupOrUnit: [[Group]] or [[Object]] - the group (or unit) of which to select a waypoint
 |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)
-|r1= [[Array]] - format [[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 doesn't exist.
-|x1= <code>[_group1,1] [[setWPPos]] [200,600,0];
-_pos = [[getWPPos]] [_group1,1];</code>
-returns [200,600,0]
+|x1= <sqf>
+[_group1, 1] setWPPos [200,600,0];
+_pos = getWPPos [_group1, 1]; // returns [200, 600, 0]
+</sqf>
 |seealso= [[setWPPos]]
 }}