Banner Image

Module Functional.MissileTrainer

Functional -- Train missile defence and deflection.


Features:

  • Track the missiles fired at you and other players, providing bearing and range information of the missiles towards the airplanes.
  • Provide alerts of missile launches, including detailed information of the units launching, including bearing, range �
  • Provide alerts when a missile would have killed your aircraft.
  • Provide alerts when the missile self destructs.
  • Enable / Disable and Configure the Missile Trainer using the various menu options.

Missions:

MIT - Missile Trainer


Uses the MOOSE messaging system to be alerted of any missiles fired, and when a missile would hit your aircraft, the class will destroy the missile within a certain range, to avoid damage to your aircraft.

When running a mission where the missile trainer is used, the following radio menu structure ( 'Radio Menu' -> 'Other (F10)' -> 'MissileTrainer' ) options are available for the players:

  • Messages: Menu to configure all messages.
    • Messages On: Show all messages.
    • Messages Off: Disable all messages.
  • Tracking: Menu to configure missile tracking messages.
    • To All: Shows missile tracking messages to all players.
    • To Target: Shows missile tracking messages only to the player where the missile is targetted at.
    • Tracking On: Show missile tracking messages.
    • Tracking Off: Disable missile tracking messages.
    • Frequency Increase: Increases the missile tracking message frequency with one second.
    • Frequency Decrease: Decreases the missile tracking message frequency with one second.
  • Alerts: Menu to configure alert messages.
    • To All: Shows alert messages to all players.
    • To Target: Shows alert messages only to the player where the missile is (was) targetted at.
    • Hits On: Show missile hit alert messages.
    • Hits Off: Disable missile hit alert messages.
    • Launches On: Show missile launch messages.
    • Launches Off: Disable missile launch messages.
  • Details: Menu to configure message details.
    • Range On: Shows range information when a missile is fired to a target.
    • Range Off: Disable range information when a missile is fired to a target.
    • Bearing On: Shows bearing information when a missile is fired to a target.
    • Bearing Off: Disable bearing information when a missile is fired to a target.
  • Distance: Menu to configure the distance when a missile needs to be destroyed when near to a player, during tracking. This will improve/influence hit calculation accuracy, but has the risk of damaging the aircraft when the missile reaches the aircraft before the distance is measured.
    • 50 meter: Destroys the missile when the distance to the aircraft is below or equal to 50 meter.
    • 100 meter: Destroys the missile when the distance to the aircraft is below or equal to 100 meter.
    • 150 meter: Destroys the missile when the distance to the aircraft is below or equal to 150 meter.
    • 200 meter: Destroys the missile when the distance to the aircraft is below or equal to 200 meter.

Authors: FlightControl

Contributions:

  • Stuka (Danny): Who you can search on the Eagle Dynamics Forums. Working together with Danny has resulted in the MISSILETRAINER class.
    Danny has shared his ideas and together we made a design. Together with the 476 virtual team, we tested the MISSILETRAINER class, and got much positive feedback!
  • 132nd Squadron: Testing and optimizing the logic.

Global(s)

Global MISSILETRAINER

Constructor:

Create a new MISSILETRAINER object with the MISSILETRAINER.New method:

  • MISSILETRAINER.New: Creates a new MISSILETRAINER object taking the maximum distance to your aircraft to evaluate when a missile needs to be destroyed.
#MISSILETRAINER MISSILETRAINER

Constructor:

Create a new MISSILETRAINER object with the MISSILETRAINER.New method:

  • MISSILETRAINER.New: Creates a new MISSILETRAINER object taking the maximum distance to your aircraft to evaluate when a missile needs to be destroyed.

MISSILETRAINER will collect each unit declared in the mission with a skill level "Client" and "Player", and will monitor the missiles shot at those.

Initialization:

A MISSILETRAINER object will behave differently based on the usage of initialization methods:

Type(s)

Fields and Methods inherited from MISSILETRAINER Description

MISSILETRAINER.AlertsHitsOnOff

MISSILETRAINER.AlertsLaunchesOnOff

MISSILETRAINER.AlertsToAll

MISSILETRAINER.DBClients

MISSILETRAINER.DetailsBearingOnOff

MISSILETRAINER.DetailsRangeOnOff

MISSILETRAINER:InitAlertsHitsOnOff(AlertsHitsOnOff)

Sets by default the display of hit alerts ON or OFF.

MISSILETRAINER:InitAlertsLaunchesOnOff(AlertsLaunchesOnOff)

Sets by default the display of launch alerts ON or OFF.

MISSILETRAINER:InitAlertsToAll(AlertsToAll)

Sets by default the display of alerts to be shown to all players or only to you.

MISSILETRAINER:InitBearingOnOff(DetailsBearingOnOff)

Sets by default the display of bearing information of missiles ON of OFF.

MISSILETRAINER:InitMenusOnOff(MenusOnOff)

Enables / Disables the menus.

MISSILETRAINER:InitMessagesOnOff(MessagesOnOff)

Sets by default the display of any message to be ON or OFF.

MISSILETRAINER:InitRangeOnOff(DetailsRangeOnOff)

Sets by default the display of range information of missiles ON of OFF.

MISSILETRAINER:InitTrackingFrequency(TrackingFrequency)

Increases, decreases the missile tracking message display frequency with the provided time interval in seconds.

MISSILETRAINER:InitTrackingOnOff(TrackingOnOff)

Sets by default the display of missile tracking report to be ON or OFF.

MISSILETRAINER:InitTrackingToAll(TrackingToAll)

Sets by default the missile tracking report for all players or only for those missiles targetted to you.

MISSILETRAINER.MenusOnOff

MISSILETRAINER.MessagesOnOff

MISSILETRAINER:New(Distance, Briefing)

Creates the main object which is handling missile tracking.

MISSILETRAINER:OnEventShot(EventData, EVentData)

Detects if an SA site was shot with an anti radiation missile.

MISSILETRAINER.TrackingFrequency

MISSILETRAINER.TrackingOnOff

MISSILETRAINER.TrackingToAll

MISSILETRAINER:_AddBearing(Client, TrainerWeapon)

MISSILETRAINER:_AddRange(Client, TrainerWeapon)

MISSILETRAINER._Alive(Client, self)

MISSILETRAINER._MenuMessages(MenuParameters)

MISSILETRAINER:_TrackMissiles()

Fields and Methods inherited from BASE Description

MISSILETRAINER.ClassID

The ID number of the class.

MISSILETRAINER.ClassName

The name of the class.

MISSILETRAINER.ClassNameAndID

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

MISSILETRAINER:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

MISSILETRAINER:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

MISSILETRAINER:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

MISSILETRAINER:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

MISSILETRAINER:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

MISSILETRAINER:E(Arguments)

Log an exception which will be traced always.

MISSILETRAINER:EventDispatcher()

Returns the event dispatcher

MISSILETRAINER:EventRemoveAll()

Remove all subscribed events

MISSILETRAINER:F(Arguments)

Trace a function call.

MISSILETRAINER:F2(Arguments)

Trace a function call level 2.

MISSILETRAINER:F3(Arguments)

Trace a function call level 3.

MISSILETRAINER:GetClassID()

Get the ClassID of the class instance.

MISSILETRAINER:GetClassName()

Get the ClassName of the class instance.

MISSILETRAINER:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

MISSILETRAINER:GetEventPriority()

Get the Class Event processing Priority.

MISSILETRAINER:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

MISSILETRAINER:GetState(Object, Key)

Get a Value given a Key from the Object.

MISSILETRAINER:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

MISSILETRAINER:I(Arguments)

Log an information which will be traced always.

MISSILETRAINER:Inherit(Child, Parent)

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

MISSILETRAINER:IsInstanceOf(ClassName)

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

MISSILETRAINER:IsTrace()

Enquires if tracing is on (for the class).

MISSILETRAINER:New()

BASE constructor.

MISSILETRAINER:OnEvent(EventData)

Occurs when an object is completely destroyed.

MISSILETRAINER:OnEventBaseCaptured(EventData)

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

MISSILETRAINER:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

MISSILETRAINER:OnEventCrash(EventData)

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

MISSILETRAINER:OnEventDead(EventData)

Occurs when an object is dead.

MISSILETRAINER:OnEventDetailedFailure(EventData)

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

MISSILETRAINER:OnEventEjection(EventData)

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

MISSILETRAINER:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

MISSILETRAINER:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

MISSILETRAINER:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

MISSILETRAINER:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

MISSILETRAINER:OnEventKill(EventData)

Occurs on the death of a unit.

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

MISSILETRAINER:OnEventLandingAfterEjection(EventData)

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

MISSILETRAINER:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

MISSILETRAINER:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

MISSILETRAINER:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

MISSILETRAINER:OnEventMissionEnd(EventData)

Occurs when a mission ends

