Banner Image

Module Tasking.Mission

Tasking -- A mission models a goal to be achieved through the execution and completion of tasks by human players.

Features:

  • A mission has a goal to be achieved, through the execution and completion of tasks of different categories by human players.
  • A mission manages these tasks.
  • A mission has a state, that indicates the fase of the mission.
  • A mission has a menu structure, that facilitates mission reports and tasking menus.
  • A mission can assign a task to a player.

Author: FlightControl

Contributions:


Global(s)

Global MISSION

Models goals to be achieved and can contain multiple tasks to be executed to achieve the goals.

#MISSION MISSION

Models goals to be achieved and can contain multiple tasks to be executed to achieve the goals.

A mission contains multiple tasks and can be of different task types. These tasks need to be assigned to human players to be executed.

A mission can have multiple states, which will evolve as the mission progresses during the DCS simulation.

  • IDLE: The mission is defined, but not started yet. No task has yet been joined by a human player as part of the mission.
  • ENGAGED: The mission is ongoing, players have joined tasks to be executed.
  • COMPLETED: The goals of the mission has been successfully reached, and the mission is flagged as completed.
  • FAILED: For a certain reason, the goals of the mission has not been reached, and the mission is flagged as failed.
  • HOLD: The mission was enaged, but for some reason it has been put on hold.

Note that a mission goals need to be checked by a goal check trigger: MISSION.OnBeforeMissionGoals(), which may return false if the goal has not been reached. This goal is checked automatically by the mission object every x seconds.

  • MISSION.Start() or MISSION.__Start() will start the mission, and will bring it from IDLE state to ENGAGED state.
  • MISSION.Stop() or MISSION.__Stop() will stop the mission, and will bring it from ENGAGED state to IDLE state.
  • MISSION.Complete() or MISSION.__Complete() will complete the mission, and will bring the mission state to COMPLETED. Note that the mission must be in state ENGAGED to be able to complete the mission.
  • MISSION.Fail() or MISSION.__Fail() will fail the mission, and will bring the mission state to FAILED. Note that the mission must be in state ENGAGED to be able to fail the mission.
  • MISSION.Hold() or MISSION.__Hold() will hold the mission, and will bring the mission state to HOLD. Note that the mission must be in state ENGAGED to be able to hold the mission. Re-engage the mission using the engage trigger.

The following sections provide an overview of the most important methods that can be used as part of a mission object. Note that the Tasking.CommandCenter system is using most of these methods to manage the missions in its system.

1. Create a mission object.

2. Mission task management.

Missions maintain tasks, which can be added or removed, or enquired.

3. Mission detailed methods.

Various methods are added to manage missions.

3.1. Naming and description.

There are several methods that can be used to retrieve the properties of a mission:

  • Use the method MISSION.GetName() to retrieve the name of the mission. This is the name given as part of the MISSION.New() constructor.

A textual description can be retrieved that provides the mission name to be used within message communication:

  • MISSION.GetShortText() returns the mission name as Mission "MissionName".
  • MISSION.GetText() returns the mission name as Mission "MissionName (MissionPriority)". A longer version including the priority text of the mission.

3.2. Get task information.

3.3. Get the command center.

3.4. Get the groups active in the mission as a Core.Set.

3.5. Get the names of the players.

4. Menu management.

A mission object is able to manage its own menu structure. Use the MISSION.GetMenu() and MISSION.SetMenu() to manage the underlying submenu structure managing the tasks of the mission.

5. Reporting management.

Several reports can be generated for a mission, and will return a text string that can be used to display using the Core.Message system.

Type(s)

MISSION , extends Core.Fsm#FSM , extends Core.Base#BASE
Fields and Methods inherited from MISSION Description

MISSION:AbortUnit(PlayerUnit)

Aborts a PlayerUnit from the Mission.

MISSION:AddGroups(GroupSet)

Adds the groups for which TASKS are given in the mission

MISSION:AddPlayerName(PlayerName)

MISSION:AddScoring(Scoring)

Add a scoring to the mission.

MISSION:AddTask(Task)

Register a Task to be completed within the Mission.

