setWaypointType: Difference between revisions

Latest revision as of 15:38, 29 June 2024

1.00

1.50

1.00

0.50

Hover & click on the images for description

Description

Description:: Sets the waypoint type of given waypoint. More details at Waypoints.
Groups:: Waypoints

Syntax

Syntax:

waypoint setWaypointType type

Parameters:

waypoint: Array - format Waypoint

type: String - waypoint type. Can be:

"MOVE"
"DESTROY"
"GETIN"
"SAD" (Seek And Destroy)
"JOIN"
"LEADER"
"GETOUT"
"CYCLE"
"LOAD"
"UNLOAD"
"TR UNLOAD"
"HOLD"
"SENTRY"
"GUARD" (used with GUARDED BY trigger or createGuardedPoint)
"TALK"
"SCRIPTED"
"SUPPORT"
"GETIN NEAREST"
"DISMISS"
"LOITER" (Arma 3)
1.34 "HOOK" (slingload object)
1.34 "UNHOOK" (slingload drop)
"AND" (only for game logics)
"OR" (only for game logics)

Return Value:

Nothing

Examples

Example 1:: _myWaypoint setWaypointType "HOLD";

Additional Information

See also:: Waypoints Types waypointType

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

ArmAtec - c: Posted on Nov 23, 2007 - 07:44 (UTC)
: Using MOVE on a game logic group will move the logic to the set location just like setPos. In the editor, only AND and OR type of waypoints are available for GAME LOGICS but you can use CYCLE type as well with setWaypointType.

RHfront - c: Posted on May 06, 2017 - 16:09 (UTC)
: To use the LAND function in a waypoint, you must set "A3\functions_f\waypoints\fn_wpLand.sqf" as the script for that waypoint.

Nelis75733126 - c

Posted on May 30, 2017 - 09:14 (UTC)

In Arma 3 v1.70, if you add a MOVE waypoint very soon after a LOITER waypoint, (assuming that the index of the MOVE waypoint is HIGHER than the index of the LOITER waypoint) then the LOITER waypoint will be considered as a MOVE waypoint.
And, if you add another waypoint after ( for example ) more than 1 second after adding the LOITER waypoint, then the LOITER waypoint will never complete even when its condition has been met.
There are two ways to quit an existing LOITER waypoint that was added more than about 1 second before adding a MOVE waypoint:

use the setCurrentWaypoint command
create a waypoint that has the same ID as the LOITER waypoint.

The difference between those two methods is that the latter prevents the LOITER waypoint from executing its statement.

@@ Line 1: / Line 1: @@
-[[Category:Scripting Commands|SETWAYPOINTTYPE]]
+{{RV|type=command
-[[Category:Scripting Commands OFP Elite |SETWAYPOINTTYPE]]
-[[Category:Scripting Commands ArmA|SETWAYPOINTTYPE]]
+|game1= arma1
+|version1= 1.00
-<h2 style="color:#000066">'''''waypoint'' setWaypointType ''type'''''</h2>
+|game2= arma2
+|version2= 1.00
+|game3= arma2oa
+|version3= 1.50
-'''Operand types:'''
+|game4= tkoh
+|version4= 1.00
-'''waypoint:''' [[Array]]
+|game5= arma3
+|version5= 0.50
-'''type:''' [[String]]
+|gr1= Waypoints
-'''Type of returned value:'''
+|descr= Sets the waypoint type of given waypoint.
-[[Nothing]]
+More details at [[Waypoints]].
-'''Compatibility:'''
+|s1= waypoint [[setWaypointType]] type
-Version 1.86 required.
+|p1= waypoint: [[Array]] - format [[Waypoint]]
-'''Description:'''
+|p2= type: [[String]] - waypoint type. Can be:
+{{Columns|4|
+* {{hl|"MOVE"}}
+* {{hl|"DESTROY"}}
+* {{hl|"GETIN"}}
+* {{hl|"SAD"}} ''(Seek And Destroy)''
+* {{hl|"JOIN"}}
+* {{hl|"LEADER"}}
+* {{hl|"GETOUT"}}
+* {{hl|"CYCLE"}}
+* {{hl|"LOAD"}}
+* {{hl|"UNLOAD"}}
+* {{hl|"TR UNLOAD"}}
+* {{hl|"HOLD"}}
+* {{hl|"SENTRY"}}
+* {{hl|"GUARD"}} <small>(used with GUARDED BY trigger or [[createGuardedPoint]])</small>
+* {{hl|"TALK"}}
+* {{hl|"SCRIPTED"}}
+* {{hl|"SUPPORT"}}
+* {{hl|"GETIN NEAREST"}}
+* {{hl|"DISMISS"}}
+* {{hl|"LOITER"}} <small>({{arma3}})</small>
+* {{GVI|arma3|1.34|size= 0.75}} {{hl|"HOOK"}} <small>(slingload object)</small>
+* {{GVI|arma3|1.34|size= 0.75}} {{hl|"UNHOOK"}} <small>(slingload drop)</small>
+* {{hl|"AND"}} <small>(only for game logics)</small>
+* {{hl|"OR"}} <small>(only for game logics)</small>
+}}
-Changes the waypoint type.
+|r1= [[Nothing]]
-Type can be: "MOVE", "DESTROY", "GETIN", "SAD", "JOIN", "LEADER", "GETOUT", "CYCLE", "LOAD", "UNLOAD", "TR UNLOAD", "HOLD", "SENTRY", "GUARD", "TALK", "SCRIPTED", "SUPPORT", "GETIN NEAREST", "AND" or "OR".
+|x1= <sqf>_myWaypoint setWaypointType "HOLD";</sqf>
+|seealso= [[2D Editor: Waypoints#Select Type|Waypoints Types]] [[waypointType]]
+}}
-'''Example:'''
+{{Note
+|user= ArmAtec
+|timestamp= 20071123074400
+|text= Using '''MOVE''' on a game logic group will move the logic to the set location just like [[setPos]]. In the editor, only '''AND''' and '''OR''' type of waypoints are available for GAME LOGICS but you can use CYCLE type as well with [[setWaypointType]].
+}}
-[grp, 2] '''setWaypointType''' "HOLD"
+{{Note
+|user= RHfront
+|timestamp= 20170506160900
+|text= To use the '''LAND''' function in a waypoint, you must set ''"A3\functions_f\waypoints\fn_wpLand.sqf"'' as the script for that waypoint.
+}}
+{{Note
+|user= Nelis75733126
+|timestamp= 20170530091400
+|text= In '''{{arma3}} v1.70''', if you add a '''MOVE''' waypoint very soon after a '''LOITER''' waypoint, (assuming that the index of the MOVE waypoint is HIGHER than the index of the LOITER waypoint) then the LOITER waypoint will be considered as a MOVE waypoint.<br>
+And, if you add another waypoint after ( for example ) more than 1 second after adding the LOITER waypoint,
+then the LOITER waypoint will never complete even when its condition has been met.<br>
+There are two ways to quit an existing LOITER waypoint that was added more than about 1 second before adding a MOVE waypoint:
+* use the {{Link|setCurrentWaypoint|setCurrentWaypoint}} command
+* create a waypoint that has the same ID as the LOITER waypoint.
+The difference between those two methods is that the latter prevents the LOITER waypoint from executing its statement.
+}}