Difference between revisions of "currentWaypoint"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (see also)
(emphasis on index)
Line 7: Line 7:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Return the index of the current waypoint.
+
| 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.
Line 27: Line 27:
 
|p3= |= PARAMETER3  
 
|p3= |= PARAMETER3  
  
| [[Number]] |= RETURNVALUE  
+
| [[Number]] - the index of current waypoint|= RETURNVALUE  
  
  

Revision as of 00:24, 9 November 2018

Introduced with Arma 2 version 1.00
  

Click on the images for descriptions

Introduced in

Game:
Arma 2
Version:
1.00

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.

Syntax

Syntax:
currentWaypoint groupName
Parameters:
groupName: Group
Return Value:
Number - the index of current waypoint

Examples

Example 1:
_index = currentWaypoint group player;

Additional Information

Multiplayer:
-
See also:
waypointsdeleteWaypointcopyWaypointssetCurrentWaypointsetWaypointBehavioursetWaypointCombatModesetWaypointCompletionRadiussetWaypointDescriptionsetWaypointFormationsetWaypointHousePositionsetWaypointPositionsetWaypointScriptsetWaypointSpeedsetWaypointStatementssetWaypointTimeoutsetWaypointTypesetWaypointVisiblewaypointAttachVehiclewaypointAttachedVehiclesetWaypointLoiterRadiuswaypointLoiterRadiusaddWaypointsetWaypointLoiterTypewaypointSpeedsetWPPoswaypointName

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section