Module Core.Message
Core - Informs the players using messages during a simulation.
Features:
- A more advanced messaging system using the DCS message system.
- Time messages.
- Send messages based on a message type, which has a pre-defined duration that can be tweaked in SETTINGS.
- Send message to all players.
- Send messages to a coalition.
- Send messages to a specific group.
- Send messages to a specific unit or client.
Global(s)
Global MESSAGE |
Message System to display Messages to Clients, Coalitions or All. |
Message System to display Messages to Clients, Coalitions or All.
Messages are shown on the display panel for an amount of seconds, and will then disappear. Messages can contain a category which is indicating the category of the message.
MESSAGE construction
Messages are created with MESSAGE.New. Note that when the MESSAGE object is created, no message is sent yet. To send messages, you need to use the To functions.
Send messages to an audience
Messages are sent:
- To a Wrapper.Client using MESSAGE.ToClient().
- To a Wrapper.Group using MESSAGE.ToGroup()
- To a Wrapper.Unit using MESSAGE.ToUnit()
- To a coalition using MESSAGE.ToCoalition().
- To the red coalition using MESSAGE.ToRed().
- To the blue coalition using MESSAGE.ToBlue().
- To all Players using MESSAGE.ToAll().
Send conditionally to an audience
Messages can be sent conditionally to an audience (when a condition is true):
- To all players using MESSAGE.ToAllIf().
- To a coalition using MESSAGE.ToCoalitionIf().
Author: FlightControl
Contributions: Applevangelist
Global _MESSAGESRS |
Type(s)
| Fields and Methods inherited from MESSAGE | Description |
|---|---|
|
Clears all previous messages from the screen before the new message is displayed. |
|
|
Creates a new MESSAGE object. |
|
|
Creates a new MESSAGE object of a certain type. |
|
|
Set up MESSAGE generally to allow Text-To-Speech via SRS and TTS functions. |
|
|
Sends a MESSAGE to all players. |
|
|
Sends a MESSAGE to all players if the given Condition is true. |
|
|
Sends a MESSAGE to the Blue coalition. |
|
|
Sends a MESSAGE to a Client Group. |
|
|
Sends a MESSAGE to a Coalition. |
|
|
Sends a MESSAGE to a Coalition if the given Condition is true. |
|
|
Sends a MESSAGE to a Country. |
|
|
Sends a MESSAGE to a Country. |
|
|
Sends a MESSAGE to a Group. |
|
|
Sends a MESSAGE to DCS log file. |
|
|
Sends a MESSAGE to DCS log file if the given Condition is true. |
|
|
Sends a MESSAGE to the Red Coalition. |
|
MESSAGE:ToSRS(frequency, modulation, gender, culture, voice, coalition, volume, coordinate) |
Sends a message via SRS. |
MESSAGE:ToSRSAll(frequency, modulation, gender, culture, voice, volume, coordinate) |
Sends a message via SRS to all - via the neutral coalition side. |
MESSAGE:ToSRSBlue(frequency, modulation, gender, culture, voice, volume, coordinate) |
Sends a message via SRS on the blue coalition side. |
MESSAGE:ToSRSRed(frequency, modulation, gender, culture, voice, volume, coordinate) |
Sends a message via SRS on the red coalition side. |
|
Sends a MESSAGE to a Unit. |
|
| Fields and Methods inherited from BASE | Description |
|---|---|
|
The ID number of the class. |
|
|
The name of the class. |
|
|
The name of the class concatenated with the ID number of the class. |
|
|
Clear the state of an object. |
|
MESSAGE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) |
Creation of a Birth Event. |
MESSAGE:CreateEventCrash(EventTime, Initiator, IniObjectCategory) |
Creation of a Crash Event. |
MESSAGE:CreateEventDead(EventTime, Initiator, IniObjectCategory) |
Creation of a Dead Event. |
|
Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event. |
|
|
Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event. |
|
|
Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event. |
|
|
Creation of a S_EVENT_NEW_DYNAMIC_CARGO event. |
|
|
Creation of a |
|
|
Creation of a Remove Unit Event. |
|
|
Creation of a Takeoff Event. |
|
|
Creation of a Crash Event. |
|
|
Log an exception which will be traced always. |
|
|
Returns the event dispatcher |
|
|
Remove all subscribed events |
|
|
Trace a function call. |
|
|
Trace a function call level 2. |
|
|
Trace a function call level 3. |
|
|
Get the ClassID of the class instance. |
|
|
Get the ClassName of the class instance. |
|
|
Get the ClassName + ClassID of the class instance. |
|
|
Get the Class Core.Event processing Priority. |
|
|
This is the worker method to retrieve the Parent class. |
|
|
Get all of the properties of an object in a table. |
|
|
Get one property of an object by the key. |
|
|
Get a Value given a Key from the Object. |
|
|
Subscribe to a DCS Event. |
|
|
Log an information which will be traced always. |
|
|
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. |
|
|
Enquires if tracing is on (for the class). |
|
|
BASE constructor. |
|
|
Occurs when an Event for an object is triggered. |
|
|
BDA. |
|
|
Occurs when a ground unit captures either an airbase or a farp. |
|
|
Occurs when any object is spawned into the mission. |
|
|
Occurs when any aircraft crashes into the ground and is completely destroyed. |
|
|
Occurs when an object is dead. |
|
|
Unknown precisely what creates this event, likely tied into newer damage model. |
|
|
Discard chair after ejection. |
|
|
Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo. |
|
|
Occurs when a dynamic cargo crate is removed. |
|
|
Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo. |
|
|
Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs when any aircraft shuts down its engines. |
|
|
Occurs when any aircraft starts its engines. |
|
|
Occurs whenever an object is hit by a weapon. |
|
|
Occurs when any system fails on a human controlled aircraft. |
|
|
Occurs on the death of a unit. |
|
|
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. |
|
|
Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up. |
|
|
Landing quality mark. |
|
|
Occurs when a new mark was added. |
|
|
Occurs when a mark text was changed. |
|
|
Occurs when a mark was removed. |
|
|
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. |
|
|
Occurs when a player creates a dynamic cargo object from the F8 ground crew menu. |
|
|
Weapon add. |
|
|
Occurs when the pilot of an aircraft is killed. |
|
|
Occurs when a player enters a slot and takes control of an aircraft. |
|
|
Occurs when any player assumes direct control of a unit. |
|
|
Occurs when any player relieves control of a unit to the AI. |
|
|
Occurs when an aircraft connects with a tanker and begins taking on fuel. |
|
|
Occurs when an aircraft is finished taking fuel. |
|
|
Occurs when any modification to the "Score" as seen on the debrief menu would occur. |
|
|
Occurs when any unit stops firing its weapon. |
|
|
Occurs when any unit begins firing a weapon that has a high rate of fire. |
|
|
Occurs whenever any unit in a mission fires a weapon. |
|
|
Occurs when an aircraft takes off from an airbase, farp, or ship. |
|
|
Trigger zone. |
|
|
Occurs when the game thinks an object is destroyed. |
|
|
Schedule a new time event. |
|
MESSAGE:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...) |
Schedule a new time event. |
|
Stops the Schedule. |
|
|
The scheduler object. |
|
|
Set the Class Core.Event processing Priority. |
|
|
Set one property of an object. |
|
|
Set a state or property of the Object given a Key and a Value. |
|
|
Trace a function logic level 1. |
|
|
Trace a function logic level 2. |
|
|
Trace a function logic level 3. |
|
|
Trace all methods in MOOSE |
|
|
Set tracing for a class |
|
|
Set tracing for a specific method of class |
|
|
Set trace level |
|
|
Set trace off. |
|
|
Set trace on. |
|
|
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. |
|
|
UnSubscribe to a DCS event. |
|
MESSAGE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function call. |
|
(Internal) Serialize arguments |
|
MESSAGE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function logic. |
|
The main event handling function... |
| Fields and Methods inherited from MESSAGE.Type | Description |
|---|---|
The MESSAGE class
Field(s)
self.MessageType .. ": "
Function(s)
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 MESSAGE.ToClient or MESSAGE.ToCoalition or MESSAGE.ToAll to send these Messages to the respective recipients.
Defined in:
MESSAGE
Parameters:
#string Text
is the text of the Message.
#number Duration
Duration in seconds how long the message text is shown.
#string Category
(Optional) String expressing the "category" of the Message. The category will be shown as the first text in the message followed by a ": ".
#boolean ClearScreen
(optional) Clear all previous messages if true.
Return value:
self
Usage:
-- 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 Core.Message#ToClient or Core.Message#ToCoalition or Core.Message#ToAll to send these Messages to the respective recipients. The message display times are automatically defined based on the timing settings in the Core.Settings menu.
Defined in:
MESSAGE
Parameters:
#string MessageText
is the text of the Message.
#MESSAGE.Type MessageType
The type of the message.
#boolean ClearScreen
(optional) Clear all previous messages.
Return value:
Usage:
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 )
Set up MESSAGE generally to allow Text-To-Speech via SRS and TTS functions.
SetMSRS() will try to use as many attributes configured with Sound.SRS#MSRS.LoadConfigFile() as possible.
Defined in:
MESSAGE
Parameters:
#string PathToSRS
(optional) Path to SRS Folder, defaults to "C:\\Program Files\\DCS-SimpleRadio-Standalone" or your configuration file setting.
#number Port
Port (optional) number of SRS, defaults to 5002 or your configuration file setting.
#string PathToCredentials
(optional) Path to credentials file for Google.
#number Frequency
Frequency in MHz. Can also be given as a #table of frequencies.
#number Modulation
Modulation, i.e. radio.modulation.AM or radio.modulation.FM. Can also be given as a #table of modulations.
#string Gender
(optional) Gender, i.e. "male" or "female", defaults to "female" or your configuration file setting.
#string Culture
(optional) Culture, e.g. "en-US", defaults to "en-GB" or your configuration file setting.
#string Voice
(optional) Voice. Will override gender and culture settings, e.g. MSRS.Voices.Microsoft.Hazel or MSRS.Voices.Google.Standard.de_DE_Standard_D. Hint on Microsoft voices - working voices are limited to Hedda, Hazel, David, Zira and Hortense. Must be installed on your Desktop or Server!
#number Coalition
(optional) Coalition, can be coalition.side.RED, coalition.side.BLUE or coalition.side.NEUTRAL. Defaults to coalition.side.NEUTRAL.
#number Volume
(optional) Volume, can be between 0.0 and 1.0 (loudest).
#string Label
(optional) Label, defaults to "MESSAGE" or the Message Category set.
Core.Point#COORDINATE Coordinate
(optional) Coordinate this messages originates from.
#string Backend
(optional) Backend to be used, can be MSRS.Backend.SRSEXE or MSRS.Backend.GRPC
Usage:
-- Mind the dot here, not using the colon this time around!
-- Needed once only
MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.BLUE)
-- later on in your code
MESSAGE:New("Test message!",15,"SPAWN"):ToSRS()
Sends a MESSAGE to all players.
Defined in:
MESSAGE
Parameters:
Core.Settings#Settings Settings
(Optional) Settings for message display.
#number Delay
(Optional) Delay in seconds before the message is send. Default instantly (nil).
Return value:
self
Usage:
-- Send a message created to all players.
MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", 25, "End of Mission"):ToAll()
or
MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", 25, "End of Mission"):ToAll()
or
MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", 25, "End of Mission")
MessageAll:ToAll()
Sends a MESSAGE to all players if the given Condition is true.
Sends a MESSAGE to the Blue coalition.
Defined in:
MESSAGE
Return value:
Usage:
-- 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", 25, "Penalty"):ToBlue()
or
MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", 25, "Penalty"):ToBlue()
or
MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", 25, "Penalty")
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".
Defined in:
MESSAGE
Parameters:
Wrapper.Client#CLIENT Client
is the Group of the Client.
Core.Settings#SETTINGS Settings
used to display the message.
Return value:
Usage:
-- 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.
Client = CLIENT:FindByName("NameOfClientUnit")
MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", 25, "Score" ):ToClient( Client )
MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", 25, "Score" ):ToClient( Client )
or
MESSAGE:New( "Congratulations, you've just hit a target", 25, "Score"):ToClient( Client )
MESSAGE:New( "Congratulations, you've just killed a target", 25, "Score"):ToClient( Client )
or
MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", 25, "Score")
MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", 25, "Score")
MessageClient1:ToClient( Client )
MessageClient2:ToClient( Client )
Sends a MESSAGE to a Coalition.
Defined in:
MESSAGE
Parameters:
DCS#coalition.side CoalitionSide
DCS.coalition.side to which the message is displayed.
Core.Settings#SETTINGS Settings
(Optional) Settings for message display.
Return value:
Message object.
Usage:
-- 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", 25, "Penalty"):ToCoalition( coalition.side.RED )
or
MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", 25, "Penalty"):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", 25, "Penalty")
MessageRED:ToCoalition( coalition.side.RED )
Sends a MESSAGE to a Coalition if the given Condition is true.
Defined in:
MESSAGE
Parameters:
CoalitionSide
needs to be filled out by the defined structure of the standard scripting engine DCS.coalition.side.
#boolean Condition
Sends the message only if the condition is true.
Return value:
self
Sends a MESSAGE to a Country.
Defined in:
MESSAGE
Parameters:
#number Country
to which the message is displayed, e.g. country.id.GERMANY. For all country numbers see here: Hoggit Wiki
Core.Settings#Settings Settings
(Optional) Settings for message display.
Return value:
Message object.
Sends a MESSAGE to a Country.
Defined in:
MESSAGE
Parameters:
#number Country
to which the message is displayed, , e.g. country.id.GERMANY. For all country numbers see here: Hoggit Wiki
#boolean Condition
Sends the message only if the condition is true.
Core.Settings#Settings Settings
(Optional) Settings for message display.
Return value:
Message object.
Sends a MESSAGE to a Group.
Defined in:
MESSAGE
Parameters:
Wrapper.Group#GROUP Group
to which the message is displayed.
Core.Settings#Settings Settings
(Optional) Settings for message display.
Return value:
Message object.
Sends a MESSAGE to DCS log file if the given Condition is true.
Sends a MESSAGE to the Red Coalition.
Defined in:
MESSAGE
Return value:
Usage:
-- 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", 25, "Penalty"):ToRed()
or
MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", 25, "Penalty"):ToRed()
or
MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", 25, "Penalty")
MessageRED:ToRed()
Sends a message via SRS.
ToSRS() will try to use as many attributes configured with Core.Message#MESSAGE.SetMSRS() and Sound.SRS#MSRS.LoadConfigFile() as possible.
Defined in:
MESSAGE
Parameters:
#number frequency
(optional) Frequency in MHz. Can also be given as a #table of frequencies. Only needed if you want to override defaults set with MESSAGE.SetMSRS() for this one setting.
#number modulation
(optional) Modulation, i.e. radio.modulation.AM or radio.modulation.FM. Can also be given as a #table of modulations. Only needed if you want to override defaults set with MESSAGE.SetMSRS() for this one setting.
#string gender
(optional) Gender, i.e. "male" or "female". Only needed if you want to change defaults set with MESSAGE.SetMSRS().
#string culture
(optional) Culture, e.g. "en-US". Only needed if you want to change defaults set with MESSAGE.SetMSRS().
#string voice
(optional) Voice. Will override gender and culture settings. Only needed if you want to change defaults set with MESSAGE.SetMSRS().
#number coalition
(optional) Coalition, can be coalition.side.RED, coalition.side.BLUE or coalition.side.NEUTRAL. Only needed if you want to change defaults set with MESSAGE.SetMSRS().
#number volume
(optional) Volume, can be between 0.0 and 1.0 (loudest). Only needed if you want to change defaults set with MESSAGE.SetMSRS().
Core.Point#COORDINATE coordinate
(optional) Coordinate this messages originates from. Only needed if you want to change defaults set with MESSAGE.SetMSRS().
Return value:
self
Usage:
-- Mind the dot here, not using the colon this time around!
-- Needed once only
MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.BLUE)
-- later on in your code
MESSAGE:New("Test message!",15,"SPAWN"):ToSRS()
Sends a message via SRS to all - via the neutral coalition side.
Defined in:
MESSAGE
Parameters:
#number frequency
(optional) Frequency in MHz. Can also be given as a #table of frequencies. Only needed if you want to override defaults set with MESSAGE.SetMSRS() for this one setting.
#number modulation
(optional) Modulation, i.e. radio.modulation.AM or radio.modulation.FM. Can also be given as a #table of modulations. Only needed if you want to override defaults set with MESSAGE.SetMSRS() for this one setting.
#string gender
(optional) Gender, i.e. "male" or "female". Only needed if you want to change defaults set with MESSAGE.SetMSRS().
#string culture
(optional) Culture, e.g. "en-US. Only needed if you want to change defaults set with MESSAGE.SetMSRS().
#string voice
(optional) Voice. Will override gender and culture settings. Only needed if you want to change defaults set with MESSAGE.SetMSRS().
#number volume
(optional) Volume, can be between 0.0 and 1.0 (loudest). Only needed if you want to change defaults set with MESSAGE.SetMSRS().
Core.Point#COORDINATE coordinate
(optional) Coordinate this messages originates from. Only needed if you want to change defaults set with MESSAGE.SetMSRS().
Return value:
self
Usage:
-- Mind the dot here, not using the colon this time around!
-- Needed once only
MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.NEUTRAL)
-- later on in your code
MESSAGE:New("Test message!",15,"SPAWN"):ToSRSAll()
Sends a message via SRS on the blue coalition side.
Defined in:
MESSAGE
Parameters:
#number frequency
(optional) Frequency in MHz. Can also be given as a #table of frequencies. Only needed if you want to override defaults set with MESSAGE.SetMSRS() for this one setting.
#number modulation
(optional) Modulation, i.e. radio.modulation.AM or radio.modulation.FM. Can also be given as a #table of modulations. Only needed if you want to override defaults set with MESSAGE.SetMSRS() for this one setting.
#string gender
(optional) Gender, i.e. "male" or "female". Only needed if you want to change defaults set with MESSAGE.SetMSRS().
#string culture
(optional) Culture, e.g. "en-US. Only needed if you want to change defaults set with MESSAGE.SetMSRS().
#string voice
(optional) Voice. Will override gender and culture settings. Only needed if you want to change defaults set with MESSAGE.SetMSRS().
#number volume
(optional) Volume, can be between 0.0 and 1.0 (loudest). Only needed if you want to change defaults set with MESSAGE.SetMSRS().
Core.Point#COORDINATE coordinate
(optional) Coordinate this messages originates from. Only needed if you want to change defaults set with MESSAGE.SetMSRS().
Return value:
self
Usage:
-- Mind the dot here, not using the colon this time around!
-- Needed once only
MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.BLUE)
-- later on in your code
MESSAGE:New("Test message!",15,"SPAWN"):ToSRSBlue()
Sends a message via SRS on the red coalition side.
Defined in:
MESSAGE
Parameters:
#number frequency
(optional) Frequency in MHz. Can also be given as a #table of frequencies. Only needed if you want to override defaults set with MESSAGE.SetMSRS() for this one setting.
#number modulation
(optional) Modulation, i.e. radio.modulation.AM or radio.modulation.FM. Can also be given as a #table of modulations. Only needed if you want to override defaults set with MESSAGE.SetMSRS() for this one setting.
#string gender
(optional) Gender, i.e. "male" or "female". Only needed if you want to change defaults set with MESSAGE.SetMSRS().
#string culture
(optional) Culture, e.g. "en-US. Only needed if you want to change defaults set with MESSAGE.SetMSRS().
#string voice
(optional) Voice. Will override gender and culture settings. Only needed if you want to change defaults set with MESSAGE.SetMSRS().
#number volume
(optional) Volume, can be between 0.0 and 1.0 (loudest). Only needed if you want to change defaults set with MESSAGE.SetMSRS().
Core.Point#COORDINATE coordinate
(optional) Coordinate this messages originates from. Only needed if you want to change defaults set with MESSAGE.SetMSRS().
Return value:
self
Usage:
-- Mind the dot here, not using the colon this time around!
-- Needed once only
MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.RED)
-- later on in your code
MESSAGE:New("Test message!",15,"SPAWN"):ToSRSRed()
Sends a MESSAGE to a Unit.
Defined in:
MESSAGE
Parameters:
Wrapper.Unit#UNIT Unit
to which the message is displayed.
Core.Settings#Settings Settings
(Optional) Settings for message display.
Return value:
Message object.
Field(s)
self.MessageType .. ": "
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_DYNAMIC_CARGO_LOADED event.
Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.
Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.
Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.
Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT 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.
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 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.
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 all of the properties of an object in a table.
Get one property of an object by the key.
Defined in:
Parameter:
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!
Return value:
Value The value that is stored. Note that the value can be a #string, but it can also be any other type! Nil if not found.
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:
Core.Event#EVENTS EventID
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.
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).
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.
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 player loads a dynamic cargo object with the F8 ground crew menu into a helo.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Occurs when a dynamic cargo crate is removed.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
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.
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.
Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
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
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.
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.
...
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.
Set one property of an object.
Defined in:
Parameters:
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 that is stored. Note that the value can be a #string, but it can also be any other type!
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.
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 off.
Set trace on.
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.
Trace a function call.
This function is private.
Defined in:
Parameters:
Arguments
A #table or any field.
DebugInfoCurrentParam
DebugInfoFromParam
(Internal) Serialize arguments
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.
Message Types