setDestination: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (VBS2 scripting category removal)
m (Undo revision 293726 by Zarickan (talk))
Tag: Undo
 
(46 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


| Set the destination for path planning of the pilot.
|game3= arma2
|version3= 1.00


Possible values for planningMode are:
|game4= arma2oa
|version4= 1.50
 
|game5= tkoh
|version5= 1.00
 
|game6= arma3
|version6= 0.50
 
|arg= local
 
|eff= global


"DoNotPlan",
|gr1= Unit Control


"LeaderPlanned",
|descr= Set the destination for path planning of the pilot.


"LeaderDirect",
Possible values for planningMode are:


"FormationPlanned",
* "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


"VehiclePlanned" |= Description
Works best when used on [[agents]]. Using "LEADER PLANNED" will trigger {{hl|"PathCalculated"}} [[Arma_3:_Event_Handlers#PathCalculated | Event Handler]]
____________________________________________________________________________________________


| object '''setDestination''' [position, planningMode, forceReplan] |= Syntax
|s1= object [[setDestination]] [position, planningMode, forceReplan]


|p1= object: [[Object]] |= Parameter 1
|p1= object: [[Object]]
|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
|p2= position: [[Array]] format [[Position]]
____________________________________________________________________________________________


| [[expectedDestination]], [[doMove]] |= See also
|p3= planningMode: [[String]]


}}
|p4= forceReplan: [[Boolean]] - specifies if replanning of the path should be forced.


<h3 style="display:none">Notes</h3>
|r1= [[Nothing]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>bob setDestination [screenToWorld [0.5,0.5], "LEADER PLANNED", true];</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[expectedDestination]] [[doMove]] [[calculatePath]]
[[Category:Scripting Commands|SETDESTINATION]]
}}
[[Category:Scripting Commands OFP Elite |SETDESTINATION]]
[[Category:Scripting Commands ArmA|SETDESTINATION]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]

Latest revision as of 02:09, 1 August 2022

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