Waypoints
63 scripting commands. Also as Markdown for agents.
- addWaypointAdds (or inserts when index is given) a new waypoint to a group.
- copyWaypointsCopy the chain of waypoints from source to target group. The target group will start to process waypoints from the first one.
- createGuardedPointAdds 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…
- currentWaypointReturns the *index* of the current waypoint (not the waypoint in Waypoint Array format).
- customWaypointPositionReturns player's custom waypoint (<kbd>LShift</kbd>+<kbd>LMB</kbd>) position.
- deleteWaypointRemoves the specified waypoint.
- enableUAVWaypointsEnables/disables the option for player to set waypoints for UAV in AV terminal.
- getWPPosReturns the position of a selected waypoint of a given group. Waypoints include only those which were placed in the mission editor.
- lockWPDisable switching to next waypoint (current waypoint will never complete while lockwp is used). Sometimes used during cut-scenes.
- setCurrentWaypointSets the currently active waypoint for a group.
- setMusicEffectDefines a music track played on activation. If another track is playing already, this will stop it and start the new track.
- setSoundEffectDefines 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…
- setTitleEffectDefines the title effect to show on activation via [Type, Effect, Text] where
- setWaypointBehaviourSwitches the unit behaviour when the waypoint becomes active.
- setWaypointCombatModeChanges a group's combat mode when the waypoint becomes active.
- setWaypointCompletionRadiusThe 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…
- setWaypointDescriptionSets the description shown in the HUD while the waypoint is active.
- setWaypointForceBehaviourForces the behavior of waypoint, disables AUTOCOMBAT.
- setWaypointFormationSwitches the group formation when the waypoint becomes active.
- setWaypointHousePositionFor waypoints attached to a house, this defines the target buildingPos index.
- setWaypointLoiterAltitudeAssigns loiter altitude to the provided waypoint.
- setWaypointLoiterRadiusAssignes loiter radius to waypoint
- setWaypointLoiterTypeSets the waypoint loiter type.
- setWaypointNameChanges the waypoint name.
- setWaypointPositionAttempts to move given waypoint to a random position inside a circle with the given center and radius.
- setWaypointScriptAttaches a script to a scripted waypoint. In early versions of Arma, command consisted of a script name and additional script arguments and the…
- setWaypointSpeedSwitches the group speed mode when the waypoint becomes active.
- setWaypointStatementsThe waypoint is done only when the condition is fulfilled. When the waypoint is done, the statement expression is executed.
- setWaypointTimeoutDefines the time between condition satisfaction and waypoint finish (randomly from min to max, with an average value mid).
- setWaypointTypeSets the waypoint type of given waypoint.
- setWaypointVisibleSets the visibility of the given waypoint in 3D HUD view (for map visibility see showWaypoint).
- setWPPosSets waypoint position.
- showWaypointDefines how waypoints are shown to the player in map view. For 3D HUD visibility see setWaypointVisible.
- showWaypointsShows/Hides task HUD markers and waypoints that will fade out in time. Dependable on difficulty settings.
- synchronizedWaypointsReturns the list of waypoints synchronized with a given trigger or waypoint.
- synchronizeTriggerSynchronizes the trigger with zero or more waypoints.
- synchronizeWaypointSynchronizes the trigger or the waypoint with an array of waypoints.
- waypointAttachedObjectGets the object attached to the waypoint.
- waypointAttachedVehicleGets the vehicle attached to the waypoint.
- waypointAttachObjectAttaches a static object via its numeric ID to the given waypoint. Not to be confused with synchronizeWaypoint!
- waypointAttachVehicleAttaches the Waypoint to the provided vehicle Object.
- waypointBehaviourGets the waypoint behavior.
- waypointCombatModeGets the waypoint's combat mode setting.
- waypointCompletionRadiusGets the radius around the waypoint where the waypoint is completed.
- waypointDescriptionGets the waypoint description.
- waypointForceBehaviourReturns true if the waypoint behavior is forced.
- waypointFormationGets the waypoint formation.
- waypointHousePositionReturns buildingPos index assigned to the waypoint.
- waypointLoiterAltitudeGets the waypoint loiter altitude.
- waypointLoiterRadiusGets the waypoint's loiter radius.
- waypointLoiterTypeGets the waypoint loiter type. Waypoint uses format Waypoint.
- waypointNameGets the waypoint name.
- waypointPositionGet provided waypoint's position.
- waypointsReturns an array of waypoints for the specified unit/group.
- waypointScriptGets the waypoint script.
- waypointsEnabledUAVChecks if the UAV has waypoints enabled.
- waypointShowA getter for showWaypoint command.
- waypointSpeedGets the waypoint speed.
- waypointStatementsGets the waypoint statements.
- waypointTimeoutGets the waypoint timeout values.
- waypointTimeoutCurrentGets the current timeout for currentWaypoint of a group or -1 if countdown is not in progress.
- waypointTypeGets the waypoint type.
- waypointVisibleA getter for setWaypointVisible command.