getWPPos: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (+ Category, wiki links)
m (clarification of index)
Line 16: Line 16:
|p1= group: [[Group]] - the group/unit, of which you want to select a waypoint |= Parameter 1
|p1= group: [[Group]] - the group/unit, of which you want to select a waypoint |= Parameter 1


|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
|p2= number: [[Integer]] - 0 equals the starting position of the group.<br>
The number used in this and other waypoint commands is one less than the one displayed in the waypoint window in the editor. (i.e. if the editor labeled a WP <tt>"2:MOVE"</tt> the you would have to use <tt>getWPPos [grp,1]</tt> to access this particular WP|= Parameter 2


| [[Array]] (format [[Position]]) -   
| [[Array]] (format [[Position]]) -   

Revision as of 07:28, 5 April 2007

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:
Uncategorised

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 number used in this and other waypoint commands is one less than the one displayed in the waypoint window in the editor. (i.e. if the editor labeled a WP "2:MOVE" the you would have to use getWPPos [grp,1] to access this particular WP
Return Value:
Array (format 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

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

Notes

Bottom Section