MISSION:ClearGroupAssignment(MissionGroup)

Clear the Wrapper.Group assignment from the Mission.

MISSION:Complete()

Synchronous Event Trigger for Event Complete.

MISSION:CrashUnit(PlayerUnit)

Handles a crash of a PlayerUnit from the Mission.

MISSION:Fail()

Synchronous Event Trigger for Event Fail.

MISSION:GetCommandCenter()

Gets the COMMANDCENTER.

MISSION.GetGroupTasks(TaskGroup, self)

Get the relevant tasks of a TaskGroup.

MISSION:GetGroups(GroupSet)

Gets the groups for which TASKS are given in the mission

MISSION:GetMenu(TaskGroup)

Gets the mission menu for the TaskGroup.

MISSION:GetName()

Gets the mission name.

MISSION:GetNextTaskID(Task)

Return the next Task ID to be completed within the Mission.

MISSION:GetPlayerNames()

MISSION:GetRootMenu(TaskGroup)

Gets the root mission menu for the TaskGroup.

MISSION:GetScoring()

Get the scoring object of a mission.

MISSION:GetShortText()

Gets the short mission text.

MISSION.GetTask(TaskName, self)

Get the TASK identified by the TaskNumber from the Mission.

MISSION:GetTaskTypes()

MISSION:GetTasks()

Get all the TASKs from the Mission.

MISSION:GetTasksRemaining()

MISSION:GetText()

Gets the mission text.

MISSION:HasGroup(TaskGroup)

Validates if the Mission has a Group

MISSION:IsCOMPLETED()

Is the Mission COMPLETED.

MISSION:IsENGAGED()

Is the Mission ENGAGED.

MISSION:IsFAILED()

Is the Mission FAILED.

MISSION:IsGroupAssigned(MissionGroup)

Returns if the Mission is assigned to the Group.

MISSION:IsHOLD()

Is the Mission HOLD.

MISSION:IsIDLE()

Is the Mission IDLE.

MISSION:JoinUnit(PlayerUnit, PlayerGroup)

Add a Unit to join the Mission.

MISSION:MarkTargetLocations(ReportGroup)

Mark all the target locations on the Map.

MISSION:MenuMarkTargetLocations(ReportGroup)

Mark all the targets of the Mission on the Map.

MISSION:MenuReportBriefing(ReportGroup)

Reports the briefing.

MISSION:MenuReportPlayersPerTask(ReportGroup)

MISSION:MenuReportPlayersProgress(ReportGroup)

MISSION:MenuReportTasksPerStatus(TaskStatus, ReportGroup)

MISSION:MenuReportTasksSummary(ReportGroup)

Report the task summary.

MISSION.MissionBriefing

MISSION:MissionGoals()

MissionGoals Trigger for MISSION

MISSION.MissionGroupMenu

MISSION.MissionMenu

MISSION:New(CommandCenter, MissionName, MissionPriority, MissionBriefing, MissionCoalition)

This is the main MISSION declaration method.

MISSION:OnAfterComplete(From, Event, To)

OnAfter Transition Handler for Event Complete.

MISSION:OnAfterFail(From, Event, To)

OnAfter Transition Handler for Event Fail.

MISSION:OnAfterMissionGoals(From, Event, To)

MissionGoals Handler OnAfter for MISSION

MISSION:OnAfterStart(From, Event, To)

OnAfter Transition Handler for Event Start.

MISSION:OnAfterStop(From, Event, To)

OnAfter Transition Handler for Event Stop.

MISSION:OnBeforeComplete(From, Event, To)

OnBefore Transition Handler for Event Complete.

MISSION:OnBeforeFail(From, Event, To)

OnBefore Transition Handler for Event Fail.

MISSION:OnBeforeMissionGoals(From, Event, To)

MissionGoals Handler OnBefore for MISSION

MISSION:OnBeforeStart(From, Event, To)

OnBefore Transition Handler for Event Start.

MISSION:OnBeforeStop(From, Event, To)

OnBefore Transition Handler for Event Stop.

MISSION:OnEnterCOMPLETED(From, Event, To)

