Module Ops.Squadron

The airwing asset.

Return value:

self

SQUADRON:AddMissionCapability(MissionTypes, Performance)

Set mission types this squadron is able to perform.

Defined in:

SQUADRON

Parameters:

#table MissionTypes

Table of mission types. Can also be passed as a #string if only one type.

#number Performance

Performance describing how good this mission can be performed. Higher is better. Default 50. Max 100.

Return value:

self

SQUADRON:AddTacanChannel(ChannelMin, ChannelMax)

Add TACAN channels to the squadron.

Note that channels can only range from 1 to 126.

Defined in:

SQUADRON

Parameters:

#number ChannelMin

Channel.

#number ChannelMax

Channel.

Return value:

self

Usage:

mysquad:AddTacanChannel(64,69)  -- adds channels 64, 65, 66, 67, 68, 69

SQUADRON:CanMission(Mission)

Check if there is a squadron that can execute a given mission.

We check the mission type, the refuelling system, engagement range

Defined in:

SQUADRON

Parameter:

Ops.Auftrag#AUFTRAG Mission

The mission.

Return value:

#boolean:

If true, Squadron can do that type of mission.

SQUADRON:CheckMissionCapability(MissionType, Capabilities)

Check if a mission type is contained in a list of possible capabilities.

Defined in:

SQUADRON

Parameters:

#string MissionType

The requested mission type.

#table Capabilities

A table with possible capabilities.

Return value:

#boolean:

If true, the requested mission type is part of the possible mission types.

SQUADRON:CheckMissionType(MissionType, PossibleTypes)

Checks if a mission type is contained in a table of possible types.

Defined in:

SQUADRON

Parameters:

#string MissionType

The requested mission type.

#table PossibleTypes

A table with possible mission types.

Return value:

#boolean:

If true, the requested mission type is part of the possible mission types.

SQUADRON:CountAssetsInStock()

Count assets in airwing (warehous) stock.

Defined in:

SQUADRON

Return value:

#number:

Assets not spawned.

SQUADRON:DelAsset(Asset)

Remove airwing asset from squadron.

Defined in:

SQUADRON

Parameter:

The airwing asset.

Return value:

self

SQUADRON:DelGroup(GroupName)

Remove airwing asset group from squadron.

Defined in:

SQUADRON

Parameter:

#string GroupName

Name of the asset group.

Return value:

self

SQUADRON:FetchTacan()

Get an unused TACAN channel.

Defined in:

SQUADRON

Return value:

#number:

TACAN channel or nil if no channel is free.

SQUADRON:GetCallsign(Asset)

Create a callsign for the asset.

Defined in:

SQUADRON

Parameter:

The airwing asset.

Return value:

self

SQUADRON:GetMissionCapabilities()

Get mission capabilities of this squadron.

Defined in:

SQUADRON

Return value:

#table:

Table of mission capabilities.

SQUADRON:GetMissionPeformance(MissionType)

Get mission performance for a given type of misson.

Defined in:

SQUADRON

Parameter:

#string MissionType

Type of mission.

Return value:

#number:

Performance or -1.

SQUADRON:GetMissionTypes()

Get mission types this squadron is able to perform.

Defined in:

SQUADRON

Return value:

#table:

Table of mission types. Could be empty {}.

SQUADRON:GetModex(Asset)

Create a modex for the asset.

Defined in:

SQUADRON

Parameter:

The airwing asset.

Return value:

self

SQUADRON:GetName()

Get name of the squadron

Defined in:

SQUADRON

Return value:

#string:

Name of the squadron.

SQUADRON:GetRadio()

Get radio frequency and modulation.

Defined in:

SQUADRON

Return values:

#number:

Radio frequency in MHz.

#number:

Radio Modulation (0=AM, 1=FM).

SQUADRON:GetRepairTime(Asset)

Get the time an asset needs to be repaired.

Defined in:

SQUADRON

Parameter:

The asset.

Return value:

#number:

Time in seconds until asset is repaired.

SQUADRON:IsOnDuty()

Check if squadron is "OnDuty".

Defined in:

SQUADRON

Return value:

#boolean:

If true, squdron is in state "OnDuty".

