addWaypoint

Global argument
Global effect
Arma 3 v0.50
First in Operation Flashpoint: Elite v1.00

Command · Markdown · JSON · original wiki page

Description

Adds (or inserts when index is given) a new waypoint to a group.

The waypoint is placed randomly within a circle with the given center and radius.

Note
For older titles and prior to Arma 3 v1.90, use setWaypointPosition if you need exact waypoint placement.

Syntax

groupName addWaypoint [center, radius, index, name]

Parameters:

groupName: Group
center: PositionAGL (PositionASL if radius is negative!) or Object
radius: Number - random waypoint placement within radius from center; Arma 3 v1.90 -1 can be used for exact waypoint placement
index: Number - (Optional, default -1) can be used to insert a waypoint in between existing waypoints; if it is invalid, the waypoint will be added at the end
name: String - (Optional, default "") waypointName

Returns: Waypoint

Examples

Example 1

_wp = _grp addWaypoint [position player, 0];

Example 2

_wp = _grp addWaypoint [position player, 0];            // imprecise, placed like setVehiclePosition's "NONE" placement
_wp setWaypointPosition [getPosASL player, -1];            // from Operation Flashpoint: Elite to Arma 3 v1.88

private _wp = _grp addWaypoint [getPosASL player, -1];    // Arma 3 v1.90+: precise placement

Community notes

Tijmenjoppe

2009-11-26

In game versions prior to Arma 3 v1.22: If you add a waypoint to your group and then want them to start moving to that waypoint, make sure to call setWaypointType "MOVE" on your waypoint.

Giova

2014-06-21

if you want to create a waypoint of type "MOVE" and set it as actual waypoint, you can use the move command that does everything for you with only one line of code !
Be aware that move command intercepts multiple waypoints and it will not line up in waypoints queue. In other word it is a quick solution if you want your group to get only one waypoint, but for several waypoints you'll have to use addwaypoint and all setwaypointXXXXXX commands around.
see move command.

OdinViking

2014-08-05

The waypoint may not be created exactly at the center position even if radius is zero. The position will be moved away if there are e.g. rocks at the center position or if it is placed at the edge of water on a shore.