setWaypointType: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Add waypoint types, fix example, comment cleanup)
m (mistake in link to setWaypoint command)
 
(44 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


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


|1.00|Game version=
|game2= arma2
____________________________________________________________________________________________
|version2= 1.00


| Changes the waypoint type.  
|game3= arma2oa
|version3= 1.50


Type can be:
|game4= tkoh
* <tt>"MOVE"</tt>
|version4= 1.00
* <tt>"DESTROY"</tt>
* <tt>"GETIN"</tt>
* <tt>"SAD"</tt> ''(Seek And Destroy)''
* <tt>"JOIN"</tt>
* <tt>"LEADER"</tt>
* <tt>"GETOUT"</tt>
* <tt>"CYCLE"</tt>
* <tt>"LOAD"</tt>
* <tt>"UNLOAD"</tt>
* <tt>"TR UNLOAD"</tt>
* <tt>"HOLD"</tt>
* <tt>"SENTRY"</tt>
* <tt>"GUARD"</tt> ''(for use with GUARDED BY trigger or [[createGuardedPoint]])''
* <tt>"TALK"</tt>
* <tt>"SCRIPTED"</tt>
* <tt>"SUPPORT"</tt>
* <tt>"GETIN NEAREST"</tt>
* <tt>"DISMISS"</tt>
* <tt>"LOITER"</tt> ''(new in Arma 3)''
* <tt>"HOOK"</tt> ''(new in Arma 3)'' - slingload object
* <tt>"UNHOOK"</tt> ''(new in Arma 3)'' - drop slingload
* <tt>"AND"</tt> ''(only for game logics)''
* <tt>"OR"</tt> ''(only for game logics)''


More details at [[Waypoint types]]. |Description=
|game5= arma3
____________________________________________________________________________________________
|version5= 0.50


| waypoint [[setWaypointType]] type |Syntax=
|gr1= Waypoints


|p1= waypoint: [[Array]] - format [[Waypoint]] |Parameter 1=
|descr= Sets the waypoint type of given waypoint.


|p2= type: [[String]] |Parameter 2=
More details at [[Waypoints]].


| [[Nothing]] |Return value=
|s1= waypoint [[setWaypointType]] type
____________________________________________________________________________________________
 
|x1= <code>_myWaypoint [[setWaypointType]] "HOLD";</code> |Example 1=
____________________________________________________________________________________________


| [[Mission_Editor:_Waypoints#Select_Type|waypoints description]], [[Waypoint types]], [[waypoints]], [[deleteWaypoint]], [[copyWaypoints]], [[setCurrentWaypoint]], [[setWaypointBehaviour]], [[setWaypointCombatMode]], [[setWaypointCompletionRadius]], [[setWaypointDescription]], [[setWaypointFormation]], [[setWaypointHousePosition]], [[setWaypointPosition]], [[setWaypointScript]], [[setWaypointSpeed]], [[setWaypointStatements]], [[setWaypointTimeout]], [[setWaypointVisible]], [[waypointAttachVehicle]], [[waypointAttachedVehicle]], [[setWaypointLoiterRadius]], [[waypointLoiterRadius]], [[addWaypoint]], [[setWaypointLoiterType]], [[waypointSpeed]], [[createGuardedPoint]] |See also=
|p1= waypoint: [[Array]] - format [[Waypoint]]
 
|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>
}}
 
|r1= [[Nothing]]
 
|x1= <sqf>_myWaypoint setWaypointType "HOLD";</sqf>
 
|seealso= [[2D Editor: Waypoints#Select Type|Waypoints Types]] [[waypointType]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= ArmAtec
<!-- Note Section BEGIN -->
|timestamp= 20071123074400
<dd class="notedate">Posted on 07:44, 23 November 2007
|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]].
<dt class="note">[[User:User:ArmAtec|ArmAtec]]</dt>
}}
<dd class="note">
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]].
</dd>


<dd class="notedate">Posted on May 6, 2017 - 16:09 (UTC)</dd>
{{Note
<dt class="note">[[User:RHfront|RHfront]]</dt>
|user= RHfront
<dd class="note">
|timestamp= 20170506160900
To use the '''LAND''' function in a waypoint, you must set ''"A3\functions_f\waypoints\fn_wpLand.sqf"'' as the script for that waypoint.
|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.
</dd>
}}


<dd class="notedate">Posted on May 30, 2017 - 09:14 (UTC)</dd>
{{Note
<dt class="note">[[User:IT07|IT07]]</dt>
|user= Nelis.75733126
<dd class="note">
|timestamp= 20170530091400
In '''Arma 3 v1.70.141838''', 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>
|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,
And, if you add another waypoint after ( for example ) more than 1 second after adding the LOITER waypoint,
then the LOITER waypoint will NOT complete even when its condition has been met.<br>
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 ago:
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
* use the {{Link|https://community.bistudio.com/wiki/setCurrentWaypoint|setCurrentWaypoint}} command
* add a waypoint that has the same ID as the LOITER waypoint.
* 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.
The difference between those two methods is that the latter prevents the LOITER waypoint from executing its statement.
</dd>
}}
</dl>
<!-- Note Section END -->
 
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP Elite |{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Waypoints|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 21:07, 16 April 2024

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.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)
  • Arma 3 logo black.png1.34 "HOOK" (slingload object)
  • Arma 3 logo black.png1.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.
Nelis.75733126 - 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.
Retrieved from "https://community.bistudio.com/wiki?title=setWaypointType&oldid=363722"