Banner Image

Module Actions.Act_Account

Actions - ACT_ACCOUNT_ classes account for (detect, count & report) various DCS events occurring on UNITs.

Banner Image


Global(s)

Global ACT_ACCOUNT

Global ACT_ACCOUNT_DEADS

Type(s)

Fields and Methods inherited from ACT_ACCOUNT Description

ACT_ACCOUNT.ClassName

ACT_ACCOUNT.DisplayCount

ACT_ACCOUNT:New()

Creates a new DESTROY process.

ACT_ACCOUNT.TargetSetUnit

ACT_ACCOUNT:onafterEvent(ProcessUnit, Event, From, To)

StateMachine callback function

ACT_ACCOUNT:onafterStart(ProcessUnit, Event, From, To)

StateMachine callback function

ACT_ACCOUNT:onenterWaiting(ProcessUnit, Event, From, To)

StateMachine callback function

Fields and Methods inherited from FSM_PROCESS Description

ACT_ACCOUNT:Assign(Task, ProcessUnit)

Assign the process to a Wrapper.Unit and activate the process.

ACT_ACCOUNT:Copy(Controllable, Task)

Creates a new FSM_PROCESS object based on this FSM_PROCESS.

ACT_ACCOUNT:GetCommandCenter()

Gets the mission of the process.

ACT_ACCOUNT:GetMission()

Gets the mission of the process.

ACT_ACCOUNT:GetTask()

Gets the task of the process.

ACT_ACCOUNT:Init(FsmProcess)

ACT_ACCOUNT:Message(Message)

Send a message of the Tasking.Task to the Group of the Unit.

ACT_ACCOUNT:New(Controllable, Task)

Creates a new FSM_PROCESS object.

ACT_ACCOUNT:Remove()

Removes an FSM_PROCESS object.

ACT_ACCOUNT:SetTask(Task)

Sets the task of the process.

ACT_ACCOUNT.Task

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

ACT_ACCOUNT:onenterFailed(ProcessUnit, Task, From, Event, To)

ACT_ACCOUNT:onstatechange(ProcessUnit, Event, From, To, Task)

StateMachine callback function for a FSM_PROCESS

#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.

Defined in:

ACT_ACCOUNT

Return value:

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.

Defined in:

Parameters:

Wrapper.Unit#UNIT ProcessUnit

Return value:

self

Creates a new FSM_PROCESS object based on this FSM_PROCESS.

Defined in:

Parameters:

Controllable

Task

Return value:

Gets the mission of the process.

Gets the mission of the process.

Defined in:

Return value:

Gets the task of the process.

Defined in:

Return value:

Defined in:

Parameter:

FsmProcess

Send a message of the Tasking.Task to the Group of the Unit.

Defined in:

Parameter:

Message

Creates a new FSM_PROCESS object.

Defined in:

Parameters:

Controllable

Task

Return value:

Removes an FSM_PROCESS object.

Defined in:

Return value:

Sets the task of the process.

Defined in:

Parameter:

Return value:

Defined in:

Parameters:

step

trigger

params

EventName

Defined in:

Parameters:

ProcessUnit

Task

From

Event

To

StateMachine callback function for a FSM_PROCESS

Defined in:

Parameters:

#string Event

#string From

#string To

Task

#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:

Field(s)

#string ACT_ACCOUNT_DEADS.DisplayCategory

Targets is the default display category

#number ACT_ACCOUNT_DEADS.DisplayTime

10 seconds is the default

Function(s)

Defined in:

ACT_ACCOUNT_DEADS

Parameter:

FsmAccount

Creates a new DESTROY process.

Defined in:

ACT_ACCOUNT_DEADS

Parameters:

Core.Set#SET_UNIT TargetSetUnit

#string TaskName

@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

#string From

#string Event

#string To

StateMachine callback function

Defined in:

ACT_ACCOUNT_DEADS

Parameters:

Wrapper.Unit#UNIT ProcessUnit

#string From

#string Event

#string To

StateMachine callback function

Defined in:

ACT_ACCOUNT_DEADS

Parameters:

Wrapper.Unit#UNIT ProcessUnit

#string From

#string Event

#string To

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