setDestination: Difference between revisions

Latest revision as of 02:09, 1 August 2022

1.00

Hover & click on the images for description

Description

Description:

Set the destination for path planning of the pilot. Possible values for planningMode are:

"DoNotPlan" - used when not moving
"DoNotPlanFormation" - used in formation when simple path testing is used
"LEADER PLANNED" - used for formation leader (full path finding used)
"LEADER DIRECT" - used for DirectGo (like getin, supply)
"FORMATION PLANNED" - used in formation when full path finding is used
"VEHICLE PLANNED" - used for vehicle driver

Works best when used on agents. Using "LEADER PLANNED" will trigger "PathCalculated" Event Handler

Groups:

Unit Control

Syntax

Syntax:: object setDestination [position, planningMode, forceReplan]
Parameters:: object: Object
: position: Array format Position
: planningMode: String
: forceReplan: Boolean - specifies if replanning of the path should be forced.
Return Value:: Nothing

Examples

Example 1:: bob setDestination [screenToWorld [0.5,0.5], "LEADER PLANNED", true];

Additional Information

See also:: expectedDestination doMove calculatePath

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

@@ Line 1: / Line 1: @@
-{{Command|Comments=
+{{RV|type=command
-| arma1 |Game name=
+|game1= ofpe
+|version1= 1.00
-|1.00|Game version=
+|game2= arma1
+|version2= 1.00
-|arg= local |Arguments in MP=
+|game3= arma2
+|version3= 1.00
-|eff= global |Effects in MP=
+|game4= arma2oa
+|version4= 1.50
-|gr1= Unit Control |GROUP1=
+|game5= tkoh
+|version5= 1.00
-| Set the destination for path planning of the pilot.
+|game6= arma3
+|version6= 0.50
+|arg= local
+|eff= global
+|gr1= Unit Control
+|descr= Set the destination for path planning of the pilot.
 Possible values for planningMode are:
@@ Line 22: / Line 36: @@
 * "VEHICLE PLANNED" - used for vehicle driver
-Works best when used on [[agents]]. Using "LEADER PLANNED" will trigger <tt>"PathCalculated"</tt> [[Arma_3:_Event_Handlers#PathCalculated | Event Handler]] |Description=
+Works best when used on [[agents]]. Using "LEADER PLANNED" will trigger {{hl|"PathCalculated"}} [[Arma_3:_Event_Handlers#PathCalculated | Event Handler]]
+|s1= object [[setDestination]] [position, planningMode, forceReplan]
+|p1= object: [[Object]]
+|p2= position: [[Array]] format [[Position]]
-| object '''setDestination''' [position, planningMode, forceReplan] |Syntax=
+|p3= planningMode: [[String]]
-|p1= object: [[Object]] |Parameter 1=
+|p4= forceReplan: [[Boolean]] - specifies if replanning of the path should be forced.
-|p2= [position, planningMode, forceReplan]: [[Array]] |Parameter 2=
-|p3= position: [[Array]] - format [[Position]] |Parameter 3=
-|p4= planningMode: [[String]] |Parameter 4=
-|p5= forceReplan: [[Boolean]] Specifies if replanning of the path should be forced. |Parameter 5=
-| [[Nothing]] |Return value=
+|r1= [[Nothing]]
-|x1= <code>bob [[setDestination]] [<nowiki/>[[screenToWorld]] [0.5,0.5], "LEADER PLANNED", [[true]]]</code> |Example 1=
+|x1= <sqf>bob setDestination [screenToWorld [0.5,0.5], "LEADER PLANNED", true];</sqf>
-| [[expectedDestination]], [[doMove]], [[calculatePath]] |See also=
+|seealso= [[expectedDestination]] [[doMove]] [[calculatePath]]
 }}
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
-{{GameCategory|ofpe|Scripting Commands}}
-{{GameCategory|arma1|Scripting Commands}}
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}