addWaypoint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Since this documentation is for all current game versions, notes about older methods of accomplishing tasks are perfectly valid (with qualification where appropriate).)
(description)
Line 22: Line 22:
|p1=  groupName: [[Group]] |= Parameter 1
|p1=  groupName: [[Group]] |= Parameter 1


|p2= [center, radius]: [[Array]] |= Parameter 2
|p2= center: [[Position]] or [[Object]] |= Parameter 2


|p3= center: [[Position]] or [[Object]] |= Parameter 3
|p3= radius: [[Number]] - random waypoint placement within ''radius'' from ''center'' |= Parameter 3


|p4= radius: [[Number]] |= Parameter 4
|p4= index: [[Number]] - can be used to insert a waypoint in between existing waypoints |= Parameter 4


|p4= index: [[Number]]  |= Parameter 5
|p5= name: [[String]]  |= Parameter 5


| [[Array]] - format [[Waypoint]] |= Return value
| [[Array]] - format [[Waypoint]] - <nowiki>[</nowiki>[[Group]], ''index''] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   

Revision as of 10:58, 22 June 2014

-wrong parameter ("Arma") defined!-1.00
Hover & click on the images for description

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].
Groups:
Uncategorised

Syntax

Syntax:
Array = groupName addWaypoint [center, radius] or [center, radius, index] or [center, radius, index, name]
Parameters:
groupName: Group
center: Position or Object
radius: Number - random waypoint placement within radius from center
index: Number - can be used to insert a waypoint in between existing waypoints
name: String
Return Value:
Array - format Waypoint - [Group, index]

Examples

Example 1:
_wp = grp addWaypoint [position player, 0]

Additional Information

See also:
waypointsdeleteWaypointcopyWaypointsmove , setCurrentWaypointsetWaypointBehavioursetWaypointCombatModesetWaypointCompletionRadiussetWaypointDescriptionsetWaypointFormationsetWaypointHousePositionsetWaypointPositionsetWaypointScriptsetWaypointSpeedsetWaypointStatementssetWaypointTimeoutsetWaypointTypesetWaypointVisiblewaypointAttachVehiclewaypointAttachedVehiclesetWaypointLoiterRadiuswaypointLoiterRadiussetWaypointLoiterTypecurrentWaypoint

Notes

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

Notes

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 18:23, 28 April 2011 (CEST)
besselinksjm
In VBS2 1.30, the randomization of addWaypoint doesn't seem to work correctly all of the time.
The alternative syntax of addWaypoint with a specified index doesn't seem to work correctly.

Bottom Section

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 !
see move command.