OnEnter Transition Handler for State COMPLETED.

MISSION:OnEnterENGAGED(From, Event, To)

OnEnter Transition Handler for State ENGAGED.

MISSION:OnEnterFAILED(From, Event, To)

OnEnter Transition Handler for State FAILED.

MISSION:OnEnterIDLE(From, Event, To)

OnEnter Transition Handler for State IDLE.

MISSION:OnLeaveCOMPLETED(From, Event, To)

OnLeave Transition Handler for State COMPLETED.

MISSION:OnLeaveENGAGED(From, Event, To)

OnLeave Transition Handler for State ENGAGED.

MISSION:OnLeaveFAILED(From, Event, To)

OnLeave Transition Handler for State FAILED.

MISSION:OnLeaveIDLE(From, Event, To)

OnLeave Transition Handler for State IDLE.

MISSION:RemoveMenu(MenuTime)

Removes the Planned Task menu.

MISSION:RemoveTask(Task)

Removes a Task to be completed within the Mission.

MISSION:RemoveTaskMenu(Task)

Removes a Task menu.

MISSION:ReportBriefing()

Create a briefing report of the Mission.

MISSION:ReportDetails(ReportGroup)

Create a detailed report of the Mission, listing all the details of the Task.

MISSION:ReportOverview(ReportGroup, TaskStatus)

Create a overview report of the Mission (multiple lines).

MISSION:ReportPlayersPerTask(ReportGroup)

Create an active player report of the Mission.

MISSION:ReportPlayersProgress(ReportGroup)

Create an Mission Progress report of the Mission.

MISSION:ReportSummary(ReportGroup)

Create a summary report of the Mission (one line).

MISSION.Scoring

MISSION:SetGroupAssigned(MissionGroup)

Set Wrapper.Group assigned to the Mission.

MISSION:SetMenu(MenuTime)

Sets the Planned Task menu.

MISSION:Start()

Synchronous Event Trigger for Event Start.

MISSION:Stop()

Synchronous Event Trigger for Event Stop.

MISSION.TaskNumber

MISSION._Clients

MISSION:__Complete(Delay)

Asynchronous Event Trigger for Event Complete.

MISSION:__Fail(Delay)

Asynchronous Event Trigger for Event Fail.

MISSION:__MissionGoals(Delay)

MissionGoals Asynchronous Trigger for MISSION

MISSION:__Start(Delay)

Asynchronous Event Trigger for Event Start.

MISSION:__Stop(Delay)

Asynchronous Event Trigger for Event Stop.

MISSION:onenterCOMPLETED(From, Event, To)

FSM function for a MISSION

Fields and Methods inherited from FSM Description

MISSION:AddEndState(State)

Adds an End state.

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

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

MISSION:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

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

Adds a score for the FSM_PROCESS to be achieved.

MISSION:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

MISSION.CallScheduler

MISSION.Events

MISSION:GetCurrentState()

MISSION:GetEndStates()

Returns the End states.

MISSION:GetProcess(From, Event)

MISSION:GetProcesses()

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

MISSION:GetScores()

Returns a table with the scores defined.

MISSION:GetStartState()

Returns the start state of the FSM.

MISSION:GetState()

MISSION:GetSubs()

Returns a table with the Subs defined.

MISSION:GetTransitions()

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

MISSION:Is(State)

MISSION:LoadCallBacks(CallBackTable)

MISSION:New()

Creates a new FSM object.

MISSION.Scores

MISSION:SetProcess(From, Event, Fsm)

MISSION:SetStartState(State)

Sets the start state of the FSM.

MISSION._EndStates

MISSION._EventSchedules

MISSION._Processes

MISSION._Scores

MISSION._StartState

MISSION._Transitions

MISSION:_add_to_map(Map, Event)

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

MISSION:_create_transition(EventName)

MISSION:_delayed_transition(EventName)

MISSION:_eventmap(Events, EventStructure)

MISSION:_gosub(ParentFrom, ParentEvent)

MISSION:_handler(EventName, ...)

MISSION:_isendstate(Current)

MISSION:_submap(subs, sub, name)

