Close ×

AI.AI_A2A_Cap

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

AI - 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 - Models the process of Ground Controlled Interception (GCI) for airplanes.
AI.AI_A2A_Patrol

AI - Models the process of air patrol of airplanes.
AI.AI_A2G_BAI

AI - Models the process of air to ground BAI engagement for airplanes and helicopters.
AI.AI_A2G_CAS

AI - Models the process of air to ground engagement for airplanes and helicopters.
AI.AI_A2G_Dispatcher

AI - Create an automated A2G defense system with reconnaissance units, coordinating SEAD, BAI and CAS operations.
AI.AI_A2G_SEAD

AI - Models the process of air to ground SEAD engagement for airplanes and helicopters.
AI.AI_Air

AI - Models the process of AI air operations.
AI.AI_Air_Dispatcher

AI - Create an automated AIR defense system with reconnaissance units, coordinating SEAD, BAI and CAP operations.
AI.AI_Air_Engage

AI - Models the process of air to ground engagement for airplanes and helicopters.
AI.AI_Air_Patrol

AI - Models the process of A2G patrolling and engaging ground targets for airplanes and helicopters.
AI.AI_Air_Squadron

AI - Models squadrons for airplanes and helicopters.
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_CAS

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

AI - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_APC

AI - Models the intelligent transportation of cargo using ground vehicles.
AI.AI_Cargo_Airplane

AI - Models the intelligent transportation of cargo using airplanes.
AI.AI_Cargo_Dispatcher

AI - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_Dispatcher_APC

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

AI - Models the intelligent transportation of infantry and other cargo using Planes.
AI.AI_Cargo_Dispatcher_Helicopter

AI - Models the intelligent transportation of infantry and other cargo using Helicopters.
AI.AI_Cargo_Dispatcher_Ship

AI - Models the intelligent transportation of infantry and other cargo using Ships.
AI.AI_Cargo_Helicopter

AI - Models the intelligent transportation of cargo using helicopters.
AI.AI_Cargo_Ship

AI - Models the intelligent transportation of infantry and other cargo.
AI.AI_Escort

AI - Taking the lead of AI escorting your flight or of other AI.
AI.AI_Escort_Dispatcher

AI - Models the automatic assignment of AI escorts to player flights.
AI.AI_Escort_Dispatcher_Request

AI - Models the assignment of AI escorts to player flights upon request using the radio menu.
AI.AI_Escort_Request

AI - Taking the lead of AI escorting your flight or of other AI, upon request using the menu.
AI.AI_Formation

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

AI - Perform Air Patrolling for airplanes.
Actions.Act_Account

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

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

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

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

Cargo - 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 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 UNIT object.
Core.Astar

Core - A* Pathfinding.
Core.Base

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

Core - TACAN and other beacons.
Core.Condition

Core - Define any or all conditions to be evaluated.
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.MarkerOps_Base

Core - Tap into markers added to the F10 map by users.
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.Pathline

Core - Path from A to B.
Core.Point

Core - Defines an extensive API to manage 3D points in the DCS World 3D simulation space.
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 missions, providing a menu for players to tweak settings in running missions.
Core.Spawn

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

Core - Spawn statics.
Core.Spot

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

Core - A Moose GetText system.
Core.Timer

Core - Timer scheduler.
Core.UserFlag

Core - Manage user flags to interact with the mission editor trigger system and server side scripts.
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.
Core.Zone_Detection

Core - The ZONE_DETECTION class, defined by a zone name, a detection object and a radius.
DCS

DCS API Prototypes.
Functional.ATC_Ground

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

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

Functional - Captures the class DETECTION_ZONES.
Functional.Escort

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

Functional - Yet Another Missile Trainer.
Functional.Mantis

Functional - Modular, Automatic and Network capable Targeting and Interception System for Air Defenses.
Functional.MissileTrainer

Functional - Train missile defence and deflection.
Functional.Movement

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

Functional - Basic ATC.
Functional.RAT

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

Functional - Range Practice.
Functional.Scoring

Functional - Administer the scoring of player achievements, file and log the scoring events for use at websites.
Functional.Sead

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

Functional - Short Range Air Defense System.
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 - Base class that models processes to achieve goals involving a Zone.
Functional.ZoneGoalCargo

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

Functional - Base class that models processes to achieve goals involving a Zone for a Coalition.
Ops.ATIS


Ops.Airboss

Ops - Manages aircraft CASE X recoveries for carrier operations (X=I, II, III).
Ops.CSAR

Ops - Combat Search and Rescue.
Ops.CTLD

Ops - Combat Troops & Logistics Department.
Ops.RecoveryTanker

Ops - Recovery tanker for carrier operations.
Ops.RescueHelo

