getWPPos

From Bohemia Interactive Community
Revision as of 07:28, 5 April 2007 by Kronzky (talk | contribs) (clarification of index)
Jump to navigation Jump to search
Introduced with Operation Flashpoint version 1.211.21Arguments of this scripting command don't have to be local to the client the command is executed on
Hover & click on the images for descriptions

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:
getWPPos [group, number]
Parameters:
group: Group - the group/unit, of which you want to select a waypoint
number: Integer - 0 equals the starting position of the group.
The number used in this and other waypoint commands is one less than the one displayed in the waypoint window in the editor. (i.e. if the editor labeled a WP "2:MOVE" the you would have to use getWPPos [grp,1] to access this particular WP
Return Value:
Array (format Position) - 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

i
Only post proven facts here. Report bugs on the feedback tracker. Use the Talk page or the Forums for discussions.

Notes

Bottom Section