Banner Image

Module Core.Scheduler

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


Features:

  • Schedule functions over time,
  • optionally in an optional specified time interval,
  • optionally repeating with a specified time repeat interval,
  • optionally randomizing with a specified time interval randomization factor,
  • optionally stop the repeating after a specified time interval.

Demo Missions

SCHEDULER Demo Missions source code

SCHEDULER Demo Missions, only for beta testers

ALL Demo Missions pack of the last release


YouTube Channel

SCHEDULER YouTube Channel (none)


Contributions:

  • FlightControl : Concept & Testing

Authors:

  • FlightControl : Design & Programming

Global(s)

Global SCHEDULER

Creates and handles schedules over time, which allow to execute code at specific time intervals with randomization.

#SCHEDULER SCHEDULER

Creates and handles schedules over time, which allow to execute code at specific time intervals with randomization.

A SCHEDULER can manage multiple (repeating) schedules. Each planned or executing schedule has a unique ScheduleID. The ScheduleID is returned when the method SCHEDULER.Schedule() is called. It is recommended to store the ScheduleID in a variable, as it is used in the methods SCHEDULER.Start() and SCHEDULER.Stop(), which can start and stop specific repeating schedules respectively within a SCHEDULER object.

SCHEDULER constructor

The SCHEDULER class is quite easy to use, but note that the New constructor has variable parameters:

The SCHEDULER.New() method returns 2 variables:

  1. The SCHEDULER object reference.
  2. The first schedule planned in the SCHEDULER object.

To clarify the different appliances, lets have a look at the following examples:

Construct a SCHEDULER object without a persistent schedule.

  • SCHEDULER.New( nil ): Setup a new SCHEDULER object, which is persistently executed after garbage collection.

    MasterObject = SCHEDULER:New() SchedulerID = MasterObject:Schedule( nil, ScheduleFunction, {} )

The above example creates a new MasterObject, but does not schedule anything. A separate schedule is created by using the MasterObject using the method :Schedule..., which returns a ScheduleID

Construct a SCHEDULER object without a volatile schedule, but volatile to the Object existence...

  • SCHEDULER.New( Object ): Setup a new SCHEDULER object, which is linked to the Object. When the Object is nillified or destroyed, the SCHEDULER object will also be destroyed and stopped after garbage collection.

    ZoneObject = ZONE:New( "ZoneName" ) MasterObject = SCHEDULER:New( ZoneObject ) SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {} ) ... ZoneObject = nil garbagecollect()

The above example creates a new MasterObject, but does not schedule anything, and is bound to the existence of ZoneObject, which is a ZONE. A separate schedule is created by using the MasterObject using the method :Schedule()..., which returns a ScheduleID Later in the logic, the ZoneObject is put to nil, and garbage is collected. As a result, the MasterObject will cancel any planned schedule.

Construct a SCHEDULER object with a persistent schedule.

  • SCHEDULER.New( nil, Function, FunctionArguments, Start, ... ): Setup a new persistent SCHEDULER object, and start a new schedule for the Function with the defined FunctionArguments according the Start and sequent parameters.

    MasterObject, SchedulerID = SCHEDULER:New( nil, ScheduleFunction, {} )

The above example creates a new MasterObject, and does schedule the first schedule as part of the call. Note that 2 variables are returned here: MasterObject, ScheduleID...

Construct a SCHEDULER object without a schedule, but volatile to the Object existence...

  • SCHEDULER.New( Object, Function, FunctionArguments, Start, ... ): Setup a new SCHEDULER object, linked to Object, and start a new schedule for the Function with the defined FunctionArguments according the Start and sequent parameters.

    ZoneObject = ZONE:New( "ZoneName" ) MasterObject, SchedulerID = SCHEDULER:New( ZoneObject, ScheduleFunction, {} ) SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {} ) ... ZoneObject = nil garbagecollect()

The above example creates a new MasterObject, and schedules a method call (ScheduleFunction), and is bound to the existence of ZoneObject, which is a ZONE object (ZoneObject). Both a MasterObject and a SchedulerID variable are returned. Later in the logic, the ZoneObject is put to nil, and garbage is collected. As a result, the MasterObject will cancel the planned schedule.

SCHEDULER timer stopping and (re-)starting.

