deleteWaypoint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Add forEachReversed example)
 
(98 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= ofpe
|version1= 1.00


|1.00|= Game version
|game2= arma1
|version2= 1.00


|arg= global |= Arguments in MP
|game3= arma2
|version3= 1.00


|eff= global |= Effects in MP
|game4= arma2oa
____________________________________________________________________________________________
|version4= 1.50


| Removes the specified waypoint. |DESCRIPTION=
|game5= tkoh
____________________________________________________________________________________________
|version5= 1.00


| '''deleteWaypoint''' [group, index] |SYNTAX=
|game6= arma3
|version6= 0.50


|arg= global


|p1=  [group, index]: [[Array]] |PARAMETER1=
|eff= global
|p2=  group: [[Group]] |PARAMETER2=
|p3= index: [[Number]] |PARAMETER3=


| [[Nothing]] |RETURNVALUE=
|gr1= Waypoints
____________________________________________________________________________________________
 
|x1= <code>[[deleteWaypoint]] [_grp, 2]</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[waypoints]], [[copyWaypoints]], [[setCurrentWaypoint]], [[setWaypointBehaviour]], [[setWaypointCombatMode]], [[setWaypointCompletionRadius]], [[setWaypointDescription]], [[setWaypointFormation]], [[setWaypointHousePosition]], [[setWaypointPosition]], [[setWaypointScript]], [[setWaypointSpeed]], [[setWaypointStatements]], [[setWaypointTimeout]], [[setWaypointType]], [[setWaypointVisible]], [[waypointAttachVehicle]], [[waypointAttachedVehicle]], [[setWaypointLoiterRadius]], [[waypointLoiterRadius]], [[addWaypoint]], [[setWaypointLoiterType]], [[waypointSpeed]] |SEEALSO=
|descr= Removes the specified waypoint.
{{Feature|informative|
* When a waypoint is deleted, all other [[group]] [[waypoints]] are immediately re-indexed. See {{Link|#Example 2}} for a deletion of all group's waypoints.
* Deleting a group's [[currentWaypoint|current waypoint]] will ''not'' stop the group on its tracks.
}}
 
|s1= [[deleteWaypoint]] [group, index]
 
|p1= group: [[Group]]
 
|p2= index: [[Number]]
 
|r1= [[Nothing]]
 
|x1= <sqf>deleteWaypoint [_grp, 2];</sqf>
 
|x2= Because waypoints get immediately re-indexed when one gets deleted, delete them from last to first:
<sqf>
private _group = group _unit;
for "_i" from (count waypoints _group - 1) to 0 step -1 do
{
deleteWaypoint [_group, _i];
};
</sqf>
or always delete the first one (if you want to delete them all)
<sqf>
private _group = group _unit;
for "_i" from 0 to (count waypoints _group - 1) do
{
deleteWaypoint [_group, 0];
};
</sqf>
or use [[forEachReversed]]:
<sqf>
{ deleteWaypoint _x } forEachReversed waypoints _group; // Arma 3 v2.14+ only
</sqf>


|seealso= [[waypoints]] [[setCurrentWaypoint]] [[setWaypointPosition]] [[setWaypointScript]] [[setWaypointStatements]] [[setWaypointType]] [[addWaypoint]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Saintolaf
<!-- Note Section BEGIN -->
|timestamp= 20080101074800
<dd class="notedate">Posted on 1 Feb, 2008 - 07:48
|text= In order to change the behavior of a unit currently following some waypoints, it is not enough to use [[deleteWaypoint]].
<dt class="note">[[User:Saintolaf|Saintolaf]]
To achieve the wanted effect, you should rather use [[setWPPos]] to the unit's current position (thereby stopping the unit), and (after a small delay) use [[deleteWaypoint]] to remove the next [[waypoints]].
<dd class="note">
}}
In order to change the behavior of a unit currently following a string of waypoints, it is not enough to use deleteWaypoint. The path of the unit is calculated by the waypoints present at start, and the unit will continue according to the original waypoints even if you delete them by using this command.
To achieve the wanted effect, you should rather use setWPPos to the units current position (thereby stopping the unit), and (after a small delay) use [[deleteWaypoint]] to remove the [[waypoints]].


<dd class="notedate">Posted on 15 Nov, 2008 - 13:37
{{Note
<dt class="note">'''[[User:VictorFarbau|VictorFarbau]]'''
|user= VictorFarbau
<dd class="note">
|timestamp= 20081115133700
Another (more foolproof) method to avoid the problem of non-deleteable waypoints is to introduce another group (createGroup) and join all units of the present group. A new group will start without any preset waypoints so you can start setting new WPs all over again.
|text= Another (more foolproof) method to avoid the problem of non-deleteable waypoints is to introduce another group ([[createGroup]]) and [[join]] all units of the present group. A new group will start without any preset waypoints so you can start setting new WPs all over again.
Old group is "_combatGroup", new group is "_combatGroup2"
Old group is "_combatGroup", new group is "_combatGroup2"
<code>_combatGroup2 = [[createGroup]] EAST;
<sqf>
{[_x] [[joinSilent]] _combatGroup2} [[forEach]] ([[units]] _combatGroup);
_combatGroup2 = createGroup east;
_combatGroup2 [[addWaypoint]] [ [[getPos]] [[player]], 25];</code>
{ [_x] joinSilent _combatGroup2 } forEach (units _combatGroup);
_combatGroup2 addWaypoint [getPos player, 25];
</sqf>
}}


{{Note
|user= Mr H.
|timestamp= 20191117165200
|text= To have the unit stop on the spot you need to set its current waypoint where it is and add a little delay, as stated above by [[User|Saintolaf]] so:


<dd class="notedate">Posted on January 04, 2011
<sqf>
<dt class="note">'''[[User:kju|kju]]'''
group _unit spawn
<dd class="note">
{
When you want to remove all waypoints, do '''NOT''' iterate over ''waypoints _group'' while trying to delete them (an array is by reference!). Instead use an approach like this:
[_this, currentWaypoint _this] setWaypointPosition [getPosASL ((units _this) select 0), -1];
<code>
sleep 0.1;
[[while]] {([[count]] ([[waypoints]] _group)) > 0} [[do]]
for "_i" from count waypoints _this - 1 to 0 step -1 do  
{
{
  [[deleteWaypoint]] (([[waypoints]] _group) [[select]] 0);
deleteWaypoint [_this, _i];
};</code>
};
<!-- Note Section END -->
};
</dl>
</sqf>
 
Will stop the group where it is and delete its waypoints.
<h3 style="display:none">Bottom Section</h3>
}}
 
[[Category:Scripting Commands|DELETEWAYPOINT]]
[[Category:Scripting Commands OFP Elite |DELETEWAYPOINT]]
[[Category:Scripting Commands ArmA|DELETEWAYPOINT]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Waypoints|{{uc:{{PAGENAME}}}}]]

