Difference between revisions of "getWPPos"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Category:Scripting Commands ArmA|" to "[[Category:Scripting Commands Armed Assault|")
m (Some wiki formatting)
 
(21 intermediate revisions by 3 users not shown)
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=
+
|descr= Returns the position of a selected waypoint of a given group. Waypoints include only those which were placed in the mission editor.
____________________________________________________________________________________________
 
  
| [[setWPPos]] |SEEALSO=
+
|s1= [[getWPPos]] [group, index]
  
}}
+
|p1= group: [[Group]] - the group/unit, of which you want 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 <tt>"0:MOVE"</tt> the you would have to use <tt>getWPPos [grp,1]</tt> to access this particular WP)
 +
 
 +
|r1= [[Array]] - format [[Position3D]]. The returned position equals [0,0,0] if the selected waypoint doesn't exist.
  
<h3 style="display:none">Notes</h3>
+
|x1= <code>[_group1,1] [[setWPPos]] [200,600,0];
<dl class="command_description">
+
_pos = [[getWPPos]] [_group1,1];</code>
<!-- Note Section BEGIN -->
 
  
<!-- Note Section END -->
+
returns [200,600,0]
</dl>
 
  
<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 Armed Assault|GETWPPOS]]
 
[[Category:Command_Group:_Waypoints|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
 

Latest revision as of 05:06, 13 June 2021

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.
Groups:
Waypoints

Syntax

Syntax:
getWPPos [group, index]
Parameters:
group: Group - the group/unit, of which you want 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.

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 or on the Forums.
Only post proven facts here! Add Note