currentWaypoint: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " \| *(game[0-9]|version[0-9]|gr[0-9]|serverExec|mp|pr|descr|s[0-9]|p[0-9]{1,3}|r[0-9]|x1?[0-9]|seealso) *= +" to " |$1= ") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
| (5 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. | ||
| Line 23: | Line 23: | ||
If there are no waypoints, then the index is 0. | If there are no waypoints, then the index is 0. | ||
By default, a group has | By default, a group has one waypoint at their starting position, which is considered completed so the currentWaypoint is 1. | ||
|s1= [[currentWaypoint]] | |s1= [[currentWaypoint]] groupName | ||
|p1= groupName: [[Group]] | |p1= groupName: [[Group]] | ||
|r1= [[Number]] - | |r1= [[Number]] - index of the current waypoint | ||
|x1= < | |x1= <sqf>_index = currentWaypoint group player;</sqf> | ||
|seealso= [[waypoints]] [[setCurrentWaypoint]] | |seealso= [[waypoints]] [[setCurrentWaypoint]] | ||
}} | }} | ||
Latest revision as of 11:42, 5 May 2024
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:
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