addWaypoint: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
Lou Montana (talk | contribs) (Add Optional information) |
||
(161 intermediate revisions by 27 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| | |game1= ofpe | ||
|version1= 1.00 | |||
|1. | |game2= arma1 | ||
|version2= 1.00 | |||
| | |game3= arma2 | ||
|version3= 1.00 | |||
| | |game4= arma2oa | ||
|version4= 1.50 | |||
| | |game5= tkoh | ||
|version5= 1.00 | |||
| | |game6= arma3 | ||
|version6= 0.50 | |||
| | |arg= global | ||
| | |eff= global | ||
|gr1= Waypoints | |||
|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. | |||
{{Feature|informative|For older titles and prior to {{arma3}} v1.90, use [[setWaypointPosition]] if you need exact waypoint placement.}} | |||
|s1= groupName [[addWaypoint]] [center, radius, index, name] | |||
|p1= groupName: [[Group]] | |||
|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 | |||
|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 | |||
|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
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.
- 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; 1.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:
- Example 2:
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
- 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.
- 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.
- 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.
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint: Elite version 1.00
- Operation Flashpoint: Elite: New Scripting Commands
- Operation Flashpoint: Elite: Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: Waypoints
- Scripting Commands: Global Effect