addWaypoint: Difference between revisions

Revision as of 13:02, 20 January 2022

Hover & click on the images for description

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. The function returns a waypoint with format [group, index].

ⓘ
Prior to Arma 3 v1.90, if you need exact waypoint placement, use setWaypointPosition
Groups:: Waypoints

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
Since Arma 3 v1.90, -1 may be used for exact waypoint placement
: index (optional): Number - can be used to insert a waypoint in between existing waypoints
: name (optional): String - waypointName
Return Value:: Array format Waypoint - [Group, index]

See also:: waypoints createGuardedPoint deleteWaypoint copyWaypoints move setCurrentWaypoint setWaypointBehaviour setWaypointCombatMode setWaypointCompletionRadius setWaypointDescription setWaypointFormation setWaypointHousePosition setWaypointPosition setWaypointScript setWaypointSpeed setWaypointStatements setWaypointTimeout setWaypointType setWaypointVisible waypointAttachVehicle waypointAttachedVehicle setWaypointLoiterRadius waypointLoiterRadius setWaypointLoiterType currentWaypoint waypointName waypointSpeed setWPPos

: 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

: Posted on November 26, 2009
tijmenjoppe: 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.
: Posted on June 21, 2014 - 20:38 (UTC)
Giova: 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.

: Posted on August 4, 2014 - 23:49 (UTC)
ThorViking: 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.

@@ Line 48: / Line 48: @@
 |x1= <code>_wp = _grp [[addWaypoint]] [<nowiki/>[[position]] [[player]], 0];</code>
-|seealso= [[waypoints]] [[createGuardedPoint]], [[deleteWaypoint]], [[copyWaypoints]], [[move]], [[setCurrentWaypoint]], [[setWaypointBehaviour]], [[setWaypointCombatMode]], [[setWaypointCompletionRadius]], [[setWaypointDescription]], [[setWaypointFormation]], [[setWaypointHousePosition]], [[setWaypointPosition]], [[setWaypointScript]], [[setWaypointSpeed]], [[setWaypointStatements]], [[setWaypointTimeout]], [[setWaypointType]], [[setWaypointVisible]], [[waypointAttachVehicle]], [[waypointAttachedVehicle]], [[setWaypointLoiterRadius]], [[waypointLoiterRadius]], [[setWaypointLoiterType]], [[currentWaypoint]], [[waypointName]], [[waypointSpeed]], [[setWPPos]]
+|seealso= [[waypoints]] [[createGuardedPoint]] [[deleteWaypoint]], [[copyWaypoints]], [[move]], [[setCurrentWaypoint]], [[setWaypointBehaviour]], [[setWaypointCombatMode]], [[setWaypointCompletionRadius]], [[setWaypointDescription]], [[setWaypointFormation]], [[setWaypointHousePosition]], [[setWaypointPosition]], [[setWaypointScript]], [[setWaypointSpeed]], [[setWaypointStatements]], [[setWaypointTimeout]], [[setWaypointType]], [[setWaypointVisible]], [[waypointAttachVehicle]], [[waypointAttachedVehicle]], [[setWaypointLoiterRadius]], [[waypointLoiterRadius]], [[setWaypointLoiterType]], [[currentWaypoint]], [[waypointName]], [[waypointSpeed]], [[setWPPos]]
 }}