Ops - Rescue helicopter for carrier operations.
Sound.Radio

Sound - Radio transmissions.
Sound.RadioQueue

Sound - Queues Radio Transmissions.
Sound.RadioSpeech

Core - Makes the radio talk.
Sound.SRS

Sound - Simple Radio Standalone (SRS) Integration and Text-to-Speech.
Sound.SoundOutput

Sound - Sound output classes.
Sound.UserSound

Sound - Manage user sound.
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.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_Capture_Dispatcher

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.
Tasking.Task_Capture_Zone

Tasking - The TASK_Protect models tasks for players to protect or capture specific zones.
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

Tasking - This module contains the TASK_MANAGER class and derived classes.
Utilities.Enums

Utilities Enumerators.
Utilities.FiFo

 UTILS - Classic FiFo Stack.
Utilities.Profiler

Utils - Lua Profiler.
Utilities.STTS

Utilities  - DCS Simple Text-To-Speech (STTS).
Utilities.Socket

Utilities - Socket.
Utilities.Templates

Utilities - Templates.
Utilities.Utils

Utilities - Derived utilities taken from the MIST framework, added helpers from the MOOSE community.
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.Marker

Wrapper - Markers On the F10 map.
Wrapper.Net

Wrapper - DCS net functions.
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.Storage

Wrapper - Warehouse storage of DCS airbases.
Wrapper.Unit

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

Wrapper - Weapon functions.

Module Core.Database

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

Features:

During mission startup, scan the mission environment, and create / instantiate intelligently the different objects as defined within the mission.
Manage database of DCS Group templates (as modelled using the mission editor).
- Group templates.
- Unit templates.
- Statics templates.
Manage database of Wrapper.Group#GROUP objects alive in the mission.
Manage database of Wrapper.Unit#UNIT objects alive in the mission.
Manage database of Wrapper.Static#STATIC objects alive in the mission.
Manage database of players.
Manage database of client slots defined using the mission editor.
Manage database of airbases on the map, and from FARPs and ships as defined using the mission editor.
Manage database of countries.
Manage database of zone names.
Manage database of hits to units and statics.
Manage database of destroys of units and statics.
Manage database of Core.Zone#ZONE_BASE objects.

Author: FlightControl

Contributions: funkyfranky

Global(s)

Global DATABASE

Contains collections of wrapper objects defined within MOOSE that reflect objects within the simulator.

#DATABASE DATABASE

Contains collections of wrapper objects defined within MOOSE that reflect objects within the simulator.

Mission designers can use the DATABASE class to refer to:

STATICS
UNITS
GROUPS
CLIENTS
AIRBASES
PLAYERSJOINED
PLAYERS
CARGOS
STORAGES (DCS warehouses)

On top, for internal MOOSE administration purposes, the DATABASE administers the Unit and Group TEMPLATES as defined within the Mission Editor.

The singleton object _DATABASE is automatically created by MOOSE, that administers all objects within the mission. Moose refers to _DATABASE within the framework extensively, but you can also refer to the _DATABASE object within your missions if required.

Type(s)

Type DATABASE

DATABASE

