Module Ops.Operation
Ops - Operation with multiple phases.
Main Features:
- Define operation phases
- Define conditions when phases are over
- Option to have branches in the phase tree
- Dedicate resources to operations
Example Missions:
Demo missions can be found on github.
Author: funkyfranky
Global(s)
Global OPERATION |
Before this time tomorrow I shall have gained a peerage, or Westminster Abbey. -- Horatio Nelson The OPERATION ConceptThis class allows you to create complex operations, which consist of multiple phases. |
Before this time tomorrow I shall have gained a peerage, or Westminster Abbey. -- Horatio Nelson
The OPERATION Concept
This class allows you to create complex operations, which consist of multiple phases.
Conditions can be specified, when a phase is over. If a phase is over, the next phase is started. FSM events can be used to customize code that is executed at each phase. Phases can also switched manually, of course.
In the simplest case, adding phases leads to a linear chain. However, you can also create branches to contruct a more tree like structure of phases. You can switch between branches manually or add "edges" with conditions when to switch branches. We are diving a bit into graph theory here. So don't feel embarrassed at all, if you stick to linear chains.
Constructor
A new operation can be created with the OPERATION.New(Name) function, where the parameter Name is a free to choose string.
Adding Phases
You can add phases with the OPERATION.AddPhase(Name, Branch) function. The first parameter Name is the name of the phase. The second parameter Branch is the branch to which the phase is
added. If this is omitted (nil), the phase is added to the default, i.e. "master branch". More about adding branches later.
Global _OPERATIONID |
Global mission counter. |
Global mission counter.
Type(s)
| Fields and Methods inherited from OPERATION | Description |
|---|---|
|
Add a new branch to the operation. |
|
|
Add (all) condition function when the whole operation is over. |
|
|
Add (any) condition function when the whole operation is over. |
|
|
Add an edge between two branches. |
|
|
Add condition function to an edge when branches are switched. |
|
|
Add mission to operation. |
|
|
Add a new phase to the operation. |
|
|
Add condition function when the given phase is over. |
|
|
Add condition function when the given phase is over. |
|
|
Add condition function when the given phase is to be repeated. |
|
|
Add Target to operation. |
|
|
Assign cohort to operation. |
|
|
Assign legion to operation. |
|
|
Triggers the FSM event "BranchSwitch". |
|
|
Name of the class. |
|
|
Count phases. |
|
|
Count targets alive. |
|
|
Get the currently active branch. |
|
|
Get the master branch. |
|
|
Get name of the branch. |
|
|
Get a name of this operation. |
|
|
Get currrently active phase. |
|
|
Get a phase by its name. |
|
|
Get condition when the given phase is over. |
|
|
Get index of phase. |
|
|
Get how many times a phase has been active. |
|
|
Get name of a phase. |
|
|
Get next phase. |
|
|
Get status of a phase. |
|
|
Get targets of operation. |
|
|
Insert a new phase after an already defined phase of the operation. |
|
|
Check if a given cohort is assigned to this operation. |
|
|
Check if a given cohort or legion is assigned to this operation. |
|
|
Check if a given legion is assigned to this operation. |
|
|
Check if operation is not "Over" or "Stopped". |
|
|
Check if operation is in FSM state "Over". |
|
|
Check if operation is in FSM state "Paused". |
|
|
Check if phase is in status "Active". |
|
|
Check if phase is in status "Over". |
|
|
Check if phase is in status "Planned". |
|
|
Check if operation is in FSM state "Planned". |
|
|
Check if operation is in FSM state "Running". |
|
|
Check if operation is in FSM state "Stopped". |
|
|
Create a new generic OPERATION object. |
|
OPERATION:OnAfterBranchSwitch(From, Event, To, Branch, Phase) |
On after "BranchSwitch" event. |
|
On after "Over" event. |
|
|
On after "PhaseChange" event. |
|
|
On after "PhaseNext" event. |
|
|
On after "PhaseOver" event. |
|
|
On after "Start" event. |
|
|
Triggers the FSM event "Over". |
|
|
Triggers the FSM event "PhaseChange". |
|
|
Triggers the FSM event "PhaseNext". |
|
|
Triggers the FSM event "PhaseOver". |
|
OPERATION:SetConditionFunctionPersistence(ConditionFunction, IsPersistent) |
Set persistence of condition function. |
|
Set condition when the given phase is over. |
|
|
Set status of a phase. |
|
|
Set start and stop time of the operation. |
|
|
Set verbosity level. |
|
|
Triggers the FSM event "Start". |
|
|
Triggers the FSM event "StatusUpdate". |
|
|
Triggers the FSM event "Stop". |
|
|
Start time in seconds of abs mission time. |
|
|
Stop time in seconds of abs mission time. |
|
|
Check phases. |
|
|
Create a new branch object. |
|
|
Create a new phase object. |
|
|
Triggers the FSM event "BranchSwitch" after a delay. |
|
|
Triggers the FSM event "Over" after a delay. |
|
|
Triggers the FSM event "PhaseChange" after a delay. |
|
|
Triggers the FSM event "PhaseNext" after a delay. |
|
|
Triggers the FSM event "PhaseOver" after a delay. |
|
|
Triggers the FSM event "Start" after a delay. |
|
|
Triggers the FSM event "Status" after a delay. |
|
|
Triggers the FSM event "Stop" after a delay. |
|
|
Active branch. |
|
|
Master branch. |
|
|
Branches. |
|
|
Dedicated cohorts. |
|
|
Over condition. |
|
|
Start condition. |
|
|
Running number counting the branches. |
|
|
Running number counting the phases. |
|
|
Duration of the operation in seconds. |
|
|
Dedicated legions. |
|
|
Class id string for output to DCS log file. |
|
|
Missions. |
|
|
Name of the operation. |
|
OPERATION:onafterBranchSwitch(From, Event, To, Branch, Phase) |
On after "BranchSwitch" event. |
|
On after "Over" event. |
|
|
On after "PhaseChange" event. |
|
|
On after "PhaseNext" event. |
|
|
On after "PhaseOver" event. |
|
|
On after "Start" event. |
|
|
On after "StatusUpdate" event. |
|
|
Currently active phase (if any). |
|
|
The phase that was active before the current one. |
|
|
Targets. |
|
|
Unique ID of the operation. |
|
|
Verbosity level. |
|
|
OPERATION class version. |
| Fields and Methods inherited from FSM | Description |
|---|---|
|
Adds an End 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. |
|
|
Adds a score for the FSM to be achieved. |
|
OPERATION:AddScoreProcess(From, Event, State, ScoreText, Score) |
Adds a score for the FSM_PROCESS to be achieved. |
|
Add a new transition rule to the FSM. |
|
|
Get current state. |
|
|
Returns the End states. |
|
|
Returns a table of the SubFSM rules defined within the FSM. |
|
|
Returns a table with the scores defined. |
|
|
Returns the start state of the FSM. |
|
|
Get current state. |
|
|
Returns a table with the Subs defined. |
|
|
Returns a table of the transition rules defined within the FSM. |
|
|
Check if FSM is in state. |
|
|
Load call backs. |
|
|
Creates a new FSM object. |
|
|
Sets the start state of the FSM. |
|
|
Add to map. |
|
|
Call handler. |
|
|
Create transition. |
|
|
Delayed transition. |
|
|
Event map. |
|
|
Go sub. |
|
|
Handler. |
|
|
Is end state. |
|
|
Sub maps. |
|
|
Check if can do an event. |
|
|
Check if cannot do an event. |
|
|
Check if FSM is in state. |
|
| Fields and Methods inherited from OPERATION.Branch | Description |
|---|---|
|
Edges of this branch. |
|
|
Name of the branch. |
|
|
Phases of this branch. |
|
|
Unique ID of the branch. |
| Fields and Methods inherited from OPERATION.Edge | Description |
|---|---|
|
The from branch. |
|
|
The branch to switch to. |
|
|
Conditions when to switch the branch. |
|
|
The from phase after which to switch. |
|
|
The phase to switch to. |
|
|
Unique ID of the edge. |
| Fields and Methods inherited from OPERATION.Phase | Description |
|---|---|
|
Abs. mission time when the phase was started. |
|
|
The branch this phase belongs to. |
|
|
Conditions when the phase is over. |
|
|
Duration in seconds how long the phase should be active after it started. |
|
|
Number of times the phase was active. |
|
|
Name of the phase. |
|
|
Phase status. |
|
|
Unique ID of the phase. |
| Fields and Methods inherited from OPERATION.PhaseStatus | Description |
|---|---|
|
Active phase. |
|
|
Phase is over. |
|
|
Planned. |
OPERATION class.
Field(s)
Name of the class.
Start time in seconds of abs mission time.
Stop time in seconds of abs mission time.
Branches.
Dedicated cohorts.
Running number counting the branches.
Running number counting the phases.
Duration of the operation in seconds.
Dedicated legions.
Class id string for output to DCS log file.
Missions.
Name of the operation.
Targets.
Unique ID of the operation.
Verbosity level.
OPERATION class version.
Function(s)
Add a new branch to the operation.
Add (all) condition function when the whole operation is over.
Must return a #boolean.
Defined in:
OPERATION
Parameters:
#function Function
Function that needs to be true before the operation is over.
...
Condition function arguments if any.
Return value:
Condition function table.
Add (any) condition function when the whole operation is over.
Must return a #boolean.
Defined in:
OPERATION
Parameters:
#function Function
Function that needs to be true before the operation is over.
...
Condition function arguments if any.
Phase
Return value:
Condition function table.
Add an edge between two branches.
Defined in:
OPERATION
Parameters:
#OPERATION.Phase PhaseFrom
The phase of the from branch after which to switch.
#OPERATION.Phase PhaseTo
The phase of the to branch to which to switch.
Core.Condition#CONDITION ConditionSwitch
(Optional) Condition(s) when to switch the branches.
Return value:
Edge table object.
Add condition function to an edge when branches are switched.
The function must return a #boolean.
If multiple condition functions are added, all of these must return true for the branch switch to occur.
Defined in:
OPERATION
Parameters:
#OPERATION.Edge Edge
The edge connecting the two branches.
#function Function
Function that needs to be true for switching between the branches.
...
Condition function arguments if any.
Return value:
Condition function table.
Add mission to operation.
Defined in:
OPERATION
Parameters:
Ops.Auftrag#AUFTRAG Mission
The mission to add.
#OPERATION.Phase Phase
(Optional) The phase in which the mission should be executed. If no phase is given, it will be exectuted ASAP.
Add a new phase to the operation.
This is added add the end of all previously added phases (if any).
Defined in:
OPERATION
Parameters:
#string Name
Name of the phase. Default "Phase-01" where the last number is a running number.
#OPERATION.Branch Branch
The branch to which this phase is added. Default is the master branch.
#number Duration
Duration in seconds how long the phase will last. Default nil=forever.
Return value:
Phase table object.
Add condition function when the given phase is over.
Must return a #boolean.
Defined in:
OPERATION
Parameters:
#OPERATION.Phase Phase
The phase.
#function Function
Function that needs to be true before the phase is over.
...
Condition function arguments if any.
Return value:
Condition function table.
Add condition function when the given phase is over.
Must return a #boolean.
Defined in:
OPERATION
Parameters:
#OPERATION.Phase Phase
The phase.
#function Function
Function that needs to be true before the phase is over.
...
Condition function arguments if any.
Return value:
Condition function table.
Add condition function when the given phase is to be repeated.
The provided function must return a #boolean.
If the condition evaluation returns true, the phase is set to state Planned instead of Over and can be repeated.
Defined in:
OPERATION
Parameters:
#OPERATION.Phase Phase
The phase.
#function Function
Function that needs to be true before the phase is over.
...
Condition function arguments if any.
Return value:
self
Add Target to operation.
Defined in:
OPERATION
Parameters:
Ops.Target#TARGET Target
The target to add.
#OPERATION.Phase Phase
(Optional) The phase in which the target should be attacked. If no phase is given, it will be attacked ASAP.
Assign cohort to operation.
Assign legion to operation.
All cohorts of this legion will be assigned and are only available.
Defined in:
OPERATION
Parameter:
Ops.Legion#LEGION Legion
The legion to be assigned.
Return value:
self
Triggers the FSM event "BranchSwitch".
Defined in:
OPERATION
Parameters:
#OPERATION.Branch Branch
The branch that is now active.
#OPERATION.Phase Phase
The new phase.
Count phases.
Defined in:
OPERATION
Parameters:
#string Status
(Optional) Only count phases in a certain status, e.g. OPERATION.PhaseStatus.PLANNED.
#OPERATION.Branch Branch
(Optional) Branch.
Return value:
#number:
Number of phases
Count targets alive.
Defined in:
OPERATION
Parameter:
#OPERATION.Phase Phase
(Optional) Only count targets set for this phase.
Return value:
#number:
Number of phases
Get the currently active branch.
Defined in:
OPERATION
Return value:
The active branch. If no branch is active, the master branch is returned.
Get the master branch.
This is the default branch and should always exist (if it was not explicitly deleted).
Get name of the branch.
Defined in:
OPERATION
Parameter:
#OPERATION.Branch Branch
The branch of which the name is requested. Default is the currently active or master branch.
Return value:
#string:
Name Name or "None"
Get a name of this operation.
Defined in:
OPERATION
Return value:
#string:
Name of this operation or "Unknown".
Get currrently active phase.
Defined in:
OPERATION
Return value:
Current phase or nil if no current phase is active.
Get a phase by its name.
Defined in:
OPERATION
Parameter:
#string Name
Name of the phase. Default "Phase-01" where the last number is a running number.
Return value:
Phase table object or nil if phase could not be found.
Get condition when the given phase is over.
Defined in:
OPERATION
Parameters:
#OPERATION.Phase Phase
The phase.
Condition
Return value:
Condition when the phase is over (if any).
Get index of phase.
Get how many times a phase has been active.
Defined in:
OPERATION
Parameter:
#OPERATION.Phase Phase
The phase.
Return value:
#number:
Number of times the phase has been active.
Get name of a phase.
Defined in:
OPERATION
Parameter:
#OPERATION.Phase Phase
The phase of which the name is returned. Default is the currently active phase.
Return value:
#string:
The name of the phase or "None" if no phase is given or active.
Get next phase.
Defined in:
OPERATION
Parameters:
#OPERATION.Branch Branch
(Optional) The branch from which the next phase is retrieved. Default is the currently active branch.
#string PhaseStatus
(Optional) Only return a phase, which is in this status. For example, OPERATION.PhaseStatus.PLANNED to make sure, the next phase is planned.
Return value:
Next phase or nil if no next phase exists.
Get status of a phase.
Defined in:
OPERATION
Parameter:
#OPERATION.Phase Phase
The phase.
Return value:
#string:
Phase status, e.g. OPERATION.PhaseStatus.OVER.
Get targets of operation.
Defined in:
OPERATION
Parameter:
#OPERATION.Phase Phase
(Optional) Only return targets set for this phase. Default is targets of all phases.
Return value:
#table:
Targets Table of #TARGET objects
Insert a new phase after an already defined phase of the operation.
Defined in:
OPERATION
Parameters:
#OPERATION.Phase PhaseAfter
The phase after which the new phase is inserted.
#string Name
Name of the phase. Default "Phase-01" where the last number is a running number.
Return value:
Phase table object.
Check if a given cohort is assigned to this operation.
Defined in:
OPERATION
Parameter:
Ops.Cohort#COHORT Cohort
The Cohort.
Return value:
#boolean:
If true, cohort is assigned to this operation.
Check if a given cohort or legion is assigned to this operation.
Defined in:
OPERATION
Parameter:
Wrapper.Object#OBJECT Object
The cohort or legion object.
Return value:
#boolean:
If true, cohort is assigned to this operation.
Check if a given legion is assigned to this operation.
All cohorts of this legion will be checked.
Defined in:
OPERATION
Parameter:
Ops.Legion#LEGION Legion
The legion to be assigned.
Return value:
#boolean:
If true, legion is assigned to this operation.
Check if operation is not "Over" or "Stopped".
Defined in:
OPERATION
Return value:
#boolean:
If true, operation is not "Over" or "Stopped".
Check if operation is in FSM state "Over".
Defined in:
OPERATION
Return value:
#boolean:
If true, operation is "Over".
Check if operation is in FSM state "Paused".
Defined in:
OPERATION
Return value:
#boolean:
If true, operation is "Paused".
Check if phase is in status "Active".
Defined in:
OPERATION
Parameter:
#OPERATION.Phase Phase
The phase.
Return value:
#boolean:
If true, phase is active.
Check if phase is in status "Over".
Defined in:
OPERATION
Parameter:
#OPERATION.Phase Phase
The phase.
Return value:
#boolean:
If true, phase is over.
Check if phase is in status "Planned".
Defined in:
OPERATION
Parameter:
#OPERATION.Phase Phase
The phase.
Return value:
#boolean:
If true, phase is Planned.
Check if operation is in FSM state "Planned".
Defined in:
OPERATION
Return value:
#boolean:
If true, operation is "Planned".
Check if operation is in FSM state "Running".
Defined in:
OPERATION
Return value:
#boolean:
If true, operation is "Running".
Check if operation is in FSM state "Stopped".
Defined in:
OPERATION
Return value:
#boolean:
If true, operation is "Stopped".
Create a new generic OPERATION object.
Defined in:
OPERATION
Parameter:
#string Name
Name of the operation. Be creative! Default "Operation-01" where the last number is a running number.
Return value:
self
On after "BranchSwitch" event.
Defined in:
OPERATION
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
#OPERATION.Branch Branch
The branch that is now active.
#OPERATION.Phase Phase
The new phase.
On after "Over" event.
Defined in:
OPERATION
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "PhaseChange" event.
Defined in:
OPERATION
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
#OPERATION.Phase Phase
The new phase.
On after "PhaseNext" event.
Defined in:
OPERATION
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "PhaseOver" event.
Defined in:
OPERATION
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
#OPERATION.Phase Phase
The phase that is over.
On after "Start" event.
Defined in:
OPERATION
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Triggers the FSM event "PhaseChange".
Triggers the FSM event "PhaseOver".
Set persistence of condition function.
By default, condition functions are removed after a phase is over.
Defined in:
OPERATION
Parameters:
Core.Condition#CONDITION.Function ConditionFunction
Condition function table.
#boolean IsPersistent
If true or nil, condition function is persistent.
Return value:
self
Set condition when the given phase is over.
Defined in:
OPERATION
Parameters:
#OPERATION.Phase Phase
The phase.
Core.Condition#CONDITION Condition
Condition when the phase is over.
Return value:
self
Set status of a phase.
Defined in:
OPERATION
Parameters:
#OPERATION.Phase Phase
The phase.
#string Status
New status, e.g. OPERATION.PhaseStatus.OVER.
Return value:
self
Set start and stop time of the operation.
Defined in:
OPERATION
Parameters:
#string ClockStart
Time the mission is started, e.g. "05:00" for 5 am. If specified as a #number, it will be relative (in seconds) to the current mission time. Default is 5 seconds after mission was added.
#string ClockStop
(Optional) Time the mission is stopped, e.g. "13:00" for 1 pm. If mission could not be started at that time, it will be removed from the queue. If specified as a #number it will be relative (in seconds) to the current mission time.
Return value:
self
Set verbosity level.
Defined in:
OPERATION
Parameter:
#number VerbosityLevel
Level of output (higher=more). Default 0.
Return value:
self
Create a new branch object.
Defined in:
OPERATION
Parameter:
#string Name
Name of the phase. Default "Phase-01" where the last number is a running number.
Return value:
Branch table object.
Create a new phase object.
Defined in:
OPERATION
Parameter:
#string Name
Name of the phase. Default "Phase-01" where the last number is a running number.
Return value:
Phase table object.
Triggers the FSM event "BranchSwitch" after a delay.
Defined in:
OPERATION
Parameters:
#number delay
Delay in seconds.
#OPERATION.Branch Branch
The branch that is now active.
#OPERATION.Phase Phase
The new phase.
Triggers the FSM event "Over" after a delay.
Defined in:
OPERATION
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "PhaseChange" after a delay.
Defined in:
OPERATION
Parameters:
#number delay
Delay in seconds.
#OPERATION.Phase Phase
The new phase.
Triggers the FSM event "PhaseNext" after a delay.
Defined in:
OPERATION
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "PhaseOver" after a delay.
Defined in:
OPERATION
Parameters:
#number delay
Delay in seconds.
#OPERATION.Phase Phase
The phase that is over.
Triggers the FSM event "Start" after a delay.
Defined in:
OPERATION
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Status" after a delay.
Defined in:
OPERATION
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Stop" after a delay.
Defined in:
OPERATION
Parameter:
#number delay
Delay in seconds.
On after "BranchSwitch" event.
Defined in:
OPERATION
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
#OPERATION.Branch Branch
The new branch.
#OPERATION.Phase Phase
The phase.
On after "Over" event.
Defined in:
OPERATION
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "PhaseChange" event.
Defined in:
OPERATION
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
#OPERATION.Phase Phase
The new phase.
On after "PhaseNext" event.
Defined in:
OPERATION
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "PhaseOver" event.
Defined in:
OPERATION
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
#OPERATION.Phase Phase
The phase that is over.
On after "Start" event.
Defined in:
OPERATION
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "StatusUpdate" event.
Defined in:
OPERATION
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Field(s)
Name of the class.
Start time in seconds of abs mission time.
Stop time in seconds of abs mission time.
Branches.
Dedicated cohorts.
Running number counting the branches.
Running number counting the phases.
Duration of the operation in seconds.
Dedicated legions.
Class id string for output to DCS log file.
Missions.
Name of the operation.
Targets.
Unique ID of the operation.
Verbosity level.
OPERATION class version.
Function(s)
Adds an End 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.
Core.Fsm#FSM_PROCESS Process
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.
Returns the End states.
Returns a table of the SubFSM rules defined within the FSM.
Returns a table with the scores defined.
Returns the start state of the FSM.
Get current state.
Returns a table with the Subs defined.
Returns a table of the transition rules defined within the FSM.
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.
Sets the start state of the FSM.
Add to map.
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.
Go sub.
Defined in:
Parameters:
#string ParentFrom
Parent from state.
#string ParentEvent
Parent event name.
Return value:
#table:
Subs.
Handler.
Is end state.
Defined in:
Parameter:
#string Current
Current state name.
Return values:
#table:
FSM parent.
#string:
Event name.
Sub maps.
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.
Operation branch.
Field(s)
Edges of this branch.
Name of the branch.
Phases of this branch.
Unique ID of the branch.
Function(s)
Operation phase.
Field(s)
Abs. mission time when the phase was started.
Duration in seconds how long the phase should be active after it started.
Number of times the phase was active.
Name of the phase.
Phase status.
Unique ID of the phase.
Function(s)
Operation phase.
Field(s)
Active phase.
Phase is over.
Planned.