expectedDestination: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (example)
No edit summary
 
(53 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= arma1
|version1= 1.00


|1.00|= Game version
|game2= arma2
|version2= 1.00


|arg= local |=
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| Return expected destination of unit as an array.|= Description
|game4= tkoh
____________________________________________________________________________________________
|version4= 1.00


| [[Array]] <nowiki>=</nowiki> '''expectedDestination''' person |= Syntax
|game5= arma3
|version5= 0.50


|p1= person: [[Object]]  |= Parameter 1
|arg= local


| [[Array]] in form:
|gr1= Unit Control
*0: [[Position]]
|gr2= AI Behaviour
*1: planningMode
*2: forceReplan|= Return value


|x1=<code>_data = [[expectedDestination]] [[player]];</code>|= EXAMPLE1
|descr= Return expected destination of unit as an array.
____________________________________________________________________________________________


| [[setDestination]] |= See also
|s1= [[expectedDestination]] person


}}
|p1= person: [[Object]]


<h3 style="display:none">Notes</h3>
|r1= [[Array]] in format [destination, planningMode, forceReplan] where:
<dl class="command_description">
* destination: [[Array]] format [[PositionAGL]]
<!-- Note Section BEGIN -->
* planningMode: [[String]] - can be one of:
** "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
* forceReplan: [[Boolean]] - specifies if path replanning was forced (through [[setDestination]])


<dd class="notedate">Posted on 16:24, 3 March 2007 (CET)
|x1= <sqf>_data = expectedDestination player;</sqf>
<dt class="note">'''[[User:Donnervogel|Donnervogel]]'''<dd class="note">For AI units I have found the following values: ''planningMode'' is "LEADER PLANNED" when the unit is ordered by the group leader to go somewhere or if the unit is the group leader and it follows a waypoint. Otherwise ''planningMode'' it is "DoNotPlan". Units moving in formation have "DoNotPlan" as long as they don't receive orders by the group leader. Units also have "DoNotPlan" when they don't move. Units executing special formation tasks like engaging or return to formation have "FORMATION PLANNED" as long they haven't fulfilled the task.


<!-- Note Section END -->
|seealso= [[setDestination]] [[getUnitState]]
</dl>
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
 
|user= Donnervogel
[[Category:Scripting Commands|EXPECTEDDESTINATION]]
|timestamp= 20070303162400
[[Category:Scripting Commands ArmA|EXPECTEDDESTINATION]]
|text= For AI units I have found the following values: ''planningMode'' is "LEADER PLANNED" when the unit is ordered by the group leader to go somewhere or if the unit is the group leader and it follows a waypoint. Otherwise ''planningMode'' it is "DoNotPlan". Units moving in formation have "DoNotPlan" as long as they don't receive orders by the group leader. Units also have "DoNotPlan" when they don't move. Units executing special formation tasks like engaging or return to formation have "FORMATION PLANNED" as long they have not fulfilled the task.
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 14:16, 22 October 2024

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LALocal
Hover & click on the images for description

Description

Description:
Return expected destination of unit as an array.
Groups:
Unit ControlAI Behaviour

Syntax

Syntax:
expectedDestination person
Parameters:
person: Object
Return Value:
Array in format [destination, planningMode, forceReplan] where:
  • destination: Array format PositionAGL
  • planningMode: String - can be one of:
    • "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
  • forceReplan: Boolean - specifies if path replanning was forced (through setDestination)

Examples

Example 1:
_data = expectedDestination player;

Additional Information

See also:
setDestination getUnitState

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
Donnervogel - c
Posted on Mar 03, 2007 - 16:24 (UTC)
For AI units I have found the following values: planningMode is "LEADER PLANNED" when the unit is ordered by the group leader to go somewhere or if the unit is the group leader and it follows a waypoint. Otherwise planningMode it is "DoNotPlan". Units moving in formation have "DoNotPlan" as long as they don't receive orders by the group leader. Units also have "DoNotPlan" when they don't move. Units executing special formation tasks like engaging or return to formation have "FORMATION PLANNED" as long they have not fulfilled the task.
Retrieved from "https://community.bistudio.com/wiki?title=expectedDestination&oldid=369980"