Banner Image

Module Core.Settings

Core - Manages various settings for running missions, consumed by moose classes and provides a menu system for players to tweak settings in running missions.


Features:

  • Provide a settings menu system to the players.
  • Provide a player settings menu and an overall mission settings menu.
  • Mission settings provide default settings, while player settings override mission settings.
  • Provide a menu to select between different coordinate formats for A2G coordinates.
  • Provide a menu to select between different coordinate formats for A2A coordinates.
  • Provide a menu to select between different message time duration options.
  • Provide a menu to select between different metric systems.

The documentation of the SETTINGS class can be found further in this document.


AUTHORS and CONTRIBUTIONS

Contributions:

Authors:

  • FlightControl: Design & Programming

Global(s)

Global SETTINGS

Takes care of various settings that influence the behaviour of certain functionalities and classes within the MOOSE framework.

#SETTINGS SETTINGS

Takes care of various settings that influence the behaviour of certain functionalities and classes within the MOOSE framework.


The SETTINGS class takes care of various settings that influence the behaviour of certain functionalities and classes within the MOOSE framework. SETTINGS can work on 2 levels:

  • Default settings: A running mission has Default settings.
  • Player settings: For each player its own Player settings can be defined, overriding the Default settings.

So, when there isn't any Player setting defined for a player for a specific setting, or, the player cannot be identified, the Default setting will be used instead.

1) _SETTINGS object

MOOSE defines by default a singleton object called _SETTINGS. Use this object to modify all the Default settings for a running mission. For each player, MOOSE will automatically allocate also a player settings object, and will expose a radio menu to allow the player to adapt the settings to his own preferences.

2) SETTINGS Menu

Settings can be adapted by the Players and by the Mission Administrator through radio menus, which are automatically available in the mission. These menus can be found on level F10 under "Settings". There are two kinds of menus generated by the system.

2.1) Default settings menu

A menu is created automatically per Command Center that allows to modify the Default settings. So, when joining a CC unit, a menu will be available that allows to change the settings parameters FOR ALL THE PLAYERS! Note that the Default settings will only be used when a player has not choosen its own settings.

2.2) Player settings menu

A menu is created automatically per Player Slot (group) that allows to modify the Player settings. So, when joining a slot, a menu wil be available that allows to change the settings parameters FOR THE PLAYER ONLY! Note that when a player has not chosen a specific setting, the Default settings will be used.

2.3) Show or Hide the Player Setting menus

Of course, it may be requried not to show any setting menus. In this case, a method is available on the _SETTINGS object. Use SETTINGS.SetPlayerMenuOff() to hide the player menus, and use SETTINGS.SetPlayerMenuOn() show the player menus. Note that when this method is used, any player already in a slot will not have its menus visibility changed. The option will only have effect when a player enters a new slot or changes a slot.

Example:

 _SETTINGS:SetPlayerMenuOff() -- will disable the player menus.
 _SETTINGS:SetPlayerMenuOn() -- will enable the player menus.
 -- But only when a player exits and reenters the slot these settings will have effect!

3) Settings

There are different settings that are managed and applied within the MOOSE framework. See below a comprehensive description of each.

3.1) A2G coordinates display formatting

3.1.1) A2G coordinates setting types

Will customize which display format is used to indicate A2G coordinates in text as part of the Command Center communications.

3.1.2) A2G coordinates setting menu

The settings can be changed by using the Default settings menu on the Command Center or the Player settings menu on the Player Slot.

3.1.3) A2G coordinates setting methods

There are different methods that can be used to change the System settings using the _SETTINGS object.

3.1.4) A2G coordinates setting - additional notes

One additional note on BR. In a situation when a BR coordinate should be given, but there isn't any player context (no player unit to reference from), the MGRS formatting will be applied!

3.2) A2A coordinates formatting

3.2.1) A2A coordinates setting types

Will customize which display format is used to indicate A2A coordinates in text as part of the Command Center communications.

3.2.2) A2A coordinates setting menu

The settings can be changed by using the Default settings menu on the Command Center or the Player settings menu on the Player Slot.

3.2.3) A2A coordinates setting methods

There are different methods that can be used to change the System settings using the _SETTINGS object.

3.2.4) A2A coordinates settings - additional notes

One additional note on BRAA. In a situation when a BRAA coordinate should be given, but there isn't any player context (no player unit to reference from), the MGRS formatting will be applied!

3.3) Measurements formatting

3.3.1) Measurements setting types

