Difference between revisions of "getWPPos"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (paired "(" with ")")
m (template:command argument fix)
Line 9: Line 9:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| 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=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[Array]] <nowiki>=</nowiki> '''getWPPos''' [group, index] |= Syntax
+
| [[Array]] <nowiki>=</nowiki> '''getWPPos''' [group, index] |SYNTAX=
  
|p1= [group, index]: [[Array]] |= Parameter 1
+
|p1= [group, index]: [[Array]] |PARAMETER1=
  
|p2= group: [[Group]] - the group/unit, of which you want to select a waypoint |= Parameter 2
+
|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>
 
|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)|= Parameter 3
+
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]].  
 
| [[Array]] - format [[Position3D]].  
The returned position equals [0,0,0], if the selected waypoint doesn't exist. |= Return value
+
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=
  
 
}}
 
}}

Revision as of 15:40, 7 April 2019

Introduced with Operation Flashpoint version 1.21
  Arguments of this scripting command don't have to be local to the client the command is executed on

Click on the images for descriptions

Introduced in

Game:
Operation Flashpoint
Version:
1.21

Description

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

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

Example 1:
[_group1,1] setWPPos [200,600,0];
_pos = getWPPos [_group1,1];
returns [200,600,0]

Additional Information

Multiplayer:
-
See also:
setWPPos

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section