setDestination: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma1 |Game name=
| arma1


|1.00|Game version=
|1.00


|arg= local |Arguments in MP=
|arg= local


|eff= global |Effects in MP=
|eff= global


|gr1= Unit Control |GROUP1=
|gr1= Unit Control


| Set the destination for path planning of the pilot.
| Set the destination for path planning of the pilot.
Line 22: Line 22:
* "VEHICLE PLANNED" - used for vehicle driver
* "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 <tt>"PathCalculated"</tt> [[Arma_3:_Event_Handlers#PathCalculated | Event Handler]]


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


|p1= object: [[Object]] |Parameter 1=
|p1= object: [[Object]]
|p2= [position, planningMode, forceReplan]: [[Array]] |Parameter 2=
|p2= [position, planningMode, forceReplan]: [[Array]]
|p3= position: [[Array]] - format [[Position]] |Parameter 3=
|p3= position: [[Array]] - format [[Position]]
|p4= planningMode: [[String]] |Parameter 4=
|p4= planningMode: [[String]]
|p5= forceReplan: [[Boolean]] Specifies if replanning of the path should be forced. |Parameter 5=
|p5= forceReplan: [[Boolean]] Specifies if replanning of the path should be forced.


| [[Nothing]] |Return value=
| [[Nothing]]


|x1= <code>bob [[setDestination]] [<nowiki/>[[screenToWorld]] [0.5,0.5], "LEADER PLANNED", [[true]]]</code> |Example 1=
|x1= <code>bob [[setDestination]] [<nowiki/>[[screenToWorld]] [0.5,0.5], "LEADER PLANNED", [[true]]]</code>


| [[expectedDestination]], [[doMove]], [[calculatePath]] |See also=
| [[expectedDestination]], [[doMove]], [[calculatePath]]
}}
}}


Revision as of 11:09, 18 January 2021

Logo A1 black.png1.00
LALocalGEGlobal
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, planningMode, forceReplan]: Array
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:
expectedDestinationdoMovecalculatePath

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
Retrieved from "https://community.bistudio.com/wiki?title=setDestination&oldid=210671"