SQUADRON:IsPaused()

Check if squadron is "Paused".

Defined in:

SQUADRON

Return value:

#boolean:

If true, squdron is in state "Paused".

SQUADRON:IsRepaired(Asset)

Checks if a mission type is contained in a table of possible types.

Defined in:

SQUADRON

Parameter:

The asset.

Return value:

#boolean:

If true, the requested mission type is part of the possible mission types.

SQUADRON:IsStopped()

Check if squadron is "Stopped".

Defined in:

SQUADRON

Return value:

#boolean:

If true, squdron is in state "Stopped".

SQUADRON:New(TemplateGroupName, Ngroups, SquadronName)

Create a new SQUADRON object and start the FSM.

Defined in:

SQUADRON

Parameters:

#string TemplateGroupName

Name of the template group.

#number Ngroups

Number of asset groups of this squadron. Default 3.

#string SquadronName

Name of the squadron, e.g. "VFA-37".

Return value:

self

SQUADRON:RecruitAssets(Mission, Nplayloads, Npayloads)

Get assets for a mission.

Defined in:

SQUADRON

Parameters:

Ops.Auftrag#AUFTRAG Mission

The mission.

#number Nplayloads

Number of payloads available.

Npayloads

Return value:

#table:

Assets that can do the required mission.

SQUADRON:ReturnTacan(channel)

"Return" a used TACAN channel.

Defined in:

SQUADRON

Parameter:

#number channel

The channel that is available again.

SQUADRON:SetAirwing(Airwing)

Set airwing.

Defined in:

SQUADRON

Parameter:

Ops.AirWing#AIRWING Airwing

The airwing.

Return value:

self

SQUADRON:SetCallsign(Callsign, Index)

Set call sign.

Defined in:

SQUADRON

Parameters:

#number Callsign

Callsign from CALLSIGN.Aircraft, e.g. "Chevy" for CALLSIGN.Aircraft.CHEVY.

#number Index

Callsign index, Chevy-1.

Return value:

self

SQUADRON:SetFuelLowRefuel(switch)

Set if low fuel threshold is reached, flight tries to refuel at the neares tanker.

Defined in:

SQUADRON

Parameter:

#boolean switch

If true or nil, flight goes for refuelling. If false, turn this off.

Return value:

self

SQUADRON:SetFuelLowThreshold(LowFuel)

Set low fuel threshold.

Defined in:

SQUADRON

Parameter:

#number LowFuel

Low fuel threshold in percent. Default 25.

Return value:

self

SQUADRON:SetGrouping(nunits)

Set number of units in groups.

Defined in:

SQUADRON

Parameter:

#number nunits

Number of units. Must be >=1 and <=4. Default 2.

Return value:

self

SQUADRON:SetLivery(LiveryName)

Set livery painted on all squadron aircraft.

Note that the livery name in general is different from the name shown in the mission editor.

Valid names are the names of the livery directories. Check out the folder in your DCS installation for:

Full modules: DCS World OpenBeta\CoreMods\aircraft\<Aircraft Type>\Liveries\<Aircraft Type>\<Livery Name>
AI units: DCS World OpenBeta\Bazar\Liveries\<Aircraft Type>\<Livery Name>

The folder name <Livery Name> is the string you want.

Or personal liveries you have installed somewhere in your saved games folder.

Defined in:

SQUADRON

Parameter:

#string LiveryName

Name of the livery.

Return value:

self

SQUADRON:SetMissionRange(Range)

Set max mission range.

Only missions in a circle of this radius around the squadron airbase are executed.

Defined in:

SQUADRON

Parameter:

#number Range

Range in NM. Default 100 NM.

Return value:

self

SQUADRON:SetModex(Modex, Prefix, Suffix)

Set modex.

Defined in:

SQUADRON

Parameters:

#number Modex

A number like 100.

#string Prefix

A prefix string, which is put before the Modex number.

#string Suffix

A suffix string, which is put after the Modex number.

Return value:

self

SQUADRON:SetRadio(Frequency, Modulation)

Set radio frequency and modulation the squad uses.

Defined in:

SQUADRON

Parameters:

#number Frequency

