Module Utils

self

FIFO:Flush()

FIFO Print stacks to dcs.log

Defined in:

FIFO

Return value:

self

FIFO:GetIDStack()

FIFO Get the data stack by UniqueID

Defined in:

FIFO

Return value:

#table:

Table of #FIFO.IDEntry entries

FIFO:GetIDStackSorted()

FIFO Get table of UniqueIDs sorthed smallest to largest

Defined in:

FIFO

Return value:

#table:

Table of #FIFO.IDEntry entries

FIFO:GetPointerStack()

FIFO Get the data stack by pointer

Defined in:

FIFO

Return value:

#table:

Table of #FIFO.IDEntry entries

FIFO:GetSize()

FIFO Get stack size

Defined in:

FIFO

Return value:

#number:

size

FIFO:HasUniqueID(UniqueID)

FIFO Check if a certain UniqeID exists

Defined in:

FIFO

Parameter:

UniqueID

Return value:

#boolean:

exists

FIFO:IsEmpty()

FIFO Check Stack is empty

Defined in:

FIFO

Return value:

#boolean:

empty

FIFO:IsNotEmpty()

FIFO Check Stack is NOT empty

Defined in:

FIFO

Return value:

#boolean:

notempty

FIFO:New()

Instantiate a new FIFO Stack

Defined in:

FIFO

Return value:

self

FIFO:Pull()

FIFO Pull Object from Stack

Defined in:

FIFO

Return value:

#table:

Object or nil if stack is empty

FIFO:PullByID(UniqueID)

FIFO Pull Object from Stack by UniqueID

Defined in:

FIFO

Parameter:

UniqueID

Return value:

#table:

Object or nil if stack is empty

FIFO:PullByPointer(Pointer)

FIFO Pull Object from Stack by Pointer

Defined in:

FIFO

Parameter:

#number Pointer

Return value:

#table:

Object or nil if stack is empty

FIFO:Push(Object, UniqueID)

FIFO Push Object to Stack

Defined in:

FIFO

Parameters:

#table Object

#string UniqueID

(optional) - will default to current pointer + 1

Return value:

self

Field(s)

#string FIFO.ClassName

Name of the class.

#number FIFO.counter

#string FIFO.lid

Class id string for output to DCS log file.

#number FIFO.pointer

#table FIFO.stackbyid

#table FIFO.stackbypointer

#string FIFO.version

Version of FiFo

Function(s)

FIFO:ClearState(Object, StateName)

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.

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

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

FIFO:CreateEventCrash(EventTime, Initiator)

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.

FIFO:CreateEventDead(EventTime, Initiator)

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.

FIFO:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Defined in:

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The aircraft unit the player entered.

FIFO:CreateEventRemoveUnit(EventTime, Initiator)

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.

FIFO:CreateEventTakeoff(EventTime, Initiator)

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.

FIFO:E(Arguments)

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

FIFO:EventDispatcher()

Returns the event dispatcher

Defined in:

Return value:

Core.Event#EVENT:

FIFO:EventRemoveAll()

Remove all subscribed events

Defined in:

Return value:

FIFO:F(Arguments)

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

FIFO:F2(Arguments)

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

FIFO:F3(Arguments)

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

FIFO:GetClassID()

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

FIFO:GetClassName()

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

FIFO:GetClassNameAndID()

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.

FIFO:GetEventPriority()

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.

FIFO:GetParent(Child, FromClass)

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:

FIFO:GetState(Object, Key)

Get a Value given a Key from the Object.

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

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

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

Return value:

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

FIFO:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

Defined in:

Parameters:

Core.Event#EVENTS EventID

Event ID.

#function EventFunction

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

Return value:

FIFO:I(Arguments)

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

FIFO:Inherit(Child, Parent)

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

FIFO:IsInstanceOf(ClassName)

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:

FIFO:IsTrace()

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

FIFO:New()

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:

FIFO:OnEvent(EventData)

Occurs when an object is completely destroyed.

initiator : The unit that is was destroyed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventBDA(EventData)

