getWPPos: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2")
 
(25 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


|gr1= Waypoints |=GROUP1
|game4= arma2
____________________________________________________________________________________________
|version4= 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=
|game5= arma2oa
____________________________________________________________________________________________
|version5= 1.50


| '''getWPPos''' [group, index] |SYNTAX=
|game6= tkoh
|version6= 1.00


|p1= [group, index]: [[Array]] |PARAMETER1=
|game7= arma3
|version7= 0.50


|p2= group: [[Group]] - the group/unit, of which you want to select a waypoint |PARAMETER2=
|arg= global


|p3= index: [[Number]] - 0 equals the starting position of the group.<br>
|gr1= Waypoints
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]].
|alias= [[waypointPosition]]
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]] [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 {{hl|"0:MOVE"}} the you would have to use {{hl|getWPPos [grp,1]}} to access this particular WP)


<h3 style="display:none">Notes</h3>
|r1= [[Array]] format [[Position#Introduction|Position3D]] - the returned position equals [0,0,0] if the selected waypoint doesn't exist.
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>
</dl>
[_group1, 1] setWPPos [200,600,0];
_pos = getWPPos [_group1, 1]; // returns [200, 600, 0]
</sqf>


<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: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 15: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"