addWaypoint

From Bohemia Interactive Community

Click on the images for descriptions

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

Syntax:: Array = groupName addWaypoint [center, radius] or [center, radius, index]
Parameters:: groupName: Group; [center, radius]: Array; center: Position or Object; index: Number
Return Value:: Array - format Waypoint

Multiplayer:: -
See also:: waypoints, deleteWaypoint, copyWaypoints, setCurrentWaypoint
setWaypointBehaviour, setWaypointCombatMode, setWaypointCompletionRadius, setWaypointDescription, setWaypointFormation, setWaypointHousePosition, setWaypointPosition, setWaypointScript, setWaypointSpeed, setWaypointStatements, setWaypointTimeout, setWaypointType, setWaypointVisible

Only post proven facts here. Use the talk page or the forums for discussions.

Posted on November 26, 2009

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 10, 2010

At least in VBS2 1.30, the randomization of addWaypoint doesn't seem to work correctly all of the time.

Posted on 18:23, 28 April 2011 (CEST)

At least in VBS2 1.30, the alternative syntax of addWaypoint with a specified index doesn't seem to work correctly.