getWPPos: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (template:command argument fix) |
||
| (23 intermediate revisions by 9 users not shown) | |||
| Line 1: | Line 1: | ||
{{Command|= Comments | |||
____________________________________________________________________________________________ | |||
| ofp |= Game name | |||
|1.21|= Game version | |||
|arg= global |= Arguments in MP | |||
____________________________________________________________________________________________ | |||
| Returns the position of a selected waypoint of a given group. Waypoints include only those which were placed in the mission editor. |DESCRIPTION= | |||
____________________________________________________________________________________________ | |||
''' | | [[Array]] <nowiki>=</nowiki> '''getWPPos''' [group, index] |SYNTAX= | ||
|p1= [group, index]: [[Array]] |PARAMETER1= | |||
[[ | |p2= group: [[Group]] - the group/unit, of which you want to select a waypoint |PARAMETER2= | ||
''' | |p3= 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 <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> | |||
returns [200,600,0] |EXAMPLE1= | |||
____________________________________________________________________________________________ | |||
| [[setWPPos]] |SEEALSO= | |||
[[ | |||
}} | |||
<h3 style="display:none">Notes</h3> | |||
<dl class="command_description"> | |||
<!-- Note Section BEGIN --> | |||
<!-- Note Section END --> | |||
</dl> | |||
<h3 style="display:none">Bottom Section</h3> | |||
[[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 ArmA|GETWPPOS]] | |||
[[Category:Command_Group:_Waypoints|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]] | |||
Revision as of 15:40, 7 April 2019
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:
- Array = 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
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
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.21
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Command Group: Uncategorised
- Scripting Commands OFP 1.99
- Scripting Commands OFP 1.96
- Scripting Commands OFP 1.46
- Scripting Commands ArmA
- Command Group: Waypoints
- Scripting Commands ArmA2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters