Close ×

AI.AI_A2A_Cap

AI -- (R2.2) - Models the process of Combat Air Patrol (CAP) for airplanes.
AI.AI_A2A_Dispatcher

AI - (R2.2) - Manages the process of an automatic A2A defense system based on an EWR network targets and coordinating CAP and GCI.
AI.AI_A2A_GCI

AI -- (R2.2) - Models the process of Ground Controlled Interception (GCI) for airplanes.
AI.AI_A2A_Patrol

AI -- (R2.2) - Models the process of air patrol of airplanes.
AI.AI_A2G_BAI

AI -- Models the process of air to ground BAI engagement for airplanes and helicopters.
AI.AI_A2G_CAS

AI -- Models the process of air to ground engagement for airplanes and helicopters.
AI.AI_A2G_Dispatcher

AI - Create an automated A2G defense system based on a detection network of reconnaissance vehicles and air units, coordinating SEAD, BAI and CAP operations.
AI.AI_A2G_SEAD

AI -- Models the process of air to ground SEAD engagement for airplanes and helicopters.
AI.AI_AIR_Dispatcher

AI - Create an automated AIR defense system based on a detection network of reconnaissance vehicles and air units, coordinating SEAD, BAI and CAP operations.
AI.AI_Air

AI - Models the process of AI air operations.
AI.AI_Air_Engage

AI -- Models the process of air to ground engagement for airplanes and helicopters.
AI.AI_Air_Patrol

AI -- Models the process of A2G patrolling and engaging ground targets for airplanes and helicopters.
AI.AI_Air_Squadron

AI - Models squadrons for airplanes and helicopters.
AI.AI_Bai

AI -- Peform Battlefield Area Interdiction (BAI) within an engagement zone.
AI.AI_Balancer

AI -- Balance player slots with AI to create an engaging simulation environment, independent of the amount of players.
AI.AI_Cap

AI -- Perform Combat Air Patrolling (CAP) for airplanes.
AI.AI_Cargo

AI - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_APC

AI - Models the intelligent transportation of cargo using ground vehicles.
AI.AI_Cargo_Airplane

AI - Models the intelligent transportation of cargo using airplanes.
AI.AI_Cargo_Dispatcher

AI - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_Dispatcher_APC

AI - Models the intelligent transportation of infantry and other cargo using APCs.
AI.AI_Cargo_Dispatcher_Airplane

AI -- (R2.4) - Models the intelligent transportation of infantry and other cargo using Planes.
AI.AI_Cargo_Dispatcher_Helicopter

AI -- (2.4) - Models the intelligent transportation of infantry and other cargo using Helicopters.
AI.AI_Cargo_Dispatcher_Ship

AI -- (2.5.1) - Models the intelligent transportation of infantry and other cargo using Ships
Features:Transport cargo to various deploy zones using naval vehicles.
AI.AI_Cargo_Helicopter

AI - Models the intelligent transportation of cargo using helicopters.
AI.AI_Cargo_Ship

AI -- (R2.5.1) - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cas

AI -- Perform Close Air Support (CAS) near friendlies.
AI.AI_ESCORT_DISPATCHER_REQUEST

AI - Models the assignment of AI escorts to player flights upon request using the radio menu.
AI.AI_Escort

Functional -- Taking the lead of AI escorting your flight or of other AI, upon request using the menu.
AI.AI_Escort_Dispatcher

AI - Models the automatic assignment of AI escorts to player flights.
AI.AI_Formation

AI -- Build large airborne formations of aircraft.
AI.AI_Patrol

AI -- Perform Air Patrolling for airplanes.
Actions.Account

Actions - ACT_ACCOUNT_ classes account for (detect, count & report) various DCS events occuring on Wrapper.Units.
Actions.Assign

(SP) (MP) (FSM) Accept or reject process for player (task) assignments.
Actions.Assist

(SP) (MP) (FSM) Route AI or players through waypoints or to zones.
Actions.Route

(SP) (MP) (FSM) Route AI or players through waypoints or to zones.
Cargo.Cargo

