getUnitState

From Bohemia Interactive Community
Revision as of 14:15, 22 October 2024 by Killzone Kid (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Returns current state of the given AI unit, which could be one of the following:
  • "WAIT" - another plan is needed (current partial plan was done or is not present)
  • "INIT" - operative planing should start, endpoint is set
  • "INITFAILED" - init failed because data are not ready
  • "BUSY" - operative plan ready and valid
  • "OK" - completed whole strategic plan
  • "DELAY" - repeat search, usually when failed
  • "CARGO" - unit is in vehicle cargo, no planning needed
  • "STOPPING" - unit is stopping (usually because of getin/getout request/landing)
  • "REPLAN" - we have a plan, but we would like to search a new one
  • "STOPPED" - unit is stopped, no planning needed (also landed. Different from stop command)
  • "PLANNING" - operative planning pending
Groups:
AI Behaviour

Syntax

Syntax:
getUnitState unit
Parameters:
unit: Object
Return Value:
String - unit state (see description)

Examples

Example 1:
_state = getUnitState bob; //"WAIT"

Additional Information

See also:
disableAI enableAI checkAIFeature enableAIFeature vehicleMoveInfo expectedDestination

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