currentWaypoint: Difference between revisions
Jump to navigation
Jump to search
(updated) |
Killzone Kid (talk | contribs) (emphasis on index) |
||
| (11 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{Command|= Comments | |||
____________________________________________________________________________________________ | |||
| arma2 |= Game name | |||
|1.00|= Game version | |||
____________________________________________________________________________________________ | |||
| 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. | |||
|= Description | |||
____________________________________________________________________________________________ | |||
| '''currentWaypoint''' groupName |= Syntax | |||
|p1= groupName: [[Group]] |= PARAMETER1 | |||
|p2= |= PARAMETER2 | |||
|p3= |= PARAMETER3 | |||
| [[Number]] - the index of current waypoint|= RETURNVALUE | |||
|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:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Scripting Commands ArmA2|{{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}}}}]] | |||
Revision as of 00:24, 9 November 2018
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