Banner Image

Module AI.AI_Air

AI - Models the process of AI air operations.


Author: FlightControl


Global(s)

Global AI_AIR

The AI_AIR class implements the core functions to operate an AI Wrapper.Group.

#AI_AIR AI_AIR

The AI_AIR class implements the core functions to operate an AI Wrapper.Group.

1) AI_AIR constructor

2) AI_AIR is a Finite State Machine.

This section must be read as follows. Each of the rows indicate a state transition, triggered through an event, and with an ending state of the event was executed. The first column is the From state, the second column the Event, and the third column the To state.

So, each of the rows have the following structure.

  • From => Event => To

Important to know is that an event can only be executed if the current state is the From state. This, when an Event that is being triggered has a From state that is equal to the Current state of the state machine, the event will be executed, and the resulting state will be the To state.

These are the different possible state transitions of this state machine implementation:

  • Idle => Start => Monitoring

2.1) AI_AIR States.

  • Idle: The process is idle.

2.2) AI_AIR Events.

  • Start: Start the transport process.
  • Stop: Stop the transport process.
  • Monitor: Monitor and take action.

Developer Note

Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE Therefore, this class is considered to be deprecated

Type(s)

Fields and Methods inherited from AI_AIR Description

AI_AIR.CheckStatus

AI_AIR:ClearTargetDistance()

AI_AIR.DisengageRadius

AI_AIR.FuelThresholdPercentage

AI_AIR:GetDispatcher()

AI_AIR.HomeAirbase

AI_AIR.IdleCount

AI_AIR:New(AIGroup)

Creates a new AI_AIR process.

AI_AIR:OnAfterRTB(Controllable, From, Event, To)

OnAfter Transition Handler for Event RTB.

AI_AIR:OnAfterRefuel(Controllable, From, Event, To)

Refuel Handler OnAfter for AI_AIR

AI_AIR:OnAfterStart(From, Event, To)

Start Handler OnAfter for AI_AIR

AI_AIR:OnAfterStatus(Controllable, From, Event, To)

OnAfter Transition Handler for Event Status.

AI_AIR:OnAfterStop(Controllable, From, Event, To)

OnAfter Transition Handler for Event Stop.

AI_AIR:OnBeforeRTB(Controllable, From, Event, To)

OnBefore Transition Handler for Event RTB.

AI_AIR:OnBeforeRefuel(Controllable, From, Event, To)

Refuel Handler OnBefore for AI_AIR

AI_AIR:OnBeforeStart(From, Event, To)

Start Handler OnBefore for AI_AIR

AI_AIR:OnBeforeStatus(Controllable, From, Event, To)

OnBefore Transition Handler for Event Status.

AI_AIR:OnBeforeStop(Controllable, From, Event, To)

OnBefore Transition Handler for Event Stop.

AI_AIR:OnCrash(EventData)

AI_AIR:OnEjection(EventData)

AI_AIR:OnEnterReturning(Controllable, From, Event, To)

OnEnter Transition Handler for State Returning.

AI_AIR:OnEnterStopped(Controllable, From, Event, To)

OnEnter Transition Handler for State Stopped.

AI_AIR:OnLeaveReturning(Controllable, From, Event, To)

OnLeave Transition Handler for State Returning.

AI_AIR:OnLeaveStopped(Controllable, From, Event, To)

OnLeave Transition Handler for State Stopped.

AI_AIR:OnPilotDead(EventData)

AI_AIR.OutOfFuelOrbitTime

AI_AIR.PatrolCeilingAltitude

AI_AIR.PatrolDamageThreshold

AI_AIR.PatrolFloorAltitude

AI_AIR.PatrolManageDamage

AI_AIR.PatrolMaxSpeed

AI_AIR.PatrolMinSpeed

AI_AIR:RTB()

Synchronous Event Trigger for Event RTB.

AI_AIR.RTBHold(AIGroup, Fsm)

AI_AIR.RTBMaxSpeed

AI_AIR.RTBMinSpeed

AI_AIR.RTBRoute(AIGroup, Fsm)

AI_AIR.RTBSpeedMaxFactor

AI_AIR.RTBSpeedMinFactor

AI_AIR:Refuel()

Refuel Trigger for AI_AIR

AI_AIR.Resume(AIGroup, Fsm)

AI_AIR:SetAltitude(PatrolFloorAltitude, PatrolCeilingAltitude)

Sets the floor and ceiling altitude of the patrol.

AI_AIR:SetDamageThreshold(PatrolDamageThreshold)

When the AI is damaged beyond a certain threshold, it is required that the AI returns to the home base.

AI_AIR:SetDisengageRadius(DisengageRadius)

Sets the disengage range, that when engaging a target beyond the specified range, the engagement will be cancelled and the plane will RTB.

AI_AIR:SetDispatcher(Dispatcher)

AI_AIR:SetFuelThreshold(FuelThresholdPercentage, OutOfFuelOrbitTime)

When the AI is out of fuel, it is required that a new AI is started, before the old AI can return to the home base.

AI_AIR:SetHomeAirbase(HomeAirbase)

Sets the home airbase.

AI_AIR:SetRTBSpeed(RTBMinSpeed, RTBMaxSpeed)

Sets (modifies) the minimum and maximum RTB speed of the patrol.

AI_AIR:SetRTBSpeedFactors(MinFactor, MaxFactor)

Set the min and max factors on RTB speed.

AI_AIR:SetSpeed(PatrolMinSpeed, PatrolMaxSpeed)

Sets (modifies) the minimum and maximum speed of the patrol.

AI_AIR:SetStatusOff()

Set the status checking off.

AI_AIR:SetTanker(TankerName)

Sets to refuel at the given tanker.

AI_AIR:SetTargetDistance(Coordinate)

AI_AIR:Start()

Start Trigger for AI_AIR

AI_AIR:Status()

Synchronous Event Trigger for Event Status.

AI_AIR:Stop()

Synchronous Event Trigger for Event Stop.

AI_AIR.TankerName

AI_AIR.TaskDelay

AI_AIR:__RTB(Delay)

Asynchronous Event Trigger for Event RTB.

AI_AIR:__Refuel(Delay)

Refuel Asynchronous Trigger for AI_AIR

AI_AIR:__Start(Delay)

Start Asynchronous Trigger for AI_AIR

AI_AIR:__Status(Delay)

Asynchronous Event Trigger for Event Status.

AI_AIR:__Stop(Delay)

Asynchronous Event Trigger for Event Stop.

AI_AIR:onafterDead()

AI_AIR:onafterHold(AIGroup, From, Event, To, HoldTime)

AI_AIR:onafterHome(AIGroup, From, Event, To)

AI_AIR:onafterRTB(AIGroup, From, Event, To)

AI_AIR:onafterRefuel(AIGroup, From, Event, To)

AI_AIR:onafterReturn(Controllable, From, Event, To)

Coordinates the approriate returning action.

AI_AIR:onafterStart(Controllable, From, Event, To)

Defines a new patrol route using the AI.AI_Patrol#AI_PATROL_ZONE parameters and settings.

AI_AIR:onafterStatus()

AI_AIR:onbeforeStatus()

Fields and Methods inherited from FSM_CONTROLLABLE Description

AI_AIR.Controllable

AI_AIR:GetControllable()

Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

AI_AIR:New(FSMT, Controllable)

Creates a new FSM_CONTROLLABLE object.

AI_AIR:OnAfterStop(Controllable, From, Event, To)

OnAfter Transition Handler for Event Stop.

AI_AIR:OnBeforeStop(Controllable, From, Event, To)

OnBefore Transition Handler for Event Stop.

AI_AIR:OnEnterStopped(Controllable, From, Event, To)

OnEnter Transition Handler for State Stopped.

AI_AIR:OnLeaveStopped(Controllable, From, Event, To)

OnLeave Transition Handler for State Stopped.

AI_AIR:SetControllable(FSMControllable)

Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

AI_AIR:Stop()

Synchronous Event Trigger for Event Stop.

AI_AIR:__Stop(Delay)

Asynchronous Event Trigger for Event Stop.

AI_AIR:_call_handler(step, trigger, params, EventName)

Fields and Methods inherited from FSM Description

AI_AIR:AddEndState(State)

Adds an End state.

AI_AIR:AddProcess(From, Event, Process, ReturnEvents)

Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

AI_AIR:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

AI_AIR:AddScoreProcess(From, Event, State, ScoreText, Score)

Adds a score for the FSM_PROCESS to be achieved.

AI_AIR:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

AI_AIR.CallScheduler

AI_AIR.Events

AI_AIR:GetCurrentState()

Get current state.

AI_AIR:GetEndStates()

Returns the End states.

AI_AIR:GetProcess(From, Event)

AI_AIR:GetProcesses()

Returns a table of the SubFSM rules defined within the FSM.

AI_AIR:GetScores()

Returns a table with the scores defined.

AI_AIR:GetStartState()

Returns the start state of the FSM.

AI_AIR:GetState()

Get current state.

AI_AIR:GetSubs()

Returns a table with the Subs defined.

AI_AIR:GetTransitions()

Returns a table of the transition rules defined within the FSM.

AI_AIR:Is(State)

Check if FSM is in state.

AI_AIR:LoadCallBacks(CallBackTable)

Load call backs.

AI_AIR:New()

Creates a new FSM object.

AI_AIR.Scores

AI_AIR:SetProcess(From, Event, Fsm)

AI_AIR:SetStartState(State)

Sets the start state of the FSM.

AI_AIR._EndStates

AI_AIR._EventSchedules

AI_AIR._Processes

AI_AIR._Scores

AI_AIR._StartState

AI_AIR._Transitions

AI_AIR:_add_to_map(Map, Event)

Add to map.

AI_AIR:_call_handler(step, trigger, params, EventName)

Call handler.

AI_AIR:_create_transition(EventName)

Create transition.

AI_AIR:_delayed_transition(EventName)

Delayed transition.

AI_AIR:_eventmap(Events, EventStructure)

Event map.

AI_AIR:_gosub(ParentFrom, ParentEvent)

Go sub.

AI_AIR:_handler(EventName, ...)

Handler.

AI_AIR:_isendstate(Current)

Is end state.

AI_AIR:_submap(subs, sub, name)

Sub maps.

AI_AIR:can(e)

Check if can do an event.

AI_AIR:cannot(e)

Check if cannot do an event.

AI_AIR.current

AI_AIR.endstates

AI_AIR:is(State, state)

Check if FSM is in state.

AI_AIR.options

AI_AIR.subs

Field(s)

#number AI_AIR.TaskDelay

The delay of each task given to the AI.

Function(s)

Defined in:

AI_AIR

Defined in:

AI_AIR

Creates a new AI_AIR process.

Defined in:

AI_AIR

Parameter:

The group object to receive the A2G Process.

Return value:

OnAfter Transition Handler for Event RTB.

Defined in:

AI_AIR

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Refuel Handler OnAfter for AI_AIR

Defined in:

AI_AIR

Parameters:

The Controllable Object managed by the FSM.

#string From

#string Event

#string To

Start Handler OnAfter for AI_AIR

Defined in:

AI_AIR

Parameters:

#string From

#string Event

#string To

OnAfter Transition Handler for Event Status.

Defined in:

AI_AIR

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnAfter Transition Handler for Event Stop.

Defined in:

AI_AIR

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnBefore Transition Handler for Event RTB.

Defined in:

AI_AIR

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

Refuel Handler OnBefore for AI_AIR

Defined in:

AI_AIR

Parameters:

The Controllable Object managed by the FSM.

#string From

#string Event

#string To

Return value:

#boolean:

Start Handler OnBefore for AI_AIR

Defined in:

AI_AIR

Parameters:

#string From

#string Event

#string To

Return value:

#boolean:

OnBefore Transition Handler for Event Status.

Defined in:

AI_AIR

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

OnBefore Transition Handler for Event Stop.

Defined in:

AI_AIR

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

@param #AI_AIR self @param Core.Event#EVENTDATA EventData

Defined in:

AI_AIR

Parameter:

EventData

@param #AI_AIR self @param Core.Event#EVENTDATA EventData

Defined in:

AI_AIR

Parameter:

EventData

OnEnter Transition Handler for State Returning.

Defined in:

AI_AIR

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnEnter Transition Handler for State Stopped.

Defined in:

AI_AIR

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnLeave Transition Handler for State Returning.

Defined in:

AI_AIR

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

OnLeave Transition Handler for State Stopped.

Defined in:

AI_AIR

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

@param #AI_AIR self @param Core.Event#EVENTDATA EventData

Defined in:

AI_AIR

Parameter:

EventData

Synchronous Event Trigger for Event RTB.

Defined in:

AI_AIR

@param Wrapper.Group#GROUP AIGroup

Defined in:

AI_AIR

Parameters:

AIGroup

Fsm

@param Wrapper.Group#GROUP AIGroup

Defined in:

AI_AIR

Parameters:

AIGroup

Fsm

Refuel Trigger for AI_AIR

Defined in:

AI_AIR

@param Wrapper.Group#GROUP AIGroup

Defined in:

AI_AIR

Parameters:

AIGroup

Fsm

Sets the floor and ceiling altitude of the patrol.

Defined in:

AI_AIR

Parameters:

DCS#Altitude PatrolFloorAltitude

The lowest altitude in meters where to execute the patrol.

DCS#Altitude PatrolCeilingAltitude

The highest altitude in meters where to execute the patrol.

Return value:

self

When the AI is damaged beyond a certain threshold, it is required that the AI returns to the home base.

However, damage cannot be foreseen early on. Therefore, when the damage threshold is reached, the AI will return immediately to the home base (RTB). Note that for groups, the average damage of the complete group will be calculated. So, in a group of 4 airplanes, 2 lost and 2 with damage 0.2, the damage threshold will be 0.25.

Defined in:

AI_AIR

Parameter:

#number PatrolDamageThreshold

The threshold in percentage (between 0 and 1) when the AI is considered to be damaged.

Return value:

self

Sets the disengage range, that when engaging a target beyond the specified range, the engagement will be cancelled and the plane will RTB.

Defined in:

AI_AIR

Parameter:

#number DisengageRadius

The disengage range.

Return value:

self

Defined in:

AI_AIR

Parameter:

Dispatcher

When the AI is out of fuel, it is required that a new AI is started, before the old AI can return to the home base.

Therefore, with a parameter and a calculation of the distance to the home base, the fuel threshold is calculated. When the fuel threshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targeted to the AI_AIR. Once the time is finished, the old AI will return to the base.

Defined in:

AI_AIR

Parameters:

#number FuelThresholdPercentage

The threshold in percentage (between 0 and 1) when the AIControllable is considered to get out of fuel.

#number OutOfFuelOrbitTime

The amount of seconds the out of fuel AIControllable will orbit before returning to the base.

Return value:

self

Sets the home airbase.

Defined in:

AI_AIR

Parameter:

Return value:

self

Sets (modifies) the minimum and maximum RTB speed of the patrol.

Defined in:

AI_AIR

Parameters:

DCS#Speed RTBMinSpeed

The minimum speed of the Wrapper.Controllable in km/h.

DCS#Speed RTBMaxSpeed

The maximum speed of the Wrapper.Controllable in km/h.

Return value:

self

Set the min and max factors on RTB speed.

Use this, if your planes are heading back to base too fast. Default values are 0.5 and 0.6. The RTB speed is calculated as the max speed of the unit multiplied by MinFactor (lower bracket) and multiplied by MaxFactor (upper bracket). A random value in this bracket is then applied in the waypoint routing generation.

Defined in:

AI_AIR

Parameters:

#number MinFactor

Lower bracket factor. Defaults to 0.5.

#number MaxFactor

Upper bracket factor. Defaults to 0.6.

Return value:

self

Sets (modifies) the minimum and maximum speed of the patrol.

Defined in:

AI_AIR

Parameters:

DCS#Speed PatrolMinSpeed

The minimum speed of the Wrapper.Controllable in km/h.

DCS#Speed PatrolMaxSpeed

The maximum speed of the Wrapper.Controllable in km/h.

Return value:

self

Set the status checking off.

Defined in:

AI_AIR

Return value:

self

Sets to refuel at the given tanker.

Defined in:

AI_AIR

Parameter:

Wrapper.Group#GROUP TankerName

The group name of the tanker as defined within the Mission Editor or spawned.

Return value:

self

Defined in:

AI_AIR

Parameter:

Coordinate

Start Trigger for AI_AIR

Defined in:

AI_AIR

Synchronous Event Trigger for Event Status.

Defined in:

AI_AIR

Synchronous Event Trigger for Event Stop.

Defined in:

AI_AIR

Asynchronous Event Trigger for Event RTB.

Defined in:

AI_AIR

Parameter:

#number Delay

The delay in seconds.

Refuel Asynchronous Trigger for AI_AIR

Defined in:

AI_AIR

Parameter:

#number Delay

Start Asynchronous Trigger for AI_AIR

Defined in:

AI_AIR

Parameter:

#number Delay

Asynchronous Event Trigger for Event Status.

Defined in:

AI_AIR

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event Stop.

Defined in:

AI_AIR

Parameter:

#number Delay

The delay in seconds.

@param #AI_AIR self

Defined in:

AI_AIR

@param #AI_AIR self @param Wrapper.Group#GROUP AIGroup

Defined in:

AI_AIR

Parameters:

AIGroup

From

Event

To

HoldTime

@param #AI_AIR self @param Wrapper.Group#GROUP AIGroup

Defined in:

AI_AIR

Parameters:

AIGroup

From

Event

To

@param #AI_AIR self @param Wrapper.Group#GROUP AIGroup

Defined in:

AI_AIR

Parameters:

AIGroup

From

Event

To

@param #AI_AIR self @param Wrapper.Group#GROUP AIGroup

Defined in:

AI_AIR

Parameters:

AIGroup

From

Event

To

Coordinates the approriate returning action.

Defined in:

AI_AIR

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

self

Defines a new patrol route using the AI.AI_Patrol#AI_PATROL_ZONE parameters and settings.

Defined in:

AI_AIR

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

self

@param #AI_AIR self

Defined in:

AI_AIR

@param #AI_AIR self

Defined in:

AI_AIR

Field(s)

#number AI_AIR.TaskDelay

The delay of each task given to the AI.

Function(s)

Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

Creates a new FSM_CONTROLLABLE object.

Defined in:

Parameters:

#table FSMT

Finite State Machine Table

(optional) The CONTROLLABLE object that the FSM_CONTROLLABLE governs.

Return value:

OnAfter Transition Handler for Event Stop.

Defined in:

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnBefore Transition Handler for Event Stop.

Defined in:

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

OnEnter Transition Handler for State Stopped.

Defined in:

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnLeave Transition Handler for State Stopped.

Defined in:

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

Defined in:

Parameter:

Return value:

Synchronous Event Trigger for Event Stop.

Asynchronous Event Trigger for Event Stop.

Defined in:

Parameter:

#number Delay

The delay in seconds.

Defined in:

Parameters:

step

trigger

params

EventName

Field(s)

#number AI_AIR.TaskDelay

The delay of each task given to the AI.

Function(s)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

Defined in:

Parameters:

#table From

Can contain a string indicating the From state or a table of strings containing multiple From states.

#string Event

The Event name.

An sub-process FSM.

#table ReturnEvents

A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.

Return value:

The SubFSM.

Adds a score for the FSM to be achieved.

Defined in:

Parameters:

#string State

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

#string ScoreText

is a text describing the score that is given according the status.

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Adds a score for the FSM_PROCESS to be achieved.

Defined in:

Parameters:

#string From

is the From State of the main process.

#string Event

is the Event of the main process.

#string State

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

#string ScoreText

is a text describing the score that is given according the status.

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Add a new transition rule to the FSM.

A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.

Defined in:

Parameters:

#table From

Can contain a string indicating the From state or a table of strings containing multiple From states.

#string Event

The Event name.

#string To

The To state.

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

Returns the End states.

Defined in:

Return value:

#table:

End states.

Defined in:

Parameters:

From

Event

Returns a table of the SubFSM rules defined within the FSM.

Defined in:

Return value:

#table:

Sub processes.

Returns a table with the scores defined.

Defined in:

Return value:

#table:

Scores.

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

Returns a table with the Subs defined.

Defined in:

Return value:

#table:

Sub processes.

Returns a table of the transition rules defined within the FSM.

Defined in:

Return value:

#table:

Transitions.

Check if FSM is in state.

Defined in:

Parameter:

#string State

State name.

Return value:

#boolean:

If true, FSM is in this state.

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

Creates a new FSM object.

Defined in:

Return value:

#FSM:

Defined in:

Parameters:

From

Event

Fsm

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

Add to map.

Defined in:

Parameters:

#table Map

Map.

#table Event

Event table.

Call handler.

Defined in:

Parameters:

#string step

Step "onafter", "onbefore", "onenter", "onleave".

#string trigger

Trigger.

#table params

Parameters.

#string EventName

Event name.

Return value:

Value.

Create transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

Delayed transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

Event map.

Defined in:

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

Check if can do an event.

Defined in:

Parameter:

#string e

Event name.

Return values:

#boolean:

If true, FSM can do the event.

#string:

To state.

Check if cannot do an event.

Defined in:

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

Check if FSM is in state.

Defined in:

Parameters:

#string State

State name.

state

Return value:

#boolean:

If true, FSM is in this state.