getWPPos: Difference between revisions

Latest revision as of 07:55, 2 January 2026

1.21

1.00

Hover & click on the images for description

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

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:: Position3D - the returned position equals [0,0,0] if the selected waypoint does not exist.

Examples

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

Additional Information

See also:: setWPPos

Notes

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

@@ Line 1: / Line 1: @@
-[[Category:Scripting Commands]]
+{{RV|type=command
-[[Category:Scripting Commands OFP 1.97]]
-[[Category:Scripting Commands OFP 1.46]]
-[[Category:Scripting Commands ArmA]]
-back to [[Scripting_Reference#G|COMREF]]
+|game1= ofp
+|version1= 1.21
-<h2 style="color:#000066"> '''getWPPos ''waypoint'''''</h2>
+|game2= ofpe
+|version2= 1.00
+|game3= arma1
+|version3= 1.00
-'''Operand types:'''
+|game4= arma2
+|version4= 1.00
-'''waypoint:''' [[Array]]
+|game5= arma2oa
+|version5= 1.50
-'''Type of returned value:'''
+|game6= tkoh
+|version6= 1.00
-[[Array]]
+|game7= arma3
+|version7= 0.50
-'''Compatibility:'''
+|arg= global
-Added in version '''1.21'''
+|gr1= Waypoints
-'''Description:'''
+|alias= [[waypointPosition]]
-Get waypoint position.<br>
+|descr= Returns the position of a selected waypoint of a given group. Waypoints include only those which were placed in the mission editor.
-[[Array]] is in format [[Waypoint]]
+|s1= [[getWPPos]] [groupOrUnit, index]
-'''Example:'''
+|p1= groupOrUnit: [[Group]] or [[Object]] - the group (or unit) of which to select a waypoint
-_wPos = '''getWPPos''' [groupOne, 1]
+|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: e.g if the editor labeled a waypoint {{hl|"0:MOVE"}} then it can be accessed using <sqf inline>getWPPos [grp, 1]</sqf>
+|r1= [[Position#Introduction|Position3D]] - the returned position equals [0,0,0] if the selected waypoint does not exist.
+|x1= <sqf>
+[_group1, 1] setWPPos [200,600,0];
+_pos = getWPPos [_group1, 1]; // returns [200, 600, 0]
+</sqf>
+|seealso= [[setWPPos]]
+}}