Latest revision as of 19:09, 27 April 2023

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:
Removes the specified waypoint.
ⓘ
  • When a waypoint is deleted, all other group waypoints are immediately re-indexed. See Example 2 for a deletion of all group's waypoints.
  • Deleting a group's current waypoint will not stop the group on its tracks.
Groups:
Waypoints

Syntax

Syntax:
deleteWaypoint [group, index]
Parameters:
group: Group
index: Number
Return Value:
Nothing

Examples

Example 1:
deleteWaypoint [_grp, 2];
Example 2:
Because waypoints get immediately re-indexed when one gets deleted, delete them from last to first:
private _group = group _unit; for "_i" from (count waypoints _group - 1) to 0 step -1 do { deleteWaypoint [_group, _i]; };
or always delete the first one (if you want to delete them all)
private _group = group _unit; for "_i" from 0 to (count waypoints _group - 1) do { deleteWaypoint [_group, 0]; };
or use forEachReversed:
{ deleteWaypoint _x } forEachReversed waypoints _group; // Arma 3 v2.14+ only

Additional Information

See also:
waypoints setCurrentWaypoint setWaypointPosition setWaypointScript setWaypointStatements setWaypointType addWaypoint

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
Saintolaf - c
Posted on Jan 01, 2008 - 07:48 (UTC)
In order to change the behavior of a unit currently following some waypoints, it is not enough to use deleteWaypoint. To achieve the wanted effect, you should rather use setWPPos to the unit's current position (thereby stopping the unit), and (after a small delay) use deleteWaypoint to remove the next waypoints.
VictorFarbau - c
Posted on Nov 15, 2008 - 13:37 (UTC)
Another (more foolproof) method to avoid the problem of non-deleteable waypoints is to introduce another group (createGroup) and join all units of the present group. A new group will start without any preset waypoints so you can start setting new WPs all over again. Old group is "_combatGroup", new group is "_combatGroup2"
_combatGroup2 = createGroup east; { [_x] joinSilent _combatGroup2 } forEach (units _combatGroup); _combatGroup2 addWaypoint [getPos player, 25];
Mr H. - c
Posted on Nov 17, 2019 - 16:52 (UTC)
To have the unit stop on the spot you need to set its current waypoint where it is and add a little delay, as stated above by Saintolaf so:
group _unit spawn { [_this, currentWaypoint _this] setWaypointPosition [getPosASL ((units _this) select 0), -1]; sleep 0.1; for "_i" from count waypoints _this - 1 to 0 step -1 do { deleteWaypoint [_this, _i]; }; };
Will stop the group where it is and delete its waypoints.
Retrieved from "https://community.bistudio.com/wiki?title=deleteWaypoint&oldid=339202"