Fields and Methods inherited from DATABASE	Description
DATABASE:AccountDestroys(Event)	Account the destroys.
DATABASE:AccountHits(Event)	Account the Hits of the Players.
DATABASE:AddAirbase(AirbaseName)	Adds a Airbase based on the Airbase Name in the DATABASE.
DATABASE:AddCargo(CargoName, Cargo)	Adds a Cargo based on the Cargo Name in the DATABASE.
DATABASE:AddClient(ClientName)	Adds a CLIENT based on the ClientName in the DATABASE.
DATABASE:AddFlightControl(flightcontrol)	Add a flight control to the data base.
DATABASE:AddGroup(GroupName)	Adds a GROUP based on the GroupName in the DATABASE.
DATABASE:AddOpsGroup(opsgroup)	Add an OPS group (FLIGHTGROUP, ARMYGROUP, NAVYGROUP) to the data base.
DATABASE:AddOpsZone(OpsZone)	Adds a Ops.OpsZone#OPSZONE based on the zone name in the DATABASE.
DATABASE:AddPathline(PathlineName, Pathline)	Adds a Core.Pathline based on its name in the DATABASE.
DATABASE:AddPlayer(UnitName, PlayerName)	Adds a player based on the Player Name in the DATABASE.
DATABASE:AddStatic(DCSStaticName)	Adds a Static based on the Static Name in the DATABASE.
DATABASE:AddStorage(AirbaseName)	Adds a STORAGE (DCS warehouse wrapper) based on the Airbase Name to the DATABASE.
DATABASE:AddUnit(DCSUnitName)	Adds a Unit based on the Unit Name in the DATABASE.
DATABASE:AddZone(ZoneName, Zone)	Adds a Core.Zone based on the zone name in the DATABASE.
DATABASE:AddZoneGoal(ZoneName, Zone)	Adds a Core.Zone based on the zone name in the DATABASE.
DATABASE:DeleteAirbase(AirbaseName)	Deletes a Airbase from the DATABASE based on the Airbase Name.
DATABASE:DeleteCargo(CargoName)	Deletes a Cargo from the DATABASE based on the Cargo Name.
DATABASE:DeleteOpsZone(ZoneName)	Deletes a Ops.OpsZone#OPSZONE from the DATABASE based on the zone name.
DATABASE:DeletePathline(PathlineName)	Deletes a Core.Pathline from the DATABASE based on its name.
DATABASE:DeletePlayer(UnitName, PlayerName)	Deletes a player from the DATABASE based on the Player Name.
DATABASE:DeleteStatic(DCSStaticName)	Deletes a Static from the DATABASE based on the Static Name.
DATABASE:DeleteStorage(AirbaseName)	Deletes a STORAGE from the DATABASE based on the name of the associated airbase.
DATABASE:DeleteUnit(DCSUnitName)	Deletes a Unit from the DATABASE based on the Unit Name.
DATABASE:DeleteZone(ZoneName)	Deletes a Core.Zone from the DATABASE based on the zone name.
DATABASE:DeleteZoneGoal(ZoneName)	Deletes a Core.Zone from the DATABASE based on the zone name.
DATABASE:FindAirbase(AirbaseName)	Finds an AIRBASE based on the AirbaseName.
DATABASE:FindCargo(CargoName)	Finds an CARGO based on the CargoName.
DATABASE:FindClient(ClientName)	Finds a CLIENT based on the ClientName.
DATABASE:FindGroup(GroupName)	Finds a GROUP based on the GroupName.
DATABASE:FindOpsGroup(groupname)	Find an OPSGROUP (FLIGHTGROUP, ARMYGROUP, NAVYGROUP) in the data base.
DATABASE:FindOpsGroupFromUnit(unitname)	Find an OPSGROUP (FLIGHTGROUP, ARMYGROUP, NAVYGROUP) in the data base for a given unit.
DATABASE:FindOpsZone(ZoneName)	Finds a Ops.OpsZone#OPSZONE based on the zone name.
DATABASE:FindPathline(PathlineName)	Finds a Core.Pathline by its name.
DATABASE:FindStatic(StaticName)	Finds a STATIC based on the StaticName.
DATABASE:FindStorage(AirbaseName)	Finds an STORAGE based on the name of the associated airbase.
DATABASE:FindUnit(UnitName)	Finds a Unit based on the Unit Name.
DATABASE:FindZone(ZoneName)	Finds a Core.Zone based on the zone name.
DATABASE:FindZoneGoal(ZoneName)	Finds a Core.Zone based on the zone name.
DATABASE:ForEach(IteratorFunction, FinalizeFunction, arg, Set)	Iterate the DATABASE and call an iterator function for the given set, providing the Object for each element within the set and optional parameters.
DATABASE:ForEachCargo(IteratorFunction, FinalizeFunction, ...)	Iterate the DATABASE and call an iterator function for each CARGO, providing the CARGO object to the function and optional parameters.
DATABASE:ForEachClient(IteratorFunction, FinalizeFunction, ...)	Iterate the DATABASE and call an iterator function for each CLIENT, providing the CLIENT to the function and optional parameters.
DATABASE:ForEachGroup(IteratorFunction, FinalizeFunction, ...)	Iterate the DATABASE and call an iterator function for each alive GROUP, providing the GROUP and optional parameters.
DATABASE:ForEachPlayer(IteratorFunction, FinalizeFunction, ...)	Iterate the DATABASE and call an iterator function for each ALIVE player, providing the player name and optional parameters.
DATABASE:ForEachPlayerJoined(IteratorFunction, FinalizeFunction, ...)	Iterate the DATABASE and call an iterator function for each player who has joined the mission, providing the Unit of the player and optional parameters.
DATABASE:ForEachPlayerUnit(IteratorFunction, FinalizeFunction, ...)	Iterate the DATABASE and call an iterator function for each ALIVE player UNIT, providing the player UNIT and optional parameters.
DATABASE:ForEachStatic(IteratorFunction, FinalizeFunction, ...)	Iterate the DATABASE and call an iterator function for each alive STATIC, providing the STATIC and optional parameters.
DATABASE:ForEachUnit(IteratorFunction, FinalizeFunction, ...)	Iterate the DATABASE and call an iterator function for each alive UNIT, providing the UNIT and optional parameters.
DATABASE:GetCategoryFromAirbase(AirbaseName)	Get category from airbase name.
DATABASE:GetCategoryFromClientTemplate(ClientName)	Get category ID from client name.
DATABASE:GetCoalitionFromAirbase(AirbaseName)	Get coalition ID from airbase name.
DATABASE:GetCoalitionFromClientTemplate(ClientName)	Get coalition ID from client name.
DATABASE:GetCountryFromClientTemplate(ClientName)	Get country ID from client name.
DATABASE:GetFlightControl(airbasename)	Get a flight control object from the data base.
DATABASE:GetGroupNameFromUnitName(UnitName)	Get group name from unit name.
DATABASE:GetGroupTemplate(GroupName)	Get group template.
DATABASE:GetGroupTemplateFromUnitName(UnitName)	Get group template from unit name.
DATABASE:GetOpsGroup(groupname)	Get an OPS group (FLIGHTGROUP, ARMYGROUP, NAVYGROUP) from the data base.
DATABASE:GetPlayerSettings(PlayerName)	Gets the player settings
DATABASE:GetPlayerUnits()	Get the player table from the DATABASE, which contains all UNIT objects.
DATABASE:GetPlayers()	Get the player table from the DATABASE.
DATABASE:GetPlayersJoined()	Get the player table from the DATABASE which have joined in the mission historically.
DATABASE:GetStaticGroupTemplate(StaticName)	Get static group template.
DATABASE:GetStaticUnitTemplate(StaticName)	Get static unit template.
DATABASE:GetStatusGroup(GroupName)	Get a status to a Group within the Database, this to check crossing events for example.
DATABASE:GetUnitTemplateFromUnitName(UnitName)	Get group template from unit name.
DATABASE:IsCargo(TemplateName)	Checks if the Template name has a #CARGO tag.
DATABASE:New()	Creates a new DATABASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.
DATABASE:OnEventDeleteCargo(EventData)	Handles the OnEventDeleteCargo.
DATABASE:OnEventDeleteZone(EventData)	Handles the OnEventDeleteZone.
DATABASE:OnEventNewCargo(EventData)	Handles the OnEventNewCargo event.
DATABASE:OnEventNewZone(EventData)	Handles the OnEventNewZone event.
DATABASE:SetPlayerSettings(PlayerName, Settings)	Sets the player settings
DATABASE:SetStatusGroup(GroupName, Status)	Set a status to a Group within the Database, this to check crossing events for example.
DATABASE:Spawn(SpawnTemplate)	Instantiate new Groups within the DCSRTE.
DATABASE.UNITS_Position
DATABASE:_EventOnBirth(Event)	Handles the OnBirth event for the alive units set.
DATABASE:_EventOnDeadOrCrash(Event)	Handles the OnDead or OnCrash event for alive units set.
DATABASE:_EventOnPlayerEnterUnit(Event)	Handles the OnPlayerEnterUnit event to fill the active players table (with the unit filter applied).
DATABASE:_EventOnPlayerLeaveUnit(Event)	Handles the OnPlayerLeaveUnit event to clean the active players table.
DATABASE:_RegisterAirbase(airbase)	Register a DCS airbase.
DATABASE:_RegisterAirbases()	Register all world airbases.
DATABASE:_RegisterCargos()	Private method that registers new Static Templates within the DATABASE Object.
DATABASE:_RegisterClients()	Private method that registers all Units of skill Client or Player within in the mission.
DATABASE:_RegisterGroupTemplate(GroupTemplate, CoalitionSide, CategoryID, CountryID, GroupName)	Private method that registers new Group Templates within the DATABASE Object.
DATABASE:_RegisterGroupsAndUnits()	Private method that registers all Groups and Units within in the mission.
DATABASE:_RegisterPlayers()	Private method that registers all alive players in the mission.
DATABASE:_RegisterStaticTemplate(StaticTemplate, CoalitionID, CategoryID, CountryID)	Private method that registers new Static Templates within the DATABASE Object.
DATABASE:_RegisterStatics()	Private method that registeres all static objects.
DATABASE:_RegisterTemplates()
DATABASE:_RegisterZones()	Private method that registers new ZONE_BASE derived objects within the DATABASE Object.

