getWPPos: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (+ Category, wiki links)
No edit summary
(25 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{Command|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| ofp |= Game name
| ofp |Game name=


|1.21|= Game version
|1.21|Game version=


|arg= global |= Arguments in MP
|arg= global |Multiplayer Arguments=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


| '''getWPPos''' [group, number] |= Syntax
| '''getWPPos''' [group, index] |SYNTAX=


|p1= group: [[Group]] - the group/unit, of which you want to select a waypoint |= Parameter 1
|p1= [group, index]: [[Array]] |PARAMETER1=


|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= group: [[Group]] - the group/unit, of which you want to select a waypoint |PARAMETER2=


| [[Array]] (format [[Position]]) - 
|p3= index: [[Number]] - 0 equals the starting position of the group.<br>
The returned position equals [0,0,0], if the selected waypoint doesn't exist. |= Return value
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]].
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>
|x1= <code>[_group1,1] [[setWPPos]] [200,600,0];<br>_pos <nowiki>=</nowiki> [[getWPPos]] [_group1,1];</code>


returns [200,600,0] |= Example 1
returns [200,600,0] |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[setWPPos]] |= See also
| [[setWPPos]] |SEEALSO=


}}
}}
Line 40: Line 43:
<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|GETWPPOS]]
[[Category:Scripting Commands|GETWPPOS]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|GETWPPOS]]
[[Category:Scripting Commands OFP 1.96|GETWPPOS]]
[[Category:Scripting Commands OFP 1.46|GETWPPOS]]
[[Category:Scripting Commands OFP 1.46|GETWPPOS]]
[[Category:Scripting Commands ArmA|GETWPPOS]]
[[Category:Scripting Commands Armed Assault|GETWPPOS]]
[[Category:Command_Group:_Waypoints|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Waypoints|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Revision as of 08:42, 2 August 2020

Logo A0.png1.21
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.
Groups:
Uncategorised

Syntax

Syntax:
getWPPos [group, index]
Parameters:
[group, index]: Array
group: Group - the group/unit, of which you want 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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=getWPPos&oldid=155939"