Close ×

AI.AI_A2A

AI -- (R2.2) - Models the process of air operations for airplanes.
AI.AI_A2A_Cap

AI -- (R2.2) - Models the process of Combat Air Patrol (CAP) for airplanes.
AI.AI_A2A_Dispatcher

AI - (R2.2) - Manages the process of an automatic A2A defense system based on an EWR network targets and coordinating CAP and GCI.
AI.AI_A2A_GCI

AI -- (R2.2) - Models the process of Ground Controlled Interception (GCI) for airplanes.
AI.AI_A2A_Patrol

AI -- (R2.2) - Models the process of air patrol of airplanes.
AI.AI_Bai

AI -- Peform Battlefield Area Interdiction (BAI) within an engagement zone.
AI.AI_Balancer

AI -- Balance player slots with AI to create an engaging simulation environment, independent of the amount of players.
AI.AI_Cap

AI -- Perform Combat Air Patrolling (CAP) for airplanes.
AI.AI_Cargo

AI -- (R2.4) - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_APC

AI -- (R2.4) - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_Airplane

AI -- (R2.4) - Models the intelligent transportation of infantry (cargo).
AI.AI_Cargo_Dispatcher

AI -- (R2.4) - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_Dispatcher_APC

AI -- (2.4) - Models the intelligent transportation of infantry and other cargo using APCs.
AI.AI_Cargo_Dispatcher_Airplane

AI -- (R2.4) - Models the intelligent transportation of infantry and other cargo using Planes.
AI.AI_Cargo_Dispatcher_Helicopter

AI -- (2.4) - Models the intelligent transportation of infantry and other cargo using Helicopters.
AI.AI_Cargo_Helicopter

AI -- (R2.4) - Models the intelligent transportation of infantry (cargo).
AI.AI_Cas

AI -- Perform Close Air Support (CAS) near friendlies.
AI.AI_Formation

AI -- Build large airborne formations of aircraft.
AI.AI_Patrol

AI -- Perform Air Patrolling for airplanes.
Actions.Account

Actions - ACT_ACCOUNT_ classes account for (detect, count & report) various DCS events occuring on Wrapper.Units.
Actions.Assign

(SP) (MP) (FSM) Accept or reject process for player (task) assignments.
Actions.Assist

(SP) (MP) (FSM) Route AI or players through waypoints or to zones.
Actions.Route

(SP) (MP) (FSM) Route AI or players through waypoints or to zones.
Cargo.Cargo

Core -- Management of CARGO logistics, that can be transported from and to transportation carriers.
Cargo.CargoCrate

Cargo -- Management of single cargo crates, which are based on a Static object.
Cargo.CargoGroup

Cargo -- Management of grouped cargo logistics, which are based on a Wrapper.Group object.
Cargo.CargoSlingload

Cargo -- Management of single cargo crates, which are based on a Static object.
Cargo.CargoUnit

Cargo -- Management of single cargo logistics, which are based on a Wrapper.Unit object.
Core.Base

Core - The base class within the framework.
Core.Database

Core - Manages several databases containing templates, mission objects, and mission information.
Core.Event

Core - Models DCS event dispatching using a publish-subscribe model.
Core.Fsm

Core - FSM (Finite State Machine) are objects that model and control long lasting business processes and workflow.
Core.Goal

Core - Models the process to achieve goal(s).
Core.Menu

Core - Manage hierarchical menu structures and commands for players within a mission.
Core.Message

Core - Informs the players using messages during a simulation.
Core.Point

Core - Defines an extensive API to manage 3D points in the DCS World 3D simulation space.
Core.Radio

Core - Is responsible for everything that is related to radio transmission and you can hear in DCS, be it TACAN beacons, Radio transmissions.
Core.Report

Core - Provides a handy means to create messages and reports.
Core.ScheduleDispatcher

Core -- SCHEDULEDISPATCHER dispatches the different schedules.
Core.Scheduler

Core - Prepares and handles the execution of functions over scheduled time (intervals).
Core.Set

Core - Define collections of objects to perform bulk actions and logically group objects.
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.
Core.Spawn

Core - Spawn dynamically new groups of units in running missions.
Core.SpawnStatic

Core - Spawn new statics in your running missions.
Core.Spot

Core - Management of spotting logistics, that can be activated and deactivated upon command.
Core.UserFlag

Core - Manage user flags to interact with the mission editor trigger system and server side scripts.
Core.UserSound

Core - Manage user sound.
Core.Velocity

Core - Models a velocity or speed, which can be expressed in various formats according the settings.
Core.Zone

Core - Define zones within your mission of various forms, with various capabilities.
DCS

DCS API prototypes
See https://wiki.hoggitworld.com/view/Simulator_Scripting_Engine_Documentation 
for further explanation and examples.
Functional.ATC_Ground

Functional -- Monitor airbase traffic and regulate speed while taxiing.
Functional.Arty

Functional - Control artillery units.
Functional.CleanUp

Functional -- Keep airbases clean of crashing or colliding airplanes, and kill missiles when being fired at airbases.
Functional.Designate

Functional -- Management of target Designation.
Functional.Detection

Functional -- Models the detection of enemy units by FACs or RECCEs and group them according various methods.
Functional.Escort

Functional -- Taking the lead of AI escorting your flight.
Functional.MissileTrainer

Functional -- Train missile defence and deflection.
Functional.Movement

Functional -- Limit the movement of simulaneous moving ground vehicles.
Functional.PseudoATC

Functional - Rudimentary ATC.
Functional.Range

Functional - Range Practice.
Functional.Rat

Functional - Create random airtraffic in your missions.
Functional.Scoring

Functional - Administer the scoring of player achievements, and create a CSV file logging the scoring events for use at team or squadron websites.
Functional.Sead

Functional -- Make SAM sites execute evasive and defensive behaviour when being fired upon.
Functional.Suppression

Functional - Suppress fire of ground units when they get hit.
Functional.Warehouse

Functional - Simulation of logistic operations.
Functional.ZoneCaptureCoalition

Functional -- Models the process to zone guarding and capturing.
Functional.ZoneGoal

Functional (WIP) -- Base class that models processes to achieve goals involving a Zone.
Functional.ZoneGoalCargo

Functional (WIP) -- Base class that models processes to achieve goals involving a Zone and Cargo.
Functional.ZoneGoalCoalition

Functional (WIP) -- Base class that models processes to achieve goals involving a Zone for a Coalition.
Tasking.CommandCenter

Tasking -- A command center governs multiple missions, and takes care of the reporting and communications.
Tasking.DetectionManager

Tasking - This module contains the DETECTION_MANAGER class and derived classes.
Tasking.Mission

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

Tasking -- A task object governs the main engine to administer human taskings.
Tasking.TaskInfo

Tasking -- Controls the information of a Task.
Tasking.TaskZoneCapture

Tasking - The TASK_Protect models tasks for players to protect or capture specific zones.
Tasking.Task_A2A

Tasking - The TASK_A2A models tasks for players in Air to Air engagements.
Tasking.Task_A2A_Dispatcher

Tasking - Dynamically allocates A2A tasks to human players, based on detected airborne targets through an EWR network.
Tasking.Task_A2G

Tasking - The TASK_A2G models tasks for players in Air to Ground engagements.
Tasking.Task_A2G_Dispatcher

Tasking -- Dynamically allocates A2G tasks to human players, based on detected ground targets through reconnaissance.
Tasking.Task_Cargo

Tasking -- Base class to model tasks for players to transport cargo.
Tasking.Task_Cargo_CSAR

Tasking -- Orchestrates the task for players to execute CSAR for downed pilots.
Tasking.Task_Cargo_Dispatcher

Tasking - Creates and manages player TASK_CARGO tasks.
Tasking.Task_Cargo_Transport

Tasking -- Models tasks for players to transport cargo.
Tasking.Task_Manager

This module contains the TASK_MANAGER class and derived classes.
Utils

This module contains derived utilities taken from the MIST framework, 
which are excellent tools to be reused in an OO environment!.
Wrapper.Airbase

Wrapper -- AIRBASE is a wrapper class to handle the DCS Airbase objects.
Wrapper.Client

Wrapper -- CLIENT wraps DCS Unit objects acting as a Client or Player within a mission.
Wrapper.Controllable

Wrapper -- CONTROLLABLE is an intermediate class wrapping Group and Unit classes "controllers".
Wrapper.Group

Wrapper -- GROUP wraps the DCS Class Group objects.
Wrapper.Identifiable

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.
Wrapper.Object

Wrapper -- OBJECT wraps the DCS Object derived objects.
Wrapper.Positionable

Wrapper -- POSITIONABLE wraps DCS classes that are "positionable".
Wrapper.Scenery

Wrapper -- SCENERY models scenery within the DCS simulator.
Wrapper.Static

Wrapper -- STATIC wraps the DCS StaticObject class.
Wrapper.Unit

Wrapper - UNIT is a wrapper class for the DCS Class Unit.
routines

Various routines

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.

A2G BR: Bearing Range.
A2G MGRS: The Military Grid Reference System. The accuracy can also be adapted.
A2G LL DMS: Lattitude Longitude Degrees Minutes Seconds. The accuracy can also be adapted.
A2G LL DDM: Lattitude Longitude Decimal Degrees Minutes. The accuracy can also be adapted.

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.

SETTINGS.SetA2G_BR(): Enable the BR display formatting by default.
SETTINGS.SetA2G_MGRS(): Enable the MGRS display formatting by default. Use SETTINGS.SetMGRS_Accuracy() to adapt the accuracy of the MGRS formatting.
SETTINGS.SetA2G_LL_DMS(): Enable the LL DMS display formatting by default. Use SETTINGS.SetLL_Accuracy() to adapt the accuracy of the Seconds formatting.
SETTINGS.SetA2G_LL_DDM(): Enable the LL DDM display formatting by default. Use SETTINGS.SetLL_Accuracy() to adapt the accuracy of the Seconds formatting.

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.