Type Core.Database

Type DATABASE

Field(s)

#number DATABASE.UNITS_Position

Function(s)

DATABASE:AccountDestroys(Event)

Account the destroys.

Defined in:

DATABASE

Parameter:

Core.Event#EVENTDATA Event

DATABASE:AccountHits(Event)

Account the Hits of the Players.

Defined in:

DATABASE

Parameter:

Core.Event#EVENTDATA Event

DATABASE:AddAirbase(AirbaseName)

Adds a Airbase based on the Airbase Name in the DATABASE.

Defined in:

DATABASE

Parameter:

#string AirbaseName

The name of the airbase.

Return value:

Wrapper.Airbase#AIRBASE:

Airbase object.

DATABASE:AddCargo(CargoName, Cargo)

Adds a Cargo based on the Cargo Name in the DATABASE.

Defined in:

DATABASE

Parameters:

#string CargoName

The name of the airbase

Cargo

DATABASE:AddClient(ClientName)

Adds a CLIENT based on the ClientName in the DATABASE.

Defined in:

DATABASE

Parameter:

#string ClientName

Name of the Client unit.

Return value:

Wrapper.Client#CLIENT:

The client object.

DATABASE:AddFlightControl(flightcontrol)

Add a flight control to the data base.

Defined in:

DATABASE