BDA.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventBaseCaptured(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

initiator : The unit that was spawned.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventCrash(EventData)

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

initiator : The unit that has crashed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventDead(EventData)

Occurs when an object is dead.

initiator : The unit that is dead.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventDetailedFailure(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventEjection(EventData)

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

initiator : The unit that is stopping its engines..

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

initiator : The unit that is starting its engines..

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventHit(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

initiator : The unit that had the failure.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventKill(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO: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. Can be an Airbase Object, FARP, or Ships.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventLandingAfterEjection(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventLandingQualityMark(EventData)

Landing quality mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventMissionEnd(EventData)

Occurs when a mission ends.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventMissionStart(EventData)

Occurs when a mission starts.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventParatrooperLanding(EventData)

Weapon add.

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventPilotDead(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventPlayerEnterAircraft(EventData)

Occurs when a player enters a slot and takes control of an aircraft.

NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. initiator : The unit that is being taken control of.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

initiator : The unit that is being taken control of.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventPlayerLeaveUnit(EventData)

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

initiator : The unit that the player left.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventRefueling(EventData)

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

initiator : The unit that is receiving fuel.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

initiator : The unit that was receiving fuel.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventScore(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventShootingEnd(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventShootingStart(EventData)

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventTakeoff(EventData)

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventTriggerZone(EventData)

Trigger zone.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

FIFO:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

initiator: The unit that is was destroyed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

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

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.

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

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.

FIFO:ScheduleStop(SchedulerFunction)

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.

FIFO:SetEventPriority(EventPriority)

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

FIFO:SetState(Object, Key, Value)

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

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

Defined in:

Parameters:

Object

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

Key

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

Value

The value to is stored in the object.

Return value:

The Value set.

FIFO:T(Arguments)

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

FIFO:T2(Arguments)

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

FIFO:T3(Arguments)

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

FIFO:TraceAll(TraceAll)

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

FIFO:TraceClass(Class)

Set tracing for a class

Defined in:

Parameter:

#string Class

FIFO:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

#string Method

FIFO:TraceLevel(Level)

Set trace level

Defined in:

Parameter:

#number Level

FIFO:TraceOff()

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

FIFO:TraceOn()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

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

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 )

FIFO:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS EventID

Event ID.

Return value:

FIFO:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

FIFO:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

FIFO:onEvent(event)

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

Type FIFO.IDEntry

Field(s)

#table FIFO.IDEntry.data

#number FIFO.IDEntry.pointer

#table FIFO.IDEntry.uniqueID

Function(s)

Type FLARECOLOR

Field(s)

Function(s)

Type LIFO

LIFO class.

Field(s)

#string LIFO.ClassName

Name of the class.

#number LIFO.counter

#string LIFO.lid

Class id string for output to DCS log file.

#number LIFO.pointer

#table LIFO.stackbyid

#table LIFO.stackbypointer

#string LIFO.version

Version of LiFo

Function(s)

LIFO:Flatten()

LIFO Housekeeping

Defined in:

LIFO

Return value:

self

LIFO:Flush()

LIFO Print stacks to dcs.log

Defined in:

LIFO

Return value:

self

LIFO:GetIDStack()

LIFO Get the data stack by UniqueID

Defined in:

LIFO

Return value:

#table:

Table of #LIFO.IDEntry entries

LIFO:GetIDStackSorted()

LIFO Get table of UniqueIDs sorthed smallest to largest

Defined in:

LIFO

Return value:

#table:

Table of #LIFO.IDEntry entries

LIFO:GetPointerStack()

LIFO Get the data stack by pointer

Defined in:

LIFO

Return value:

#table:

Table of #LIFO.IDEntry entries

LIFO:GetSize()

LIFO Get stack size

Defined in:

LIFO

Return value:

#number:

size

LIFO:HasUniqueID(UniqueID)

LIFO Check if a certain UniqeID exists

Defined in:

LIFO

Parameter:

UniqueID

Return value:

#boolean:

exists

LIFO:IsEmpty()

LIFO Check Stack is empty

Defined in:

LIFO

Return value:

#boolean:

empty

LIFO:IsNotEmpty()

LIFO Check Stack is NOT empty

Defined in:

LIFO

Return value:

#boolean:

notempty

LIFO:New()

Instantiate a new LIFO Stack

Defined in:

LIFO

Return value:

self

LIFO:Pull()

LIFO Pull Object from Stack

Defined in:

LIFO

Return value:

#table:

Object or nil if stack is empty

LIFO:PullByID(UniqueID)

LIFO Pull Object from Stack by UniqueID

Defined in:

LIFO

Parameter:

UniqueID

Return value:

#table:

Object or nil if stack is empty

LIFO:PullByPointer(Pointer)

LIFO Pull Object from Stack by Pointer

Defined in:

LIFO

Parameter:

#number Pointer

Return value:

#table:

Object or nil if stack is empty

LIFO:Push(Object, UniqueID)

LIFO Push Object to Stack

Defined in:

LIFO

Parameters:

#table Object

#string UniqueID

(optional) - will default to current pointer + 1

Return value:

self

Field(s)

#string LIFO.ClassName

Name of the class.

#number LIFO.counter

#string LIFO.lid

Class id string for output to DCS log file.

#number LIFO.pointer

#table LIFO.stackbyid

#table LIFO.stackbypointer

#string LIFO.version

Version of LiFo

Function(s)

LIFO:ClearState(Object, StateName)

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.

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

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

LIFO:CreateEventCrash(EventTime, Initiator)

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.

LIFO:CreateEventDead(EventTime, Initiator)

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.

LIFO:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Defined in:

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The aircraft unit the player entered.

LIFO:CreateEventRemoveUnit(EventTime, Initiator)

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.

LIFO:CreateEventTakeoff(EventTime, Initiator)

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.

LIFO:E(Arguments)

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

LIFO:EventDispatcher()

Returns the event dispatcher

Defined in:

Return value:

Core.Event#EVENT:

LIFO:EventRemoveAll()

Remove all subscribed events

Defined in:

Return value:

LIFO:F(Arguments)

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

LIFO:F2(Arguments)

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

LIFO:F3(Arguments)

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

LIFO:GetClassID()

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

LIFO:GetClassName()

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

LIFO:GetClassNameAndID()

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.

LIFO:GetEventPriority()

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.

LIFO:GetParent(Child, FromClass)

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:

LIFO:GetState(Object, Key)

Get a Value given a Key from the Object.

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

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

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

Return value:

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

LIFO:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

Defined in:

Parameters:

Core.Event#EVENTS EventID

Event ID.

#function EventFunction

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

Return value:

LIFO:I(Arguments)

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

LIFO:Inherit(Child, Parent)

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

LIFO:IsInstanceOf(ClassName)

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:

LIFO:IsTrace()

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

LIFO:New()

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:

LIFO:OnEvent(EventData)

Occurs when an object is completely destroyed.

initiator : The unit that is was destroyed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventBDA(EventData)

BDA.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventBaseCaptured(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

initiator : The unit that was spawned.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventCrash(EventData)

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

initiator : The unit that has crashed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventDead(EventData)

Occurs when an object is dead.

initiator : The unit that is dead.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventDetailedFailure(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventEjection(EventData)

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

initiator : The unit that is stopping its engines..

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

initiator : The unit that is starting its engines..

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventHit(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

initiator : The unit that had the failure.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventKill(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO: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. Can be an Airbase Object, FARP, or Ships.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventLandingAfterEjection(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventLandingQualityMark(EventData)

Landing quality mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventMissionEnd(EventData)

Occurs when a mission ends.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventMissionStart(EventData)

Occurs when a mission starts.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventParatrooperLanding(EventData)

Weapon add.

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventPilotDead(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventPlayerEnterAircraft(EventData)

Occurs when a player enters a slot and takes control of an aircraft.

NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. initiator : The unit that is being taken control of.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

initiator : The unit that is being taken control of.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventPlayerLeaveUnit(EventData)

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

initiator : The unit that the player left.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventRefueling(EventData)

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

initiator : The unit that is receiving fuel.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

initiator : The unit that was receiving fuel.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventScore(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventShootingEnd(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventShootingStart(EventData)

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventTakeoff(EventData)

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventTriggerZone(EventData)

Trigger zone.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

LIFO:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

initiator: The unit that is was destroyed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

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

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.

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

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.

LIFO:ScheduleStop(SchedulerFunction)

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.

LIFO:SetEventPriority(EventPriority)

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

LIFO:SetState(Object, Key, Value)

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

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

Defined in:

Parameters:

Object

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

Key

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

Value

The value to is stored in the object.

Return value:

The Value set.

LIFO:T(Arguments)

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

LIFO:T2(Arguments)

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

LIFO:T3(Arguments)

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

LIFO:TraceAll(TraceAll)

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

LIFO:TraceClass(Class)

Set tracing for a class

Defined in:

Parameter:

#string Class

LIFO:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

#string Method

LIFO:TraceLevel(Level)

Set trace level

Defined in:

Parameter:

#number Level

LIFO:TraceOff()

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

LIFO:TraceOn()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

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

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 )

LIFO:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS EventID

Event ID.

Return value:

LIFO:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

LIFO:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

LIFO:onEvent(event)

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

Type LIFO.IDEntry

Field(s)

#table LIFO.IDEntry.data

#number LIFO.IDEntry.pointer

#table LIFO.IDEntry.uniqueID

Function(s)

Type SMOKECOLOR

Field(s)

Function(s)

Type UTILS

Utilities static class.

Field(s)

#number UTILS._MarkID

Marker index counter. Running number when marker is added.

Function(s)

UTILS.BasicSerialize(s)

porting in Slmod's "safestring" basic serialize

Defined in:

UTILS

Parameter:

UTILS.BearingToCardinal(Heading)

Heading Degrees (0-360) to Cardinal

Defined in:

UTILS

Parameter:

#number Heading

The heading

Return value:

#string:

Cardinal, e.g. "NORTH"

UTILS.BeaufortScale(speed)

Beaufort scale: returns Beaufort number and wind description as a function of wind speed in m/s.

Defined in:

UTILS

Parameter:

#number speed

Wind speed in m/s.

Return values:

#number:

Beaufort number.

#string:

Beauford wind description.

UTILS.CelsiusToFahrenheit(Celcius)

Convert temperature from Celsius to Fahrenheit.

Defined in:

UTILS

Parameter:

#number Celcius

Temperature in degrees Celsius.

Return value:

#number:

Temperature in degrees Fahrenheit.

UTILS.CheckFileExists(Path, Filename)

Function to check if a file exists.

Defined in:

UTILS

Parameters:

#string Path

The path to use. Use double backslashes \\ on Windows filesystems.

#string Filename

The name of the file.

Return value:

#boolean:

outcome True if reading is possible, else false.

UTILS.CheckMemory(output)

Checks the current memory usage collectgarbage("count").

Info is printed to the DCS log file. Time stamp is the current mission runtime.

Defined in:

UTILS

Parameter:

#boolean output

If true, print to DCS log file.

Return value:

#number:

Memory usage in kByte.

UTILS.ClockToSeconds(clock)

Convert clock time from hours, minutes and seconds to seconds.

Defined in:

UTILS

Parameter:

#string clock

String of clock time. E.g., "06:12:35" or "5:1:30+1". Format is (H)H:(M)M:((S)S)(+D) H=Hours, M=Minutes, S=Seconds, D=Days.

Return value:

#number:

Seconds. Corresponds to what you cet from timer.getAbsTime() function.

UTILS.DeepCopy(object)

Deep copy a table.

See http://lua-users.org/wiki/CopyTable

Defined in:

UTILS

Parameter:

#table object

The input table.

Return value:

#table:

Copy of the input table.

UTILS.DisplayMissionTime(duration)

Display clock and mission time on screen as a message to all.

Defined in:

UTILS

Parameter:

#number duration

Duration in seconds how long the time is displayed. Default is 5 seconds.

UTILS.DoString(s)

porting in Slmod's dostring

Defined in:

UTILS

Parameter:

UTILS.FeetToMeters(feet)

Defined in:

UTILS

Parameter:

feet

UTILS.FileExists(file)

Checks if a file exists or not.

This requires io to be desanitized.

Defined in:

UTILS

Parameter:

#string file

File that should be checked.

Return value:

#boolean:

True if the file exists, false if the file does not exist or nil if the io module is not available and the check could not be performed.

UTILS.GMTToLocalTimeDifference()

Get the time difference between GMT and local time.

Defined in:

UTILS

Return value:

#number:

Local time difference in hours compared to GMT. E.g. Dubai is GMT+4 ==> +4 is returned.

UTILS.GenerateFMFrequencies()

Function to generate valid FM frequencies in mHz for radio beacons (FM).

Defined in:

UTILS

Return value:

#table:

Table of frequencies.

UTILS.GenerateLaserCodes()

Function to generate valid laser codes for JTAC.

Defined in:

UTILS

Return value:

#table:

Laser Codes.

UTILS.GenerateUHFrequencies()

Function to generate valid UHF Frequencies in mHz (AM).

Defined in:

UTILS

Return value:

#table:

UHF Frequencies

UTILS.GenerateVHFrequencies()

Function to generate valid VHF frequencies in kHz for radio beacons (FM).

Defined in:

UTILS

Return value:

#table:

VHFrequencies

UTILS.GetCallsignName(Callsign)

Get the callsign name from its enumerator value

Defined in:

UTILS

Parameter:

#number Callsign

The enumerator callsign.

Return value:

#string:

The callsign name or "Ghostrider".

UTILS.GetCharacters(str)

Get a table of all characters in a string.

Defined in:

UTILS

Parameter:

#string str

Sting.

Return value:

#table:

Individual characters.

UTILS.GetCoalitionName(Coalition)

Get the coalition name from its numerical ID, e.g.

coaliton.side.RED.

Defined in:

UTILS

Parameter:

#number Coalition

The coalition ID.

Return value:

#string:

The coalition name, i.e. "Neutral", "Red" or "Blue" (or "Unknown").

UTILS.GetDCSMap()

Returns the DCS map/theatre as optained by env.mission.theatre

Defined in:

UTILS

Return value:

#string:

DCS map name.

UTILS.GetDCSMissionDate()

Returns the mission date.

This is the date the mission started.

Defined in:

UTILS

Return values:

#string:

Mission date in yyyy/mm/dd format.

#number:

The year anno domini.

#number:

The month.

#number:

The day.

UTILS.GetDayOfYear(Year, Month, Day)

Get the day of the year.

Counting starts on 1st of January.

Defined in:

UTILS

Parameters:

#number Year

The year.

#number Month

The month.

#number Day

The day.

Return value:

#number:

The day of the year.

UTILS.GetMagneticDeclination(map)

Returns the magnetic declination of the map.

Returned values for the current maps are:

Caucasus +6 (East), year ~ 2011
NTTR +12 (East), year ~ 2011
Normandy -10 (West), year ~ 1944
Persian Gulf +2 (East), year ~ 2011
The Cannel Map -10 (West)
Syria +5 (East)
Mariana Islands +2 (East)

Defined in:

UTILS

Parameter:

#string map

(Optional) Map for which the declination is returned. Default is from env.mission.theatre

Return value:

#number:

Declination in degrees.

UTILS.GetMarkID()

get a new mark ID for markings

Defined in:

UTILS

UTILS.GetMissionDay(Time)

Returns the day of the mission.

Defined in:

UTILS

Parameter:

#number Time

(Optional) Abs. time in seconds. Default now, i.e. the value return from timer.getAbsTime().

Return value:

#number:

Day of the mission. Mission starts on day 0.

UTILS.GetMissionDayOfYear(Time)

Returns the current day of the year of the mission.

Defined in:

UTILS

Parameter:

#number Time

(Optional) Abs. time in seconds. Default now, i.e. the value return from timer.getAbsTime().

Return value:

#number:

Current day of year of the mission. For example, January 1st returns 0, January 2nd returns 1 etc.

UTILS.GetModulationName(Modulation)

Get the modulation name from its numerical value.

Defined in:

UTILS

Parameter:

#number Modulation

The modulation enumerator number. Can be either 0 or 1.

Return value:

#string:

The modulation name, i.e. "AM"=0 or "FM"=1. Anything else will return "Unknown".

UTILS.GetOSTime()

Get OS time.

Needs os to be desanitized!

Defined in:

UTILS

Return value:

#number:

Os time in seconds.

UTILS.GetRandomTableElement(t, replace)

Get a random element of a table.

Defined in:

UTILS

Parameters:

#table t

Table.

#boolean replace

If true, the drawn element is replaced, i.e. not deleted.

Return value:

#number:

Table element.

UTILS.GetSunRiseAndSet(DayOfYear, Latitude, Longitude, Rising, Tlocal)

Get sunrise or sun set of a specific day of the year at a specific location.

Defined in:

UTILS

Parameters:

#number DayOfYear

The day of the year.

#number Latitude

Latitude.

#number Longitude

Longitude.

#boolean Rising

If true, calc sun rise, or sun set otherwise.

#number Tlocal

Local time offset in hours. E.g. +4 for a location which has GMT+4.

Return value:

#number:

Sun rise/set in seconds of the day.

UTILS.GetSunrise(Day, Month, Year, Latitude, Longitude, Rising, Tlocal)

Get sun rise of a specific day of the year at a specific location.

Defined in:

UTILS

Parameters:

#number Day

Day of the year.

#number Month

Month of the year.

#number Year

Year.

#number Latitude

Latitude.

#number Longitude

Longitude.

#boolean Rising

If true, calc sun rise, or sun set otherwise.

#number Tlocal

Local time offset in hours. E.g. +4 for a location which has GMT+4. Default 0.

Return value:

#number:

Sun rise in seconds of the day.

UTILS.GetSunset(Day, Month, Year, Latitude, Longitude, Rising, Tlocal)

Get sun set of a specific day of the year at a specific location.

Defined in:

UTILS

Parameters:

#number Day

Day of the year.

#number Month

Month of the year.

#number Year

Year.

#number Latitude

Latitude.

#number Longitude

Longitude.

#boolean Rising

If true, calc sun rise, or sun set otherwise.

#number Tlocal

Local time offset in hours. E.g. +4 for a location which has GMT+4. Default 0.

Return value:

#number:

Sun rise in seconds of the day.

UTILS.HdgDiff(h1, h2)

Calculate the difference between two "heading", i.e.

angles in [0,360) deg.

Defined in:

UTILS

Parameters:

#number h1

Heading one.

#number h2

Heading two.

Return value:

#number:

Heading difference in degrees.

UTILS.IsInRadius(InVec2, Vec2, Radius)

Test if a Vec2 is in a radius of another Vec2

Defined in:

UTILS

Parameters:

InVec2

Vec2

Radius

UTILS.IsInSphere(InVec3, Vec3, Radius)

Test if a Vec3 is in the sphere of another Vec3

Defined in:

UTILS

Parameters:

InVec3

Vec3

Radius

UTILS.IsInstanceOf(object, className)

Function to infer instance of an object

Examples:

UTILS.IsInstanceOf( 'some text', 'string' ) will return true
UTILS.IsInstanceOf( some_function, 'function' ) will return true
UTILS.IsInstanceOf( 10, 'number' ) will return true
UTILS.IsInstanceOf( false, 'boolean' ) will return true
UTILS.IsInstanceOf( nil, 'nil' ) will return true
UTILS.IsInstanceOf( ZONE:New( 'some zone', ZONE ) will return true
UTILS.IsInstanceOf( ZONE:New( 'some zone', 'ZONE' ) will return true
UTILS.IsInstanceOf( ZONE:New( 'some zone', 'zone' ) will return true
UTILS.IsInstanceOf( ZONE:New( 'some zone', 'BASE' ) will return true
UTILS.IsInstanceOf( ZONE:New( 'some zone', 'GROUP' ) will return false

Defined in:

UTILS

Parameters:

object

is the object to be evaluated

className

is the name of the class to evaluate (can be either a string or a Moose class)

Return value:

#boolean:

UTILS.IsLoadingDoorOpen(unit_name)

(Helicopter) Check if one loading door is open.

Defined in:

UTILS

Parameter:

#string unit_name

Unit name to be checked

Return value:

#boolean:

Outcome - true if a (loading door) is open, false if not, nil if none exists.

UTILS.KiloMetersToFeet(kilometers)

Defined in:

UTILS

Parameter:

kilometers

UTILS.KiloMetersToNM(kilometers)

Defined in:

UTILS

Parameter:

kilometers

UTILS.KiloMetersToSM(kilometers)

Defined in:

UTILS

Parameter:

kilometers

UTILS.KmphToKnots(knots)

Defined in:

UTILS

Parameter:

knots

UTILS.KmphToMps(kmph)

Defined in:

UTILS

Parameter:

kmph

UTILS.KnotsToAltKIAS(knots, altitude)

Convert knots to alitude corrected KIAS, e.g.

for tankers.

Defined in:

UTILS

Parameters:

#number knots

Speed in knots.

#number altitude

Altitude in feet

Return value:

#number:

Corrected KIAS

UTILS.KnotsToKmph(knots)

Defined in:

UTILS

Parameter:

knots

UTILS.KnotsToMps(knots)

Convert knots to meters per second.

Defined in:

UTILS

Parameter:

#number knots

Speed in knots.

Return value:

#number:

Speed in m/s.

UTILS.LoadFromFile(Path, Filename)

Function to save an object to a file

Defined in:

UTILS

Parameters:

#string Path

The path to use. Use double backslashes \\ on Windows filesystems.

#string Filename

The name of the file.

Return values:

#boolean:

outcome True if reading is possible and successful, else false.

#table:

data The data read from the filesystem (table of lines of text). Each line is one single #string!

UTILS.LoadSetOfGroups(Path, Filename, Spawn)

Load back a SET of groups from file.

Defined in:

UTILS

Parameters:

#string Path

The path to use. Use double backslashes \\ on Windows filesystems.

#string Filename

The name of the file.

#boolean Spawn

If set to false, do not re-spawn the groups loaded in location and reduce to size.

Return value:

Core.Set#SET_GROUP:

Set of GROUP objects. Returns nil when file cannot be read. Returns a table of data entries if Spawn is false: { groupname=groupname, size=size, coordinate=coordinate }

UTILS.LoadSetOfStatics(Path, Filename)

Load back a SET of statics from file.

Defined in:

UTILS

Parameters:

#string Path

The path to use. Use double backslashes \\ on Windows filesystems.

#string Filename

The name of the file.

Return value:

Core.Set#SET_STATIC:

Set SET_STATIC containing the static objects.

UTILS.LoadStationaryListOfGroups(Path, Filename, Reduce)

Load back a stationary list of groups from file.

Defined in:

UTILS

Parameters:

#string Path

The path to use. Use double backslashes \\ on Windows filesystems.

#string Filename

The name of the file.

#boolean Reduce

If false, existing loaded groups will not be reduced to fit the saved number.

Return value:

#table:

Table of data objects (tables) containing groupname, coordinate and group object. Returns nil when file cannot be read.

UTILS.LoadStationaryListOfStatics(Path, Filename, Reduce)

Load back a stationary list of statics from file.

Defined in:

UTILS

Parameters:

#string Path

The path to use. Use double backslashes \\ on Windows filesystems.

#string Filename

The name of the file.

#boolean Reduce

If false, do not destroy the units with size=0.

Return value:

#table:

Table of data objects (tables) containing staticname, size (0=dead else 1), coordinate and the static object. Returns nil when file cannot be read.

UTILS.MetersToFeet(meters)

Defined in:

UTILS

Parameter:

meters

UTILS.MetersToNM(meters)

Defined in:

UTILS

Parameter:

meters

UTILS.MetersToSM(meters)

Defined in:

UTILS

Parameter:

meters

UTILS.MiphToMps(miph)

Defined in:

UTILS

Parameter:

miph

UTILS.MpsToKmph(mps)

Defined in:

UTILS

Parameter:

mps

UTILS.MpsToKnots(mps)

Convert meters per second to knots.

Defined in:

UTILS

Parameter:

#number mps

Speed in m/s.

Return value:

#number:

Speed in knots.

UTILS.MpsToMiph(mps)

Convert meters per second to miles per hour.

Defined in:

UTILS

Parameter:

#number mps

Speed in m/s.

Return value:

#number:

Speed in miles per hour.

UTILS.NMToKiloMeters(NM)

Defined in:

UTILS

Parameter:

UTILS.NMToMeters(NM)

Defined in:

UTILS

Parameter:

UTILS.OneLineSerialize(tbl)

Porting in Slmod's serialize_slmod2.

Defined in:

UTILS

Parameter:

#table tbl

Input table.

UTILS.RandomGaussian(x0, sigma, xmin, xmax, imax)

Generate a Gaussian pseudo-random number.

Defined in:

UTILS

Parameters:

#number x0

Expectation value of distribution.

#number sigma

(Optional) Standard deviation. Default 10.

#number xmin

(Optional) Lower cut-off value.

#number xmax

(Optional) Upper cut-off value.

#number imax

(Optional) Max number of tries to get a value between xmin and xmax (if specified). Default 100.

Return value:

#number:

Gaussian random number.

UTILS.Randomize(value, fac, lower, upper)

Randomize a value by a certain amount.

Defined in:

UTILS

Parameters:

#number value

The value which should be randomized

#number fac

Randomization factor.

#number lower

(Optional) Lower limit of the returned value.

#number upper

(Optional) Upper limit of the returned value.

Return value:

#number:

Randomized value.

Usages:

UTILS.Randomize(100, 0.1) returns a value between 90 and 110, i.e. a plus/minus ten percent variation.

UTILS.Randomize(100, 0.5, nil, 120) returns a value between 50 and 120, i.e. a plus/minus fivty percent variation with upper bound 120.

UTILS.RemoveMark(MarkID, Delay)

Remove an object (marker, circle, arrow, text, quad, ...) on the F10 map.

Defined in:

UTILS

Parameters:

#number MarkID

Unique ID of the object.

#number Delay

(Optional) Delay in seconds before the mark is removed.

UTILS.ReplaceIllegalCharacters(Text, ReplaceBy)

Replace illegal characters [<>|/?*:\] in a string.

Defined in:

UTILS

Parameters:

#string Text

Input text.

#string ReplaceBy

Replace illegal characters by this character or string. Default underscore "_".

Return value:

#string:

The input text with illegal chars replaced.

UTILS.Rotate2D(a, angle)

Rotate 3D vector in the 2D (x,z) plane.

y-component (usually altitude) unchanged.

Defined in:

UTILS

Parameters:

Vector in 3D with x, y, z components.

#number angle

Rotation angle in degrees.

Return value:

Vector rotated in the (x,z) plane.

UTILS.Round(num, idp)

From http://lua-users.org/wiki/SimpleRound use negative idp for rounding ahead of decimal place, positive for rounding after decimal place

Defined in:

UTILS

Parameters:

num

idp

UTILS.SaveSetOfGroups(Set, Path, Filename)

Function to save the state of a set of Wrapper.Group#GROUP objects.

Defined in:

UTILS

Parameters:

Core.Set#SET_BASE Set

of objects to save

#string Path

The path to use. Use double backslashes \\ on Windows filesystems.

#string Filename

The name of the file.

Return value:

#boolean:

outcome True if saving is successful, else false.

Usage:

We will go through the set and find the corresponding group and save the current group size and current position.
The idea is to respawn the groups **spawned during an earlier run of the mission** at the given location and reduce 
the number of units in the group when reloading the data again to restart the saved mission. Note that *dead* groups 
cannot be covered with this.
**Note** Do NOT use dashes or hashes in group template names (-,#)!
The data will be a simple comma separated list of groupname and size, with one header line.
The current task/waypoint/etc cannot be restored.

UTILS.SaveSetOfStatics(Set, Path, Filename)

Function to save the state of a set of Wrapper.Static#STATIC objects.

Defined in:

UTILS

Parameters:

Core.Set#SET_BASE Set

of objects to save

#string Path

The path to use. Use double backslashes \\ on Windows filesystems.

#string Filename

The name of the file.

Return value:

#boolean:

outcome True if saving is successful, else false.

Usage:

We will go through the set and find the corresponding static and save the current name and postion when alive.
The data will be a simple comma separated list of name and state etc, with one header line.

UTILS.SaveStationaryListOfGroups(List, Path, Filename)

Function to save the state of a list of groups found by name

Defined in:

UTILS

Parameters:

#table List

Table of strings with groupnames

#string Path

The path to use. Use double backslashes \\ on Windows filesystems.

#string Filename

The name of the file.

Return value:

#boolean:

outcome True if saving is successful, else false.

Usage:

We will go through the list and find the corresponding group and save the current group size (0 when dead).
These groups are supposed to be put on the map in the ME and have *not* moved (e.g. stationary SAM sites). 
Position is still saved for your usage.
The idea is to reduce the number of units when reloading the data again to restart the saved mission.
The data will be a simple comma separated list of groupname and size, with one header line.

UTILS.SaveStationaryListOfStatics(List, Path, Filename)

Function to save the state of a list of statics found by name

Defined in:

UTILS

Parameters:

#table List

Table of strings with statics names

#string Path

The path to use. Use double backslashes \\ on Windows filesystems.

#string Filename

The name of the file.

Return value:

#boolean:

outcome True if saving is successful, else false.

Usage:

We will go through the list and find the corresponding static and save the current alive state as 1 (0 when dead).
Position is saved for your usage. **Note** this works on UNIT-name level.
The idea is to reduce the number of units when reloading the data again to restart the saved mission.
The data will be a simple comma separated list of name and state etc, with one header line.

UTILS.SaveToFile(Path, Filename, Data)

Function to save an object to a file

Defined in:

UTILS

Parameters:

#string Path

The path to use. Use double backslashes \\ on Windows filesystems.

#string Filename

The name of the file. Existing file will be overwritten.

#table Data

The LUA data structure to save. This will be e.g. a table of text lines with an \n at the end of each line.

Return value:

#boolean:

outcome True if saving is possible, else false.

UTILS.SecondsOfToday()

Seconds of today.

Defined in:

UTILS

Return value:

#number:

Seconds passed since last midnight.

UTILS.SecondsToClock(seconds, short)

Convert time in seconds to hours, minutes and seconds.

Defined in:

UTILS

Parameters:

#number seconds

Time in seconds, e.g. from timer.getAbsTime() function.

#boolean short

(Optional) If true, use short output, i.e. (HH:)MM:SS without day.

Return value:

#string:

Time in format Hours:Minutes:Seconds+Days (HH:MM:SS+D).

UTILS.SecondsToMidnight()

Cound seconds until next midnight.

Defined in:

UTILS

Return value:

#number:

Seconds to midnight.

UTILS.ShuffleTable(t)

Shuffle a table accoring to Fisher Yeates algorithm

Defined in:

UTILS

Parameter:

#table t

Table to be shuffled.

Return value:

#table:

Shuffled table.

UTILS.Split(str, sep)

Split string at seperators.

C.f. http://stackoverflow.com/questions/1426954/split-string-in-lua

Defined in:

UTILS

Parameters:

#string str

Sting to split.

#string sep

Speparator for split.

Return value:

#table:

Split text.

UTILS.TACANToFrequency(TACANChannel, TACANMode)

Converts a TACAN Channel/Mode couple into a frequency in Hz.

Defined in:

UTILS

Parameters:

#number TACANChannel

The TACAN channel, i.e. the 10 in "10X".

#string TACANMode

The TACAN mode, i.e. the "X" in "10X".

Return value:

#number:

Frequency in Hz or #nil if parameters are invalid.

UTILS.ToDegree(angle)

Defined in:

UTILS

Parameter:

angle

UTILS.ToRadian(angle)

Defined in:

UTILS

Parameter:

angle

UTILS.ToStringBRAANATO(FromGrp, ToGrp)

Create a BRAA NATO call string BRAA between two GROUP objects

Defined in:

UTILS

Parameters:

Wrapper.Group#GROUP FromGrp

GROUP object

Wrapper.Group#GROUP ToGrp

GROUP object

Return value:

#string:

Formatted BRAA NATO call

UTILS.Vec2Add(a, b)

Calculate the total vector of two 2D vectors by adding the x,y components of each other.

Defined in:

UTILS

Parameters:

Vector in 2D with x, y components.

Vector in 2D with x, y components.

Return value:

Vector c=a+b with c(i)=a(i)+b(i), i=x,y.

UTILS.Vec2Dot(a, b)

Calculate the dot product of two 2D vectors.

The result is a number.

Defined in:

UTILS

Parameters:

Vector in 2D with x, y components.

Vector in 2D with x, y components.

Return value:

#number:

Scalar product of the two vectors a*b.

UTILS.Vec2Hdg(a)

Calculate "heading" of a 2D vector in the X-Y plane.

Defined in:

UTILS

Parameter:

Vector in "D with x, y components.

Return value:

#number:

Heading in degrees in [0,360).

UTILS.Vec2Norm(a)

Calculate the euclidean norm (length) of a 2D vector.

Defined in:

UTILS

Parameter:

Vector in 2D with x, y components.

Return value:

#number:

Norm of the vector.

UTILS.Vec2Rotate2D(a, angle)

Rotate 2D vector in the 2D (x,z) plane.

Defined in:

UTILS

Parameters:

Vector in 2D with x, y components.

#number angle

Rotation angle in degrees.

Return value:

Vector rotated in the (x,y) plane.

UTILS.Vec2Substract(a, b)

Calculate the difference between two 2D vectors by substracting the x,y components from each other.

Defined in:

UTILS

Parameters:

Vector in 2D with x, y components.

Vector in 2D with x, y components.

Return value:

Vector c=a-b with c(i)=a(i)-b(i), i=x,y.

UTILS.Vec2Translate(a, distance, angle)

Translate 2D vector in the 2D (x,z) plane.

Defined in:

UTILS

Parameters:

Vector in 2D with x, y components.

#number distance

The distance to translate.

#number angle

Rotation angle in degrees.

Return value:

Translated vector.

UTILS.VecAdd(a, b)

Calculate the total vector of two 3D vectors by adding the x,y,z components of each other.

Defined in:

UTILS

Parameters:

Vector in 3D with x, y, z components.

Vector in 3D with x, y, z components.

Return value:

Vector c=a+b with c(i)=a(i)+b(i), i=x,y,z.

UTILS.VecAngle(a, b)

Calculate the angle between two 3D vectors.

Defined in:

UTILS

Parameters:

Vector in 3D with x, y, z components.

Vector in 3D with x, y, z components.

Return value:

#number:

Angle alpha between and b in degrees. alpha=acos(ab)/(|a||b|), ( denotes the dot product).

UTILS.VecCross(a, b)

Calculate the cross product of two 3D vectors.

The result is a 3D vector.

Defined in:

UTILS

Parameters:

Vector in 3D with x, y, z components.

Vector in 3D with x, y, z components.

Return value:

Vector

UTILS.VecDist2D(a, b)

Calculate the distance between two 2D vectors.

Defined in:

UTILS

Parameters:

Vector in 3D with x, y components.

Vector in 3D with x, y components.

Return value:

#number:

Distance between the vectors.

UTILS.VecDist3D(a, b)

Calculate the distance between two 3D vectors.

Defined in:

UTILS

Parameters:

Vector in 3D with x, y, z components.

Vector in 3D with x, y, z components.

Return value:

#number:

Distance between the vectors.

UTILS.VecDot(a, b)

Calculate the dot product of two vectors.

The result is a number.

Defined in:

UTILS

Parameters:

Vector in 3D with x, y, z components.

Vector in 3D with x, y, z components.

Return value:

#number:

Scalar product of the two vectors a*b.

UTILS.VecHdg(a)

Calculate "heading" of a 3D vector in the X-Z plane.

Defined in:

UTILS

Parameter:

Vector in 3D with x, y, z components.

Return value:

#number:

Heading in degrees in [0,360).

UTILS.VecNorm(a)

Calculate the euclidean norm (length) of a 3D vector.

Defined in:

UTILS

Parameter:

Vector in 3D with x, y, z components.

Return value:

#number:

Norm of the vector.

UTILS.VecSubstract(a, b)

Calculate the difference between two 3D vectors by substracting the x,y,z components from each other.

Defined in:

UTILS

Parameters:

Vector in 3D with x, y, z components.

Vector in 3D with x, y, z components.

Return value:

Vector c=a-b with c(i)=a(i)-b(i), i=x,y,z.

UTILS.VecTranslate(a, distance, angle)

Translate 3D vector in the 2D (x,z) plane.

y-component (usually altitude) unchanged.

Defined in:

UTILS

Parameters:

Vector in 3D with x, y, z components.

#number distance

The distance to translate.

#number angle

Rotation angle in degrees.

Return value: