currentWaypoint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(explain return values, example, see also)
m (fix group type)
Line 21: Line 21:
| '''currentWaypoint''' groupName |= Syntax
| '''currentWaypoint''' groupName |= Syntax


|p1= groupName: [[group]]  |= PARAMETER1  
|p1= groupName: [[Group]]  |= PARAMETER1  


|p2= |= PARAMETER2  
|p2= |= PARAMETER2  

Revision as of 11:16, 19 July 2009

Hover & click on the images for description

Description

Description:
Return the index of the current waypoint. To determine the validity of the index, compare it to the waypoints count. If all waypoints are 'completed', then the index is 1 greater than the last valid index. If there are no waypoints, then the index is 0. By default, a group has 1 waypoint at their starting position, which is considered completed and so the currentWaypoint is 1.
Groups:
Uncategorised

Syntax

Syntax:
currentWaypoint groupName
Parameters:
groupName: Group
Return Value:
Number

Examples

Example 1:
_index = currentWaypoint group player;

Additional Information

See also:
setCurrentWaypointwaypoints

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