Parameter:

Ops.FlightControl#FLIGHTCONTROL flightcontrol

DATABASE:AddGroup(GroupName)

Adds a GROUP based on the GroupName in the DATABASE.

Defined in:

DATABASE

Parameter:

GroupName

DATABASE:AddOpsGroup(opsgroup)

Add an OPS group (FLIGHTGROUP, ARMYGROUP, NAVYGROUP) to the data base.

Defined in:

DATABASE

Parameter:

Ops.OpsGroup#OPSGROUP opsgroup

The OPS group added to the DB.

DATABASE:AddOpsZone(OpsZone)

Adds a Ops.OpsZone#OPSZONE based on the zone name in the DATABASE.

Defined in:

DATABASE

Parameter:

Ops.OpsZone#OPSZONE OpsZone

The zone.

DATABASE:AddPathline(PathlineName, Pathline)

Adds a Core.Pathline based on its name in the DATABASE.

Defined in:

DATABASE

Parameters:

#string PathlineName

The name of the pathline

Core.Pathline#PATHLINE Pathline

The pathline.

DATABASE:AddPlayer(UnitName, PlayerName)

Adds a player based on the Player Name in the DATABASE.

Defined in:

DATABASE

Parameters:

UnitName

PlayerName

DATABASE:AddStatic(DCSStaticName)

Adds a Static based on the Static Name in the DATABASE.

Defined in:

DATABASE

Parameter:

#string DCSStaticName

Name of the static.

Return value:

Wrapper.Static#STATIC:

The static object.

DATABASE:AddStorage(AirbaseName)

Adds a STORAGE (DCS warehouse wrapper) based on the Airbase Name to the DATABASE.

Defined in:

DATABASE

Parameter:

#string AirbaseName

The name of the airbase.

Return value:

Wrapper.Storage#STORAGE:

Storage object.

DATABASE:AddUnit(DCSUnitName)

Adds a Unit based on the Unit Name in the DATABASE.

Defined in:

DATABASE

Parameter:

#string DCSUnitName

Unit name.

Return value:

Wrapper.Unit#UNIT:

The added unit.

DATABASE:AddZone(ZoneName, Zone)

Adds a Core.Zone based on the zone name in the DATABASE.

Defined in:

DATABASE

Parameters:

#string ZoneName

The name of the zone.

Core.Zone#ZONE_BASE Zone

The zone.

DATABASE:AddZoneGoal(ZoneName, Zone)

Adds a Core.Zone based on the zone name in the DATABASE.

Defined in:

DATABASE

Parameters:

#string ZoneName

The name of the zone.

Core.Zone#ZONE_BASE Zone

The zone.

DATABASE:DeleteAirbase(AirbaseName)

Deletes a Airbase from the DATABASE based on the Airbase Name.

Defined in:

DATABASE

Parameter:

#string AirbaseName

The name of the airbase

DATABASE:DeleteCargo(CargoName)

Deletes a Cargo from the DATABASE based on the Cargo Name.

Defined in:

DATABASE

Parameter:

#string CargoName

The name of the airbase

DATABASE:DeleteOpsZone(ZoneName)

Deletes a Ops.OpsZone#OPSZONE from the DATABASE based on the zone name.

Defined in:

DATABASE

Parameter:

#string ZoneName

The name of the zone.

DATABASE:DeletePathline(PathlineName)

Deletes a Core.Pathline from the DATABASE based on its name.

Defined in:

DATABASE

Parameter:

#string PathlineName

The name of the PATHLINE.

DATABASE:DeletePlayer(UnitName, PlayerName)

Deletes a player from the DATABASE based on the Player Name.

Defined in:

DATABASE

Parameters:

UnitName

PlayerName

DATABASE:DeleteStatic(DCSStaticName)

Deletes a Static from the DATABASE based on the Static Name.

Defined in:

DATABASE

Parameter:

DCSStaticName

DATABASE:DeleteStorage(AirbaseName)

Deletes a STORAGE from the DATABASE based on the name of the associated airbase.

Defined in:

DATABASE

Parameter:

