Difference between revisions of "getWPPos"

From Bohemia Interactive Community
Jump to navigation Jump to search
Line 1: Line 1:
[[Category:Scripting Commands|GETWPPOS]]
+
{{Command|= Comments
[[Category:Scripting Commands OFP 1.96|GETWPPOS]]
+
____________________________________________________________________________________________
[[Category:Scripting Commands OFP 1.46|GETWPPOS]]
+
 
[[Category:Scripting Commands ArmA|GETWPPOS]]
+
| ofp |= Game name
  
 +
|1.21|= Game version
  
<h2 style="color:#000066"> '''getWPPos ''waypoint'''''</h2>
+
|arg= global |= Arguments in MP
 +
____________________________________________________________________________________________
  
 +
| Returns the position of a selected waypoint of a given group. Waypoints include only those which were placed in the mission editor. |= Description
 +
____________________________________________________________________________________________
  
'''Operand types:'''
+
| '''getWPPos''' [group, number] |= Syntax
  
'''waypoint:''' [[Array]]
+
|p1= group: [[Group]] - the group/unit, of which you want to select a waypoint |= Parameter 1
  
'''Type of returned value:'''
+
|p2= number: [[Integer]] - 0 equals the starting position of the group, the waypoints are numbered 1, 2, ... An easy way to remember which number to take: the waypoint number in the mission editor + 1 |= Parameter 2
  
[[Array]]
+
| [[Position]] - 
 +
The returned position equals [0,0,0], if the selected waypoint doesn't exist. |= Return value
 +
____________________________________________________________________________________________
 +
 
 +
|x1= <pre>[group1,1] setWPPos [200,600,0]
  
'''Compatibility:'''
+
_pos = getWPPos [group1,1]</pre>
  
Added in version '''1.21'''
+
returns [200,600,0] |= Example 1
 +
____________________________________________________________________________________________
  
'''Description:'''
+
| [[setWPPos]] |= See also
  
Get waypoint position.<br>
+
}}
[[Array]] is in format [[Waypoint]]
 
  
 +
<h3 style="display:none">Notes</h3>
 +
<dl class="command_description">
 +
<!-- Note Section BEGIN -->
  
'''Example:'''
+
<!-- Note Section END -->
 +
</dl>
  
_wPos = '''getWPPos''' [groupOne, 1]
+
<h3 style="display:none">Bottom Section</h3>
 +
[[Category:Scripting Commands|GETWPPOS]]
 +
[[Category:Scripting Commands OFP 1.96|GETWPPOS]]
 +
[[Category:Scripting Commands OFP 1.46|GETWPPOS]]
 +
[[Category:Scripting Commands ArmA|GETWPPOS]]

Revision as of 01:23, 2 August 2006

Introduced with Operation Flashpoint version 1.211.21Arguments of this scripting command don't have to be local to the client the command is executed on
Hover & click on the images for descriptions

Description

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

Syntax

Syntax:
getWPPos [group, number]
Parameters:
group: Group - the group/unit, of which you want to select a waypoint
number: Integer - 0 equals the starting position of the group, the waypoints are numbered 1, 2, ... An easy way to remember which number to take: the waypoint number in the mission editor + 1
Return Value:
Position - 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

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

Notes

Bottom Section