currentWaypoint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (template:command argument fix)
Line 16: Line 16:


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.
|= Description
|DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''currentWaypoint''' groupName |= Syntax
| '''currentWaypoint''' groupName |SYNTAX=


|p1= groupName: [[Group]]  |PARAMETER1=  
|p1= groupName: [[Group]]  |PARAMETER1=  

Revision as of 14:37, 7 April 2019

Hover & click on the images for description

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:
Uncategorised

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:
waypointsdeleteWaypointcopyWaypointssetCurrentWaypointsetWaypointBehavioursetWaypointCombatModesetWaypointCompletionRadiussetWaypointDescriptionsetWaypointFormationsetWaypointHousePositionsetWaypointPositionsetWaypointScriptsetWaypointSpeedsetWaypointStatementssetWaypointTimeoutsetWaypointTypesetWaypointVisiblewaypointAttachVehiclewaypointAttachedVehiclesetWaypointLoiterRadiuswaypointLoiterRadiusaddWaypointsetWaypointLoiterTypewaypointSpeedsetWPPoswaypointName

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

Notes

Bottom Section