#string AirbaseName

The name of the airbase.

DATABASE:DeleteUnit(DCSUnitName)

Deletes a Unit from the DATABASE based on the Unit Name.

Defined in:

DATABASE

Parameter:

DCSUnitName

DATABASE:DeleteZone(ZoneName)

Deletes a Core.Zone from the DATABASE based on the zone name.

Defined in:

DATABASE

Parameter:

#string ZoneName

The name of the zone.

DATABASE:DeleteZoneGoal(ZoneName)

Deletes a Core.Zone from the DATABASE based on the zone name.

Defined in:

DATABASE

Parameter:

#string ZoneName

The name of the zone.

DATABASE:FindAirbase(AirbaseName)

Finds an AIRBASE based on the AirbaseName.

Defined in:

DATABASE

Parameter:

#string AirbaseName

Return value:

Wrapper.Airbase#AIRBASE:

The found AIRBASE.

DATABASE:FindCargo(CargoName)

Finds an CARGO based on the CargoName.

Defined in:

DATABASE

Parameter:

#string CargoName

Return value:

Wrapper.Cargo#CARGO:

The found CARGO.

DATABASE:FindClient(ClientName)

Finds a CLIENT based on the ClientName.

Defined in:

DATABASE

Parameter:

#string ClientName

Return value:

Wrapper.Client#CLIENT:

The found CLIENT.

DATABASE:FindGroup(GroupName)

Finds a GROUP based on the GroupName.

Defined in:

DATABASE

Parameter:

#string GroupName

Return value:

Wrapper.Group#GROUP:

The found GROUP.

DATABASE:FindOpsGroup(groupname)

Find an OPSGROUP (FLIGHTGROUP, ARMYGROUP, NAVYGROUP) in the data base.

Defined in:

DATABASE

Parameter:

#string groupname

Group name of the group. Can also be passed as GROUP object.

Return value:

Ops.OpsGroup#OPSGROUP:

OPS group object.

DATABASE:FindOpsGroupFromUnit(unitname)

Find an OPSGROUP (FLIGHTGROUP, ARMYGROUP, NAVYGROUP) in the data base for a given unit.

Defined in:

DATABASE

Parameter:

#string unitname

Unit name. Can also be passed as UNIT object.

Return value:

Ops.OpsGroup#OPSGROUP:

OPS group object.

DATABASE:FindOpsZone(ZoneName)

Finds a Ops.OpsZone#OPSZONE based on the zone name.

Defined in:

DATABASE

Parameter:

#string ZoneName

The name of the zone.

Return value:

Ops.OpsZone#OPSZONE:

The found OPSZONE.

DATABASE:FindPathline(PathlineName)

Finds a Core.Pathline by its name.

Defined in:

DATABASE

Parameter:

#string PathlineName

The name of the Pathline.

Return value:

Core.Pathline#PATHLINE:

The found PATHLINE.

DATABASE:FindStatic(StaticName)

Finds a STATIC based on the StaticName.

Defined in:

DATABASE

Parameter:

#string StaticName

Return value:

Wrapper.Static#STATIC:

The found STATIC.

DATABASE:FindStorage(AirbaseName)

Finds an STORAGE based on the name of the associated airbase.

Defined in:

DATABASE

Parameter:

#string AirbaseName

Name of the airbase.

Return value:

Wrapper.Storage#STORAGE:

The found STORAGE.

DATABASE:FindUnit(UnitName)

Finds a Unit based on the Unit Name.

Defined in:

DATABASE

Parameter:

#string UnitName

Return value:

Wrapper.Unit#UNIT:

The found Unit.

DATABASE:FindZone(ZoneName)

Finds a Core.Zone based on the zone name.

Defined in:

DATABASE

Parameter:

#string ZoneName

The name of the zone.

Return value:

Core.Zone#ZONE_BASE:

The found ZONE.

DATABASE:FindZoneGoal(ZoneName)

Finds a Core.Zone based on the zone name.

Defined in:

DATABASE

Parameter:

#string ZoneName

The name of the zone.

Return value:

Core.Zone#ZONE_BASE:

The found ZONE.

DATABASE:ForEach(IteratorFunction, FinalizeFunction, arg, Set)

Iterate the DATABASE and call an iterator function for the given set, providing the Object for each element within the set and optional parameters.

Defined in:

DATABASE

Parameters:

#function IteratorFunction

The function that will be called when there is an alive player in the database.

FinalizeFunction

arg

Set

Return value:

#DATABASE:

self

DATABASE:ForEachCargo(IteratorFunction, FinalizeFunction, ...)

Iterate the DATABASE and call an iterator function for each CARGO, providing the CARGO object to the function and optional parameters.

Defined in:

DATABASE

Parameters:

#function IteratorFunction

The function that will be called for each object in the database. The function needs to accept a CLIENT parameter.

FinalizeFunction

...

Return value:

#DATABASE:

self

DATABASE:ForEachClient(IteratorFunction, FinalizeFunction, ...)

Iterate the DATABASE and call an iterator function for each CLIENT, providing the CLIENT to the function and optional parameters.

Defined in:

DATABASE

Parameters:

#function IteratorFunction

The function that will be called object in the database. The function needs to accept a CLIENT parameter.

FinalizeFunction

...

Return value:

#DATABASE:

self

DATABASE:ForEachGroup(IteratorFunction, FinalizeFunction, ...)

Iterate the DATABASE and call an iterator function for each alive GROUP, providing the GROUP and optional parameters.

Defined in:

DATABASE

Parameters:

#function IteratorFunction

The function that will be called for each object in the database. The function needs to accept a GROUP parameter.

FinalizeFunction

...

Return value:

#DATABASE:

self

DATABASE:ForEachPlayer(IteratorFunction, FinalizeFunction, ...)

Iterate the DATABASE and call an iterator function for each ALIVE player, providing the player name and optional parameters.

Defined in:

DATABASE

Parameters:

#function IteratorFunction

The function that will be called for each object in the database. The function needs to accept the player name.

FinalizeFunction

...

Return value:

#DATABASE:

self

DATABASE:ForEachPlayerJoined(IteratorFunction, FinalizeFunction, ...)

Iterate the DATABASE and call an iterator function for each player who has joined the mission, providing the Unit of the player and optional parameters.

Defined in:

DATABASE

Parameters:

#function IteratorFunction

The function that will be called for each object in the database. The function needs to accept a UNIT parameter.

FinalizeFunction

...

Return value:

#DATABASE:

self

DATABASE:ForEachPlayerUnit(IteratorFunction, FinalizeFunction, ...)

Iterate the DATABASE and call an iterator function for each ALIVE player UNIT, providing the player UNIT and optional parameters.

Defined in:

DATABASE

Parameters:

#function IteratorFunction

The function that will be called for each object in the database. The function needs to accept the player name.

FinalizeFunction

...

Return value:

#DATABASE:

self

DATABASE:ForEachStatic(IteratorFunction, FinalizeFunction, ...)

Iterate the DATABASE and call an iterator function for each alive STATIC, providing the STATIC and optional parameters.

Defined in:

DATABASE

Parameters:

#function IteratorFunction

The function that will be called for each object in the database. The function needs to accept a STATIC parameter.

FinalizeFunction

...

Return value:

#DATABASE:

self

DATABASE:ForEachUnit(IteratorFunction, FinalizeFunction, ...)

Iterate the DATABASE and call an iterator function for each alive UNIT, providing the UNIT and optional parameters.

Defined in:

DATABASE

Parameters:

#function IteratorFunction

The function that will be called for each object in the database. The function needs to accept a UNIT parameter.

FinalizeFunction

...

Return value:

#DATABASE:

self

DATABASE:GetCategoryFromAirbase(AirbaseName)

Get category from airbase name.

Defined in:

DATABASE

Parameter:

#string AirbaseName

Name of the airbase.

Return value:

#number:

Category.

DATABASE:GetCategoryFromClientTemplate(ClientName)

Get category ID from client name.

Defined in:

DATABASE

Parameter:

#string ClientName

Name of the Client.

Return value:

#number:

Category ID.

DATABASE:GetCoalitionFromAirbase(AirbaseName)

Get coalition ID from airbase name.

Defined in:

DATABASE

Parameter:

#string AirbaseName

Name of the airbase.

Return value:

#number:

Coalition ID.

DATABASE:GetCoalitionFromClientTemplate(ClientName)

Get coalition ID from client name.

Defined in:

DATABASE

Parameter:

#string ClientName

Name of the Client.

Return value:

#number:

Coalition ID.

DATABASE:GetCountryFromClientTemplate(ClientName)

Get country ID from client name.

Defined in:

DATABASE

Parameter:

#string ClientName

Name of the Client.

Return value:

#number:

Country ID.

DATABASE:GetFlightControl(airbasename)

Get a flight control object from the data base.

Defined in:

DATABASE

Parameter:

#string airbasename

Name of the associated airbase.

Return value:

Ops.FlightControl#FLIGHTCONTROL:

The FLIGHTCONTROL object.s

DATABASE:GetGroupNameFromUnitName(UnitName)

Get group name from unit name.

Defined in:

DATABASE

Parameter:

#string UnitName

Name of the unit.

Return value:

#string:

Group name.

DATABASE:GetGroupTemplate(GroupName)

Get group template.

Defined in:

DATABASE

Parameter:

#string GroupName