A2A BRAA: Bearing Range Altitude Aspect.
A2A MGRS: The Military Grid Reference System. The accuracy can also be adapted.
A2A LL DMS: Lattitude Longitude Degrees Minutes Seconds. The accuracy can also be adapted.
A2A LL DDM: Lattitude Longitude Decimal Degrees and Minutes. The accuracy can also be adapted.
A2A BULLS: Bullseye.

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.

SETTINGS.SetA2A_BRAA(): Enable the BR display formatting by default.
SETTINGS.SetA2A_MGRS(): Enable the MGRS display formatting by default. Use SETTINGS.SetMGRS_Accuracy() to adapt the accuracy of the MGRS formatting.
SETTINGS.SetA2A_LL_DMS(): Enable the LL DMS display formatting by default. Use SETTINGS.SetLL_Accuracy() to adapt the accuracy of the Seconds formatting.
SETTINGS.SetA2A_LL_DDM(): Enable the LL DDM display formatting by default. Use SETTINGS.SetLL_Accuracy() to adapt the accuracy of the Seconds formatting.
SETTINGS.SetA2A_BULLS(): Enable the BULLSeye display formatting by default.

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.

Metrics system: Applies the Metrics system ...
Imperial system: Applies the Imperial system ...

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.

SETTINGS.SetMetric(): Enable the Metric system.
SETTINGS.SetImperial(): Enable the Imperial system.

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.

SETTINGS.SetMessageTime(): Define for a specific Message.MESSAGE.MessageType the duration to be displayed in seconds.
SETTINGS.GetMessageTime(): Retrieves for a specific Message.MESSAGE.MessageType the duration to be displayed in seconds.

Type(s)

Type SETTINGS

SETTINGS , extends Core.Base#BASE

Fields and Methods inherited from SETTINGS	Description
SETTINGS:A2AMenuSystem(MenuGroup, RootMenu, A2ASystem)
SETTINGS.A2ASystem
SETTINGS:A2GMenuSystem(MenuGroup, RootMenu, A2GSystem)
SETTINGS.A2GSystem
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: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: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

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

Type Core.Settings

Type SETTINGS

Field(s)

SETTINGS.A2ASystem

#string SETTINGS.A2GSystem

SETTINGS.LL_Accuracy

SETTINGS.MGRS_Accuracy

#boolean SETTINGS.Metric

SETTINGS.PlayerMenu

#boolean SETTINGS.ShowPlayerMenu

Function(s)

SETTINGS:A2AMenuSystem(MenuGroup, RootMenu, A2ASystem)

Defined in:

SETTINGS

Parameters:

MenuGroup

RootMenu

A2ASystem

SETTINGS:A2GMenuSystem(MenuGroup, RootMenu, A2GSystem)

The type of the message.

Defined in:

SETTINGS

Parameters:

PlayerUnit

PlayerGroup

PlayerName

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

Defined in:

SETTINGS

Defined in:

SETTINGS

Parameters:

MenuGroup

RootMenu

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

Defined in:

SETTINGS

Parameters:

MenuGroup

RootMenu

MessageType

MessageTime

SETTINGS:RemovePlayerMenu(PlayerUnit)

Removes the player menu from the PlayerUnit.

Defined in:

SETTINGS

Parameter:

Wrapper.Client#CLIENT PlayerUnit

Return value:

The type of the message.

#number MessageTime

The display time duration in seconds of the MessageType.

SETTINGS:SetMetric()

Sets the SETTINGS metric.

Defined in:

SETTINGS

SETTINGS:SetPlayerMenu(PlayerUnit)

Updates the menu of the player seated in the PlayerUnit.

Defined in:

SETTINGS

Parameter:

Wrapper.Client#CLIENT PlayerUnit

Return value:

#SETTINGS:

self

SETTINGS:SetPlayerMenuOff()

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:

#SETTINGS:

self

Usage:

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

SETTINGS:SetPlayerMenuOn()

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:

#SETTINGS:

Usage:

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

SETTINGS:SetSystemMenu(MenuGroup, RootMenu)

Defined in:

SETTINGS

Parameters:

MenuGroup

RootMenu

Return value:

#SETTINGS:

Field(s)

SETTINGS.A2ASystem

#string SETTINGS.A2GSystem

SETTINGS.LL_Accuracy

SETTINGS.MGRS_Accuracy

#boolean SETTINGS.Metric

SETTINGS.PlayerMenu

#boolean SETTINGS.ShowPlayerMenu

Function(s)

SETTINGS:ClearState(Object, StateName)

Clear the state of an object.