MISSION:can(e)

MISSION:cannot(e)

MISSION.current

MISSION.endstates

MISSION:is(state)

MISSION.options

MISSION.subs

Fields and Methods inherited from BASE Description

MISSION.ClassID

The ID number of the class.

MISSION.ClassName

The name of the class.

MISSION.ClassNameAndID

The name of the class concatenated with the ID number of the class.

MISSION:ClearState(Object, StateName)

Clear the state of an object.

MISSION:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

Creation of a Birth Event.

MISSION:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

MISSION:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

MISSION:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

MISSION:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

MISSION:E(Arguments)

Log an exception which will be traced always.

MISSION:EventDispatcher()

Returns the event dispatcher

MISSION:EventRemoveAll()

Remove all subscribed events

MISSION:F(Arguments)

Trace a function call.

MISSION:F2(Arguments)

Trace a function call level 2.

MISSION:F3(Arguments)

Trace a function call level 3.

MISSION:GetClassID()

Get the ClassID of the class instance.

MISSION:GetClassName()

Get the ClassName of the class instance.

MISSION:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

MISSION:GetEventPriority()

Get the Class Event processing Priority.

MISSION:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

MISSION:GetState(Object, Key)

Get a Value given a Key from the Object.

MISSION:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

MISSION:I(Arguments)

Log an information which will be traced always.

MISSION:Inherit(Child, Parent)

This is the worker method to inherit from a parent class.

MISSION:IsInstanceOf(ClassName)

This is the worker method to check if an object is an (sub)instance of a class.

MISSION:IsTrace()

Enquires if tracing is on (for the class).

MISSION:New()

BASE constructor.

MISSION:OnEvent(EventData)

Occurs when an object is completely destroyed.

MISSION:OnEventBaseCaptured(EventData)

Occurs when a ground unit captures either an airbase or a farp.

MISSION:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

MISSION:OnEventCrash(EventData)

Occurs when any aircraft crashes into the ground and is completely destroyed.

MISSION:OnEventDead(EventData)

Occurs when an object is dead.

MISSION:OnEventEjection(EventData)

Occurs when a pilot ejects from an aircraft initiator : The unit that has ejected

MISSION:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

MISSION:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

MISSION:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

MISSION:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

MISSION:OnEventLand(EventData)

Occurs when an aircraft lands at an airbase, farp or ship initiator : The unit that has landed place: Object that the unit landed on.

MISSION:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

MISSION:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

MISSION:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

MISSION:OnEventMissionEnd(EventData)

Occurs when a mission ends

MISSION:OnEventMissionStart(EventData)

Occurs when a mission starts

MISSION:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

MISSION:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

MISSION:OnEventPlayerLeaveUnit(EventData)

Occurs when any player relieves control of a unit to the AI.

MISSION:OnEventRefueling(EventData)

Occurs when an aircraft connects with a tanker and begins taking on fuel.

MISSION:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

MISSION:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

MISSION:OnEventShootingStart(EventData)

Occurs when any unit begins firing a weapon that has a high rate of fire.

MISSION:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

MISSION:OnEventTakeoff(EventData)

Occurs when an aircraft takes off from an airbase, farp, or ship.

MISSION:ScheduleOnce(Start, SchedulerFunction, ...)

Schedule a new time event.

MISSION:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

Schedule a new time event.

MISSION:ScheduleStop(SchedulerFunction)

Stops the Schedule.

MISSION.Scheduler

MISSION:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

MISSION:SetState(Object, Key, Value)

Set a state or property of the Object given a Key and a Value.

MISSION:T(Arguments)

Trace a function logic level 1.

MISSION:T2(Arguments)

Trace a function logic level 2.

MISSION:T3(Arguments)

Trace a function logic level 3.

MISSION:TraceAll(TraceAll)

Trace all methods in MOOSE

MISSION:TraceClass(Class)

Set tracing for a class

MISSION:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

MISSION:TraceLevel(Level)

Set trace level

MISSION:TraceOff()

Set trace off.

MISSION:TraceOn()

Set trace on.

MISSION:TraceOnOff(TraceOnOff)

Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.

