Banner Image

Module Core.Spot

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


SPOT implements the DCS Spot class functionality, but adds additional luxury to be able to:

  • Spot for a defined duration.
  • Updates of laer spot position every 0.2 seconds for moving targets.
  • Wiggle the spot at the target.
  • Provide a Wrapper.Unit as a target, instead of a point.
  • Implement a status machine, LaseOn, LaseOff.

Demo Missions

SPOT Demo Missions source code

SPOT Demo Missions, only for beta testers

ALL Demo Missions pack of the last release


YouTube Channel

SPOT YouTube Channel


Author: FlightControl

Contributions:

  • Ciribob: Showing the way how to lase targets + how laser codes work!!! Explained the autolase script.
  • EasyEB: Ideas and Beta Testing
  • Wingthor: Beta Testing

Global(s)

Global SPOT

Implements the target spotting or marking functionality, but adds additional luxury to be able to:

  • Mark targets for a defined duration.
#SPOT SPOT

Implements the target spotting or marking functionality, but adds additional luxury to be able to:

  • Mark targets for a defined duration.
  • Updates of laer spot position every 0.2 seconds for moving targets.
  • Wiggle the spot at the target.
  • Provide a Wrapper.Unit as a target, instead of a point.
  • Implement a status machine, LaseOn, LaseOff.

1. SPOT constructor

  • SPOT.New(..\Presentations\SPOT\Dia2.JPG): Creates a new SPOT object.

2. SPOT is a FSM

Process

2.1 SPOT States

  • Off: Lasing is switched off.
  • On: Lasing is switched on.
  • Destroyed: Target is destroyed.

2.2 SPOT Events

3. Check if a Target is being lased

The method SPOT.IsLasing() indicates whether lasing is on or off.

Type(s)

SPOT , extends Core.Fsm#FSM , extends Core.Base#BASE
Fields and Methods inherited from SPOT Description

SPOT:Destroyed()

Destroyed Trigger for SPOT

SPOT:IsLasing()

Check if the SPOT is lasing

SPOT:LaseOff()

LaseOff Trigger for SPOT

SPOT:LaseOn(Target, LaserCode, Duration)

LaseOn Trigger for SPOT

SPOT:LaseOnCoordinate(Coordinate, LaserCode, Duration)

LaseOnCoordinate Trigger for SPOT.

SPOT.LaseScheduler

SPOT.LaserCode

SPOT.Lasing

SPOT:New(Recce)

SPOT Constructor.

SPOT:OnAfterDestroyed(From, Event, To)

Destroyed Handler OnAfter for SPOT

SPOT:OnAfterLaseOff(From, Event, To)

LaseOff Handler OnAfter for SPOT

SPOT:OnAfterLaseOn(From, Event, To)

LaseOn Handler OnAfter for SPOT

SPOT:OnAfterLaseOnCoordinate(From, Event, To)

LaseOnCoordinate Handler OnAfter for SPOT.

SPOT:OnBeforeDestroyed(From, Event, To)

Destroyed Handler OnBefore for SPOT

SPOT:OnBeforeLaseOff(From, Event, To)

LaseOff Handler OnBefore for SPOT

SPOT:OnBeforeLaseOn(From, Event, To)

LaseOn Handler OnBefore for SPOT

SPOT:OnBeforeLaseOnCoordinate(From, Event, To)

LaseOnCoordinate Handler OnBefore for SPOT.

SPOT:OnEventDead(EventData)

SPOT.Recce

SPOT.ScheduleID

SPOT.SpotIR

SPOT.SpotLaser

SPOT.Target

SPOT.TargetCoord

SPOT:__Destroyed(Delay)

Destroyed Asynchronous Trigger for SPOT

SPOT:__LaseOff(Delay)

LaseOff Asynchronous Trigger for SPOT

SPOT:__LaseOn(Delay, Target, LaserCode, Duration)

LaseOn Asynchronous Trigger for SPOT

