Clears all previous messages from the screen before the new message is displayed.

Not that this must come before all functions starting with ToX(), e.g. ToAll(), ToGroup() etc.

Creates a new MESSAGE object.

Note that these MESSAGE objects are not yet displayed on the display panel. You must use the functions ToClient or ToCoalition or ToAll to send these Messages to the respective recipients.

-- Create a series of new Messages.
-- MessageAll is meant to be sent to all players, for 25 seconds, and is classified as "Score".
-- MessageRED is meant to be sent to the RED players only, for 10 seconds, and is classified as "End of Mission", with ID "Win".
-- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
-- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!",  25, "End of Mission" )
MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", 25, "Penalty" )
MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target",  25, "Score" )
MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", 25, "Score")

Creates a new MESSAGE object of a certain type.

Note that these MESSAGE objects are not yet displayed on the display panel. You must use the functions ToClient or ToCoalition or ToAll to send these Messages to the respective recipients. The message display times are automatically defined based on the timing settings in the Settings menu.

  MessageAll = MESSAGE:NewType( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", MESSAGE.Type.Information )
  MessageRED = MESSAGE:NewType( "To the RED Players: You receive a penalty because you've killed one of your own units", MESSAGE.Type.Information )
  MessageClient1 = MESSAGE:NewType( "Congratulations, you've just hit a target", MESSAGE.Type.Update )
  MessageClient2 = MESSAGE:NewType( "Congratulations, you've just killed a target", MESSAGE.Type.Update )

Sends a MESSAGE to all players.

-- Send a message created to all players.
MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" ):ToAll()
or
MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" ):ToAll()
or
MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" )
MessageAll:ToAll()

Sends a MESSAGE to all players if the given Condition is true.

Sends a MESSAGE to the Blue coalition.

-- Send a message created with the @{New} method to the BLUE coalition.
MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
or
MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
or
MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
MessageBLUE:ToBlue()

Sends a MESSAGE to a Client Group.

Note that the Group needs to be defined within the ME with the skillset "Client" or "Player".

-- Send the 2 messages created with the @{New} method to the Client Group.
-- Note that the Message of MessageClient2 is overwriting the Message of MessageClient1.
ClientGroup = Group.getByName( "ClientGroup" )

MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" ):ToClient( ClientGroup )
MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" ):ToClient( ClientGroup )
or
MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" ):ToClient( ClientGroup )
MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" ):ToClient( ClientGroup )
or
MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" )
MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" )
MessageClient1:ToClient( ClientGroup )
MessageClient2:ToClient( ClientGroup )

Sends a MESSAGE to a Coalition.

-- Send a message created with the @{New} method to the RED coalition.
MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToCoalition( coalition.side.RED )
or
MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToCoalition( coalition.side.RED )
or
MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
MessageRED:ToCoalition( coalition.side.RED )

Sends a MESSAGE to a Coalition if the given Condition is true.

Sends a MESSAGE to a Group.

Sends a MESSAGE to the Red Coalition.

-- Send a message created with the @{New} method to the RED coalition.
MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToRed()
or
MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToRed()
or
MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
MessageRED:ToRed()

Clear the state of an object.

Creation of a Birth Event.

Creation of a Crash Event.

Creation of a Dead Event.

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Creation of a Remove Unit Event.

Creation of a Takeoff Event.

Creation of a Crash Event.

Log an exception which will be traced always.

Can be anywhere within the function logic.

Returns the event dispatcher

Remove all subscribed events

Trace a function call.

Must be at the beginning of the function logic.

Trace a function call level 2.

Must be at the beginning of the function logic.

Trace a function call level 3.

Must be at the beginning of the function logic.

Get the ClassID of the class instance.

Get the ClassName of the class instance.

Get the ClassName + ClassID of the class instance.

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

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.

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

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.

Subscribe to a DCS Event.

Log an information which will be traced always.

Can be anywhere within the function logic.

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

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

Enquires if tracing is on (for the class).

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
  

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.

BDA.

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

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.

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

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

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.

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.

Discard chair after ejection.

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

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

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.

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.

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.

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

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

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

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.

Landing quality mark.

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

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.

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.

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.

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

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

Trigger zone.

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

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.

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.

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.

Stops the Schedule.

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.

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.

Trace a function logic level 1.

Can be anywhere within the function logic.

Trace a function logic level 2.

Can be anywhere within the function logic.

Trace a function logic level 3.

Can be anywhere within the function logic.

Trace all methods in MOOSE

Set tracing for a class

Set tracing for a specific method of class

Set trace level

Set trace off.

-- Switch the tracing Off
BASE:TraceOff()

Set trace on.

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

-- Switch the tracing On
BASE:TraceOnOff( true )

-- Switch the tracing Off
BASE:TraceOnOff( false )

UnSubscribe to a DCS event.

Trace a function call.

This function is private.

Trace a function logic.

The main event handling function...

This function captures all events generated for the class.