setDestination: Difference between revisions

Latest revision as of 03: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: @@
-[[Category:Scripting Commands|SETDestination]]
+{{RV|type=command
-[[Category:Scripting Commands OFP Elite |SETDestination]]
-[[Category:Scripting Commands ArmA|SETDestination]]
+|game1= ofpe
+|version1= 1.00
-<h2 style="color:#000066">'''''object'' setDestination ''[position, planningMode, forceReplan]'''''</h2>
+|game2= arma1
+|version2= 1.00
+|game3= arma2
+|version3= 1.00
-'''Operand types:'''
+|game4= arma2oa
+|version4= 1.50
-'''object:''' [[Object]]
+|game5= tkoh
-'''[position, planningMode, forceReplan]:''' [[Array]]
+|version5= 1.00
-'''Type of returned value:'''
+|game6= arma3
+|version6= 0.50
-[[Nothing]]
+|arg= local
-'''Compatibility:'''
+|eff= global
-Version 2.92 required.
+|gr1= Unit Control
-'''Description:'''
+|descr= Set the destination for path planning of the pilot.
-Set the destination for path planning of the pilot.
+Possible values for planningMode are:
-'''Example:'''
+* "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 {{hl|"PathCalculated"}} [[Arma_3:_Event_Handlers#PathCalculated | Event Handler]]
+|s1= object [[setDestination]] [position, planningMode, forceReplan]
+|p1= object: [[Object]]
+|p2= position: [[Array]] format [[Position]]
+|p3= planningMode: [[String]]
+|p4= forceReplan: [[Boolean]] - specifies if replanning of the path should be forced.
+|r1= [[Nothing]]
+|x1= <sqf>bob setDestination [screenToWorld [0.5,0.5], "LEADER PLANNED", true];</sqf>
+|seealso= [[expectedDestination]] [[doMove]] [[calculatePath]]
+}}