setDestination: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(locality)
Line 1: Line 1:
{{Command|= Comments
{{Command|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma |= Game name
| arma |Game name=


|1.00|= Game version
|1.00|Game version=


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


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


Line 22: Line 22:
* "VEHICLE PLANNED" - used for vehicle driver
* "VEHICLE PLANNED" - used for vehicle driver


Works best when used on [[agents]]
Works best when used on [[agents]]. |Description=


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


| object '''setDestination''' [position, planningMode, forceReplan] |= Syntax
|p1= object: [[Object]] |Parameter 1=
|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=


|p1= object: [[Object]] |= Parameter 1
| [[Nothing]] |Return value=
|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
|x1= <code>bob [[setDestination]] <nowiki>[</nowiki>[[screenToWorld]] [0.5,0.5], "LEADER PLANNED", [[true]]]</code> |Example 1=
 
|x1= <code>bob [[setDestination]] <nowiki>[</nowiki>[[screenToWorld]] [0.5,0.5], "LEADER PLANNED", [[true]]]</code> |= Example 1
____________________________________________________________________________________________
____________________________________________________________________________________________


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


Line 51: Line 48:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|SETDESTINATION]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP Elite |SETDESTINATION]]
[[Category:Scripting Commands OFP Elite |{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|SETDESTINATION]]
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Command Group: Waypoints]]

Revision as of 23:00, 20 March 2019

-wrong parameter ("Arma") defined!-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.
Groups:
Uncategorised

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

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

Notes

Bottom Section