SPOT:onafterLaseOff(From, Event, To)

SPOT:onafterLaseOn(From, Event, To, Target, LaserCode, Duration)

On after LaseOn event.

SPOT:onafterLaseOnCoordinate(From, Event, To, Coordinate, LaserCode, Duration)

On after LaseOnCoordinate event.

SPOT:onafterLasing(From, Event, To)

Fields and Methods inherited from FSM Description

SPOT:AddEndState(State)

Adds an End state.

SPOT:AddProcess(From, Event, Process, ReturnEvents)

Set the default Process template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

SPOT:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

SPOT:AddScoreProcess(From, Event, State, ScoreText, Score)

Adds a score for the FSM_PROCESS to be achieved.

SPOT:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

SPOT.CallScheduler

Call scheduler.

SPOT.ClassName

Name of the class.

SPOT.Events

SPOT:GetCurrentState()

Get current state.

SPOT:GetEndStates()

Returns the End states.

SPOT:GetProcess(From, Event)

SPOT:GetProcesses()

Returns a table of the SubFSM rules defined within the FSM.

SPOT:GetScores(Scores)

Returns a table with the scores defined.

SPOT:GetStartState()

Returns the start state of the FSM.

SPOT:GetState()

Get current state.

SPOT:GetSubs()

Returns a table with the Subs defined.

SPOT:GetTransitions()

Returns a table of the transition rules defined within the FSM.

SPOT:Is(State, If)

Check if FSM is in state.

SPOT:LoadCallBacks(CallBackTable)

Load call backs.

SPOT:New()

Creates a new FSM object.

SPOT.Scores

Scores.

SPOT:SetProcess(From, Event, Fsm)

SPOT:SetStartState(State)

Sets the start state of the FSM.

SPOT._EndStates

SPOT._EventSchedules

SPOT._Processes

SPOT._Scores

SPOT._StartState

SPOT._Transitions

SPOT:_add_to_map(Map, Event)

Add to map.

SPOT:_call_handler(step, trigger, params, EventName)

Call handler.

SPOT:_create_transition(EventName)

Create transition.

SPOT:_delayed_transition(EventName)

Delayed transition.

SPOT:_eventmap(Events, EventStructure)

Event map.

SPOT:_gosub(ParentFrom, ParentEvent)

Go sub.

SPOT:_handler(EventName, ...)

Handler.

SPOT:_isendstate(Current)

Is end state.

SPOT:_submap(subs, sub, name)

Sub maps.

SPOT:can(e)

Check if can do an event.

SPOT:cannot(e)

Check if cannot do an event.

SPOT.current

Current state name.

SPOT.endstates

SPOT:is(State, If, state)

Check if FSM is in state.

SPOT.options

Options.

SPOT.subs

Subs.

Fields and Methods inherited from BASE Description

SPOT.ClassID

The ID number of the class.

SPOT.ClassName

The name of the class.

SPOT.ClassNameAndID

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

SPOT:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

SPOT:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

SPOT:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

SPOT:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

SPOT:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

SPOT:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

SPOT:E(Arguments)

Log an exception which will be traced always.

SPOT:EventDispatcher()

Returns the event dispatcher

SPOT:EventRemoveAll()

Remove all subscribed events

SPOT:F(Arguments)

Trace a function call.

SPOT:F2(Arguments)

Trace a function call level 2.

SPOT:F3(Arguments)

Trace a function call level 3.

SPOT:GetClassID()

Get the ClassID of the class instance.

SPOT:GetClassName()

Get the ClassName of the class instance.

SPOT:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

SPOT:GetEventPriority()

Get the Class Event processing Priority.

SPOT:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

SPOT:GetState(Object, Key)

Get a Value given a Key from the Object.

SPOT:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

SPOT:I(Arguments)

Log an information which will be traced always.

SPOT:Inherit(Child, Parent)

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

SPOT:IsInstanceOf(ClassName)

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

SPOT:IsTrace()

Enquires if tracing is on (for the class).

SPOT:New()

BASE constructor.

SPOT:OnEvent(EventData)

Occurs when an object is completely destroyed.

SPOT:OnEventBaseCaptured(EventData)

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

SPOT:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

SPOT:OnEventCrash(EventData)

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

SPOT:OnEventDead(EventData)

Occurs when an object is dead.

SPOT:OnEventDetailedFailure(EventData)

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

SPOT:OnEventEjection(EventData)

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

SPOT:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

SPOT:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

SPOT:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

SPOT:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

SPOT:OnEventKill(EventData)

Occurs on the death of a unit.

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

SPOT:OnEventLandingAfterEjection(EventData)

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

SPOT:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

SPOT:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

SPOT:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

SPOT:OnEventMissionEnd(EventData)

Occurs when a mission ends

SPOT:OnEventMissionStart(EventData)

Occurs when a mission starts

SPOT:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

SPOT:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

SPOT:OnEventPlayerLeaveUnit(EventData)

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

SPOT:OnEventRefueling(EventData)

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

SPOT:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

SPOT:OnEventScore(EventData)

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

SPOT:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

SPOT:OnEventShootingStart(EventData)

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

SPOT:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

SPOT:OnEventTakeoff(EventData)

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

SPOT:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

SPOT:ScheduleStop(SchedulerFunction)

Stops the Schedule.

SPOT.Scheduler

SPOT:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

SPOT:SetState(Object, Key, Value)

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

SPOT:T(Arguments)

Trace a function logic level 1.

SPOT:T2(Arguments)

Trace a function logic level 2.

SPOT:T3(Arguments)

Trace a function logic level 3.

SPOT:TraceAll(TraceAll)

Trace all methods in MOOSE

SPOT:TraceClass(Class)

Set tracing for a class

SPOT:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

SPOT:TraceLevel(Level)

Set trace level

SPOT:TraceOff()

Set trace off.

SPOT:TraceOn()

Set trace on.

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

SPOT:UnHandleEvent(Event)

UnSubscribe to a DCS event.

SPOT._

SPOT:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

SPOT:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

SPOT.__

SPOT:onEvent(event)

Field(s)

#boolean SPOT.Lasing

Function(s)

Destroyed Trigger for SPOT

Defined in:

SPOT

Check if the SPOT is lasing

Defined in:

SPOT

Return value:

#boolean:

true if it is lasing

LaseOff Trigger for SPOT

Defined in:

SPOT

LaseOn Trigger for SPOT

Defined in:

SPOT

Parameters:

#number LaserCode

Laser code.

#number Duration

Duration of lasing in seconds.

LaseOnCoordinate Trigger for SPOT.

Defined in:

SPOT

Parameters:

The coordinate to lase.

#number LaserCode

Laser code.

#number Duration

Duration of lasing in seconds.

SPOT Constructor.

Defined in:

SPOT

Parameter:

Unit that is lasing

Return value:

Destroyed Handler OnAfter for SPOT

Defined in:

SPOT

Parameters:

#string From

#string Event

#string To

LaseOff Handler OnAfter for SPOT

Defined in:

SPOT

Parameters:

#string From

#string Event

#string To

LaseOn Handler OnAfter for SPOT

Defined in:

SPOT

Parameters:

#string From

#string Event

#string To

LaseOnCoordinate Handler OnAfter for SPOT.

Defined in:

SPOT

Parameters:

#string From

#string Event

#string To

Destroyed Handler OnBefore for SPOT

Defined in:

SPOT

Parameters:

#string From

#string Event

#string To

Return value:

#boolean:

LaseOff Handler OnBefore for SPOT

Defined in:

SPOT

Parameters:

#string From

#string Event

#string To

Return value:

#boolean:

LaseOn Handler OnBefore for SPOT

Defined in:

SPOT

Parameters:

#string From

#string Event