Radio frequency in MHz. Default 251 MHz.

#number Modulation

Radio modulation. Default 0=AM.

Return value:

self

Usage:

mysquadron:SetSkill(AI.Skill.EXCELLENT)

SQUADRON:SetSkill(Skill)

Set skill level of all squadron team members.

Defined in:

SQUADRON

Parameter:

#string Skill

Skill of all flights.

Return value:

self

Usage:

mysquadron:SetSkill(AI.Skill.EXCELLENT)

SQUADRON:SetTurnoverTime(MaintenanceTime, RepairTime)

Set turnover and repair time.

If an asset returns from a mission to the airwing, it will need some time until the asset is available for further missions.

Defined in:

SQUADRON

Parameters:

#number MaintenanceTime

Time in minutes it takes until a flight is combat ready again. Default is 0 min.

#number RepairTime

Time in minutes it takes to repair a flight for each life point taken. Default is 0 min.

Return value:

self

SQUADRON:SetVerbosity(VerbosityLevel)

Set verbosity level.

Defined in:

SQUADRON

Parameter:

#number VerbosityLevel

Level of output (higher=more). Default 0.

Return value:

self

SQUADRON:Start()

Triggers the FSM event "Start".

Starts the SQUADRON. Initializes parameters and starts event handlers.

Defined in:

SQUADRON

SQUADRON:Status()

Triggers the FSM event "Status".

Defined in:

SQUADRON

SQUADRON:_CheckAssetStatus()

Check asset status.

Defined in:

SQUADRON

SQUADRON:__Start(delay)

Triggers the FSM event "Start" after a delay.

Starts the SQUADRON. Initializes parameters and starts event handlers.

Defined in:

SQUADRON

Parameter:

#number delay

Delay in seconds.

SQUADRON:__Status(delay)

Triggers the FSM event "Status" after a delay.

Defined in:

SQUADRON

Parameter:

#number delay

Delay in seconds.

SQUADRON:__Stop(delay)

Triggers the FSM event "Stop" after a delay.

Stops the SQUADRON and all its event handlers.

Defined in:

SQUADRON

Parameter:

#number delay

Delay in seconds.

SQUADRON:onafterStart(From, Event, To)

On after Start event.

Starts the FLIGHTGROUP FSM and event handlers.

Defined in:

SQUADRON

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

SQUADRON:onafterStatus(From, Event, To)

On after "Status" event.

Defined in:

SQUADRON

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

SQUADRON:onafterStop(From, Event, To)

On after "Stop" event.

Defined in:

SQUADRON

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Field(s)

#string SQUADRON.ClassName

Name of the class.

#number SQUADRON.Ngroups

Number of asset flight groups this squadron has.

#string SQUADRON.aircrafttype

Type of the airframe the squadron is using.

Ops.AirWing#AIRWING SQUADRON.airwing

The AIRWING object the squadron belongs to.

#table SQUADRON.assets

Squadron assets.

#string SQUADRON.attribute

Generalized attribute of the squadron template group.

SQUADRON.callsignIndex

#string SQUADRON.callsignName

Callsign name.

#number SQUADRON.callsigncounter

Counter to increase callsign names for new assets.

#number SQUADRON.engageRange

Mission range in meters.

#number SQUADRON.fuellow

Low fuel threshold.

#boolean SQUADRON.fuellowRefuel

If true, flight tries to refuel at the nearest tanker.

#string SQUADRON.lid

Class id string for output to DCS log file.

#string SQUADRON.livery

Livery of the squadron.

#number SQUADRON.maintenancetime

Time in seconds needed for maintenance of a returned flight.

#table SQUADRON.missiontypes

Capabilities (mission types and performances) of the squadron.

#number SQUADRON.modex

Modex.

SQUADRON.modexPrefix

SQUADRON.modexSuffix

#number SQUADRON.modexcounter

Counter to incease modex number for assets.

#string SQUADRON.name

Name of the squadron.

#number SQUADRON.ngrouping

User defined number of units in the asset group.

#number SQUADRON.radioFreq

Radio frequency in MHz the squad uses.

#number SQUADRON.radioModu

Radio modulation the squad uses.

