getWPPos: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2")
 
(61 intermediate revisions by 15 users not shown)
Line 1: Line 1:
back to [[Scripting_Reference#G|COMREF]]
{{RV|type=command


<h2 style="color:#000066"> '''getWPPos ''waypoint'''''</h2>
|game1= ofp
|version1= 1.21


|game2= ofpe
|version2= 1.00


'''Operand types:'''
|game3= arma1
|version3= 1.00


'''waypoint:''' [[Array]]
|game4= arma2
|version4= 1.00


'''Type of returned value:'''
|game5= arma2oa
|version5= 1.50


[[Array]]
|game6= tkoh
|version6= 1.00


'''Compatibility:'''
|game7= arma3
|version7= 0.50


Added in version '''1.21'''
|arg= global


'''Description:'''
|gr1= Waypoints


Get waypoint position.
|alias= [[waypointPosition]]


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


'''Example:'''
|s1= [[getWPPos]] [groupOrUnit, index]


_wPos = '''getWPPos''' [groupOne, 1]
|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. (i.e. if the editor labeled a WP {{hl|"0:MOVE"}} the you would have to use {{hl|getWPPos [grp,1]}} to access this particular WP)
 
|r1= [[Array]] format [[Position#Introduction|Position3D]] - the returned position equals [0,0,0] if the selected waypoint doesn't exist.
 
|x1= <sqf>
[_group1, 1] setWPPos [200,600,0];
_pos = getWPPos [_group1, 1]; // returns [200, 600, 0]
</sqf>
 
|seealso= [[setWPPos]]
}}

Latest revision as of 16:50, 8 November 2023

Logo A0.png1.21ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobal
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. (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
Retrieved from "https://community.bistudio.com/wiki?title=getWPPos&oldid=349183"