The SCHEDULER can be stopped and restarted with the following methods:

  • SCHEDULER.Start(): (Re-)Start the schedules within the SCHEDULER object. If a CallID is provided to :Start(), only the schedule referenced by CallID will be (re-)started.

  • SCHEDULER.Stop(): Stop the schedules within the SCHEDULER object. If a CallID is provided to :Stop(), then only the schedule referenced by CallID will be stopped.

    ZoneObject = ZONE:New( "ZoneName" ) MasterObject, SchedulerID = SCHEDULER:New( ZoneObject, ScheduleFunction, {} ) SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {}, 10, 10 ) ... MasterObject:Stop( SchedulerID ) ... MasterObject:Start( SchedulerID )

The above example creates a new MasterObject, and does schedule the first schedule as part of the call. Note that 2 variables are returned here: MasterObject, ScheduleID...
Later in the logic, the repeating schedule with SchedulerID is stopped.
A bit later, the repeating schedule with SchedulerId is (re)-started.

Create a new schedule

With the method SCHEDULER.Schedule() a new time event can be scheduled. This method is used by the :New() constructor when a new schedule is planned.

Consider the following code fragment of the SCHEDULER object creation.

ZoneObject = ZONE:New( "ZoneName" )
MasterObject = SCHEDULER:New( ZoneObject )

Several parameters can be specified that influence the behaviour of a Schedule.

A single schedule, immediately executed

SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {} )

The above example schedules a new ScheduleFunction call to be executed asynchronously, within milleseconds ...

A single schedule, planned over time

SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {}, 10 )

The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds ...

A schedule with a repeating time interval, planned over time

SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {}, 10, 60 )

The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds, and repeating 60 every seconds ...

A schedule with a repeating time interval, planned over time, with time interval randomization

SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {}, 10, 60, 0.5 )

The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds, and repeating 60 seconds, with a 50% time interval randomization ... So the repeating time interval will be randomized using the 0.5,
and will calculate between 60 - ( 60 * 0.5 ) and 60 + ( 60 * 0.5 ) for each repeat, which is in this example between 30 and 90 seconds.

A schedule with a repeating time interval, planned over time, with time interval randomization, and stop after a time interval

SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {}, 10, 60, 0.5, 300 )

The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds, The schedule will repeat every 60 seconds. So the repeating time interval will be randomized using the 0.5,
and will calculate between 60 - ( 60 * 0.5 ) and 60 + ( 60 * 0.5 ) for each repeat, which is in this example between 30 and 90 seconds. The schedule will stop after 300 seconds.

Type(s)

Fields and Methods inherited from SCHEDULER Description

SCHEDULER:Clear()

Clears all pending schedules.

SCHEDULER.MasterObject

Master object.

SCHEDULER:New(MasterObject, SchedulerFunction, SchedulerArguments, Start, Repeat, RandomizeFactor, Stop)

SCHEDULER constructor.

SCHEDULER:NoTrace()

No tracing for this scheduler.

SCHEDULER:Remove(ScheduleID)

Removes a specific schedule if a valid ScheduleID is provided.

SCHEDULER:Schedule(MasterObject, SchedulerFunction, SchedulerArguments, Start, Repeat, RandomizeFactor, Stop, TraceLevel, Fsm)

Schedule a new time event.

SCHEDULER.Schedules

Table of schedules.

SCHEDULER.ShowTrace

Trace info if true.

SCHEDULER:Start(ScheduleID)

(Re-)Starts the schedules or a specific schedule if a valid ScheduleID is provided.

SCHEDULER:Stop(ScheduleID)

Stops the schedules or a specific schedule if a valid ScheduleID is provided.

Fields and Methods inherited from BASE Description

SCHEDULER.ClassID

The ID number of the class.

SCHEDULER.ClassName

The name of the class.

SCHEDULER.ClassNameAndID

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

SCHEDULER:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

SCHEDULER:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

SCHEDULER:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

SCHEDULER:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

SCHEDULER:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

SCHEDULER:E(Arguments)

Log an exception which will be traced always.

SCHEDULER:EventDispatcher()

Returns the event dispatcher

SCHEDULER:EventRemoveAll()

Remove all subscribed events

SCHEDULER:F(Arguments)

Trace a function call.

SCHEDULER:F2(Arguments)

Trace a function call level 2.

SCHEDULER:F3(Arguments)

Trace a function call level 3.

SCHEDULER:GetClassID()

Get the ClassID of the class instance.

SCHEDULER:GetClassName()

Get the ClassName of the class instance.

SCHEDULER:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

SCHEDULER:GetEventPriority()

Get the Class Event processing Priority.

SCHEDULER:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

SCHEDULER:GetState(Object, Key)

Get a Value given a Key from the Object.

SCHEDULER:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

SCHEDULER:I(Arguments)

Log an information which will be traced always.

SCHEDULER:Inherit(Child, Parent)

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