#number SQUADRON.refuelSystem

For refuelable squads, the refuel system used (boom=0 or probe=1). Default nil.

#number SQUADRON.repairtime

Time in seconds for each

#number SQUADRON.skill

Skill of squadron members.

#table SQUADRON.tacanChannel

List of TACAN channels available to the squadron.

#number SQUADRON.tankerSystem

For tanker squads, the refuel system used (boom=0 or probpe=1). Default nil.

Wrapper.Group#GROUP SQUADRON.templategroup

Template group.

#string SQUADRON.templatename

Name of the template group.

#number SQUADRON.verbose

Verbosity level.

#string SQUADRON.version

SQUADRON class version.

Function(s)

SQUADRON:AddEndState(State)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

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

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

Defined in:

Parameters:

#table From

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

#string Event

The Event name.

Core.Fsm#FSM_PROCESS Process

An sub-process FSM.

#table ReturnEvents

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

Return value:

Core.Fsm#FSM_PROCESS:

The SubFSM.

SQUADRON:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

Defined in:

Parameters:

#string State

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

#string ScoreText

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

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

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

Adds a score for the FSM_PROCESS to be achieved.

Defined in:

Parameters:

#string From

is the From State of the main process.

#string Event

is the Event of the main process.

#string State

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

#string ScoreText

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

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

SQUADRON:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

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

Defined in:

Parameters:

#table From

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

#string Event

The Event name.

#string To

The To state.

SQUADRON:GetCurrentState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

SQUADRON:GetEndStates()

Returns the End states.

Defined in:

Return value:

#table:

End states.

SQUADRON:GetProcess(From, Event)

Defined in:

Parameters:

From

Event

SQUADRON:GetProcesses()

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

Defined in:

Return value:

#table:

Sub processes.

SQUADRON:GetScores(Scores)

Returns a table with the scores defined.

Defined in:

Parameter:

#table Scores

SQUADRON:GetStartState()

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

SQUADRON:GetState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

SQUADRON:GetSubs()

Returns a table with the Subs defined.

Defined in:

Return value:

#table:

Sub processes.

SQUADRON:GetTransitions()

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

Defined in:

Return value:

#table:

Transitions.

SQUADRON:Is(State)

Check if FSM is in state.

Defined in:

Parameter:

#string State

State name.

Return value:

#boolean:

If true, FSM is in this state.

SQUADRON:LoadCallBacks(CallBackTable)

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

SQUADRON:New()

Creates a new FSM object.

Defined in:

Return value:

#FSM:

SQUADRON:SetProcess(From, Event, Fsm)

Defined in:

Parameters:

From

Event

Fsm

SQUADRON:SetStartState(State)

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

SQUADRON:_add_to_map(Map, Event)

Add to map.

Defined in:

Parameters:

#table Map

Map.

#table Event

Event table.

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

Call handler.

Defined in:

Parameters:

#string step

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

#string trigger

Trigger.

#table params

Parameters.

#string EventName

Event name.

Return value:

Value.

SQUADRON:_create_transition(EventName)

Create transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

SQUADRON:_delayed_transition(EventName)

Delayed transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

SQUADRON:_eventmap(Events, EventStructure)

Event map.

Defined in:

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

SQUADRON:_gosub(ParentFrom, ParentEvent)

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

SQUADRON:_handler(EventName, ...)

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

SQUADRON:_isendstate(Current)

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

SQUADRON:_submap(subs, sub, name)

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

SQUADRON:can(e)

Check if can do an event.

Defined in:

Parameter:

#string e

Event name.

Return values:

#boolean:

If true, FSM can do the event.

#string:

To state.

SQUADRON:cannot(e)

Check if cannot do an event.

Defined in:

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

SQUADRON:is(State, state)

Check if FSM is in state.

Defined in:

Parameters:

#string State

State name.

state

Return value:

#boolean:

If true, FSM is in this state.

Field(s)

#string SQUADRON.ClassName

Name of the class.

#number SQUADRON.Ngroups

Number of asset flight groups this squadron has.

#string SQUADRON.aircrafttype

Type of the airframe the squadron is using.

Ops.AirWing#AIRWING SQUADRON.airwing