Cargo - Management of CARGO logistics, that can be transported from and to transportation carriers.
Cargo.CargoCrate

Cargo -- Management of single cargo crates, which are based on a Static object.
Cargo.CargoGroup

Cargo - Management of grouped cargo logistics, which are based on a Wrapper.Group object.
Cargo.CargoSlingload

Cargo -- Management of single cargo crates, which are based on a Static object.
Cargo.CargoUnit

Cargo - Management of single cargo logistics, which are based on a Wrapper.Unit object.
Core.Astar

Core - A* Pathfinding.
Core.Base

Core - The base class within the framework.
Core.Database

Core - Manages several databases containing templates, mission objects, and mission information.
Core.Event

Core - Models DCS event dispatching using a publish-subscribe model.
Core.Fsm

Core - FSM (Finite State Machine) are objects that model and control long lasting business processes and workflow.
Core.Goal

Core - Models the process to achieve goal(s).
Core.Menu

Core - Manage hierarchical menu structures and commands for players within a mission.
Core.Message

Core - Informs the players using messages during a simulation.
Core.Point

Core - Defines an extensive API to manage 3D points in the DCS World 3D simulation space.
Core.Radio

Core - Is responsible for everything that is related to radio transmission and you can hear in DCS, be it TACAN beacons, Radio transmissions.
Core.RadioQueue

Core - Queues Radio Transmissions.
Core.RadioSpeech

Core - Makes the radio talk.
Core.Report

Core - Provides a handy means to create messages and reports.
Core.ScheduleDispatcher

Core -- SCHEDULEDISPATCHER dispatches the different schedules.
Core.Scheduler

Core - Prepares and handles the execution of functions over scheduled time (intervals).
Core.Set

Core - Define collections of objects to perform bulk actions and logically group objects.
Core.Settings

Core - Manages various settings for running missions, consumed by moose classes and provides a menu system for players to tweak settings in running missions.
Core.Spawn

Core - Spawn dynamically new groups of units in running missions.
Core.SpawnStatic

Core - Spawn statics.
Core.Spot

Core - Management of spotting logistics, that can be activated and deactivated upon command.
Core.Timer

Core - Timer scheduler.
Core.UserFlag

Core - Manage user flags to interact with the mission editor trigger system and server side scripts.
Core.UserSound

Core - Manage user sound.
Core.Velocity

Core - Models a velocity or speed, which can be expressed in various formats according the settings.
Core.Zone

Core - Define zones within your mission of various forms, with various capabilities.
DCS

DCS API Prototypes
See the Simulator Scripting Engine Documentation on Hoggit for further explanation and examples.
ENUMS

Utilities Enumerators.
Functional.ATC_Ground

Functional -- Monitor airbase traffic and regulate speed while taxiing.
Functional.Arty

Functional - Control artillery units.
Functional.CleanUp

Functional -- Keep airbases clean of crashing or colliding airplanes, and kill missiles when being fired at airbases.
Functional.Designate

Functional -- Management of target Designation.
Functional.Detection

Functional -- Models the detection of enemy units by FACs or RECCEs and group them according various methods.
Functional.Escort

Functional -- Taking the lead of AI escorting your flight.
Functional.FOX

Functional - (R2.5) - Yet Another Missile Trainer.
Functional.Mantis

Functional -- Modular, Automatic and Network capable Targeting and Interception System for Air Defenses
MANTIS - Moose derived  Modular, Automatic and Network capable Targeting and Interception System
Controls a network of SAM sites.
Functional.MissileTrainer

Functional -- Train missile defence and deflection.
Functional.Movement

Functional -- Limit the movement of simulaneous moving ground vehicles.
Functional.PseudoATC

Functional - Rudimentary ATC.
Functional.Range

Functional - Range Practice.
Functional.Rat

Functional - Create random airtraffic in your missions.
Functional.Scoring

Functional - Administer the scoring of player achievements, and create a CSV file logging the scoring events for use at team or squadron websites.
Functional.Sead

Functional -- Make SAM sites execute evasive and defensive behaviour when being fired upon.
Functional.Shorad

Functional -- Short Range Air Defense System
SHORAD - Short Range Air Defense System
Controls a network of short range air/missile defense groups.
Functional.Suppression

Functional - Suppress fire of ground units when they get hit.
Functional.Warehouse

Functional - Simulation of logistic operations.
Functional.ZoneCaptureCoalition

Functional -- Models the process to zone guarding and capturing.
Functional.ZoneGoal

Functional (WIP) -- Base class that models processes to achieve goals involving a Zone.
Functional.ZoneGoalCargo

Functional (WIP) -- Base class that models processes to achieve goals involving a Zone and Cargo.
Functional.ZoneGoalCoalition

Functional (WIP) -- Base class that models processes to achieve goals involving a Zone for a Coalition.
Ops.Airboss

Ops - Manages aircraft CASE X recoveries for carrier operations (X=I, II, III).
Ops.Airwing

Ops - Airwing Warehouse.
Ops.ArmyGroup

Ops - Enhanced Ground Group.
Ops.Atis

Ops - Automatic Terminal Information Service (ATIS).
Ops.Auftrag

Ops - Auftrag (mission) for Ops.
Ops.FlightGroup

Ops - Enhanced Airborne Group.
Ops.Intel

Ops - Office of Military Intelligence.
Ops.NavyGroup

Ops - Enhanced Naval Group.
Ops.OpsGroup

Ops - Generic group enhancement.
Ops.RecoveryTanker

Ops - Recovery tanker for carrier operations.
Ops.RescueHelo

Ops - Rescue helicopter for carrier operations.
Ops.Squadron

Ops - Airwing Squadron.
Ops.Target

Ops - Target.
Tasking.CommandCenter

Tasking -- A command center governs multiple missions, and takes care of the reporting and communications.
Tasking.DetectionManager

Tasking - This module contains the DETECTION_MANAGER class and derived classes.
Tasking.Mission

Tasking -- A mission models a goal to be achieved through the execution and completion of tasks by human players.
Tasking.Task

Tasking -- A task object governs the main engine to administer human taskings.
Tasking.TaskInfo

Tasking -- Controls the information of a Task.
Tasking.TaskZoneCapture

Tasking - The TASK_Protect models tasks for players to protect or capture specific zones.
Tasking.Task_A2A

Tasking - The TASK_A2A models tasks for players in Air to Air engagements.
Tasking.Task_A2A_Dispatcher

Tasking - Dynamically allocates A2A tasks to human players, based on detected airborne targets through an EWR network.
Tasking.Task_A2G

Tasking - The TASK_A2G models tasks for players in Air to Ground engagements.
Tasking.Task_A2G_Dispatcher

Tasking -- Dynamically allocates A2G tasks to human players, based on detected ground targets through reconnaissance.
Tasking.Task_Cargo

Tasking -- Base class to model tasks for players to transport cargo.
Tasking.Task_Cargo_CSAR

Tasking -- Orchestrates the task for players to execute CSAR for downed pilots.
Tasking.Task_Cargo_Dispatcher

Tasking - Creates and manages player TASK_CARGO tasks.
Tasking.Task_Cargo_Transport

Tasking -- Models tasks for players to transport cargo.
Tasking.Task_Manager

This module contains the TASK_MANAGER class and derived classes.
Tasking.Task_Zone_Capture_Dispatcher

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.
Utilities.PROFILER

Utils - Lua Profiler.
Utils

This module contains derived utilities taken from the MIST framework, which are excellent tools to be reused in an OO environment.
Wrapper.Airbase

Wrapper -- AIRBASE is a wrapper class to handle the DCS Airbase objects.
Wrapper.Client

Wrapper -- CLIENT wraps DCS Unit objects acting as a Client or Player within a mission.
Wrapper.Controllable

Wrapper -- CONTROLLABLE is an intermediate class wrapping Group and Unit classes "controllers".
Wrapper.Group

Wrapper -- GROUP wraps the DCS Class Group objects.
Wrapper.Identifiable

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

Wrapper - Markers On the F10 map.
Wrapper.Object

Wrapper -- OBJECT wraps the DCS Object derived objects.
Wrapper.Positionable

Wrapper -- POSITIONABLE wraps DCS classes that are "positionable".
Wrapper.Scenery

Wrapper -- SCENERY models scenery within the DCS simulator.
Wrapper.Static

Wrapper -- STATIC wraps the DCS StaticObject class.
Wrapper.Unit

Wrapper - UNIT is a wrapper class for the DCS Class Unit.
routines

Various routines

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.

Global(s)

Global MESSAGE

Message System to display Messages to Clients, Coalitions or All.

#MESSAGE MESSAGE

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 Client using MESSAGE.ToClient().
To a Wrapper.Group using MESSAGE.ToGroup()
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:

Type(s)

Type MESSAGE

MESSAGE , extends Core.Base#BASE

Fields and Methods inherited from MESSAGE	Description
MESSAGE:Clear()	Clears all previous messages from the screen before the new message is displayed.
MESSAGE.ClearScreen
MESSAGE.MessageCategory
MESSAGE.MessageDuration
MESSAGE:New(MessageText, MessageDuration, MessageCategory, ClearScreen)	Creates a new MESSAGE object.
MESSAGE:NewType(MessageText, MessageType, ClearScreen)	Creates a new MESSAGE object of a certain type.
MESSAGE:ToAll(Settings)	Sends a MESSAGE to all players.
MESSAGE:ToAllIf(Condition)	Sends a MESSAGE to all players if the given Condition is true.
MESSAGE:ToBlue()	Sends a MESSAGE to the Blue coalition.
MESSAGE:ToClient(Client, Settings)	Sends a MESSAGE to a Client Group.
MESSAGE:ToCoalition(CoalitionSide, Settings)	Sends a MESSAGE to a Coalition.
MESSAGE:ToCoalitionIf(CoalitionSide, Condition)	Sends a MESSAGE to a Coalition if the given Condition is true.
MESSAGE:ToGroup(Group, Settings)	Sends a MESSAGE to a Group.
MESSAGE:ToRed()	Sends a MESSAGE to the Red Coalition.
MESSAGE.Type

Fields and Methods inherited from BASE	Description
MESSAGE.ClassID	The ID number of the class.
MESSAGE.ClassName	The name of the class.
MESSAGE.ClassNameAndID	The name of the class concatenated with the ID number of the class.
MESSAGE:ClearState(Object, StateName)	Clear the state of an object.
MESSAGE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)	Creation of a Birth Event.
MESSAGE:CreateEventCrash(EventTime, Initiator)	Creation of a Crash Event.
MESSAGE:CreateEventDead(EventTime, Initiator)	Creation of a Dead Event.
MESSAGE:CreateEventPlayerEnterAircraft(PlayerUnit)	Creation of a `S_EVENT_PLAYER_ENTER_AIRCRAFT` event.
MESSAGE:CreateEventRemoveUnit(EventTime, Initiator)	Creation of a Remove Unit Event.
MESSAGE:CreateEventTakeoff(EventTime, Initiator)	Creation of a Takeoff Event.
MESSAGE:CreateEventUnitLost(EventTime, Initiator)	Creation of a Crash Event.
MESSAGE:E(Arguments)	Log an exception which will be traced always.
MESSAGE:EventDispatcher()	Returns the event dispatcher
MESSAGE:EventRemoveAll()	Remove all subscribed events
MESSAGE:F(Arguments)	Trace a function call.
MESSAGE:F2(Arguments)	Trace a function call level 2.
MESSAGE:F3(Arguments)	Trace a function call level 3.
MESSAGE:GetClassID()	Get the ClassID of the class instance.
MESSAGE:GetClassName()	Get the ClassName of the class instance.
MESSAGE:GetClassNameAndID()	Get the ClassName + ClassID of the class instance.
MESSAGE:GetEventPriority()	Get the Class Event processing Priority.
MESSAGE:GetParent(Child, FromClass)	This is the worker method to retrieve the Parent class.
MESSAGE:GetState(Object, Key)	Get a Value given a Key from the Object.
MESSAGE:HandleEvent(EventID, EventFunction)	Subscribe to a DCS Event.
MESSAGE:I(Arguments)	Log an information which will be traced always.
MESSAGE:Inherit(Child, Parent)	This is the worker method to inherit from a parent class.
MESSAGE:IsInstanceOf(ClassName)	This is the worker method to check if an object is an (sub)instance of a class.
MESSAGE:IsTrace()	Enquires if tracing is on (for the class).
MESSAGE:New()	BASE constructor.
MESSAGE:OnEvent(EventData)	Occurs when an object is completely destroyed.
MESSAGE:OnEventBaseCaptured(EventData)	Occurs when a ground unit captures either an airbase or a farp.
MESSAGE:OnEventBirth(EventData)	Occurs when any object is spawned into the mission.
MESSAGE:OnEventCrash(EventData)	Occurs when any aircraft crashes into the ground and is completely destroyed.
MESSAGE:OnEventDead(EventData)	Occurs when an object is dead.
MESSAGE:OnEventDetailedFailure(EventData)	Unknown precisely what creates this event, likely tied into newer damage model.
MESSAGE:OnEventEjection(EventData)	Occurs when a pilot ejects from an aircraft initiator : The unit that has ejected
MESSAGE:OnEventEngineShutdown(EventData)	Occurs when any aircraft shuts down its engines.
MESSAGE:OnEventEngineStartup(EventData)	Occurs when any aircraft starts its engines.
MESSAGE:OnEventHit(EventData)	Occurs whenever an object is hit by a weapon.
MESSAGE:OnEventHumanFailure(EventData)	Occurs when any system fails on a human controlled aircraft.
MESSAGE:OnEventKill(EventData)	Occurs on the death of a unit.
MESSAGE: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.
MESSAGE:OnEventLandingAfterEjection(EventData)	Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.
MESSAGE:OnEventMarkAdded(EventData)	Occurs when a new mark was added.
MESSAGE:OnEventMarkChange(EventData)	Occurs when a mark text was changed.
MESSAGE:OnEventMarkRemoved(EventData)	Occurs when a mark was removed.
MESSAGE:OnEventMissionEnd(EventData)	Occurs when a mission ends
MESSAGE:OnEventMissionStart(EventData)	Occurs when a mission starts
MESSAGE:OnEventPilotDead(EventData)	Occurs when the pilot of an aircraft is killed.
MESSAGE:OnEventPlayerEnterAircraft(EventData)	Occurs when a player enters a slot and takes control of an aircraft.
MESSAGE:OnEventPlayerEnterUnit(EventData)	Occurs when any player assumes direct control of a unit.
MESSAGE:OnEventPlayerLeaveUnit(EventData)	Occurs when any player relieves control of a unit to the AI.
MESSAGE:OnEventRefueling(EventData)	Occurs when an aircraft connects with a tanker and begins taking on fuel.
MESSAGE:OnEventRefuelingStop(EventData)	Occurs when an aircraft is finished taking fuel.
MESSAGE:OnEventScore(EventData)	Occurs when any modification to the "Score" as seen on the debrief menu would occur.
MESSAGE:OnEventShootingEnd(EventData)	Occurs when any unit stops firing its weapon.
MESSAGE:OnEventShootingStart(EventData)	Occurs when any unit begins firing a weapon that has a high rate of fire.
MESSAGE:OnEventShot(EventData)	Occurs whenever any unit in a mission fires a weapon.
MESSAGE:OnEventTakeoff(EventData)	Occurs when an aircraft takes off from an airbase, farp, or ship.
MESSAGE:OnEventUnitLost(EventData)	Occurs when the game thinks an object is destroyed.
MESSAGE:ScheduleOnce(Start, SchedulerFunction, ...)	Schedule a new time event.
MESSAGE:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)	Schedule a new time event.
MESSAGE:ScheduleStop(SchedulerFunction)	Stops the Schedule.
MESSAGE.Scheduler
MESSAGE:SetEventPriority(EventPriority)	Set the Class Event processing Priority.
MESSAGE:SetState(Object, Key, Value)	Set a state or property of the Object given a Key and a Value.
MESSAGE:T(Arguments)	Trace a function logic level 1.
MESSAGE:T2(Arguments)	Trace a function logic level 2.
MESSAGE:T3(Arguments)	Trace a function logic level 3.
MESSAGE:TraceAll(TraceAll)	Trace all methods in MOOSE
MESSAGE:TraceClass(Class)	Set tracing for a class
MESSAGE:TraceClassMethod(Class, Method)	Set tracing for a specific method of class
MESSAGE:TraceLevel(Level)	Set trace level
MESSAGE:TraceOff()	Set trace off.
MESSAGE:TraceOn()	Set trace on.
MESSAGE: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.
MESSAGE:UnHandleEvent(EventID)	UnSubscribe to a DCS event.
MESSAGE._
MESSAGE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)	Trace a function call.
MESSAGE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)	Trace a function logic.
MESSAGE.__
MESSAGE:onEvent(event)

Type MESSAGE.Type

MESSAGE.Type

Fields and Methods inherited from MESSAGE.Type	Description
MESSAGE.Type.Briefing
MESSAGE.Type.Detailed
MESSAGE.Type.Information
MESSAGE.Type.Overview
MESSAGE.Type.Update

Field(s)

#boolean MESSAGE.ClearScreen

#string MESSAGE.MessageCategory

self.MessageType .. ": "

MESSAGE.MessageDuration

#MESSAGE.Type MESSAGE.Type

Function(s)

MESSAGE:Clear()

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.

Defined in:

MESSAGE

Return value:

#MESSAGE:

MESSAGE:New(MessageText, MessageDuration, MessageCategory, ClearScreen)

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.

Defined in:

MESSAGE

Parameters:

#string MessageText

is the text of the Message.

#number MessageDuration

is a number in seconds of how long the MESSAGE should be shown on the display panel.

#string MessageCategory

(optional) is a 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:

#MESSAGE:

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

MESSAGE:NewType(MessageText, MessageType, ClearScreen)

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.

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:

#MESSAGE:

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 )

MESSAGE:ToAll(Settings)

Sends a MESSAGE to all players.

Defined in:

MESSAGE

Parameter:

Core.Settings#Settings Settings

(Optional) Settings for message display.

Return value:

#MESSAGE:

Usage:

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

MESSAGE:ToAllIf(Condition)

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

Defined in:

MESSAGE

Parameter:

Condition

Return value:

#MESSAGE:

MESSAGE:ToBlue()

Sends a MESSAGE to the Blue coalition.

Defined in:

MESSAGE

Return value:

#MESSAGE:

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

MESSAGE:ToClient(Client, Settings)

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

Settings used to display the message.

Return value:

#MESSAGE:

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

MESSAGE:ToCoalition(CoalitionSide, Settings)

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:

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", "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 )

MESSAGE:ToCoalitionIf(CoalitionSide, Condition)

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

#boolean Condition

Sends the message only if the condition is true.

Return value:

#MESSAGE:

self

MESSAGE:ToGroup(Group, Settings)

Sends a MESSAGE to a Group.

Defined in:

MESSAGE

Parameters:

Wrapper.Group#GROUP Group

to which the message is displayed.

Settings

Return value:

#MESSAGE:

Message object.

MESSAGE:ToRed()

Sends a MESSAGE to the Red Coalition.

Defined in:

MESSAGE

Return value:

#MESSAGE:

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

Field(s)

#boolean MESSAGE.ClearScreen

#string MESSAGE.MessageCategory

self.MessageType .. ": "

MESSAGE.MessageDuration

#MESSAGE.Type MESSAGE.Type

Function(s)

MESSAGE:ClearState(Object, StateName)

Clear the state of an object.