Will customize the measurements system being used as part as part of the Command Center communications.

3.3.2) Measurements setting menu

The settings can be changed by using the Default settings menu on the Command Center or the Player settings menu on the Player Slot.

3.3.3) Measurements setting methods

There are different methods that can be used to change the Default settings using the _SETTINGS object.

3.4) Message display times

3.4.1) Message setting types

There are various Message Types that will influence the duration how long a message will appear as part of the Command Center communications.

  • Update message: A short update message.
  • Information message: Provides new information while executing a mission.
  • Briefing message: Provides a complete briefing before executing a mission.
  • Overview report: Provides a short report overview, the summary of the report.
  • Detailed report: Provides a complete report.

3.4.2) Message setting menu

The settings can be changed by using the Default settings menu on the Command Center or the Player settings menu on the Player Slot.

Each Message Type has specific timings that will be applied when the message is displayed. The Settings Menu will provide for each Message Type a selection of proposed durations from which can be choosen. So the player can choose its own amount of seconds how long a message should be displayed of a certain type. Note that Update messages can be chosen not to be displayed at all!

3.4.3) Message setting methods

There are different methods that can be used to change the System settings using the _SETTINGS object.

3.5) Era of the battle

The threat level metric is scaled according the era of the battle. A target that is AAA, will pose a much greather threat in WWII than on modern warfare. Therefore, there are 4 era that are defined within the settings:

  • WWII era: Use for warfare with equipment during the world war II time.
  • Korea era: Use for warfare with equipment during the Korea war time.
  • Cold War era: Use for warfare with equipment during the cold war time.
  • Modern era: Use for warfare with modern equipment in the 2000s.

There are different API defined that you can use with the _SETTINGS object to configure your mission script to work in one of the 4 era: SETTINGS.SetEraWWII(), SETTINGS.SetEraKorea(), SETTINGS.SetEraCold(), SETTINGS.SetEraModern()


Type(s)

Fields and Methods inherited from SETTINGS Description

SETTINGS:A2AMenuSystem(MenuGroup, RootMenu, A2ASystem)

SETTINGS.A2ASystem

SETTINGS:A2GMenuSystem(MenuGroup, RootMenu, A2GSystem)

SETTINGS.A2GSystem

SETTINGS.Era

SETTINGS:GetLL_DDM_Accuracy()

Gets the SETTINGS LL accuracy.

SETTINGS:GetMGRS_Accuracy()

Gets the SETTINGS MGRS accuracy.

SETTINGS:GetMessageTime(MessageType)

Gets the SETTINGS Message Display Timing of a MessageType

SETTINGS:IsA2A_BRAA()

Is BRA

SETTINGS:IsA2A_BULLS()

Is BULLS

SETTINGS:IsA2A_LL_DDM()

Is LL DDM

SETTINGS:IsA2A_LL_DMS()

Is LL DMS

SETTINGS:IsA2A_MGRS()

Is MGRS

SETTINGS:IsA2G_BR()

Is BRA

SETTINGS:IsA2G_LL_DDM()

Is LL DDM

SETTINGS:IsA2G_LL_DMS()

Is LL DMS

SETTINGS:IsA2G_MGRS()

Is MGRS

SETTINGS:IsImperial()

Gets if the SETTINGS is imperial.

SETTINGS:IsMetric()

Gets if the SETTINGS is metric.

SETTINGS.LL_Accuracy

SETTINGS.MGRS_Accuracy

SETTINGS:MenuGroupA2ASystem(PlayerUnit, PlayerGroup, PlayerName, A2ASystem)

SETTINGS:MenuGroupA2GSystem(PlayerUnit, PlayerGroup, PlayerName, A2GSystem)

SETTINGS:MenuGroupLL_DDM_AccuracySystem(PlayerUnit, PlayerGroup, PlayerName, LL_Accuracy)

SETTINGS:MenuGroupMGRS_AccuracySystem(PlayerUnit, PlayerGroup, PlayerName, MGRS_Accuracy)

SETTINGS:MenuGroupMWSystem(PlayerUnit, PlayerGroup, PlayerName, MW)

SETTINGS:MenuGroupMessageTimingsSystem(PlayerUnit, PlayerGroup, PlayerName, MessageType, MessageTime)

SETTINGS:MenuLL_DDM_Accuracy(MenuGroup, RootMenu, LL_Accuracy)

SETTINGS:MenuMGRS_Accuracy(MenuGroup, RootMenu, MGRS_Accuracy)

SETTINGS:MenuMWSystem(MenuGroup, RootMenu, MW)

SETTINGS:MenuMessageTimingsSystem(MenuGroup, RootMenu, MessageType, MessageTime)

SETTINGS.MessageTypeTimings

SETTINGS.Metric

SETTINGS.PlayerMenu

SETTINGS:RemovePlayerMenu(PlayerUnit)

Removes the player menu from the PlayerUnit.

SETTINGS:Set(PlayerName)

SETTINGS constructor.

SETTINGS:SetA2A_BRAA()

Sets A2A BRA

SETTINGS:SetA2A_BULLS()

Sets A2A BULLS

SETTINGS:SetA2A_LL_DDM()

Sets A2A LL DDM

SETTINGS:SetA2A_LL_DMS()

Sets A2A LL DMS

SETTINGS:SetA2A_MGRS()

Sets A2A MGRS

SETTINGS:SetA2G_BR()

Sets A2G BRA

SETTINGS:SetA2G_LL_DDM()

Sets A2G LL DDM

SETTINGS:SetA2G_LL_DMS()

Sets A2G LL DMS

SETTINGS:SetA2G_MGRS()

Sets A2G MGRS

SETTINGS:SetEraCold()

Configures the era of the mission to be Cold war.

SETTINGS:SetEraKorea()

Configures the era of the mission to be Korea.

SETTINGS:SetEraModern()

Configures the era of the mission to be Modern war.

SETTINGS:SetEraWWII()

Configures the era of the mission to be WWII.

SETTINGS:SetImperial()

Sets the SETTINGS imperial.

SETTINGS:SetLL_Accuracy(LL_Accuracy)

Sets the SETTINGS LL accuracy.

SETTINGS:SetMGRS_Accuracy(MGRS_Accuracy)

Sets the SETTINGS MGRS accuracy.

SETTINGS:SetMenuStatic(onoff)

Set menu to be static.

SETTINGS:SetMenutextShort(onoff)

Set short text for menus on (true) or off (false).

SETTINGS:SetMessageTime(MessageType, MessageTime)

Sets the SETTINGS Message Display Timing of a MessageType

SETTINGS:SetMetric()

Sets the SETTINGS metric.

SETTINGS:SetPlayerMenu(PlayerUnit)

Updates the menu of the player seated in the PlayerUnit.

SETTINGS:SetPlayerMenuOff()

Sets the player menus off, so that the Player setting menus won't show up for the players.

SETTINGS:SetPlayerMenuOn()

Sets the player menus on, so that the Player setting menus show up for the players.

SETTINGS:SetSystemMenu(MenuGroup, RootMenu)

SETTINGS.ShowPlayerMenu

SETTINGS.__Enum

Fields and Methods inherited from BASE Description

SETTINGS.ClassID

The ID number of the class.

SETTINGS.ClassName

The name of the class.

SETTINGS.ClassNameAndID

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

SETTINGS:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

SETTINGS:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

SETTINGS:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

SETTINGS:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

SETTINGS:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

SETTINGS:E(Arguments)

Log an exception which will be traced always.

SETTINGS:EventDispatcher()

Returns the event dispatcher

SETTINGS:EventRemoveAll()

Remove all subscribed events

SETTINGS:F(Arguments)

Trace a function call.

SETTINGS:F2(Arguments)

Trace a function call level 2.

SETTINGS:F3(Arguments)

Trace a function call level 3.

SETTINGS:GetClassID()

Get the ClassID of the class instance.

SETTINGS:GetClassName()

Get the ClassName of the class instance.

SETTINGS:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

SETTINGS:GetEventPriority()

Get the Class Event processing Priority.

SETTINGS:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

SETTINGS:GetState(Object, Key)

Get a Value given a Key from the Object.

SETTINGS:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

SETTINGS:I(Arguments)

Log an information which will be traced always.

SETTINGS:Inherit(Child, Parent)

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

SETTINGS:IsInstanceOf(ClassName)

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

SETTINGS:IsTrace()

Enquires if tracing is on (for the class).

SETTINGS:New()

BASE constructor.

SETTINGS:OnEvent(EventData)

Occurs when an object is completely destroyed.

SETTINGS:OnEventBaseCaptured(EventData)

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

SETTINGS:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

SETTINGS:OnEventCrash(EventData)

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

SETTINGS:OnEventDead(EventData)

Occurs when an object is dead.

SETTINGS:OnEventDetailedFailure(EventData)

Unknown precisely what creates this event, likely tied into newer damage model.

SETTINGS:OnEventEjection(EventData)

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

SETTINGS:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

SETTINGS:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

SETTINGS:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

SETTINGS:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

SETTINGS:OnEventKill(EventData)

Occurs on the death of a unit.

SETTINGS: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.

SETTINGS:OnEventLandingAfterEjection(EventData)

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

SETTINGS:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

SETTINGS:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

SETTINGS:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

SETTINGS:OnEventMissionEnd(EventData)

Occurs when a mission ends

SETTINGS:OnEventMissionStart(EventData)

Occurs when a mission starts

SETTINGS:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

SETTINGS:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

SETTINGS:OnEventPlayerLeaveUnit(EventData)

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

SETTINGS:OnEventRefueling(EventData)

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

SETTINGS:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

SETTINGS:OnEventScore(EventData)

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

SETTINGS:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

SETTINGS:OnEventShootingStart(EventData)

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

SETTINGS:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

SETTINGS:OnEventTakeoff(EventData)

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

SETTINGS:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

SETTINGS:ScheduleStop(SchedulerFunction)

Stops the Schedule.

SETTINGS.Scheduler

SETTINGS:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

SETTINGS:SetState(Object, Key, Value)

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

SETTINGS:T(Arguments)

Trace a function logic level 1.

SETTINGS:T2(Arguments)

Trace a function logic level 2.

SETTINGS:T3(Arguments)

Trace a function logic level 3.

SETTINGS:TraceAll(TraceAll)

Trace all methods in MOOSE

SETTINGS:TraceClass(Class)

Set tracing for a class

SETTINGS:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

SETTINGS:TraceLevel(Level)

Set trace level

SETTINGS:TraceOff()

Set trace off.

SETTINGS:TraceOn()

Set trace on.

SETTINGS: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.

SETTINGS:UnHandleEvent(Event)

UnSubscribe to a DCS event.

SETTINGS._

SETTINGS:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

SETTINGS:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

SETTINGS.__

SETTINGS:onEvent(event)

Fields and Methods inherited from SETTINGS.__Enum.Era Description

SETTINGS.__Enum.Era.Cold

SETTINGS.__Enum.Era.Korea

SETTINGS.__Enum.Era.Modern

SETTINGS.__Enum.Era.WWII

Field(s)

#boolean SETTINGS.Metric

Function(s)

Defined in:

SETTINGS

Parameters:

MenuGroup

RootMenu

A2ASystem

Defined in:

SETTINGS

Parameters:

MenuGroup

RootMenu

A2GSystem

Gets the SETTINGS LL accuracy.

Defined in:

SETTINGS

Return value:

#number:

Gets the SETTINGS MGRS accuracy.

Defined in:

SETTINGS

Return value:

#number:

Gets the SETTINGS Message Display Timing of a MessageType

Defined in:

SETTINGS

Parameter:

Core.Message#MESSAGE MessageType

The type of the message.

Return value:

#number:

Is BRA

Defined in:

SETTINGS

Return value:

#boolean:

true if BRA

Is BULLS

Defined in:

SETTINGS

Return value:

#boolean:

true if BULLS

Is LL DDM

Defined in:

SETTINGS

Return value:

#boolean:

true if LL DDM

Is LL DMS

Defined in:

SETTINGS

Return value:

#boolean:

true if LL DMS

Is MGRS

Defined in:

SETTINGS

Return value:

#boolean:

true if MGRS

Is BRA

Defined in:

SETTINGS

Return value:

#boolean:

true if BRA

Is LL DDM

Defined in:

SETTINGS

Return value:

#boolean:

true if LL DDM

Is LL DMS

Defined in:

SETTINGS

Return value:

#boolean:

true if LL DMS

Is MGRS

Defined in:

SETTINGS

Return value:

#boolean:

true if MGRS

Gets if the SETTINGS is imperial.

Defined in:

SETTINGS

Return value:

#boolean:

true if imperial.

Gets if the SETTINGS is metric.

Defined in:

SETTINGS

Return value:

#boolean:

true if metric.

Defined in:

SETTINGS

Parameters:

PlayerUnit

PlayerGroup

PlayerName

A2ASystem

Defined in:

SETTINGS

Parameters:

PlayerUnit

PlayerGroup

PlayerName

A2GSystem

Defined in:

SETTINGS

Parameters:

PlayerUnit

PlayerGroup

PlayerName

LL_Accuracy

Defined in:

SETTINGS

Parameters:

PlayerUnit

PlayerGroup

PlayerName

MGRS_Accuracy

Defined in:

SETTINGS

Parameters:

PlayerUnit

PlayerGroup

PlayerName

MW

Defined in:

SETTINGS

Parameters:

PlayerUnit

PlayerGroup

PlayerName

MessageType

MessageTime

Defined in:

SETTINGS

Parameters:

MenuGroup

RootMenu

LL_Accuracy

Defined in:

SETTINGS

Parameters:

MenuGroup

RootMenu

MGRS_Accuracy

Defined in:

SETTINGS

Parameters:

MenuGroup

RootMenu

MW

Defined in:

SETTINGS

Parameters:

MenuGroup

RootMenu

MessageType

MessageTime

Removes the player menu from the PlayerUnit.

Defined in:

SETTINGS

Parameter:

Return value:

self

SETTINGS constructor.

Defined in:

SETTINGS

Parameter:

PlayerName

Return value:

Sets A2A BRA

Defined in:

SETTINGS

Return value:

Sets A2A BULLS

Defined in:

SETTINGS

Return value:

Sets A2A LL DDM

Defined in:

SETTINGS

Return value:

Sets A2A LL DMS

Defined in:

SETTINGS

Return value:

Sets A2A MGRS

Defined in:

SETTINGS

Return value:

Sets A2G BRA

Defined in:

SETTINGS

Return value:

Sets A2G LL DDM

Defined in:

SETTINGS

Return value:

Sets A2G LL DMS

Defined in:

SETTINGS

Return value:

Sets A2G MGRS

Defined in:

SETTINGS

Return value:

Configures the era of the mission to be Cold war.

Defined in:

SETTINGS

Return value:

self

Configures the era of the mission to be Korea.

Defined in:

SETTINGS

Return value:

self

Configures the era of the mission to be Modern war.

Defined in:

SETTINGS

Return value:

self

Configures the era of the mission to be WWII.

Defined in:

SETTINGS

Return value:

self

Sets the SETTINGS imperial.

Defined in:

SETTINGS

Sets the SETTINGS LL accuracy.

Defined in:

SETTINGS

Parameter:

#number LL_Accuracy

Return value:

Sets the SETTINGS MGRS accuracy.

Defined in:

SETTINGS

Parameter:

#number MGRS_Accuracy

Return value:

Set menu to be static.

Defined in:

SETTINGS

Parameter:

#boolean onoff

If true menu is static. If false menu will be updated after changes (default).

Set short text for menus on (true) or off (false).

Short text are better suited for, e.g., VR.

Defined in:

SETTINGS

Parameter:

#boolean onoff

If true use short menu texts. If false long ones (default).

Sets the SETTINGS Message Display Timing of a MessageType

Defined in:

SETTINGS

Parameters:

Core.Message#MESSAGE MessageType

The type of the message.

#number MessageTime

The display time duration in seconds of the MessageType.

Sets the SETTINGS metric.

Defined in:

SETTINGS

Updates the menu of the player seated in the PlayerUnit.

Defined in:

SETTINGS

Parameter:

Return value:

self

Sets the player menus off, so that the Player setting menus won't show up for the players.

But only when a player exits and reenters the slot these settings will have effect! It is advised to use this method at the start of the mission.

Defined in:

SETTINGS

Return value:

self

Usage:

  _SETTINGS:SetPlayerMenuOff() -- will disable the player menus.

Sets the player menus on, so that the Player setting menus show up for the players.

But only when a player exits and reenters the slot these settings will have effect! It is advised to use this method at the start of the mission.

Defined in:

SETTINGS

Return value:

Usage:

  _SETTINGS:SetPlayerMenuOn() -- will enable the player menus.

Defined in:

SETTINGS

Parameters:

Group for which to add menus.

#table RootMenu

Root menu table

Return value:

Field(s)

#boolean SETTINGS.Metric

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.

Unknown precisely what creates this event, likely tied into newer damage model.

Will update this page when new information become available.

  • initiator: The unit that had the failure.

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 on the death of a unit.

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs.

  • initiator: The unit that killed the target
  • target: Target Object
  • weapon: Weapon Object

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 shortly after the landing animation of an ejected pilot touching the ground and standing up.

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker.

  • initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
  • place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
  • subplace: is always 0 for unknown reasons.

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 modification to the "Score" as seen on the debrief menu would occur.

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard.

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.

Occurs when the game thinks an object is destroyed.

  • initiator: The unit that is was destroyed.

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