setDestination: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|s([0-9])\= ([^' ]+)'''([^' ]+)'''([^ ]*) " to "|s$1= $2$3$4 ")
mNo edit summary
Line 42: Line 42:
|p1= object: [[Object]]
|p1= object: [[Object]]
|p2= [position, planningMode, forceReplan]: [[Array]]
|p2= [position, planningMode, forceReplan]: [[Array]]
|p3= position: [[Array]] - format [[Position]]
|p3= position: [[Position]]
|p4= planningMode: [[String]]
|p4= planningMode: [[String]]
|p5= forceReplan: [[Boolean]] Specifies if replanning of the path should be forced.
|p5= forceReplan: [[Boolean]] - Specifies if replanning of the path should be forced.


|r1= [[Nothing]]
|r1= [[Nothing]]

Revision as of 13:07, 9 October 2021

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: 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