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: @@
-{{Command|Comments=
+{{RV|type=command
-____________________________________________________________________________________________
-| ofp |Game name=
+|game1= ofp
+|version1= 1.21
-|1.21|Game version=
+|game2= ofpe
+|version2= 1.00
-|arg= global |Multiplayer Arguments=
+|game3= arma1
-____________________________________________________________________________________________
+|version3= 1.00
-| Returns the position of a selected waypoint of a given group. Waypoints include only those which were placed in the mission editor. |DESCRIPTION=
+|game4= arma2
-____________________________________________________________________________________________
+|version4= 1.00
-| [[Array]] <nowiki>=</nowiki> '''getWPPos''' [group, index] |SYNTAX=
+|game5= arma2oa
+|version5= 1.50
-|p1= [group, index]: [[Array]] |PARAMETER1=
+|game6= tkoh
+|version6= 1.00
-|p2= group: [[Group]] - the group/unit, of which you want to select a waypoint |PARAMETER2=
+|game7= arma3
+|version7= 0.50
-|p3= index: [[Number]] - 0 equals the starting position of the group.<br>
+|arg= global
-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 <tt>"0:MOVE"</tt> the you would have to use <tt>getWPPos [grp,1]</tt> to access this particular WP)|PARAMETER3=
-| [[Array]] - format [[Position3D]].
+|gr1= Waypoints
-The returned position equals [0,0,0], if the selected waypoint doesn't exist. |RETURNVALUE=
-____________________________________________________________________________________________
-|x1= <code>[_group1,1] [[setWPPos]] [200,600,0];<br />_pos <nowiki>=</nowiki> [[getWPPos]] [_group1,1];</code>
-returns [200,600,0] |EXAMPLE1=
+|alias= [[waypointPosition]]
-____________________________________________________________________________________________
-| [[setWPPos]] |SEEALSO=
+|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]] [groupOrUnit, index]
+|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: e.g if the editor labeled a waypoint {{hl|"0:MOVE"}} then it can be accessed using <sqf inline>getWPPos [grp, 1]</sqf>
-<h3 style="display:none">Notes</h3>
+|r1= [[Position#Introduction|Position3D]] - the returned position equals [0,0,0] if the selected waypoint does not exist.
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|x1= <sqf>
-</dl>
+[_group1, 1] setWPPos [200,600,0];
+_pos = getWPPos [_group1, 1]; // returns [200, 600, 0]
+</sqf>
-<h3 style="display:none">Bottom Section</h3>
+|seealso= [[setWPPos]]
-[[Category:Scripting Commands|GETWPPOS]]
+}}
-[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands OFP 1.96|GETWPPOS]]
-[[Category:Scripting Commands OFP 1.46|GETWPPOS]]
-[[Category:Scripting Commands ArmA|GETWPPOS]]
-[[Category:Command_Group:_Waypoints|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]