MISSION:UnHandleEvent(Event)

UnSubscribe to a DCS event.

MISSION._

MISSION:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

MISSION:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

MISSION.__

MISSION:onEvent(event)

Field(s)

Function(s)

Aborts a PlayerUnit from the Mission.

For each Task within the Mission, the PlayerUnit is removed from Task where it is assigned. If the Unit was not part of a Task in the Mission, false is returned. If the Unit is part of a Task in the Mission, true is returned.

Defined in:

MISSION

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The CLIENT or UNIT of the Player joining the Mission.

Return value:

Adds the groups for which TASKS are given in the mission

Defined in:

MISSION

Parameter:

Return value:

Defined in:

MISSION

Parameter:

PlayerName

Add a scoring to the mission.

Defined in:

MISSION

Parameter:

Scoring

Return value:

self

Register a Task to be completed within the Mission.

Note that there can be multiple Tasks registered to be completed. Each Task can be set a certain Goals. The Mission will not be completed until all Goals are reached.

Defined in:

MISSION

Parameter:

is the Task object.

Return value:

The task added.

Clear the Wrapper.Group assignment from the Mission.

Defined in:

MISSION

Parameter:

Wrapper.Group#GROUP MissionGroup

Return value:

Synchronous Event Trigger for Event Complete.

Defined in:

MISSION

Handles a crash of a PlayerUnit from the Mission.

For each Task within the Mission, the PlayerUnit is removed from Task where it is assigned. If the Unit was not part of a Task in the Mission, false is returned. If the Unit is part of a Task in the Mission, true is returned.

Defined in:

MISSION

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The CLIENT or UNIT of the Player crashing.

Return value:

Synchronous Event Trigger for Event Fail.

Defined in:

MISSION

Gets the COMMANDCENTER.

Defined in:

MISSION

Return value:

Get the relevant tasks of a TaskGroup.

Defined in:

MISSION

Parameters:

self

Return value:

#list<Tasking.Task#TASK>:

Gets the groups for which TASKS are given in the mission

Defined in:

MISSION

Parameter:

Return value:

Gets the mission menu for the TaskGroup.

Defined in:

MISSION

Parameter:

Task group.

Return value:

Gets the mission name.

Defined in:

MISSION

Return value:

self

Return the next Task ID to be completed within the Mission.

Defined in:

MISSION

Parameter:

is the Task object.

Return value:

The task added.

Defined in:

MISSION

Gets the root mission menu for the TaskGroup.

Obsolete?! Originally no reference to TaskGroup parameter!

Defined in:

MISSION

Parameter:

Task group.

Return value:

Get the scoring object of a mission.

Defined in:

MISSION

Return value:

Scoring

Gets the short mission text.

Defined in:

MISSION

Return value:

self

Get the TASK identified by the TaskNumber from the Mission.

This function is useful in GoalFunctions.

Defined in:

MISSION

Parameters:

#string TaskName

The Name of the Task within the Mission.

self

Return values:

The Task

#nil:

Returns nil if no task was found.

Defined in:

MISSION

Return value:

#number:

Get all the TASKs from the Mission.

This function is useful in GoalFunctions.

Defined in:

MISSION

Return value:

{TASK,...} Structure of TASKS with the TASK number as the key.

Usage:

-- Get Tasks from the Mission.
Tasks = Mission:GetTasks()
env.info( "Task 2 Completion = " .. Tasks[2]:GetGoalPercentage() .. "%" )

Defined in:

MISSION

Return value:

#number:

Gets the mission text.

Defined in:

MISSION

Return value:

self

Validates if the Mission has a Group

Defined in:

MISSION

Parameter:

TaskGroup

Return value:

#boolean:

true if the Mission has a Group.

Is the Mission COMPLETED.

Defined in:

MISSION

Return value:

#boolean:

Is the Mission ENGAGED.

Defined in:

MISSION

Return value:

#boolean:

Is the Mission FAILED.

Defined in:

MISSION

Return value:

#boolean:

Returns if the Mission is assigned to the Group.

Defined in:

MISSION

Parameter:

Wrapper.Group#GROUP MissionGroup

Return value:

#boolean:

Is the Mission HOLD.

Defined in:

MISSION

Return value:

#boolean:

Is the Mission IDLE.

Defined in:

MISSION

Return value:

#boolean:

Add a Unit to join the Mission.

For each Task within the Mission, the Unit is joined with the Task. If the Unit was not part of a Task in the Mission, false is returned. If the Unit is part of a Task in the Mission, true is returned.

Defined in:

MISSION

Parameters:

Wrapper.Unit#UNIT PlayerUnit

The CLIENT or UNIT of the Player joining the Mission.

Wrapper.Group#GROUP PlayerGroup

The GROUP of the player joining the Mission.

Return value:

#boolean:

true if Unit is part of a Task in the Mission.

Mark all the target locations on the Map.

Defined in:

MISSION

Parameter:

Wrapper.Group#GROUP ReportGroup

Return value:

#string:

Mark all the targets of the Mission on the Map.

Defined in:

MISSION

Parameter:

Wrapper.Group#GROUP ReportGroup

Reports the briefing.

Defined in:

MISSION

Parameter:

Wrapper.Group#GROUP ReportGroup

The group to which the report needs to be sent.

Defined in:

MISSION

Parameter:

Wrapper.Group#GROUP ReportGroup

Defined in:

MISSION

Parameter:

Wrapper.Group#GROUP ReportGroup

Defined in:

MISSION

Parameters:

#string TaskStatus

The status

Wrapper.Group#GROUP ReportGroup

Report the task summary.

Defined in:

MISSION

Parameter:

Wrapper.Group#GROUP ReportGroup

MissionGoals Trigger for MISSION

Defined in:

MISSION

This is the main MISSION declaration method.

Each Mission is like the master or a Mission orchestration between, Clients, Tasks, Stages etc.

Defined in:

MISSION

Parameters:

#string MissionName

Name of the mission. This name will be used to reference the status of each mission by the players.

#string MissionPriority

String indicating the "priority" of the Mission. e.g. "Primary", "Secondary". It is free format and up to the Mission designer to choose. There are no rules behind this field.

#string MissionBriefing

String indicating the mission briefing to be shown when a player joins a CLIENT.

DCS#coaliton.side MissionCoalition

Side of the coalition, i.e. and enumerator DCS.coalition.side corresponding to RED, BLUE or NEUTRAL.

Return value:

self

OnAfter Transition Handler for Event Complete.

Defined in:

MISSION

Parameters:

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnAfter Transition Handler for Event Fail.

Defined in:

MISSION

Parameters:

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

MissionGoals Handler OnAfter for MISSION

Defined in:

MISSION

Parameters:

#string From

#string Event

#string To

OnAfter Transition Handler for Event Start.

Defined in:

MISSION

Parameters:

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

MISSION

Parameters:

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnBefore Transition Handler for Event Complete.

Defined in:

MISSION

Parameters:

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

Defined in:

MISSION

Parameters:

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

MissionGoals Handler OnBefore for MISSION

Defined in:

MISSION

Parameters:

#string From

#string Event

#string To

Return value:

#boolean:

OnBefore Transition Handler for Event Start.

Defined in:

MISSION

Parameters:

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

MISSION

Parameters:

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

Defined in:

MISSION

Parameters:

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnEnter Transition Handler for State ENGAGED.

Defined in:

MISSION

Parameters:

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnEnter Transition Handler for State FAILED.

Defined in:

MISSION

Parameters:

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnEnter Transition Handler for State IDLE.

Defined in:

MISSION

Parameters:

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnLeave Transition Handler for State COMPLETED.

Defined in:

MISSION

Parameters:

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

Defined in:

MISSION

Parameters:

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

Defined in:

MISSION

Parameters:

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

Defined in:

MISSION

Parameters:

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

Removes the Planned Task menu.

Defined in:

MISSION

Parameter:

#number MenuTime

Removes a Task to be completed within the Mission.

Note that there can be multiple Tasks registered to be completed. Each Task can be set a certain Goals. The Mission will not be completed until all Goals are reached.

