currentWaypoint: Difference between revisions

Revision as of 10:48, 19 July 2009

Hover & click on the images for description

Description:: Return the index of the current waypoint. 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:: Uncategorised

Example 1:

_index = currentWaypoint group player;

: 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

@@ Line 7: / Line 7: @@
 ____________________________________________________________________________________________
-| Return the index of the current waypoint.  |= Description
+| Return the index of the current waypoint.
+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.
+|= Description
 ____________________________________________________________________________________________
-| '''currentWaypoint''' group |= Syntax
+| '''currentWaypoint''' groupName |= Syntax
-|p1= group:  -  |= PARAMETER1
+|p1= groupName: [[group]]  |= PARAMETER1
 |p2= |= PARAMETER2
@@ Line 21: / Line 30: @@
-|x1= <code>(example)</code>|= EXAMPLE1
+|x1= <pre>_index = currentWaypoint group player;</pre>|= EXAMPLE1
 ____________________________________________________________________________________________
-|  |= SEEALSO
+| [[setCurrentWaypoint]], [[waypoints]] |= SEEALSO
 |  |= MPBEHAVIOUR