#string To

Return value:

#boolean:

LaseOnCoordinate Handler OnBefore for SPOT.

Defined in:

SPOT

Parameters:

#string From

#string Event

#string To

Return value:

#boolean:

Defined in:

SPOT

Parameter:

Destroyed Asynchronous Trigger for SPOT

Defined in:

SPOT

Parameter:

#number Delay

LaseOff Asynchronous Trigger for SPOT

Defined in:

SPOT

Parameter:

#number Delay

LaseOn Asynchronous Trigger for SPOT

Defined in:

SPOT

Parameters:

#number Delay

#number LaserCode

Laser code.

#number Duration

Duration of lasing in seconds.

Defined in:

SPOT

Parameters:

From

Event

To

Return value:

On after LaseOn event.

Activates the laser spot.

Defined in:

SPOT

Parameters:

From

Event

To

Unit that is being lased.

#number LaserCode

Laser code.

#number Duration

Duration of lasing in seconds.

On after LaseOnCoordinate event.

Activates the laser spot.

Defined in:

SPOT

Parameters:

From

Event

To

The coordinate at which the laser is pointing.

#number LaserCode

Laser code.

#number Duration

Duration of lasing in seconds.

Defined in:

SPOT

Parameters:

From

Event

To

Field(s)

#boolean SPOT.Lasing

Function(s)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

Set the default Process template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

Defined in:

Parameters:

#table From

Can contain a string indicating the From state or a table of strings containing multiple From states.

#string Event

The Event name.

An sub-process FSM.

#table ReturnEvents

A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.

Return value:

The SubFSM.

Adds a score for the FSM to be achieved.

Defined in:

Parameters:

#string State

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

#string ScoreText

is a text describing the score that is given according the status.

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Adds a score for the FSM_PROCESS to be achieved.

Defined in:

Parameters:

#string From

is the From State of the main process.

#string Event

is the Event of the main process.

#string State

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

#string ScoreText

is a text describing the score that is given according the status.

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Add a new transition rule to the FSM.

A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.

Defined in:

Parameters:

#table From

Can contain a string indicating the From state or a table of strings containing multiple From states.

#string Event

The Event name.

#string To

The To state.

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

Returns the End states.

Defined in:

Return value:

#table:

End states.

Defined in:

Parameters:

From

Event

Returns a table of the SubFSM rules defined within the FSM.

Defined in:

Return value:

#table:

Sub processes.

Returns a table with the scores defined.

Defined in:

Parameter:

#table Scores

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

Returns a table with the Subs defined.

Defined in:

Return value:

#table:

Sub processes.

Returns a table of the transition rules defined within the FSM.

Defined in:

Return value:

#table:

Transitions.

Check if FSM is in state.

Defined in:

Parameters:

#string State

State name.

#boolean If

true, FSM is in this state.

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

Creates a new FSM object.

Defined in:

Return value:

#FSM:

Defined in:

Parameters:

From

Event

Fsm

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

Add to map.

Defined in:

Parameters:

#table Map

Map.

#table Event

Event table.

Call handler.

Defined in:

Parameters:

#string step

Step "onafter", "onbefore", "onenter", "onleave".

#string trigger

Trigger.

#table params

Parameters.

#string EventName

Event name.

Return value:

Value.

Create transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

Delayed transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

Event map.

Defined in:

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

Check if can do an event.

Defined in:

Parameter:

#string e

Event name.

Return values:

#boolean:

If true, FSM can do the event.

#string:

To state.

Check if cannot do an event.

Defined in:

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

Check if FSM is in state.

Defined in:

Parameters:

#string State

State name.

#boolean If

true, FSM is in this state.

state

Field(s)

#boolean SPOT.Lasing

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.

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Returns the event dispatcher

Defined in:

Return value:

Remove all subscribed events

Defined in:

Return value:

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

Get the ClassName + ClassID of the class instance.

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

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

Get the Class 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