currentWaypoint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (see also)
m (Some wiki formatting)
 
(36 intermediate revisions by 4 users not shown)
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


| Return the index of the current waypoint.
|game3= tkoh
|version3= 1.00


To determine the validity of the index, compare it to the waypoints count.
|game4= arma3
|version4= 0.50


If all waypoints are 'completed', then the index is 1 greater than the last valid index.
|gr1= Waypoints


If there are no waypoints, then the index is 0.
|descr= Returns the ''index'' of the current waypoint ('''not''' the waypoint in [[Waypoint|Waypoint Array]] format).


By default, a group has 1 waypoint at their starting position, which is considered completed and so the currentWaypoint is 1.
To determine the validity of the index, compare it to the waypoints count.
|= Description
____________________________________________________________________________________________


| '''currentWaypoint''' groupName |= Syntax
If all waypoints are completed, then the index is 1 greater than the last valid index.


|p1= groupName: [[Group]]  |= PARAMETER1
If there are no waypoints, then the index is 0.


|p2= |= PARAMETER2
By default, a group has one waypoint at their starting position, which is considered completed so the currentWaypoint is 1.


|p3= |= PARAMETER3
|s1= [[currentWaypoint]] groupName


| [[Number]] |= RETURNVALUE
|p1= groupName: [[Group]]


|r1= [[Number]] - index of the current waypoint


|x1= <code>_index = [[currentWaypoint]] [[group]] [[player]];</code>|= EXAMPLE1
|x1= <sqf>_index = currentWaypoint group player;</sqf>


____________________________________________________________________________________________
|seealso= [[waypoints]] [[setCurrentWaypoint]]
 
| [[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:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Waypoints|{{uc:{{PAGENAME}}}}]]

Latest revision as of 12:42, 5 May 2024

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.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 waypoint at their starting position, which is considered completed so the currentWaypoint is 1.
Groups:
Waypoints

Syntax

Syntax:
currentWaypoint groupName
Parameters:
groupName: Group
Return Value:
Number - index of the 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
Retrieved from "https://community.bistudio.com/wiki?title=currentWaypoint&oldid=364149"