currentWaypoint: Difference between revisions
Lou Montana (talk | contribs) m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 15: | Line 15: | ||
|gr1= Waypoints | |gr1= Waypoints | ||
|descr= Returns the | |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. | |||
By default, a group has one already-completed waypoint at their starting position, making the first waypoint number one, not zero. | |||
|s1= [[currentWaypoint]] groupName | |||
|s1= [[currentWaypoint]] | |||
|p1= groupName: [[Group]] | |p1= groupName: [[Group]] | ||
|r1= [[Number]] - | |r1= [[Number]] - index of the current waypoint | ||
|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 22:40, 22 February 2026
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.
- Groups:
- Waypoints
Syntax
- Syntax:
- currentWaypoint groupName
- Parameters:
- groupName: Group
- Return Value:
- Number - index of the current waypoint
Examples
- Example 1:
- Example 2:
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