Defined in:

MISSION

Parameter:

is the Task object.

Return value:

#nil:

The cleaned Task reference.

Removes a Task menu.

Defined in:

MISSION

Parameter:

Return value:

self

Create a briefing report of the Mission.

Defined in:

MISSION

Return value:

#string:

Create a detailed report of the Mission, listing all the details of the Task.

Defined in:

MISSION

Parameter:

ReportGroup

Return value:

#string:

Create a overview report of the Mission (multiple lines).

Defined in:

MISSION

Parameters:

ReportGroup

TaskStatus

Return value:

#string:

Create an active player report of the Mission.

This reports provides a one liner of the mission status. It indicates how many players and how many Tasks.

Mission "<MissionName>" - <MissionStatus> - Active Players Report
 - Player "<PlayerName>: Task <TaskName> <TaskStatus>, Task <TaskName> <TaskStatus>
 - Player <PlayerName>: Task <TaskName> <TaskStatus>, Task <TaskName> <TaskStatus>
 - ..

Defined in:

MISSION

Parameter:

ReportGroup

Return value:

#string:

Create an Mission Progress report of the Mission.

This reports provides a one liner per player of the mission achievements per task.

Mission "<MissionName>" - <MissionStatus> - Active Players Report
 - Player <PlayerName>: Task <TaskName> <TaskStatus>: <Progress>
 - Player <PlayerName>: Task <TaskName> <TaskStatus>: <Progress>
 - ..

Defined in:

MISSION

Parameter:

ReportGroup

Return value:

#string:

Create a summary report of the Mission (one line).

Defined in:

MISSION

Parameter:

Wrapper.Group#GROUP ReportGroup

Return value:

#string:

Set Wrapper.Group assigned to the Mission.

Defined in:

MISSION

Parameter:

Wrapper.Group#GROUP MissionGroup

Return value:

Sets the Planned Task menu.

Defined in:

MISSION

Parameter:

#number MenuTime

Synchronous Event Trigger for Event Start.

Defined in:

MISSION

Synchronous Event Trigger for Event Stop.

Defined in:

MISSION

Asynchronous Event Trigger for Event Complete.

Defined in:

MISSION

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event Fail.

Defined in:

MISSION

Parameter:

#number Delay

The delay in seconds.

MissionGoals Asynchronous Trigger for MISSION

Defined in:

MISSION

Parameter:

#number Delay

Asynchronous Event Trigger for Event Start.

Defined in:

MISSION

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event Stop.

Defined in:

MISSION

Parameter:

#number Delay

The delay in seconds.

FSM function for a MISSION

Defined in:

MISSION

Parameters:

#string From

#string Event

#string To

Field(s)

Function(s)

Adds an End state.

Defined in:

Parameter:

State

Set the default 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.

Returns the End states.

Defined in:

Defined in:

Parameters:

From

Event

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

Defined in:

Return value:

#table:

Returns a table with the scores defined.

Defined in:

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

Returns a table with the Subs defined.

Defined in:

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

Defined in:

Return value:

#table:

Defined in:

Parameter:

State

Defined in:

Parameter:

CallBackTable

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.

Defined in:

Parameters:

Map

Event

Defined in:

Parameters:

step

trigger

params

EventName

Defined in:

Parameter:

EventName

Defined in:

Parameter:

EventName

Defined in:

Parameters:

Events

EventStructure

Defined in:

Parameters:

ParentFrom

ParentEvent

Defined in:

Parameters:

EventName

...

Defined in:

Parameter:

Current

Defined in:

Parameters:

subs

sub

name

Defined in:

Parameter:

e

Defined in:

Parameter:

e

Defined in:

Parameter:

state

Field(s)

Function(s)

Clear the state of an object.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

StateName

The key that is should be cleared.

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

#string IniUnitName

The initiating unit name.

place

subplace

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Remove Unit Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Takeoff Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Returns the event dispatcher

Defined in:

Return value:

Remove all subscribed events

Defined in:

Return value:

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

Get the ClassName + ClassID of the class instance.