Group name.

Return value:

#table:

Group template table.

DATABASE:GetGroupTemplateFromUnitName(UnitName)

Get group template from unit name.

Defined in:

DATABASE

Parameter:

#string UnitName

Name of the unit.

Return value:

#table:

Group template.

DATABASE:GetOpsGroup(groupname)

Get an OPS group (FLIGHTGROUP, ARMYGROUP, NAVYGROUP) from the data base.

Defined in:

DATABASE

Parameter:

#string groupname

Group name of the group. Can also be passed as GROUP object.

Return value:

Ops.OpsGroup#OPSGROUP:

OPS group object.

DATABASE:GetPlayerSettings(PlayerName)

Gets the player settings

Defined in:

DATABASE

Parameter:

#string PlayerName

Return value:

Core.Settings#SETTINGS:

DATABASE:GetPlayerUnits()

Get the player table from the DATABASE, which contains all UNIT objects.

The player table contains all UNIT objects of the player with the key the name of the player (PlayerName).

Defined in:

DATABASE

Usage:

  local PlayerUnits = _DATABASE:GetPlayerUnits()
  for PlayerName, PlayerUnit in pairs( PlayerUnits ) do
    ..
  end

DATABASE:GetPlayers()

Get the player table from the DATABASE.

The player table contains all unit names with the key the name of the player (PlayerName).

Defined in:

DATABASE

Usage:

  local Players = _DATABASE:GetPlayers()
  for PlayerName, UnitName in pairs( Players ) do
    ..
  end

DATABASE:GetPlayersJoined()

Get the player table from the DATABASE which have joined in the mission historically.

The player table contains all UNIT objects with the key the name of the player (PlayerName).

Defined in:

DATABASE

Usage:

  local PlayersJoined = _DATABASE:GetPlayersJoined()
  for PlayerName, PlayerUnit in pairs( PlayersJoined ) do
    ..
  end

DATABASE:GetStaticGroupTemplate(StaticName)

Get static group template.

Defined in:

DATABASE

Parameter:

#string StaticName

Name of the static.

Return value:

#table:

Static template table.

DATABASE:GetStaticUnitTemplate(StaticName)

Get static unit template.

Defined in:

DATABASE

Parameter:

#string StaticName

Name of the static.

Return value:

#table:

Static template table.

DATABASE:GetStatusGroup(GroupName)

Get a status to a Group within the Database, this to check crossing events for example.

Defined in:

DATABASE

Parameter:

#string GroupName

Group name.

Return value:

#string:

Status or an empty string "".

DATABASE:GetUnitTemplateFromUnitName(UnitName)

Get group template from unit name.

Defined in:

DATABASE

Parameter:

#string UnitName

Name of the unit.

Return value:

#table:

Group template.

DATABASE:IsCargo(TemplateName)

Checks if the Template name has a #CARGO tag.

If yes, the group is a cargo.

Defined in:

DATABASE

Parameter:

#string TemplateName

Return value:

#boolean:

DATABASE:New()

Creates a new DATABASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.

Defined in:

DATABASE

Return value:

#DATABASE:

Usage:

-- Define a new DATABASE Object. This DBObject will contain a reference to all Group and Unit Templates defined within the ME and the DCSRTE.
DBObject = DATABASE:New()

DATABASE:OnEventDeleteCargo(EventData)

Handles the OnEventDeleteCargo.

Defined in:

DATABASE

Parameter:

Core.Event#EVENTDATA EventData

DATABASE:OnEventDeleteZone(EventData)

Handles the OnEventDeleteZone.

Defined in:

DATABASE

Parameter:

Core.Event#EVENTDATA EventData

DATABASE:OnEventNewCargo(EventData)

Handles the OnEventNewCargo event.

Defined in:

DATABASE

Parameter:

Core.Event#EVENTDATA EventData

DATABASE:OnEventNewZone(EventData)

Handles the OnEventNewZone event.

Defined in:

DATABASE

Parameter:

Core.Event#EVENTDATA EventData

DATABASE:SetPlayerSettings(PlayerName, Settings)

Sets the player settings

Defined in:

DATABASE

Parameters:

#string PlayerName

Core.Settings#SETTINGS Settings

Return value:

Core.Settings#SETTINGS:

DATABASE:SetStatusGroup(GroupName, Status)

Set a status to a Group within the Database, this to check crossing events for example.

Defined in:

DATABASE

Parameters:

#string GroupName

Group name.

#string Status

Status.

DATABASE:Spawn(SpawnTemplate)

Instantiate new Groups within the DCSRTE.

This method expects EXACTLY the same structure as a structure within the ME, and needs 2 additional fields defined: SpawnCountryID, SpawnCategoryID This method is used by the SPAWN class.