waypoints: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| arma1 |Game name=
| arma1 |Game name=
Line 9: Line 8:


|gr1= Waypoints |GROUP1=
|gr1= Waypoints |GROUP1=
____________________________________________________________________________________________


| Returns an array of waypoints for the specified unit/group. |DESCRIPTION=
| Returns an array of waypoints for the specified unit/group. |DESCRIPTION=
____________________________________________________________________________________________


| '''waypoints''' groupName |SYNTAX=
| '''waypoints''' groupName |SYNTAX=
Line 19: Line 16:


| [[Array]] of waypoints each in format [[Waypoint]] |RETURNVALUE=
| [[Array]] of waypoints each in format [[Waypoint]] |RETURNVALUE=
____________________________________________________________________________________________
   
   
|x1=<code>[[waypoints]] [[player]];</code>  
|x1=<code>[[waypoints]] [[player]];</code>  
|x2=<code>_wPosArray = [[waypoints]] group10;{{cc|could return [[EAST 1-1-A,0],[EAST 1-1-A,1],[EAST 1-1-A,2]]}}</code>|EXAMPLE1=
|x2=<code>_wPosArray = [[waypoints]] group10;{{cc|could return [[EAST 1-1-A,0],[EAST 1-1-A,1],[EAST 1-1-A,2]]}}</code>|EXAMPLE1=
____________________________________________________________________________________________


| [[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]]
| [[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]]

Revision as of 04:21, 17 January 2021

Hover & click on the images for description

Description

Description:
Returns an array of waypoints for the specified unit/group.
Groups:
Waypoints

Syntax

Syntax:
waypoints groupName
Parameters:
groupName: Group
Return Value:
Array of waypoints each in format Waypoint

Examples

Example 1:
waypoints player;
Example 2:
_wPosArray = waypoints group10;// could return [[EAST 1-1-A,0],[EAST 1-1-A,1],[EAST 1-1-A,2]]

Additional Information

See also:
deleteWaypointcopyWaypointssetCurrentWaypointsetWaypointBehavioursetWaypointCombatModesetWaypointCompletionRadiussetWaypointDescriptionsetWaypointFormationsetWaypointHousePositionsetWaypointPositionsetWaypointScriptsetWaypointSpeedsetWaypointStatementssetWaypointTimeoutsetWaypointTypesetWaypointVisiblewaypointAttachVehiclewaypointAttachedVehiclesetWaypointLoiterRadiuswaypointLoiterRadiusaddWaypointsetWaypointLoiterTypewaypointSpeedsetWPPoswaypointName

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