Banner Image

Module Core.TextAndSound

Core - A Moose GetText system.


Main Features:

  • A GetText for Moose
  • Build a set of localized text entries, alongside their sounds and subtitles
  • Aimed at class developers to offer localizable language support

Example Missions:

Demo missions can be found on github.


Author: applevangelist

Date: April 2022


Global(s)

Global TEXTANDSOUND

Type(s)

Fields and Methods inherited from TEXTANDSOUND Description

TEXTANDSOUND:AddEntry(Locale, ID, Text, Soundfile, Soundlength, Subtitle)

Add an entry

TEXTANDSOUND.ClassName

Name of this class.

TEXTANDSOUND:FlushToLog()

Flush all entries to the log

TEXTANDSOUND:GetDefaultLocale()

Get the default locale of this object

TEXTANDSOUND:GetEntry(ID, Locale)

Get an entry

TEXTANDSOUND:HasLocale(Locale)

Check if a locale exists

TEXTANDSOUND:New(ClassName, Defaultlocale)

Instantiate a new object

TEXTANDSOUND:SetDefaultLocale(locale)

Set default locale of this object

TEXTANDSOUND.entries

Table of entries.

TEXTANDSOUND.lid

LID for log entries.

TEXTANDSOUND.locale

Default locale of this object.

TEXTANDSOUND.textclass

Name of the class the texts belong to.

TEXTANDSOUND.version

Versioning.

Fields and Methods inherited from BASE Description

TEXTANDSOUND.ClassID

The ID number of the class.

TEXTANDSOUND.ClassName

The name of the class.

TEXTANDSOUND.ClassNameAndID

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

TEXTANDSOUND:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

TEXTANDSOUND:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

TEXTANDSOUND:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

TEXTANDSOUND:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

TEXTANDSOUND:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

TEXTANDSOUND:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

TEXTANDSOUND:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

TEXTANDSOUND:E(Arguments)

Log an exception which will be traced always.

TEXTANDSOUND:EventDispatcher()

Returns the event dispatcher

TEXTANDSOUND:EventRemoveAll()

Remove all subscribed events

TEXTANDSOUND:F(Arguments)

Trace a function call.

TEXTANDSOUND:F2(Arguments)

Trace a function call level 2.

TEXTANDSOUND:F3(Arguments)

Trace a function call level 3.

TEXTANDSOUND:GetClassID()

Get the ClassID of the class instance.

TEXTANDSOUND:GetClassName()

Get the ClassName of the class instance.

TEXTANDSOUND:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

TEXTANDSOUND:GetEventPriority()

Get the Class Core.Event processing Priority.

TEXTANDSOUND:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

TEXTANDSOUND:GetState(Object, Key)

Get a Value given a Key from the Object.

TEXTANDSOUND:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

TEXTANDSOUND:I(Arguments)

Log an information which will be traced always.

TEXTANDSOUND:Inherit(Child, Parent)

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

TEXTANDSOUND:IsInstanceOf(ClassName)

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

TEXTANDSOUND:IsTrace()

Enquires if tracing is on (for the class).

TEXTANDSOUND:New()

BASE constructor.

TEXTANDSOUND:OnEvent(EventData)

Occurs when an Event for an object is triggered.

TEXTANDSOUND:OnEventBDA(EventData)

BDA.

TEXTANDSOUND:OnEventBaseCaptured(EventData)

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

TEXTANDSOUND:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

TEXTANDSOUND:OnEventCrash(EventData)

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

TEXTANDSOUND:OnEventDead(EventData)

Occurs when an object is dead.

TEXTANDSOUND:OnEventDetailedFailure(EventData)

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

TEXTANDSOUND:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

TEXTANDSOUND:OnEventEjection(EventData)

Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.

TEXTANDSOUND:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

TEXTANDSOUND:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

TEXTANDSOUND:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

TEXTANDSOUND:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

TEXTANDSOUND:OnEventKill(EventData)

Occurs on the death of a unit.

TEXTANDSOUND:OnEventLand(EventData)

Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes.

TEXTANDSOUND:OnEventLandingAfterEjection(EventData)

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

TEXTANDSOUND:OnEventLandingQualityMark(EventData)

