getWPPos: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\[\[Category:Scripting Commands OFP 1.[4-9]{2}(\|(\{\{uc:\{\{PAGENAME\}\}\}\}|#))?\]\] " to "") |
Lou Montana (talk | contribs) m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2") |
||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{RV|type=command | {{RV|type=command | ||
| ofp | |game1= ofp | ||
|version1= 1.21 | |||
|1. | |game2= ofpe | ||
|version2= 1.00 | |||
|game3= arma1 | |||
|version3= 1.00 | |||
|game4= arma2 | |||
|version4= 1.00 | |||
|game5= arma2oa | |||
|version5= 1.50 | |||
|game6= tkoh | |||
|version6= 1.00 | |||
|game7= arma3 | |||
|version7= 0.50 | |||
|arg= global | |arg= global | ||
| Line 9: | Line 26: | ||
|gr1= Waypoints | |gr1= Waypoints | ||
| | |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. | ||
| | |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. (i.e. if the editor labeled a WP | 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) | ||
| [[Array]] | |r1= [[Array]] format [[Position#Introduction|Position3D]] - the returned position equals [0,0,0] if the selected waypoint doesn't exist. | ||
returns [200,600,0] | |x1= <sqf> | ||
[_group1, 1] setWPPos [200,600,0]; | |||
_pos = getWPPos [_group1, 1]; // returns [200, 600, 0] | |||
</sqf> | |||
|seealso= [[setWPPos]] | |seealso= [[setWPPos]] | ||
}} | }} | ||
Latest revision as of 15:50, 8 November 2023
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:
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
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.21
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Operation Flashpoint: Elite: Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: Waypoints