currentWaypoint: Difference between revisions

From Bohemia Interactive Community
m (Some wiki formatting)
m (Some wiki formatting)
 
Line 17: Line 17:
|descr= Returns the ''index'' of the current waypoint ('''not''' the waypoint in [[Waypoint|Waypoint Array]] format).
|descr= Returns the ''index'' of the current waypoint ('''not''' the waypoint in [[Waypoint|Waypoint Array]] format).


To determine the validity of the index, compare it to the waypoints count.
* 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.


If all waypoints are completed, then the index is 1 greater than the last valid index.
By default, a group has one already-completed waypoint at their starting position, making the first waypoint number one, not zero.
 
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.


|s1= [[currentWaypoint]] groupName
|s1= [[currentWaypoint]] groupName
Line 32: Line 30:


|x1= <sqf>_index = currentWaypoint group player;</sqf>
|x1= <sqf>_index = currentWaypoint group player;</sqf>
|x2= <sqf>_waypointFormat = [_group, currentWaypoint _group];</sqf>


|seealso= [[waypoints]] [[setCurrentWaypoint]]
|seealso= [[waypoints]] [[setCurrentWaypoint]]
}}
}}

Latest revision as of 21:40, 22 February 2026

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 already-completed waypoint at their starting position, making the first waypoint number one, not zero.
Groups:
Waypoints

Syntax

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

Examples

Example 1:
_index = currentWaypoint group player;
Example 2:
_waypointFormat = [_group, currentWaypoint _group];

Additional Information

See also:
waypoints setCurrentWaypoint

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord.
Only post proven facts here! Add Note