The ClassName + ClassID is formatted as '%s#%09d'.

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

Get the Class Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Return value:

#number:

The Event processing Priority.

This is the worker method to retrieve the Parent class.

Note that the Parent class must be passed to call the parent class method.

self:GetParent(self):ParentMethod()


Defined in:

Parameters:

#BASE Child

This is the Child class from which the Parent class needs to be retrieved.

#BASE FromClass

(Optional) The class from which to get the parent.

Return value:

Get a Value given a Key from the Object.

Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

Return value:

The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.

Subscribe to a DCS Event.

Defined in:

Parameters:

#function EventFunction

(optional) The function to be called when the event occurs for the unit.

Return value:

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

This is the worker method to inherit from a parent class.

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

This is the worker method to check if an object is an (sub)instance of a class.

Examples:

  • ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

Defined in:

Parameter:

ClassName

is the name of the class or the class itself to run the check against

Return value:

#boolean:

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

BASE constructor.

This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.

function EVENT:New()
  local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
  return self
end
  

Defined in:

Return value:

Occurs when an object is completely destroyed.

initiator : The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

Occurs when a ground unit captures either an airbase or a farp.

initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

Defined in:

Parameter:

The EventData structure.

Occurs when any object is spawned into the mission.

initiator : The unit that was spawned

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft crashes into the ground and is completely destroyed.

initiator : The unit that has crashed

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

initiator : The unit that is dead.

Defined in:

Parameter:

The EventData structure.

Occurs when a pilot ejects from an aircraft initiator : The unit that has ejected

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

initiator : The unit that is stopping its engines.

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

initiator : The unit that is starting its engines.

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.

Defined in:

Parameter:

The EventData structure.

Occurs when any system fails on a human controlled aircraft.

initiator : The unit that had the failure

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft lands at an airbase, farp or ship initiator : The unit that has landed place: Object that the unit landed on.

Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

Occurs when a new mark was added.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission ends

Defined in:

Parameter:

The EventData structure.

Occurs when a mission starts

Defined in:

Parameter:

The EventData structure.

Occurs when the pilot of an aircraft is killed.

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. initiator : The unit that the pilot has died in.

Defined in:

Parameter:

The EventData structure.

Occurs when any player assumes direct control of a unit.

initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

Occurs when any player relieves control of a unit to the AI.

initiator : The unit that the player left.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft connects with a tanker and begins taking on fuel.

initiator : The unit that is receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

initiator : The unit that was receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

Event will always correspond with a shooting start event. initiator : The unit that was doing the shooting.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit begins firing a weapon that has a high rate of fire.

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. initiator : The unit that is doing the shooting. target: The unit that is being targeted.

Defined in:

Parameter:

The EventData structure.

Occurs whenever any unit in a mission fires a weapon.

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft takes off from an airbase, farp, or ship.

initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#number:

The ScheduleID of the planned schedule.

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#number Repeat

Specifies the interval in seconds when the scheduler will call the event function.

#number RandomizeFactor

Specifies a randomization factor between 0 and 1 to randomize the Repeat.

#number Stop

Specifies the amount of seconds when the scheduler will be stopped.

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#number:

The ScheduleID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

Set the Class Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Parameter:

#number EventPriority

The Event processing Priority.

Return value:

self

Set a state or property of the Object given a Key and a Value.

Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that will hold the Value set by the Key.

Key

The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

Value

The value to is stored in the object.

Return value:

The Value set.

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

Set tracing for a class

Defined in:

Parameter:

#string Class

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

#string Method

Set trace level

Defined in:

Parameter:

#number Level

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.

So tracing must be switched on manually in your mission if you are using Moose statically. When moose is loading dynamically (for moose class development), tracing is switched on by default.

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:

-- Switch the tracing On
BASE:TraceOnOff( true )

-- Switch the tracing Off
BASE:TraceOnOff( false )

UnSubscribe to a DCS event.

Defined in:

Parameter:

Return value:

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

TODO: Complete DCS#Event structure.
- The main event handling function... This function captures all events generated for the class. @param #BASE self @param DCS#Event event

Defined in:

Parameter:

event