SCHEDULER:IsInstanceOf(ClassName)

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

SCHEDULER:IsTrace()

Enquires if tracing is on (for the class).

SCHEDULER:New()

BASE constructor.

SCHEDULER:OnEvent(EventData)

Occurs when an object is completely destroyed.

SCHEDULER:OnEventBaseCaptured(EventData)

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

SCHEDULER:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

SCHEDULER:OnEventCrash(EventData)

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

SCHEDULER:OnEventDead(EventData)

Occurs when an object is dead.

SCHEDULER:OnEventDetailedFailure(EventData)

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

SCHEDULER:OnEventEjection(EventData)

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

SCHEDULER:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

SCHEDULER:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

SCHEDULER:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

SCHEDULER:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

SCHEDULER:OnEventKill(EventData)

Occurs on the death of a unit.

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

SCHEDULER:OnEventLandingAfterEjection(EventData)

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

SCHEDULER:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

SCHEDULER:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

SCHEDULER:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

SCHEDULER:OnEventMissionEnd(EventData)

Occurs when a mission ends

SCHEDULER:OnEventMissionStart(EventData)

Occurs when a mission starts

SCHEDULER:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

SCHEDULER:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

SCHEDULER:OnEventPlayerLeaveUnit(EventData)

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

SCHEDULER:OnEventRefueling(EventData)

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

SCHEDULER:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

SCHEDULER:OnEventScore(EventData)

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

SCHEDULER:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

SCHEDULER:OnEventShootingStart(EventData)

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

SCHEDULER:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

SCHEDULER:OnEventTakeoff(EventData)

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

SCHEDULER:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

SCHEDULER:ScheduleStop(SchedulerFunction)

Stops the Schedule.

SCHEDULER.Scheduler

SCHEDULER:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

SCHEDULER:SetState(Object, Key, Value)

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

SCHEDULER:T(Arguments)

Trace a function logic level 1.

SCHEDULER:T2(Arguments)

Trace a function logic level 2.

SCHEDULER:T3(Arguments)

Trace a function logic level 3.

SCHEDULER:TraceAll(TraceAll)

Trace all methods in MOOSE

SCHEDULER:TraceClass(Class)

Set tracing for a class

SCHEDULER:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

SCHEDULER:TraceLevel(Level)

Set trace level

SCHEDULER:TraceOff()

Set trace off.

SCHEDULER:TraceOn()

Set trace on.

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

SCHEDULER:UnHandleEvent(Event)

UnSubscribe to a DCS event.

SCHEDULER._

SCHEDULER:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

SCHEDULER:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

SCHEDULER.__

SCHEDULER:onEvent(event)

The SCHEDULER class

Field(s)

#table SCHEDULER.MasterObject

Master object.

#table SCHEDULER.Schedules

Table of schedules.

#boolean SCHEDULER.ShowTrace

Trace info if true.

Function(s)

Clears all pending schedules.

Defined in:

SCHEDULER

SCHEDULER constructor.

Defined in:

SCHEDULER

Parameters:

#table MasterObject

Specified for which Moose object the timer is setup. If a value of nil is provided, a scheduler will be setup without an object reference.

#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 SchedulerArguments

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

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

Return values:

self.

#table:

The ScheduleID of the planned schedule.

No tracing for this scheduler.

Defined in:

SCHEDULER

Removes a specific schedule if a valid ScheduleID is provided.

Defined in:

SCHEDULER

Parameter:

#string ScheduleID

(optional) The ScheduleID of the planned (repeating) 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:

SCHEDULER

Parameters:

#table MasterObject

Specified for which Moose object the timer is setup. If a value of nil is provided, a scheduler will be setup without an object reference.

#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 SchedulerArguments

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

#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 time 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

Time interval in seconds after which the scheduler will be stoppe.

#number TraceLevel

Trace level [0,3]. Default 3.

Finite state model.

Return value:

#table:

The ScheduleID of the planned schedule.

(Re-)Starts the schedules or a specific schedule if a valid ScheduleID is provided.

Defined in:

SCHEDULER

Parameter:

#string ScheduleID

(Optional) The ScheduleID of the planned (repeating) schedule.

Stops the schedules or a specific schedule if a valid ScheduleID is provided.

Defined in:

SCHEDULER

Parameter:

#string ScheduleID

(Optional) The ScheduleID of the planned (repeating) schedule.

Field(s)

#table SCHEDULER.MasterObject

Master object.

#table SCHEDULER.Schedules

Table of schedules.

#boolean SCHEDULER.ShowTrace

Trace info if true.

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