The AIRWING object the squadron belongs to.

#table SQUADRON.assets

Squadron assets.

#string SQUADRON.attribute

Generalized attribute of the squadron template group.

SQUADRON.callsignIndex

#string SQUADRON.callsignName

Callsign name.

#number SQUADRON.callsigncounter

Counter to increase callsign names for new assets.

#number SQUADRON.engageRange

Mission range in meters.

#number SQUADRON.fuellow

Low fuel threshold.

#boolean SQUADRON.fuellowRefuel

If true, flight tries to refuel at the nearest tanker.

#string SQUADRON.lid

Class id string for output to DCS log file.

#string SQUADRON.livery

Livery of the squadron.

#number SQUADRON.maintenancetime

Time in seconds needed for maintenance of a returned flight.

#table SQUADRON.missiontypes

Capabilities (mission types and performances) of the squadron.

#number SQUADRON.modex

Modex.

SQUADRON.modexPrefix

SQUADRON.modexSuffix

#number SQUADRON.modexcounter

Counter to incease modex number for assets.

#string SQUADRON.name

Name of the squadron.

#number SQUADRON.ngrouping

User defined number of units in the asset group.

#number SQUADRON.radioFreq

Radio frequency in MHz the squad uses.

#number SQUADRON.radioModu

Radio modulation the squad uses.

#number SQUADRON.refuelSystem

For refuelable squads, the refuel system used (boom=0 or probe=1). Default nil.

#number SQUADRON.repairtime

Time in seconds for each

#number SQUADRON.skill

Skill of squadron members.

#table SQUADRON.tacanChannel

List of TACAN channels available to the squadron.

#number SQUADRON.tankerSystem

For tanker squads, the refuel system used (boom=0 or probpe=1). Default nil.

Wrapper.Group#GROUP SQUADRON.templategroup

Template group.

#string SQUADRON.templatename

Name of the template group.

#number SQUADRON.verbose

Verbosity level.

#string SQUADRON.version

SQUADRON class version.

Function(s)

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

SQUADRON: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

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

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

SQUADRON:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Defined in:

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The aircraft unit the player entered.

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

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

SQUADRON:CreateEventUnitLost(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.

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

SQUADRON:EventDispatcher()

Returns the event dispatcher

Defined in:

Return value:

Core.Event#EVENT:

SQUADRON:EventRemoveAll()

Remove all subscribed events

Defined in:

Return value:

SQUADRON:F(Arguments)

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

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

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

SQUADRON:GetClassID()

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

SQUADRON:GetClassName()

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

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

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

SQUADRON: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:

SQUADRON:GetState(Object, Key)

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.

SQUADRON: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:

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

SQUADRON: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

SQUADRON: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:

SQUADRON:IsTrace()

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

SQUADRON: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:

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

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

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

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

SQUADRON:OnEventDead(EventData)

Occurs when an object is dead.

initiator : The unit that is dead.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

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

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

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

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

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

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

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

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

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

SQUADRON:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

SQUADRON:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

SQUADRON:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

SQUADRON:OnEventMissionEnd(EventData)

Occurs when a mission ends

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

SQUADRON:OnEventMissionStart(EventData)

Occurs when a mission starts

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

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

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

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

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

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

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

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

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

SQUADRON:OnEventShootingStart(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

SQUADRON:OnEventShot(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

SQUADRON:OnEventTakeoff(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

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

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

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

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

SQUADRON: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

SQUADRON: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, 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.

SQUADRON:T(Arguments)

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

SQUADRON:T2(Arguments)

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

SQUADRON:T3(Arguments)

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

SQUADRON:TraceAll(TraceAll)

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

SQUADRON:TraceClass(Class)

Set tracing for a class

Defined in:

Parameter:

#string Class

SQUADRON:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

#string Method

SQUADRON:TraceLevel(Level)

Set trace level

Defined in:

Parameter:

#number Level

SQUADRON:TraceOff()

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

SQUADRON:TraceOn()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

SQUADRON: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 )

SQUADRON:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS EventID

Event ID.

Return value:

SQUADRON:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

SQUADRON:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

SQUADRON: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: