Banner Image

Module Wrapper.Identifiable

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


Author: FlightControl

Contributions:


Global(s)

Global IDENTIFIABLE

Wrapper class to handle the DCS Identifiable objects.

#IDENTIFIABLE IDENTIFIABLE

Wrapper class to handle the DCS Identifiable objects.

  • Support all DCS Identifiable APIs.
  • Enhance with Identifiable specific APIs not in the DCS Identifiable API set.
  • Manage the "state" of the DCS Identifiable.

IDENTIFIABLE constructor

The IDENTIFIABLE class provides the following functions to construct a IDENTIFIABLE instance:

Type(s)

Fields and Methods inherited from IDENTIFIABLE Description

IDENTIFIABLE:GetCallsign()

Gets the CallSign of the IDENTIFIABLE, which is a blank by default.

IDENTIFIABLE:GetCategory()

Returns object category of the DCS Identifiable.

IDENTIFIABLE:GetCategoryName()

Returns the DCS Identifiable category name as defined within the DCS Identifiable Descriptor.

IDENTIFIABLE:GetCoalition()

Returns coalition of the Identifiable.

IDENTIFIABLE:GetCoalitionName()

Returns the name of the coalition of the Identifiable.

IDENTIFIABLE:GetCountry()

Returns country of the Identifiable.

IDENTIFIABLE:GetCountryName()

Returns country name of the Identifiable.

IDENTIFIABLE:GetDesc()

Returns Identifiable descriptor.

IDENTIFIABLE:GetName()

Returns DCS Identifiable object name.

IDENTIFIABLE:GetThreatLevel()

IDENTIFIABLE:GetTypeName()

Returns the type name of the DCS Identifiable.

IDENTIFIABLE:HasAttribute(AttributeName)

Check if the Object has the attribute.

IDENTIFIABLE.IdentifiableName

The name of the identifiable.

IDENTIFIABLE:IsAlive()

Returns if the Identifiable is alive.

IDENTIFIABLE:New(IdentifiableName)

Create a new IDENTIFIABLE from a DCSIdentifiable

Fields and Methods inherited from OBJECT Description

IDENTIFIABLE:Destroy()

Destroys the OBJECT.

IDENTIFIABLE:GetID()

Returns the unit's unique identifier.

IDENTIFIABLE:New(ObjectName, Test)

Create a new OBJECT from a DCSObject

IDENTIFIABLE.ObjectName

The name of the Object.

Fields and Methods inherited from BASE Description

IDENTIFIABLE.ClassID

The ID number of the class.

IDENTIFIABLE.ClassName

The name of the class.

IDENTIFIABLE.ClassNameAndID

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

IDENTIFIABLE:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

IDENTIFIABLE:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

IDENTIFIABLE:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

IDENTIFIABLE:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

IDENTIFIABLE:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

IDENTIFIABLE:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

IDENTIFIABLE:E(Arguments)

Log an exception which will be traced always.

IDENTIFIABLE:EventDispatcher()

Returns the event dispatcher

IDENTIFIABLE:EventRemoveAll()

Remove all subscribed events

IDENTIFIABLE:F(Arguments)

Trace a function call.

IDENTIFIABLE:F2(Arguments)

Trace a function call level 2.

IDENTIFIABLE:F3(Arguments)

Trace a function call level 3.

IDENTIFIABLE:GetClassID()

Get the ClassID of the class instance.

IDENTIFIABLE:GetClassName()

Get the ClassName of the class instance.

IDENTIFIABLE:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

IDENTIFIABLE:GetEventPriority()

Get the Class Event processing Priority.

IDENTIFIABLE:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

IDENTIFIABLE:GetState(Object, Key)

Get a Value given a Key from the Object.

IDENTIFIABLE:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

IDENTIFIABLE:I(Arguments)

Log an information which will be traced always.

IDENTIFIABLE:Inherit(Child, Parent)

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

IDENTIFIABLE:IsInstanceOf(ClassName)

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

IDENTIFIABLE:IsTrace()

Enquires if tracing is on (for the class).

IDENTIFIABLE:New()

BASE constructor.

IDENTIFIABLE:OnEvent(EventData)

Occurs when an object is completely destroyed.

IDENTIFIABLE:OnEventBaseCaptured(EventData)

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

IDENTIFIABLE:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

IDENTIFIABLE:OnEventCrash(EventData)

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

IDENTIFIABLE:OnEventDead(EventData)

Occurs when an object is dead.

IDENTIFIABLE:OnEventDetailedFailure(EventData)

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

IDENTIFIABLE:OnEventEjection(EventData)

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

IDENTIFIABLE:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

IDENTIFIABLE:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

IDENTIFIABLE:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

IDENTIFIABLE:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

IDENTIFIABLE:OnEventKill(EventData)

Occurs on the death of a unit.

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

IDENTIFIABLE:OnEventLandingAfterEjection(EventData)

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

IDENTIFIABLE:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

IDENTIFIABLE:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

IDENTIFIABLE:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

IDENTIFIABLE:OnEventMissionEnd(EventData)

Occurs when a mission ends

IDENTIFIABLE:OnEventMissionStart(EventData)

Occurs when a mission starts

IDENTIFIABLE:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

IDENTIFIABLE:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

IDENTIFIABLE:OnEventPlayerLeaveUnit(EventData)

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

IDENTIFIABLE:OnEventRefueling(EventData)

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

IDENTIFIABLE:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

IDENTIFIABLE:OnEventScore(EventData)

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

IDENTIFIABLE:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

IDENTIFIABLE:OnEventShootingStart(EventData)

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

IDENTIFIABLE:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

IDENTIFIABLE:OnEventTakeoff(EventData)

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

IDENTIFIABLE:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

IDENTIFIABLE:ScheduleStop(SchedulerFunction)

Stops the Schedule.

IDENTIFIABLE.Scheduler

IDENTIFIABLE:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

IDENTIFIABLE:SetState(Object, Key, Value)

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

IDENTIFIABLE:T(Arguments)

Trace a function logic level 1.

IDENTIFIABLE:T2(Arguments)

Trace a function logic level 2.

IDENTIFIABLE:T3(Arguments)

Trace a function logic level 3.

IDENTIFIABLE:TraceAll(TraceAll)

Trace all methods in MOOSE

IDENTIFIABLE:TraceClass(Class)

Set tracing for a class

IDENTIFIABLE:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

IDENTIFIABLE:TraceLevel(Level)

Set trace level

IDENTIFIABLE:TraceOff()

Set trace off.

IDENTIFIABLE:TraceOn()

Set trace on.

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

IDENTIFIABLE:UnHandleEvent(Event)

UnSubscribe to a DCS event.

IDENTIFIABLE._

IDENTIFIABLE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

IDENTIFIABLE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

IDENTIFIABLE.__

IDENTIFIABLE:onEvent(event)

Field(s)

#string IDENTIFIABLE.IdentifiableName

The name of the identifiable.

Function(s)

Gets the CallSign of the IDENTIFIABLE, which is a blank by default.

Defined in:

IDENTIFIABLE

Return value:

#string:

The CallSign of the IDENTIFIABLE.

Returns object category of the DCS Identifiable.

One of

  • Object.Category.UNIT = 1
  • Object.Category.WEAPON = 2
  • Object.Category.STATIC = 3
  • Object.Category.BASE = 4
  • Object.Category.SCENERY = 5
  • Object.Category.Cargo = 6

Defined in:

IDENTIFIABLE

Return value:

The category ID, i.e. a number.

Returns the DCS Identifiable category name as defined within the DCS Identifiable Descriptor.

Defined in:

IDENTIFIABLE

Return value:

#string:

The DCS Identifiable Category Name

Returns coalition of the Identifiable.

Defined in:

IDENTIFIABLE

Return values:

The side of the coalition.

#nil:

The DCS Identifiable is not existing or alive.

Returns the name of the coalition of the Identifiable.

Defined in:

IDENTIFIABLE

Return values:

#string:

The name of the coalition.

#nil:

The DCS Identifiable is not existing or alive.

Returns country of the Identifiable.

Defined in:

IDENTIFIABLE

Return values:

The country identifier.

#nil:

The DCS Identifiable is not existing or alive.

Returns country name of the Identifiable.

Defined in:

IDENTIFIABLE

Return value:

#string:

Name of the country.

Returns Identifiable descriptor.

Descriptor type depends on Identifiable category.

Defined in:

IDENTIFIABLE

Return values:

The Identifiable descriptor.

#nil:

The DCS Identifiable is not existing or alive.

Returns DCS Identifiable object name.

The function provides access to non-activated objects too.

Defined in:

IDENTIFIABLE

Return values:

#string:

The name of the DCS Identifiable.

#nil:

The DCS Identifiable is not existing or alive.

Defined in:

IDENTIFIABLE

Returns the type name of the DCS Identifiable.

Defined in:

IDENTIFIABLE

Return value:

#string:

The type name of the DCS Identifiable.

Check if the Object has the attribute.

Defined in:

IDENTIFIABLE

Parameter:

#string AttributeName

The attribute name.

Return values:

#boolean:

true if the attribute exists.

#nil:

The DCS Identifiable is not existing or alive.

Returns if the Identifiable is alive.

If the Identifiable is not alive, nil is returned.
If the Identifiable is alive, true is returned.

Defined in:

IDENTIFIABLE

Return values:

#boolean:

true if Identifiable is alive.

#nil:

if the Identifiable is not existing or is not alive.

Create a new IDENTIFIABLE from a DCSIdentifiable

Defined in:

IDENTIFIABLE

Parameter:

#string IdentifiableName

The DCS Identifiable name

Return value:

Field(s)

#string IDENTIFIABLE.IdentifiableName

The name of the identifiable.

Function(s)

Destroys the OBJECT.

Defined in:

Return values:

#boolean:

true if the object is destroyed.

#nil:

The DCS Unit is not existing or alive.

Returns the unit's unique identifier.

Defined in:

Return value:

ObjectID or #nil if the DCS Object is not existing or alive. Note that the ID is passed as a string and not a number.

Create a new OBJECT from a DCSObject

Defined in:

Parameters:

DCS#Object ObjectName

The Object name

Test

Return value:

self

Field(s)

#string IDENTIFIABLE.IdentifiableName

The name of the identifiable.

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.

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.

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