currentWaypoint: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ |()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}") |
(formatting) |
||
| Line 1: | Line 1: | ||
{{RV|type=command | {{RV|type=command | ||
| arma2 | |game1= arma2 | ||
|1.00 | |version1= 1.00 | ||
|game2= arma2oa | |||
|version2= 1.51 | |||
|game3= tkoh | |||
|version3= 1.00 | |||
|game4= arma3 | |||
|version4= 0.50 | |||
|gr1= Waypoints | |gr1= Waypoints | ||
| Returns the '''index''' of the current waypoint contrary to misleading name. | |descr= Returns the '''index''' of the current waypoint contrary to misleading name. | ||
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 | 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 there are no waypoints, then the index is 0. | ||
| Line 17: | Line 29: | ||
By default, a group has 1 waypoint at their starting position, which is considered completed and so the currentWaypoint is 1. | By default, a group has 1 waypoint at their starting position, which is considered completed and so the currentWaypoint is 1. | ||
| '''currentWaypoint''' groupName | |s1= '''currentWaypoint''' groupName | ||
|p1= groupName: [[Group]] | |p1= groupName: [[Group]] | ||
| [[Number]] - | |r1= [[Number]] - The index of current waypoint | ||
|x1= <code>_index = [[currentWaypoint]] [[group]] [[player]];</code> | |x1= <code>_index = [[currentWaypoint]] [[group]] [[player]];</code> | ||
|seealso= [[waypoints]] | |seealso= [[waypoints]] [[setCurrentWaypoint]] | ||
}} | }} | ||
Revision as of 10:20, 26 March 2021
Description
- Description:
- Returns the index of the current waypoint contrary to misleading name. 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:
- Waypoints
Syntax
- Syntax:
- currentWaypoint groupName
- Parameters:
- groupName: Group
- Return Value:
- Number - The index of 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