Modules

• index

• Base
• CARGO
• CleanUp
• Client
• DCSAirbase
• DCSCoalitionObject
• DCSController
• DCSGroup
• DCSObject
• DCSTask
• DCSTypes
• DCSUnit
• DCStimer
• DEPLOYTASK
• DESTROYBASETASK
• DESTROYGROUPSTASK
• DESTROYRADARSTASK
• DESTROYUNITTYPESTASK
• Database
• Escort
• GOHOMETASK
• Group
• MISSION
• MOVEMENT
• Menu
• Message
• NOTASK
• PICKUPTASK
• ROUTETASK
• STAGE
• Sead
• Spawn
• StaticObject
• TASK
• Unit
• Zone
• env
• land
• routines

Module Base

The BASE class for all the classes defined within MOOSE.

Global(s)

BASE
FORMATION

Type BASE

BASE:AddEvent(Event, EventFunction)	Set a new listener for the class.
BASE.ClassID	The ID number of the class.
BASE.ClassName	The name of the class.
BASE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)	Creation of a Birth Event.
BASE:CreateEventCrash(EventTime, Initiator)	Creation of a Crash Event.
BASE:DisableEvents()	Disable the event listeners for the class.
BASE:E(Arguments)	Log an exception which will be traced always.
BASE:EnableEvents()	Enable the event listeners for the class.
BASE.Events
BASE:F(Arguments)	Trace a function call.
BASE:F2(Arguments)	Trace a function call level 2.
BASE:F3(Arguments)	Trace a function call level 3.
BASE:GetClassID()	Get the ClassID of the class instance.
BASE:GetClassName()	Get the ClassName of the class instance.
BASE:GetClassNameAndID()	Get the ClassName + ClassID of the class instance.
BASE:Inherit(Child, Parent)	This is the worker method to inherit from a parent class.
BASE:Inherited(Child)	This is the worker method to retrieve the Parent class.
BASE:New()
BASE:T(Arguments)	Trace a function logic.
BASE:T2(Arguments)	Trace a function logic level 2.
BASE:T3(Arguments)	Trace a function logic level 3.
BASE:onEvent(event)

Type FORMATION

FORMATION.Cone

A cone formation.

Global(s)

#BASE BASE

#FORMATION FORMATION

Type Base

Type BASE

The BASE Class

Field(s)

BASE:AddEvent(Event, EventFunction)

Set a new listener for the class.

Parameters

• DCSTypes#Event Event :

• #function EventFunction :

Return value

#BASE:

BASE.ClassID

The ID number of the class.

BASE.ClassName

The name of the class.

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

Creation of a Birth Event.

Parameters

• DCSTypes#Time EventTime : The time stamp of the event.

• DCSObject#Object Initiator : The initiating object of the event.

• #string IniUnitName : The initiating unit name.

• place :

• subplace :

BASE:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

Parameters

• DCSTypes#Time EventTime : The time stamp of the event.

• DCSObject#Object Initiator : The initiating object of the event.

BASE:DisableEvents()

Disable the event listeners for the class.

Return value

#BASE:

BASE:E(Arguments)

Log an exception which will be traced always.

Can be anywhere within the function logic.

Parameter

• Arguments : A #table or any field.

BASE:EnableEvents()

Enable the event listeners for the class.

Return value

#BASE:

BASE.Events

BASE:F(Arguments)

Trace a function call.

Must be at the beginning of the function logic.

Parameter

• Arguments : A #table or any field.

BASE:F2(Arguments)

Trace a function call level 2.

Must be at the beginning of the function logic.

Parameter

• Arguments : A #table or any field.

BASE:F3(Arguments)

Trace a function call level 3.

Must be at the beginning of the function logic.

Parameter

• Arguments : A #table or any field.

BASE:GetClassID()

Get the ClassID of the class instance.

Return value

#string: The ClassID of the class instance.

BASE:GetClassName()

Get the ClassName of the class instance.

Return value

#string: The ClassName of the class instance.

BASE:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

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

Return value

#string: The ClassName + ClassID of the class instance.

BASE:Inherit(Child, Parent)

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

Parameters

• Child : is the Child class that inherits.

• #BASE Parent : is the Parent class that the Child inherits from.

Return value

#BASE: Child

BASE:Inherited(Child)

This is the worker method to retrieve the Parent class.

Parameter

• #BASE Child : is the Child class from which the Parent class needs to be retrieved.

Return value

#BASE:

BASE:New()

BASE:T(Arguments)

Trace a function logic.

Can be anywhere within the function logic.

Parameter

• Arguments : A #table or any field.

BASE:T2(Arguments)

Trace a function logic level 2.

Can be anywhere within the function logic.

Parameter

• Arguments : A #table or any field.

BASE:T3(Arguments)

Trace a function logic level 3.

Can be anywhere within the function logic.

Parameter

• Arguments : A #table or any field.

BASE:onEvent(event)

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

Parameter

• event :

Type FORMATION

The Formation Class

Field(s)

FORMATION.Cone

A cone formation.