Landing quality mark.

TEXTANDSOUND:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

TEXTANDSOUND:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

TEXTANDSOUND:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

TEXTANDSOUND:OnEventMissionEnd(EventData)

Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes.

TEXTANDSOUND:OnEventMissionStart(EventData)

Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes.

TEXTANDSOUND:OnEventParatrooperLanding(EventData)

Weapon add.

TEXTANDSOUND:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

TEXTANDSOUND:OnEventPlayerEnterAircraft(EventData)

Occurs when a player enters a slot and takes control of an aircraft.

TEXTANDSOUND:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

TEXTANDSOUND:OnEventPlayerLeaveUnit(EventData)

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

TEXTANDSOUND:OnEventRefueling(EventData)

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

TEXTANDSOUND:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

TEXTANDSOUND:OnEventScore(EventData)

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

TEXTANDSOUND:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

TEXTANDSOUND:OnEventShootingStart(EventData)

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

TEXTANDSOUND:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

TEXTANDSOUND:OnEventTakeoff(EventData)

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

TEXTANDSOUND:OnEventTriggerZone(EventData)

Trigger zone.

TEXTANDSOUND:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

TEXTANDSOUND:ScheduleStop(SchedulerID)

Stops the Schedule.

TEXTANDSOUND.Scheduler

TEXTANDSOUND:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

TEXTANDSOUND:SetState(Object, Key, Value)

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

TEXTANDSOUND:T(Arguments)

Trace a function logic level 1.

TEXTANDSOUND:T2(Arguments)

Trace a function logic level 2.

TEXTANDSOUND:T3(Arguments)

Trace a function logic level 3.

TEXTANDSOUND:TraceAll(TraceAll)

Trace all methods in MOOSE

TEXTANDSOUND:TraceClass(Class)

Set tracing for a class

TEXTANDSOUND:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

TEXTANDSOUND:TraceLevel(Level)

Set trace level

TEXTANDSOUND:TraceOff()

Set trace off.

TEXTANDSOUND:TraceOn()

Set trace on.

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

TEXTANDSOUND:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

TEXTANDSOUND._

TEXTANDSOUND:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

TEXTANDSOUND:_Serialize(Arguments)

(Internal) Serialize arguments

TEXTANDSOUND:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

TEXTANDSOUND.__

TEXTANDSOUND:onEvent(event)

The main event handling function...

Fields and Methods inherited from TEXTANDSOUND.Data Description

TEXTANDSOUND.Data.ID

ID of this entry for retrieval.

TEXTANDSOUND.Data.Soundfile

(optional) Soundfile File name of the corresponding sound file.

TEXTANDSOUND.Data.Soundlength

(optional) Length of the sound file in seconds.

TEXTANDSOUND.Data.Subtitle

(optional) Subtitle for the sound file.

TEXTANDSOUND.Data.Text

Text of this entry.

Fields and Methods inherited from TEXTANDSOUND.Entry Description

TEXTANDSOUND.Entry.Classname

Name of the class this entry is for.

TEXTANDSOUND.Entry.Data

The list of entries.

TEXTANDSOUND.Entry.Locale

Locale of this entry, defaults to "en".

Text and Sound class.

Field(s)

#string TEXTANDSOUND.ClassName

Name of this class.

#table TEXTANDSOUND.entries

Table of entries.

#string TEXTANDSOUND.lid

LID for log entries.

#string TEXTANDSOUND.locale

Default locale of this object.

#string TEXTANDSOUND.textclass

Name of the class the texts belong to.

#string TEXTANDSOUND.version

Versioning.

Function(s)

Add an entry

Defined in:

TEXTANDSOUND

Parameters:

#string Locale

Locale to set for this entry, e.g. "de".

#string ID

Unique(!) ID of this entry under this locale (i.e. use the same ID to get localized text for the entry in another language).

#string Text

Text for this entry.

#string Soundfile

(Optional) Sound file name for this entry.

#number Soundlength

(Optional) Length of the sound file in seconds.

#string Subtitle

(Optional) Subtitle to be used alongside the sound file.

Return value:

Flush all entries to the log

Defined in:

TEXTANDSOUND

Return value:

Get the default locale of this object

Defined in:

TEXTANDSOUND

Return value:

#string:

locale

Get an entry

Defined in:

TEXTANDSOUND

Parameters:

#string ID

The unique ID of the data to be retrieved.

#string Locale

(Optional) The locale of the text to be retrieved - defauls to default locale set with New().

Return values:

#string:

Text Text or nil if not found and no fallback.

#string:

Soundfile Filename or nil if not found and no fallback.

#string:

Soundlength Length of the sound or 0 if not found and no fallback.

#string:

Subtitle Text for subtitle or nil if not found and no fallback.

Check if a locale exists

Defined in:

TEXTANDSOUND

Parameter:

Locale

Return value:

#boolean:

outcome

Instantiate a new object

Defined in:

TEXTANDSOUND

Parameters:

#string ClassName

Name of the class this instance is providing texts for.

#string Defaultlocale

(Optional) Default locale of this instance, defaults to "en".

Return value:

Set default locale of this object

Defined in:

TEXTANDSOUND

Parameter:

#string locale

Return value:

Field(s)

#string TEXTANDSOUND.ClassName

Name of this class.

#table TEXTANDSOUND.entries

Table of entries.

#string TEXTANDSOUND.lid

LID for log entries.

#string TEXTANDSOUND.locale

Default locale of this object.

#string TEXTANDSOUND.textclass

Name of the class the texts belong to.

#string TEXTANDSOUND.version

Versioning.

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.

IniObjectCategory

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.

IniObjectCategory

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Defined in:

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The aircraft unit the player entered.

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 Core.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 Core.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, set to nil, 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:

Event ID.

#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 Event for an object is triggered.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that triggered the event.

Defined in:

Parameter:

The EventData structure.

BDA.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was spawned

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that has crashed

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

Discard chair after ejection.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator : The unit that has ejected

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is stopping its engines.

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is starting its engines.

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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. Have a look at the class Core.Event#EVENT as these are just the prototypes.

  • 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 Have a look at the class Core.Event#EVENT as these are just the prototypes.

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. Have a look at the class Core.Event#EVENT as these are just the prototypes.

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

Landing quality mark.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when a new mark was added.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Weapon add.

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. Have a look at the class Core.Event#EVENT as these are just the prototypes.

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. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the pilot has died in.

Defined in:

Parameter:

The EventData structure.

Occurs when a player enters a slot and takes control of an aircraft.

Have a look at the class Core.Event#EVENT as these are just the prototypes. NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

Occurs when any player assumes direct control of a unit.

Note - not Mulitplayer safe. Use PlayerEnterAircraft. Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

Event will always correspond with a shooting start event. Have a look at the class Core.Event#EVENT as these are just the prototypes. 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. Have a look at the class Core.Event#EVENT as these are just the prototypes. 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. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

Trigger zone.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when the game thinks an object is destroyed.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

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

#string:

The Schedule ID 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:

#string:

The Schedule ID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.

Set the Class Core.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 Core.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, set to nil, 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

Class name.

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

Class name.

#string Method

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:

Event ID.

Return value:

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

(Internal) Serialize arguments

Defined in:

Parameter:

#table Arguments

Return value:

#string:

Text

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

The main event handling function...

This function captures all events generated for the class.

Defined in:

Parameter:

DCS#Event event

Text and Sound data

Field(s)

#string TEXTANDSOUND.Data.ID

ID of this entry for retrieval.

#string TEXTANDSOUND.Data.Soundfile

(optional) Soundfile File name of the corresponding sound file.

#number TEXTANDSOUND.Data.Soundlength

(optional) Length of the sound file in seconds.

#string TEXTANDSOUND.Data.Subtitle

(optional) Subtitle for the sound file.

#string TEXTANDSOUND.Data.Text

Text of this entry.

Function(s)

Text and Sound entry.

Field(s)

#string TEXTANDSOUND.Entry.Classname

Name of the class this entry is for.

#table TEXTANDSOUND.Entry.Data

The list of entries.

#string TEXTANDSOUND.Entry.Locale

Locale of this entry, defaults to "en".

Function(s)