# Waypoints (scripting commands)

- [addWaypoint](../../commands/addWaypoint.md): Adds (or inserts when index is given) a new waypoint to a group.
- [copyWaypoints](../../commands/copyWaypoints.md): Copy the chain of waypoints from source to target group. The target group will start to process waypoints from the first one.
- [createGuardedPoint](../../commands/createGuardedPoint.md): Adds a point guarded by the given side (scripted way of adding equivalent of "GUARDED BY" trigger in Editor). A closest AI group in the given side with assigned "GUARD" waypoint will attempt to secure this guard point.
- [currentWaypoint](../../commands/currentWaypoint.md): Returns the *index* of the current waypoint (not the waypoint in Waypoint Array format).
- [customWaypointPosition](../../commands/customWaypointPosition.md): Returns player's custom waypoint (<kbd>LShift</kbd>+<kbd>LMB</kbd>) position.
- [deleteWaypoint](../../commands/deleteWaypoint.md): Removes the specified waypoint.
- [enableUAVWaypoints](../../commands/enableUAVWaypoints.md): Enables/disables the option for player to set waypoints for UAV in AV terminal.
- [getWPPos](../../commands/getWPPos.md): Returns the position of a selected waypoint of a given group. Waypoints include only those which were placed in the mission editor.
- [lockWP](../../commands/lockWP.md): Disable switching to next waypoint (current waypoint will never complete while lockwp is used). Sometimes used during cut-scenes.
- [setCurrentWaypoint](../../commands/setCurrentWaypoint.md): Sets the currently active waypoint for a group.
- [setMusicEffect](../../commands/setMusicEffect.md): Defines a music track played on activation. If another track is playing already, this will stop it and start the new track.
- [setSoundEffect](../../commands/setSoundEffect.md): Defines the different sound effects for a trigger or a waypoint. To stop any sound, deactivate the trigger (might take up to 0.5 seconds to stop) or delete the trigger/waypoint (immediate).
- [setTitleEffect](../../commands/setTitleEffect.md): Defines the title effect to show on activation via [Type, Effect, Text] where
- [setWaypointBehaviour](../../commands/setWaypointBehaviour.md): Switches the unit behaviour when the waypoint becomes active.
- [setWaypointCombatMode](../../commands/setWaypointCombatMode.md): Changes a group's combat mode when the waypoint becomes active.
- [setWaypointCompletionRadius](../../commands/setWaypointCompletionRadius.md): The completion radius allows units to call the waypoint completed once they are inside of the given circle. If the given radius is less than unit’s or vehicle’s configured 'precision' then the latter is used.
- [setWaypointDescription](../../commands/setWaypointDescription.md): Sets the description shown in the HUD while the waypoint is active.
- [setWaypointForceBehaviour](../../commands/setWaypointForceBehaviour.md): Forces the behavior of waypoint, disables AUTOCOMBAT.
- [setWaypointFormation](../../commands/setWaypointFormation.md): Switches the group formation when the waypoint becomes active.
- [setWaypointHousePosition](../../commands/setWaypointHousePosition.md): For waypoints attached to a house, this defines the target buildingPos index.
- [setWaypointLoiterAltitude](../../commands/setWaypointLoiterAltitude.md): Assigns loiter altitude to the provided waypoint.
- [setWaypointLoiterRadius](../../commands/setWaypointLoiterRadius.md): Assignes loiter radius to waypoint
- [setWaypointLoiterType](../../commands/setWaypointLoiterType.md): Sets the waypoint loiter type.
- [setWaypointName](../../commands/setWaypointName.md): Changes the waypoint name.
- [setWaypointPosition](../../commands/setWaypointPosition.md): Attempts to move given waypoint to a random position inside a circle with the given center and radius.
- [setWaypointScript](../../commands/setWaypointScript.md): Attaches a script to a scripted waypoint. In early versions of Arma, command consisted of a script name and additional script arguments and the script had to use SQS Syntax.
- [setWaypointSpeed](../../commands/setWaypointSpeed.md): Switches the group speed mode when the waypoint becomes active.
- [setWaypointStatements](../../commands/setWaypointStatements.md): The waypoint is done only when the condition is fulfilled. When the waypoint is done, the statement expression is executed.
- [setWaypointTimeout](../../commands/setWaypointTimeout.md): Defines the time between condition satisfaction and waypoint finish (randomly from min to max, with an average value mid).
- [setWaypointType](../../commands/setWaypointType.md): Sets the waypoint type of given waypoint.
- [setWaypointVisible](../../commands/setWaypointVisible.md): Sets the visibility of the given waypoint in 3D HUD view (for map visibility see showWaypoint).
- [setWPPos](../../commands/setWPPos.md): Sets waypoint position.
- [showWaypoint](../../commands/showWaypoint.md): Defines how waypoints are shown to the player in map view. For 3D HUD visibility see setWaypointVisible.
- [showWaypoints](../../commands/showWaypoints.md): Shows/Hides task HUD markers and waypoints that will fade out in time. Dependable on difficulty settings.
- [synchronizedWaypoints](../../commands/synchronizedWaypoints.md): Returns the list of waypoints synchronized with a given trigger or waypoint.
- [synchronizeTrigger](../../commands/synchronizeTrigger.md): Synchronizes the trigger with zero or more waypoints.
- [synchronizeWaypoint](../../commands/synchronizeWaypoint.md): Synchronizes the trigger or the waypoint with an array of waypoints.
- [waypointAttachedObject](../../commands/waypointAttachedObject.md): Gets the object attached to the waypoint.
- [waypointAttachedVehicle](../../commands/waypointAttachedVehicle.md): Gets the vehicle attached to the waypoint.
- [waypointAttachObject](../../commands/waypointAttachObject.md): Attaches a static object via its numeric ID to the given waypoint. Not to be confused with synchronizeWaypoint!
- [waypointAttachVehicle](../../commands/waypointAttachVehicle.md): Attaches the Waypoint to the provided vehicle Object.
- [waypointBehaviour](../../commands/waypointBehaviour.md): Gets the waypoint behavior.
- [waypointCombatMode](../../commands/waypointCombatMode.md): Gets the waypoint's combat mode setting.
- [waypointCompletionRadius](../../commands/waypointCompletionRadius.md): Gets the radius around the waypoint where the waypoint is completed.
- [waypointDescription](../../commands/waypointDescription.md): Gets the waypoint description.
- [waypointForceBehaviour](../../commands/waypointForceBehaviour.md): Returns true if the waypoint behavior is forced.
- [waypointFormation](../../commands/waypointFormation.md): Gets the waypoint formation.
- [waypointHousePosition](../../commands/waypointHousePosition.md): Returns buildingPos index assigned to the waypoint.
- [waypointLoiterAltitude](../../commands/waypointLoiterAltitude.md): Gets the waypoint loiter altitude.
- [waypointLoiterRadius](../../commands/waypointLoiterRadius.md): Gets the waypoint's loiter radius.
- [waypointLoiterType](../../commands/waypointLoiterType.md): Gets the waypoint loiter type. Waypoint uses format Waypoint.
- [waypointName](../../commands/waypointName.md): Gets the waypoint name.
- [waypointPosition](../../commands/waypointPosition.md): Get provided waypoint's position.
- [waypoints](../../commands/waypoints.md): Returns an array of waypoints for the specified unit/group.
- [waypointScript](../../commands/waypointScript.md): Gets the waypoint script.
- [waypointsEnabledUAV](../../commands/waypointsEnabledUAV.md): Checks if the UAV has waypoints enabled.
- [waypointShow](../../commands/waypointShow.md): A getter for showWaypoint command.
- [waypointSpeed](../../commands/waypointSpeed.md): Gets the waypoint speed.
- [waypointStatements](../../commands/waypointStatements.md): Gets the waypoint statements.
- [waypointTimeout](../../commands/waypointTimeout.md): Gets the waypoint timeout values.
- [waypointTimeoutCurrent](../../commands/waypointTimeoutCurrent.md): Gets the current timeout for currentWaypoint of a group or -1 if countdown is not in progress.
- [waypointType](../../commands/waypointType.md): Gets the waypoint type.
- [waypointVisible](../../commands/waypointVisible.md): A getter for setWaypointVisible command.