addWaypoint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(Add Optional information)
 
(164 intermediate revisions by 27 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|ADDWAYPOINT]]
{{RV|type=command
[[Category:Scripting Commands OFP Elite |ADDWAYPOINT]]
[[Category:Scripting Commands ArmA|ADDWAYPOINT]]


|game1= ofpe
|version1= 1.00


|game2= arma1
|version2= 1.00


<h2 style="color:#000066">'''''group'' addWaypoint ''[center, radius]'''''</h2>
|game3= arma2
|version3= 1.00


|game4= arma2oa
|version4= 1.50


'''Operand types:'''
|game5= tkoh
|version5= 1.00


'''group''': [[Group]]
|game6= arma3
|version6= 0.50


'''[center, radius]''': [[Array]]
|arg= global


'''Type of returned value:'''
|eff= global


[[Array]]
|gr1= Waypoints


'''Compatibility:'''
|descr= Adds (or inserts when index is given) a new waypoint to a group.


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


'''Description:'''
{{Feature|informative|For older titles and prior to {{arma3}} v1.90, use [[setWaypointPosition]] if you need exact waypoint placement.}}


Adds a new waypoint to a '''group'''.
|s1= groupName [[addWaypoint]] [center, radius, index, name]


The waypoint is placed randomly in a circle with the given center and radius.
|p1= groupName: [[Group]]


The function returns a waypoint with format [group, index].
|p2= center: [[Array]] format [[Position#PositionAGL|PositionAGL]] ([[Position#PositionASL|PositionASL]] if ''radius'' is negative!) or [[Object]]


|p3= radius: [[Number]] - random waypoint placement within ''radius'' from ''center''; {{GVI|arma3|1.90|size= 0.75}} -1 can be used for exact waypoint placement


'''Example''':
|p4= 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


grp '''addWaypoint''' [ [[position]] [[player]], 0]
|p5= name: [[String]] - (Optional, default "") [[waypointName]]
 
|r1= [[Array]] format [[Waypoint]]
 
|x1= <sqf>_wp = _grp addWaypoint [position player, 0];</sqf>
 
|x2= <sqf>
_wp = _grp addWaypoint [position player, 0]; // imprecise, placed like [[setVehiclePosition]]'s "NONE" placement
_wp setWaypointPosition [getPosASL player, -1]; // from {{ofpe}} to {{arma3}} v1.88
 
private _wp = _grp addWaypoint [getPosASL player, -1]; // {{arma3}} v1.90+: precise placement
</sqf>
 
|seealso= [[waypoints]] [[createGuardedPoint]] [[deleteWaypoint]] [[copyWaypoints]] [[move]] [[setCurrentWaypoint]] [[setWaypointBehaviour]] [[setWaypointCombatMode]] [[setWaypointCompletionRadius]] [[setWaypointDescription]] [[setWaypointHousePosition]] [[setWaypointPosition]] [[currentWaypoint]] [[waypointName]] [[waypointSpeed]] [[setWPPos]]
}}
 
{{Note
|user= Tijmenjoppe
|timestamp= 20091126180700
|text= In game versions prior to {{arma3}} 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.
}}
 
{{Note
|user= Giova
|timestamp= 20140621223800
|text= 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 !<br>
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.<br>see [[move]] command.
}}
 
{{Note
|user= OdinViking
|timestamp= 20140805014900
|text= 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.
}}

Latest revision as of 12:09, 1 April 2024

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.
ⓘ
For older titles and prior to Arma 3 v1.90, use setWaypointPosition if you need exact waypoint placement.
Groups:
Waypoints

Syntax

Syntax:
groupName addWaypoint [center, radius, index, name]
Parameters:
groupName: Group
center: Array format PositionAGL (PositionASL if radius is negative!) or Object
radius: Number - random waypoint placement within radius from center; Arma 3 logo black.png1.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
Return Value:
Array format 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

Additional Information

See also:
waypoints createGuardedPoint deleteWaypoint copyWaypoints move setCurrentWaypoint setWaypointBehaviour setWaypointCombatMode setWaypointCompletionRadius setWaypointDescription setWaypointHousePosition setWaypointPosition currentWaypoint waypointName waypointSpeed setWPPos

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
Tijmenjoppe - c
Posted on Nov 26, 2009 - 18:07 (UTC)
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 - c
Posted on Jun 21, 2014 - 22:38 (UTC)
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 - c
Posted on Aug 05, 2014 - 01:49 (UTC)
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=363497"