currentWaypoint

From Bohemia Interactive Community
Revision as of 11:42, 5 May 2024 by Lou Montana (talk | contribs) (Some wiki formatting)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Returns the index of the current waypoint (not the waypoint in Waypoint Array format). 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 one waypoint at their starting position, which is considered completed so the currentWaypoint is 1.
Groups:
Waypoints

Syntax

Syntax:
currentWaypoint groupName
Parameters:
groupName: Group
Return Value:
Number - index of the current waypoint

Examples

Example 1:
_index = currentWaypoint group player;

Additional Information

See also:
waypoints setCurrentWaypoint

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