currentWaypoint: Difference between revisions

Latest revision as of 21:40, 22 February 2026

1.00

1.50

1.00

0.50

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

@@ Line 1: / Line 1: @@
-{{Command|Comments=
+{{RV|type=command
-____________________________________________________________________________________________
-| arma2 |Game name=
+|game1= arma2
+|version1= 1.00
-|1.00|Game version=
+|game2= arma2oa
+|version2= 1.50
-|gr1= Waypoints |GROUP1=
+|game3= tkoh
-____________________________________________________________________________________________
+|version3= 1.00
-| Returns the '''index''' of the current waypoint contrary to misleading name.
+|game4= arma3
+|version4= 0.50
-To determine the validity of the index, compare it to the waypoints count.
+|gr1= Waypoints
-If all waypoints are 'completed', then the index is 1 greater than the last valid index.
+|descr= Returns the ''index'' of the current waypoint ('''not''' the waypoint in [[Waypoint|Waypoint Array]] format).
-If there are no waypoints, then the index is 0.
+* 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.
+By default, a group has one already-completed waypoint at their starting position, making the first waypoint number one, not zero.
-|DESCRIPTION=
-____________________________________________________________________________________________
-| '''currentWaypoint''' groupName |SYNTAX=
+|s1= [[currentWaypoint]] groupName
-|p1= groupName: [[Group]]  |PARAMETER1=
+|p1= groupName: [[Group]]
-|p2= |PARAMETER2=
+|r1= [[Number]] - index of the current waypoint
-|p3= |PARAMETER3=
+|x1= <sqf>_index = currentWaypoint group player;</sqf>
-| [[Number]] - the index of current waypoint|RETURNVALUE=
+|x2= <sqf>_waypointFormat = [_group, currentWaypoint _group];</sqf>
+|seealso= [[waypoints]] [[setCurrentWaypoint]]
-|x1= <code>_index = [[currentWaypoint]] [[group]] [[player]];</code>|EXAMPLE1=
-____________________________________________________________________________________________
-| [[waypoints]], [[deleteWaypoint]], [[copyWaypoints]], [[setCurrentWaypoint]], [[setWaypointBehaviour]], [[setWaypointCombatMode]], [[setWaypointCompletionRadius]], [[setWaypointDescription]], [[setWaypointFormation]], [[setWaypointHousePosition]], [[setWaypointPosition]], [[setWaypointScript]], [[setWaypointSpeed]], [[setWaypointStatements]], [[setWaypointTimeout]], [[setWaypointType]], [[setWaypointVisible]], [[waypointAttachVehicle]], [[waypointAttachedVehicle]], [[setWaypointLoiterRadius]], [[waypointLoiterRadius]], [[addWaypoint]], [[setWaypointLoiterType]], [[waypointSpeed]], [[setWPPos]], [[waypointName]] |SEEALSO=
-|  |MPBEHAVIOUR=
-____________________________________________________________________________________________
 }}
-<h3 style='display:none'>Notes</h3>
-<dl class='command_description'>
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style='display:none'>Bottom Section</h3>
-[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]