addWaypoint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| *([^=]+)\s*\|p1=" to " |s1= $1 |p1=")
m (Fix regex replace)
Tag: Undo
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofpe
|game1= ofpe
| 1.00
|version1= 1.00


|game2= arma1
|game2= arma1
Line 25: Line 25:
|gr1= Waypoints
|gr1= Waypoints


|s1= Adds (or inserts when index is given) a new waypoint to a group.
|descr= 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 waypoint is placed randomly within a circle with the given center and radius.


The function returns a waypoint with format [group, index].<br><br>  
The function returns a waypoint with format [group, index].<br><br>  
{{Feature | Informative | Prior to Arma 3 v1.90, if you need exact waypoint placement, use [[setWaypointPosition]]}}
{{Feature | Informative | Prior to {{arma3}} v1.90, if you need exact waypoint placement, use [[setWaypointPosition]]}}


| groupName '''addWaypoint''' [center, radius, index, name]
|s1= groupName [[addWaypoint]] [center, radius, index, name]
   
   
|p1=  groupName: [[Group]]
|p1=  groupName: [[Group]]
Line 38: Line 38:
|p2= center: [[PositionAGL]] ([[PositionASL]] if ''radius'' is negative!) or [[Object]]
|p2= center: [[PositionAGL]] ([[PositionASL]] if ''radius'' is negative!) or [[Object]]


|p3= radius: [[Number]] - random waypoint placement within ''radius'' from ''center'' {{Feature|arma3| Since Arma 3 v1.90, -1 may be used for exact waypoint placement}}
|p3= radius: [[Number]] - random waypoint placement within ''radius'' from ''center'' {{Feature|arma3| Since {{arma3}} v1.90, -1 may be used for exact waypoint placement}}


|p4= index (optional): [[Number]] - can be used to insert a waypoint in between existing waypoints
|p4= index (optional): [[Number]] - can be used to insert a waypoint in between existing waypoints
Line 44: Line 44:
|p5= name (optional): [[String]] - [[waypointName]]
|p5= name (optional): [[String]] - [[waypointName]]


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


|x1= <code>_wp <nowiki>=</nowiki>_grp [[addWaypoint]] [<nowiki/>[[position]] [[player]], 0];</code>
|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]]
}}
}}
{{GameCategory|ofpe|Scripting Commands}}
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}


<dl class="command_description">
<dl class="command_description">

Revision as of 16:46, 13 June 2021

ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobalGEGlobal
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].

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

Syntax

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

Examples

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

Additional Information

See also:
waypointscreateGuardedPointdeleteWaypointcopyWaypointsmovesetCurrentWaypointsetWaypointBehavioursetWaypointCombatModesetWaypointCompletionRadiussetWaypointDescriptionsetWaypointFormationsetWaypointHousePositionsetWaypointPositionsetWaypointScriptsetWaypointSpeedsetWaypointStatementssetWaypointTimeoutsetWaypointTypesetWaypointVisiblewaypointAttachVehiclewaypointAttachedVehiclesetWaypointLoiterRadiuswaypointLoiterRadiussetWaypointLoiterTypecurrentWaypointwaypointNamewaypointSpeedsetWPPos

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
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.
Retrieved from "https://community.bistudio.com/wiki?title=addWaypoint&oldid=276261"