MISSILETRAINER:OnEventMissionStart(EventData)

Occurs when a mission starts

MISSILETRAINER:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

MISSILETRAINER:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

MISSILETRAINER:OnEventPlayerLeaveUnit(EventData)

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

MISSILETRAINER:OnEventRefueling(EventData)

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

MISSILETRAINER:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

MISSILETRAINER:OnEventScore(EventData)

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

MISSILETRAINER:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

MISSILETRAINER:OnEventShootingStart(EventData)

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

MISSILETRAINER:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

MISSILETRAINER:OnEventTakeoff(EventData)

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

MISSILETRAINER:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

MISSILETRAINER:ScheduleStop(SchedulerFunction)

Stops the Schedule.

MISSILETRAINER.Scheduler

MISSILETRAINER:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

MISSILETRAINER:SetState(Object, Key, Value)

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

MISSILETRAINER:T(Arguments)

Trace a function logic level 1.

MISSILETRAINER:T2(Arguments)

Trace a function logic level 2.

MISSILETRAINER:T3(Arguments)

Trace a function logic level 3.

MISSILETRAINER:TraceAll(TraceAll)

Trace all methods in MOOSE

MISSILETRAINER:TraceClass(Class)

Set tracing for a class

MISSILETRAINER:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

MISSILETRAINER:TraceLevel(Level)

Set trace level

MISSILETRAINER:TraceOff()

Set trace off.

MISSILETRAINER:TraceOn()

Set trace on.

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

MISSILETRAINER:UnHandleEvent(Event)

UnSubscribe to a DCS event.

MISSILETRAINER._

MISSILETRAINER:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

MISSILETRAINER:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

MISSILETRAINER.__

MISSILETRAINER:onEvent(event)

Field(s)

Function(s)

Sets by default the display of hit alerts ON or OFF.

Defined in:

MISSILETRAINER

Parameter:

#boolean AlertsHitsOnOff

true or false

Return value:

Sets by default the display of launch alerts ON or OFF.

Defined in:

MISSILETRAINER

Parameter:

#boolean AlertsLaunchesOnOff

true or false

Return value:

Sets by default the display of alerts to be shown to all players or only to you.

Defined in:

MISSILETRAINER

Parameter:

#boolean AlertsToAll

true or false

Return value:

Sets by default the display of bearing information of missiles ON of OFF.

Defined in:

MISSILETRAINER

Parameter:

#boolean DetailsBearingOnOff

true or false

Return value:

Enables / Disables the menus.

Defined in:

MISSILETRAINER

Parameter:

#boolean MenusOnOff

true or false

Return value:

Sets by default the display of any message to be ON or OFF.

Defined in:

MISSILETRAINER

Parameter:

#boolean MessagesOnOff

true or false

Return value:

Sets by default the display of range information of missiles ON of OFF.

Defined in:

MISSILETRAINER

Parameter:

#boolean DetailsRangeOnOff

true or false

Return value:

Increases, decreases the missile tracking message display frequency with the provided time interval in seconds.

The default frequency is a 3 second interval, so the Tracking Frequency parameter specifies the increase or decrease from the default 3 seconds or the last frequency update.

Defined in:

MISSILETRAINER

Parameter:

#number TrackingFrequency

Provide a negative or positive value in seconds to incraese or decrease the display frequency.

Return value:

Sets by default the display of missile tracking report to be ON or OFF.

Defined in:

MISSILETRAINER

Parameter:

#boolean TrackingOnOff

true or false

Return value:

Sets by default the missile tracking report for all players or only for those missiles targetted to you.

Defined in:

MISSILETRAINER

Parameter:

#boolean TrackingToAll

true or false

Return value:

Creates the main object which is handling missile tracking.

When a missile is fired a SCHEDULER is set off that follows the missile. When near a certain a client player, the missile will be destroyed.

Defined in:

MISSILETRAINER

Parameters:

#number Distance

The distance in meters when a tracked missile needs to be destroyed when close to a player.

#string Briefing

(Optional) Will show a text to the players when starting their mission. Can be used for briefing purposes.

Return value:

Detects if an SA site was shot with an anti radiation missile.

In this case, take evasive actions based on the skill level set within the ME.

Defined in:

MISSILETRAINER

Parameters:

EVentData

Defined in:

MISSILETRAINER

Parameters:

Client

TrainerWeapon

Defined in:

MISSILETRAINER

Parameters:

Client

TrainerWeapon

Defined in:

MISSILETRAINER

Parameters:

Client

self

Defined in:

MISSILETRAINER

Parameter:

MenuParameters

Defined in:

MISSILETRAINER

Field(s)

Function(s)

Clear the state of an object.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

StateName

The key that is should be cleared.

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

#string IniUnitName

The initiating unit name.

place

subplace

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Remove Unit Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Takeoff Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Returns the event dispatcher

Defined in:

Return value:

Remove all subscribed events

Defined in:

Return value:

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

Get the ClassName + ClassID of the class instance.

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

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

Get the Class Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Return value:

#number:

The Event processing Priority.

This is the worker method to retrieve the Parent class.

Note that the Parent class must be passed to call the parent class method.

self:GetParent(self):ParentMethod()


Defined in:

Parameters:

#BASE Child

This is the Child class from which the Parent class needs to be retrieved.

#BASE FromClass

(Optional) The class from which to get the parent.

Return value:

Get a Value given a Key from the Object.

Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

Return value:

The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.

Subscribe to a DCS Event.

Defined in:

Parameters:

#function EventFunction

(optional) The function to be called when the event occurs for the unit.

Return value:

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

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

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

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

Examples:

  • ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

Defined in:

Parameter:

ClassName

is the name of the class or the class itself to run the check against

Return value:

#boolean:

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

BASE constructor.

This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.

function EVENT:New()
  local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
  return self
end
  

Defined in:

Return value:

Occurs when an object is completely destroyed.

initiator : The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

Defined in:

Parameter:

The EventData structure.

Occurs when any object is spawned into the mission.

initiator : The unit that was spawned

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that has crashed

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

initiator : The unit that is dead.

Defined in:

Parameter:

The EventData structure.

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

Will update this page when new information become available.

  • initiator: The unit that had the failure.

Defined in:

Parameter:

The EventData structure.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

initiator : The unit that is stopping its engines.

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

initiator : The unit that is starting its engines.

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.

Defined in:

Parameter:

The EventData structure.

Occurs when any system fails on a human controlled aircraft.

initiator : The unit that had the failure

Defined in:

Parameter:

The EventData structure.

Occurs on the death of a unit.

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs.

  • initiator: The unit that killed the target
  • target: Target Object
  • weapon: Weapon Object

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft lands at an airbase, farp or ship initiator : The unit that has landed place: Object that the unit landed on.

Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

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

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker.

  • initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
  • place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
  • subplace: is always 0 for unknown reasons.

Defined in:

Parameter:

The EventData structure.

Occurs when a new mark was added.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission ends

Defined in:

Parameter:

The EventData structure.

Occurs when a mission starts

Defined in:

Parameter:

The EventData structure.

Occurs when the pilot of an aircraft is killed.

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. initiator : The unit that the pilot has died in.

Defined in:

Parameter:

The EventData structure.

Occurs when any player assumes direct control of a unit.

initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that the player left.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that is receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

initiator : The unit that was receiving fuel.

Defined in:

Parameter:

The EventData structure.

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

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

Event will always correspond with a shooting start event. initiator : The unit that was doing the shooting.

Defined in:

Parameter:

The EventData structure.

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

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. initiator : The unit that is doing the shooting. target: The unit that is being targeted.

Defined in:

Parameter:

The EventData structure.

Occurs whenever any unit in a mission fires a weapon.

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

Occurs when the game thinks an object is destroyed.

  • initiator: The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#number:

The ScheduleID of the planned schedule.

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#number Repeat

Specifies the interval in seconds when the scheduler will call the event function.

#number RandomizeFactor

Specifies a randomization factor between 0 and 1 to randomize the Repeat.

#number Stop

Specifies the amount of seconds when the scheduler will be stopped.

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#number:

The ScheduleID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

Set the Class Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Parameter:

#number EventPriority

The Event processing Priority.

Return value:

self

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

Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that will hold the Value set by the Key.

Key

The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

Value

The value to is stored in the object.

Return value:

The Value set.

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

Set tracing for a class

Defined in:

Parameter:

#string Class

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

#string Method

Set trace level

Defined in:

Parameter:

#number Level

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.

So tracing must be switched on manually in your mission if you are using Moose statically. When moose is loading dynamically (for moose class development), tracing is switched on by default.

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:

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

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

UnSubscribe to a DCS event.

Defined in:

Parameter:

Return value:

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

TODO: Complete DCS#Event structure.
- The main event handling function... This function captures all events generated for the class. @param #BASE self @param DCS#Event event

Defined in:

Parameter:

event