Module Actions.Act_Account
Actions - ACT_ACCOUNT_ classes account for (detect, count & report) various DCS events occurring on UNITs.
Global(s)
Global ACT_ACCOUNT |
Global ACT_ACCOUNT_DEADS |
Type(s)
| Fields and Methods inherited from ACT_ACCOUNT | Description |
|---|---|
|
Creates a new DESTROY process. |
|
|
StateMachine callback function |
|
|
StateMachine callback function |
|
|
StateMachine callback function |
| Fields and Methods inherited from FSM_PROCESS | Description |
|---|---|
|
Assign the process to a Wrapper.Unit and activate the process. |
|
|
Creates a new FSM_PROCESS object based on this FSM_PROCESS. |
|
|
Gets the mission of the process. |
|
|
Gets the mission of the process. |
|
|
Gets the task of the process. |
|
|
Send a message of the Tasking.Task to the Group of the Unit. |
|
|
Creates a new FSM_PROCESS object. |
|
|
Removes an FSM_PROCESS object. |
|
|
Sets the task of the process. |
|
ACT_ACCOUNT:onenterFailed(ProcessUnit, Task, From, Event, To) |
|
ACT_ACCOUNT:onstatechange(ProcessUnit, Event, From, To, Task) |
StateMachine callback function for a FSM_PROCESS |
| Fields and Methods inherited from FSM_CONTROLLABLE | Description |
|---|---|
|
Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs. |
|
|
Creates a new FSM_CONTROLLABLE object. |
|
|
OnAfter Transition Handler for Event Stop. |
|
|
OnBefore Transition Handler for Event Stop. |
|
|
OnEnter Transition Handler for State Stopped. |
|
|
OnLeave Transition Handler for State Stopped. |
|
|
Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs. |
|
|
Synchronous Event Trigger for Event Stop. |
|
|
Asynchronous Event Trigger for Event Stop. |
|
| 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. |
|
ACT_ACCOUNT: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 ACT_ACCOUNT_DEADS | Description |
|---|---|
|
Creates a new DESTROY process. |
|
ACT_ACCOUNT_DEADS:onafterEvent(ProcessUnit, Task, From, Event, To, EventData) |
StateMachine callback function |
ACT_ACCOUNT_DEADS:onenterAccountForOther(ProcessUnit, Task, From, Event, To, EventData) |
StateMachine callback function |
ACT_ACCOUNT_DEADS:onenterAccountForPlayer(ProcessUnit, Task, From, Event, To, EventData) |
StateMachine callback function |
ACT_ACCOUNT_DEADS:onenterReport(ProcessUnit, Event, From, To, Task) |
StateMachine callback function |
#ACT_ACCOUNT FSM class, extends Core.Fsm#FSM_PROCESS
ACT_ACCOUNT state machine:
This class is a state machine: it manages a process that is triggered by events causing state transitions to occur.
All derived classes from this class will start with the class name, followed by a _. See the relevant derived class descriptions below. Each derived class follows exactly the same process, using the same events and following the same state transitions, but will have different implementation behaviour upon each event or state transition.
ACT_ACCOUNT States
- Assigned: The player is assigned.
- Waiting: Waiting for an event.
- Report: Reporting.
- Account: Account for an event.
- Accounted: All events have been accounted for, end of the process.
- Failed: Failed the process.
ACT_ACCOUNT Events
- Start: Start the process.
- Wait: Wait for an event.
- Report: Report the status of the accounting.
- Event: An event happened, process the event.
- More: More targets.
- NoMore (*): No more targets.
- Fail (*): The action process has failed.
(*) End states of the process.
ACT_ACCOUNT state transition methods:
State transition functions can be set by the mission designer customizing or improving the behaviour of the state. There are 2 moments when state transition methods will be called by the state machine:
Before the state transition. The state transition method needs to start with the name OnBefore + the name of the state. If the state transition method returns false, then the processing of the state transition will not be done! If you want to change the behaviour of the AIControllable at this event, return false, but then you'll need to specify your own logic using the AIControllable!
After the state transition. The state transition method needs to start with the name OnAfter + the name of the state. These state transition methods need to provide a return value, which is specified at the function description.
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
Field(s)
Function(s)
Creates a new DESTROY process.
StateMachine callback function
Defined in:
ACT_ACCOUNT
Parameters:
Wrapper.Unit#UNIT ProcessUnit
#string Event
#string From
#string To
StateMachine callback function
Defined in:
ACT_ACCOUNT
Parameters:
Wrapper.Unit#UNIT ProcessUnit
#string Event
#string From
#string To
StateMachine callback function
Defined in:
ACT_ACCOUNT
Parameters:
Wrapper.Unit#UNIT ProcessUnit
#string Event
#string From
#string To
Field(s)
Function(s)
Assign the process to a Wrapper.Unit and activate the process.
Creates a new FSM_PROCESS object based on this FSM_PROCESS.
Gets the mission of the process.
Gets the mission of the process.
Gets the task of the process.
Send a message of the Tasking.Task to the Group of the Unit.
Creates a new FSM_PROCESS object.
Removes an FSM_PROCESS object.
Sets the task of the process.
StateMachine callback function for a FSM_PROCESS
Defined in:
Parameters:
Wrapper.Controllable#CONTROLLABLE ProcessUnit
#string Event
#string From
#string To
Task
Field(s)
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
Wrapper.Controllable#CONTROLLABLE Controllable
(optional) The CONTROLLABLE object that the FSM_CONTROLLABLE governs.
Return value:
OnAfter Transition Handler for Event Stop.
Defined in:
Parameters:
Wrapper.Controllable#CONTROLLABLE Controllable
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:
Wrapper.Controllable#CONTROLLABLE Controllable
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:
Wrapper.Controllable#CONTROLLABLE Controllable
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:
Wrapper.Controllable#CONTROLLABLE Controllable
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.
Asynchronous Event Trigger for Event Stop.
Field(s)
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.
#ACT_ACCOUNT_DEADS FSM class, extends #ACT_ACCOUNT
The ACT_ACCOUNT_DEADS class accounts (detects, counts and reports) successful kills of DCS units.
The process is given a Core.Set of units that will be tracked upon successful destruction. The process will end after each target has been successfully destroyed. Each successful dead will trigger an Account state transition that can be scored, modified or administered.
ACT_ACCOUNT_DEADS constructor:
- ACT_ACCOUNT_DEADS.New(): Creates a new ACT_ACCOUNT_DEADS object.
Field(s)
Targets is the default display category
10 seconds is the default
Function(s)
Defined in:
ACT_ACCOUNT_DEADS
Parameter:
FsmAccount
Creates a new DESTROY process.
@param #ACT_ACCOUNT_DEADS self @param Core.Event#EVENTDATA EventData
Defined in:
ACT_ACCOUNT_DEADS
Parameter:
EventData
StateMachine callback function
Defined in:
ACT_ACCOUNT_DEADS
Parameters:
Wrapper.Unit#UNIT ProcessUnit
Tasking.Task#TASK Task
#string From
#string Event
#string To
Core.Event#EVENTDATA EventData
StateMachine callback function
Defined in:
ACT_ACCOUNT_DEADS
Parameters:
Wrapper.Unit#UNIT ProcessUnit
Tasking.Task#TASK Task
#string From
#string Event
#string To
Core.Event#EVENTDATA EventData
StateMachine callback function
Defined in:
ACT_ACCOUNT_DEADS
Parameters:
Wrapper.Unit#UNIT ProcessUnit
Tasking.Task#TASK Task
#string From
#string Event
#string To
Core.Event#EVENTDATA EventData
StateMachine callback function
Defined in:
ACT_ACCOUNT_DEADS
Parameters:
Wrapper.Unit#UNIT ProcessUnit
#string Event
#string From
#string To
Task
@param #ACT_ACCOUNT_DEADS self @param Core.Event#EVENTDATA EventData
Defined in:
ACT_ACCOUNT_DEADS
Parameter:
EventData
@param #ACT_ACCOUNT_DEADS self @param Core.Event#EVENTDATA EventData
Defined in:
ACT_ACCOUNT_DEADS
Parameter:
EventData