Banner Image

Module Ops.Squadron

Ops - Airwing Squadron.

Main Features:

  • Set parameters like livery, skill valid for all squadron members.
  • Define modex and callsigns.
  • Define mission types, this squadron can perform (see Ops.Auftrag#AUFTRAG).
  • Pause/unpause squadron operations.

Author: funkyfranky

Global(s)

Global SQUADRON

It is unbelievable what a squadron of twelve aircraft did to tip the balance -- Adolf Galland


The SQUADRON Concept

A SQUADRON is essential part of an Ops.Airwing#AIRWING and consists of one type of aircraft.

#SQUADRON SQUADRON

It is unbelievable what a squadron of twelve aircraft did to tip the balance -- Adolf Galland


The SQUADRON Concept

A SQUADRON is essential part of an Ops.Airwing#AIRWING and consists of one type of aircraft.

Type(s)

SQUADRON , extends Ops.Cohort#COHORT , extends Core.Fsm#FSM , extends Core.Base#BASE
Fields and Methods inherited from SQUADRON Description

SQUADRON.ClassName

Name of the class.

SQUADRON:GetAirwing(Airwing)

Get airwing.

SQUADRON:New(TemplateGroupName, Ngroups, SquadronName)

Create a new SQUADRON object and start the FSM.

SQUADRON.Ngroups

Number of asset flight groups this squadron has.

SQUADRON:SetAirwing(Airwing)

Set airwing.

SQUADRON:SetDespawnAfterHolding(Switch)

Set despawn after holding.

SQUADRON:SetDespawnAfterLanding(Switch)

Set despawn after landing.

SQUADRON:SetFuelLowRefuel(switch)

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

SQUADRON:SetFuelLowThreshold(LowFuel)

Set low fuel threshold.

SQUADRON:SetGrouping(nunits)

Set number of units in groups.

SQUADRON:SetParkingIDs(ParkingIDs)

Set valid parking spot IDs.

SQUADRON:SetTakeoffAir()

Set takeoff type air.

SQUADRON:SetTakeoffCold()

Set takeoff type cold (default).

SQUADRON:SetTakeoffHot()

Set takeoff type hot.

SQUADRON:SetTakeoffType(TakeoffType)

Set takeoff type.

SQUADRON.aircrafttype

Type of the airframe the squadron is using.

SQUADRON.assets

Squadron assets.

SQUADRON.attribute

Generalized attribute of the squadron template group.

SQUADRON.callsignName

Callsign name.

SQUADRON.callsigncounter

Counter to increase callsign names for new assets.

SQUADRON.despawnAfterHolding

Aircraft are despawned after holding.

SQUADRON.despawnAfterLanding

Aircraft are despawned after landing.

SQUADRON.engageRange

Mission range in meters.

SQUADRON.fuellow

Low fuel threshold.

SQUADRON.fuellowRefuel

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

SQUADRON.isAir

SQUADRON.legion

SQUADRON.lid

Class id string for output to DCS log file.

SQUADRON.livery

Livery of the squadron.

SQUADRON.maintenancetime

Time in seconds needed for maintenance of a returned flight.

SQUADRON.missiontypes

Capabilities (mission types and performances) of the squadron.

SQUADRON.modex

Modex.

SQUADRON.modexcounter

Counter to incease modex number for assets.

SQUADRON.name

Name of the squadron.

SQUADRON.ngrouping

User defined number of units in the asset group.

SQUADRON:onafterStart(From, Event, To)

On after Start event.

SQUADRON:onafterStatus(From, Event, To)

On after "Status" event.

SQUADRON.parkingIDs

Parking IDs for this squadron.

SQUADRON.radioFreq

Radio frequency in MHz the squad uses.

SQUADRON.radioModu

Radio modulation the squad uses.

SQUADRON.refuelSystem

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

SQUADRON.repairtime

Time in seconds for each

SQUADRON.skill

Skill of squadron members.

SQUADRON.tacanChannel

List of TACAN channels available to the squadron.

SQUADRON.takeoffType

Take of type.

SQUADRON.tankerSystem

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

SQUADRON.templategroup

Template group.

SQUADRON.templatename

Name of the template group.

SQUADRON.verbose

Verbosity level.

SQUADRON.version

SQUADRON class version.

Fields and Methods inherited from COHORT Description

SQUADRON:AddAsset(Asset)

Add asset to cohort.

SQUADRON:AddMissionCapability(MissionTypes, Performance)

Set mission types this cohort is able to perform.

SQUADRON:AddTacanChannel(ChannelMin, ChannelMax)

Add TACAN channels to the cohort.

SQUADRON:AddWeaponRange(RangeMin, RangeMax, BitType)

Add a weapon range for ARTY missions (Ops.Auftrag#AUFTRAG).

SQUADRON:CanMission(Mission)

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

SQUADRON:CheckAttribute(Attributes)

Check if the cohort attribute matches the given attribute(s).

SQUADRON.ClassName

Name of the class.

SQUADRON:CountAssets(InStock, MissionTypes, Attributes)

Count assets in legion warehouse stock.

SQUADRON:DelAsset(Asset)

Remove asset from chort.

SQUADRON:DelGroup(GroupName)

Remove asset group from cohort.

SQUADRON:FetchTacan()

Get an unused TACAN channel.

SQUADRON:GetCallsign(Asset)

Create a callsign for the asset.

SQUADRON:GetMissionCapabilities()

Get mission capabilities of this cohort.

SQUADRON:GetMissionCapability(MissionType)

Get missin capability for a given mission type.

SQUADRON:GetMissionPeformance(MissionType)

Get mission performance for a given type of misson.

SQUADRON:GetMissionRange(WeaponTypes)

Get max mission range.

SQUADRON:GetMissionTypes()

Get mission types this cohort is able to perform.

SQUADRON:GetModex(Asset)

Create a modex for the asset.

SQUADRON:GetName()

Get name of the cohort.

SQUADRON:GetRadio()

Get radio frequency and modulation.

SQUADRON:GetRepairTime(Asset)

Get the time an asset needs to be repaired.

SQUADRON:GetWeaponData(BitType)

Get weapon range for given bit type.

SQUADRON:HasProperty(Property)

Check if cohort assets have a given property (DCS attribute).

SQUADRON:IsOnDuty()

Check if cohort is "OnDuty".

SQUADRON:IsPaused()

Check if cohort is "Paused".

SQUADRON:IsRelocating()

Check if cohort is "Relocating".

SQUADRON:IsRepaired(Asset)

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

SQUADRON:IsStopped()

Check if cohort is "Stopped".

SQUADRON:New(TemplateGroupName, Ngroups, CohortName)

Create a new COHORT object and start the FSM.

SQUADRON.Ngroups

Number of asset OPS groups this cohort has.

SQUADRON.Nkilled

Number of destroyed asset groups.

SQUADRON:Pause()

Triggers the FSM event "Pause".

SQUADRON:RecruitAssets(MissionType, Npayloads)

Get assets for a mission.

SQUADRON:Relocate()

Triggers the FSM event "Relocate".

SQUADRON:Relocated()

Triggers the FSM event "Relocated".

SQUADRON:ReturnTacan(channel)

"Return" a used TACAN channel.

SQUADRON:SetCallsign(Callsign, Index)

Set call sign.

SQUADRON:SetGrouping(nunits)

Set number of units in groups.

SQUADRON:SetLegion(Legion)

Set Legion.

SQUADRON:SetLivery(LiveryName)

Set livery painted on all cohort units.

SQUADRON:SetMissionRange(Range)

Set max mission range.

SQUADRON:SetModex(Modex, Prefix, Suffix)

Set modex.

SQUADRON:SetRadio(Frequency, Modulation)

Set radio frequency and modulation the cohort uses.

SQUADRON:SetSkill(Skill)

Set skill level of all cohort team members.

SQUADRON:SetTurnoverTime(MaintenanceTime, RepairTime)

Set turnover and repair time.

SQUADRON:SetVerbosity(VerbosityLevel)

Set verbosity level.

SQUADRON:Start()

Triggers the FSM event "Start".

SQUADRON:Status()

Triggers the FSM event "Status".

SQUADRON:Unpause()

Triggers the FSM event "Unpause".

SQUADRON:_CheckAmmo()

Check ammo.

SQUADRON:_CheckAssetStatus()

Check asset status.

SQUADRON:_MissileCategoryName(categorynumber)

Returns a name of a missile category.

SQUADRON:__Pause(delay)

Triggers the FSM event "Pause" after a delay.

SQUADRON:__Relocate(delay)

Triggers the FSM event "Relocate" after a delay.

SQUADRON:__Relocated(delay)

Triggers the FSM event "Relocated" after a delay.

SQUADRON:__Start(delay)

Triggers the FSM event "Start" after a delay.

SQUADRON:__Status(delay)

Triggers the FSM event "Status" after a delay.

SQUADRON:__Stop(delay)

Triggers the FSM event "Stop" after a delay.

SQUADRON:__Unpause(delay)

Triggers the FSM event "Unpause" after a delay.

SQUADRON.aircrafttype

Type of the units the cohort is using.

SQUADRON.assets

Cohort assets.

SQUADRON.attribute

Generalized attribute of the cohort template group.

SQUADRON.callsignIndex

SQUADRON.callsignName

SQUADRON.callsigncounter

SQUADRON.cargobayLimit

Cargo bay capacity in kg.

SQUADRON.category

Group category of the assets: Group.Category.AIRPLANE, Group.Category.HELICOPTER, Group.Category.GROUND, Group.Category.SHIP, Group.Category.TRAIN.

SQUADRON.descriptors

DCS descriptors.

SQUADRON.engageRange

Mission range in meters.

SQUADRON.isAir

SQUADRON.isGround

Is ground.

SQUADRON.isNaval

Is naval.

SQUADRON.legion

The LEGION object the cohort belongs to.

SQUADRON.lid

Class id string for output to DCS log file.

SQUADRON.livery

Livery of the cohort.

SQUADRON.maintenancetime

Time in seconds needed for maintenance of a returned flight.

SQUADRON.missiontypes

Capabilities (mission types and performances) of the cohort.

SQUADRON.modex

SQUADRON.modexPrefix

SQUADRON.modexSuffix

SQUADRON.modexcounter

SQUADRON.name

Name of the cohort.

SQUADRON.ngrouping

SQUADRON:onafterStart(From, Event, To)

On after Start event.

SQUADRON:onafterStop(From, Event, To)

On after "Stop" event.

SQUADRON.properties

DCS attributes.

SQUADRON.radioFreq

Radio frequency in MHz the cohort uses.

SQUADRON.radioModu

Radio modulation the cohort uses.

SQUADRON.repairtime

Time in seconds for each

SQUADRON.skill

Skill of cohort members.

SQUADRON.tacanChannel

List of TACAN channels available to the cohort.

SQUADRON.templategroup

Template group.

SQUADRON.templatename

Name of the template group.

SQUADRON.verbose

Verbosity level.

SQUADRON.version

COHORT class version.

SQUADRON.weaponData

SQUADRON.weightAsset

Weight of one assets group in kg.

Fields and Methods inherited from FSM Description

SQUADRON:AddEndState(State)

Adds an End 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.

SQUADRON:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

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

Adds a score for the FSM_PROCESS to be achieved.

SQUADRON:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

SQUADRON.CallScheduler

Call scheduler.

SQUADRON.ClassName

Name of the class.

SQUADRON.Events

SQUADRON:GetCurrentState()

Get current state.

SQUADRON:GetEndStates()

Returns the End states.

SQUADRON:GetProcess(From, Event)

SQUADRON:GetProcesses()

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

SQUADRON:GetScores()

Returns a table with the scores defined.

SQUADRON:GetStartState()

Returns the start state of the FSM.

SQUADRON:GetState()

Get current state.

SQUADRON:GetSubs()

Returns a table with the Subs defined.

SQUADRON:GetTransitions()

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

SQUADRON:Is(State)

Check if FSM is in state.

SQUADRON:LoadCallBacks(CallBackTable)

Load call backs.

SQUADRON:New()

Creates a new FSM object.

SQUADRON.Scores

Scores.

SQUADRON:SetProcess(From, Event, Fsm)

SQUADRON:SetStartState(State)

Sets the start state of the FSM.

SQUADRON._EndStates

SQUADRON._EventSchedules

SQUADRON._Processes

SQUADRON._Scores

SQUADRON._StartState

SQUADRON._Transitions

SQUADRON:_add_to_map(Map, Event)

Add to map.

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

Call handler.

SQUADRON:_create_transition(EventName)

Create transition.

SQUADRON:_delayed_transition(EventName)

Delayed transition.

SQUADRON:_eventmap(Events, EventStructure)

Event map.

SQUADRON:_gosub(ParentFrom, ParentEvent)

Go sub.

SQUADRON:_handler(EventName, ...)

Handler.

SQUADRON:_isendstate(Current)

Is end state.

SQUADRON:_submap(subs, sub, name)

Sub maps.

SQUADRON:can(e)

Check if can do an event.

SQUADRON:cannot(e)

Check if cannot do an event.

SQUADRON.current

Current state name.

SQUADRON.endstates

SQUADRON:is(State, state)

Check if FSM is in state.

SQUADRON.options

Options.

SQUADRON.subs

Subs.

Fields and Methods inherited from BASE Description

SQUADRON.ClassID

The ID number of the class.

SQUADRON.ClassName

The name of the class.

SQUADRON.ClassNameAndID

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

SQUADRON:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

SQUADRON:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

SQUADRON:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

SQUADRON:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

SQUADRON:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

SQUADRON:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

SQUADRON:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

SQUADRON:E(Arguments)

Log an exception which will be traced always.

SQUADRON:EventDispatcher()

Returns the event dispatcher

SQUADRON:EventRemoveAll()

Remove all subscribed events

SQUADRON:F(Arguments)

Trace a function call.

SQUADRON:F2(Arguments)

Trace a function call level 2.

SQUADRON:F3(Arguments)

Trace a function call level 3.

SQUADRON:GetClassID()

Get the ClassID of the class instance.

SQUADRON:GetClassName()

Get the ClassName of the class instance.

SQUADRON:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

SQUADRON:GetEventPriority()

Get the Class Event processing Priority.

SQUADRON:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

SQUADRON:GetState(Object, Key)

Get a Value given a Key from the Object.

SQUADRON:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

SQUADRON:I(Arguments)

Log an information which will be traced always.

SQUADRON:Inherit(Child, Parent)

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

SQUADRON:IsInstanceOf(ClassName)

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

SQUADRON:IsTrace()

Enquires if tracing is on (for the class).

SQUADRON:New()

BASE constructor.

SQUADRON:OnEvent(EventData)

Occurs when an Event for an object is triggered.

SQUADRON:OnEventBDA(EventData)

BDA.

SQUADRON:OnEventBaseCaptured(EventData)

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

SQUADRON:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

SQUADRON:OnEventCrash(EventData)

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

SQUADRON:OnEventDead(EventData)

Occurs when an object is dead.

SQUADRON:OnEventDetailedFailure(EventData)

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

SQUADRON:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

SQUADRON:OnEventEjection(EventData)

Occurs when a pilot ejects from an aircraft Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

SQUADRON:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

SQUADRON:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

SQUADRON:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

SQUADRON:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

SQUADRON:OnEventKill(EventData)

Occurs on the death of a unit.

SQUADRON:OnEventLand(EventData)

Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

SQUADRON:OnEventLandingAfterEjection(EventData)

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

SQUADRON:OnEventLandingQualityMark(EventData)

Landing quality mark.

SQUADRON:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

SQUADRON:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

SQUADRON:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

SQUADRON:OnEventMissionEnd(EventData)

Occurs when a mission ends Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

SQUADRON:OnEventMissionStart(EventData)

Occurs when a mission starts Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

SQUADRON:OnEventParatrooperLanding(EventData)

Weapon add.

SQUADRON:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

SQUADRON:OnEventPlayerEnterAircraft(EventData)

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

SQUADRON:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

SQUADRON:OnEventPlayerLeaveUnit(EventData)

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

SQUADRON:OnEventRefueling(EventData)

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

SQUADRON:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

SQUADRON:OnEventScore(EventData)

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

SQUADRON:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

SQUADRON:OnEventShootingStart(EventData)

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

SQUADRON:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

SQUADRON:OnEventTakeoff(EventData)

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

SQUADRON:OnEventTriggerZone(EventData)

Trigger zone.

SQUADRON:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

SQUADRON:ScheduleStop(SchedulerID)

Stops the Schedule.

SQUADRON.Scheduler

SQUADRON:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

SQUADRON:SetState(Object, Key, Value)

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

SQUADRON:T(Arguments)

Trace a function logic level 1.

SQUADRON:T2(Arguments)

Trace a function logic level 2.

SQUADRON:T3(Arguments)

Trace a function logic level 3.

SQUADRON:TraceAll(TraceAll)

Trace all methods in MOOSE

SQUADRON:TraceClass(Class)

Set tracing for a class

SQUADRON:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

SQUADRON:TraceLevel(Level)

Set trace level

SQUADRON:TraceOff()

Set trace off.

SQUADRON:TraceOn()

Set trace on.

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.

SQUADRON:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

SQUADRON._

SQUADRON:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

SQUADRON:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

SQUADRON.__

SQUADRON:onEvent(event)

The main event handling function...

SQUADRON class.

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.

#table SQUADRON.assets

Squadron assets.

#string SQUADRON.attribute

Generalized attribute of the squadron template group.

#string SQUADRON.callsignName

Callsign name.

#number SQUADRON.callsigncounter

Counter to increase callsign names for new assets.

#boolean SQUADRON.despawnAfterHolding

Aircraft are despawned after holding.

#boolean SQUADRON.despawnAfterLanding

Aircraft are despawned after landing.

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

#boolean SQUADRON.isAir

Is air.

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

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

#table SQUADRON.parkingIDs

Parking IDs for this squadron.

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

#string SQUADRON.takeoffType

Take of type.

#number SQUADRON.tankerSystem

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

#string SQUADRON.templatename

Name of the template group.

#number SQUADRON.verbose

Verbosity level.

#string SQUADRON.version

SQUADRON class version.

Function(s)

Get airwing.

Defined in:

SQUADRON

Parameter:

Airwing

Return value:

The airwing.

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

Set airwing.

Defined in:

SQUADRON

Parameter:

The airwing.

Return value:

self

Set despawn after holding.

Aircraft will be despawned when they arrive at their holding position at the airbase. Can help to avoid DCS AI taxiing issues.

Defined in:

SQUADRON

Parameter:

#boolean Switch

If true (default), activate despawn after holding.

Return value:

self

Set despawn after landing.

Aircraft will be despawned after the landing event. Can help to avoid DCS AI taxiing issues.

Defined in:

SQUADRON

Parameter:

#boolean Switch

If true (default), activate despawn after landing.

Return value:

self

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

Set low fuel threshold.

Defined in:

SQUADRON

Parameter:

#number LowFuel

Low fuel threshold in percent. Default 25.

Return value:

self

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

Set valid parking spot IDs.

Assets of this squad are only allowed to be spawned at these parking spots. Note that the IDs are different from the ones displayed in the mission editor!

Defined in:

SQUADRON

Parameter:

#table ParkingIDs

Table of parking ID numbers or a single #number.

Return value:

self

Set takeoff type air.

All assets of this squadron will be spawned in air above the airbase.

Defined in:

SQUADRON

Return value:

self

Set takeoff type cold (default).

All assets of this squadron will be spawned with engines off (cold).

Defined in:

SQUADRON

Return value:

self

Set takeoff type hot.

All assets of this squadron will be spawned with engines on (hot).

Defined in:

SQUADRON

Return value:

self

Set takeoff type.

All assets of this squadron will be spawned with cold (default) or hot engines. Spawning on runways is not supported.

Defined in:

SQUADRON

Parameter:

#string TakeoffType

Take off type: "Cold" (default) or "Hot" with engines on or "Air" for spawning in air.

Return value:

self

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.

On after "Status" 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.

#table SQUADRON.assets

Squadron assets.

#string SQUADRON.attribute

Generalized attribute of the squadron template group.

#string SQUADRON.callsignName

Callsign name.

#number SQUADRON.callsigncounter

Counter to increase callsign names for new assets.

#boolean SQUADRON.despawnAfterHolding

Aircraft are despawned after holding.

#boolean SQUADRON.despawnAfterLanding

Aircraft are despawned after landing.

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

#boolean SQUADRON.isAir

Is air.

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

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

#table SQUADRON.parkingIDs

Parking IDs for this squadron.

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

#string SQUADRON.takeoffType

Take of type.

#number SQUADRON.tankerSystem

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

#string SQUADRON.templatename

Name of the template group.

#number SQUADRON.verbose

Verbosity level.

#string SQUADRON.version

SQUADRON class version.

Function(s)

Add asset to cohort.

Defined in:

Parameter:

The warehouse asset.

Return value:

self

Set mission types this cohort is able to perform.

Defined in:

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

Add TACAN channels to the cohort.

Note that channels can only range from 1 to 126.

Defined in:

Parameters:

#number ChannelMin

Channel.

#number ChannelMax

Channel.

Return value:

self

Usage:

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

Add a weapon range for ARTY missions (Ops.Auftrag#AUFTRAG).

Defined in:

Parameters:

#number RangeMin

Minimum range in nautical miles. Default 0 NM.

#number RangeMax

Maximum range in nautical miles. Default 10 NM.

#number BitType

Bit mask of weapon type for which the given min/max ranges apply. Default is ENUMS.WeaponFlag.Auto, i.e. for all weapon types.

Return value:

self

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

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

Defined in:

Parameter:

The mission.

Return value:

#boolean:

If true, Cohort can do that type of mission.

Check if the cohort attribute matches the given attribute(s).

Defined in:

Parameter:

#table Attributes

The requested attributes. See WAREHOUSE.Attribute enum. Can also be passed as a single attribute #string.

Return value:

#boolean:

If true, the cohort has the requested attribute.

Count assets in legion warehouse stock.

Defined in:

Parameters:

#boolean InStock

If true, only assets that are in the warehouse stock/inventory are counted. If false, only assets that are NOT in stock (i.e. spawned) are counted. If nil, all assets are counted.

#table MissionTypes

(Optional) Count only assest that can perform certain mission type(s). Default is all types.

#table Attributes

(Optional) Count only assest that have a certain attribute(s), e.g. WAREHOUSE.Attribute.AIR_BOMBER.

Return value:

#number:

Number of assets.

Remove asset from chort.

Defined in:

Parameter:

Return value:

self

Remove asset group from cohort.

Defined in:

Parameter:

#string GroupName

Name of the asset group.

Return value:

self

Get an unused TACAN channel.

Defined in:

Return value:

#number:

TACAN channel or nil if no channel is free.

Create a callsign for the asset.

Defined in:

Parameter:

The warehouse asset.

Return value:

self

Get mission capabilities of this cohort.

Defined in:

Return value:

#table:

Table of mission capabilities.

Get missin capability for a given mission type.

Defined in:

Parameter:

#string MissionType

Mission type, e.g. AUFTRAG.Type.BAI.

Return value:

Capability table or nil if the capability does not exist.

Get mission performance for a given type of misson.

Defined in:

Parameter:

#string MissionType

Type of mission.

Return value:

#number:

Performance or -1.

Get max mission range.

We add the largest weapon range, e.g. for arty or naval if weapon data is available.

Defined in:

Parameter:

#table WeaponTypes

(Optional) Weapon bit type(s) to add to the total range. Default is the max weapon type available.

Return value:

#number:

Range in meters.

Get mission types this cohort is able to perform.

Defined in:

Return value:

#table:

Table of mission types. Could be empty {}.

Create a modex for the asset.

Defined in:

Parameter:

The warehouse asset.

Return value:

self

Get name of the cohort.

Defined in:

Return value:

#string:

Name of the cohort.

Get radio frequency and modulation.

Defined in:

Return values:

#number:

Radio frequency in MHz.

#number:

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

Get the time an asset needs to be repaired.

Defined in:

Parameter:

Return value:

#number:

Time in seconds until asset is repaired.

Get weapon range for given bit type.

Defined in:

Parameter:

#number BitType

Bit mask of weapon type.

Return value:

Check if cohort assets have a given property (DCS attribute).

Defined in:

Parameter:

#string Property

The property.

Return value:

#boolean:

If true, cohort assets have the attribute.

Check if cohort is "OnDuty".

Defined in:

Return value:

#boolean:

If true, cohort is in state "OnDuty".

Check if cohort is "Paused".

Defined in:

Return value:

#boolean:

If true, cohort is in state "Paused".

Check if cohort is "Relocating".

Defined in:

Return value:

#boolean:

If true, cohort is relocating.

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

Defined in:

Parameter:

Return value:

#boolean:

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

Check if cohort is "Stopped".

Defined in:

Return value:

#boolean:

If true, cohort is in state "Stopped".

Create a new COHORT object and start the FSM.

Defined in:

Parameters:

#string TemplateGroupName

Name of the template group.

#number Ngroups

Number of asset groups of this Cohort. Default 3.

#string CohortName

Name of the cohort.

Return value:

self

Triggers the FSM event "Pause".

Defined in:

Get assets for a mission.

Defined in:

Parameters:

#string MissionType

Mission type.

#number Npayloads

Number of payloads available.

Return values:

#table:

Assets that can do the required mission.

#number:

Number of payloads still available after recruiting the assets.

Triggers the FSM event "Relocate".

Defined in:

Triggers the FSM event "Relocated".

Defined in:

"Return" a used TACAN channel.

Defined in:

Parameter:

#number channel

The channel that is available again.

Set call sign.

Defined in:

Parameters:

#number Callsign

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

#number Index

Callsign index, Chevy-1.

Return value:

self

Set number of units in groups.

Defined in:

Parameter:

#number nunits

Number of units. Default 2.

Return value:

self

Set Legion.

Defined in:

Parameter:

The Legion.

Return value:

self

Set livery painted on all cohort units.

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:

Parameter:

#string LiveryName

Name of the livery.

Return value:

self

Set max mission range.

Only missions in a circle of this radius around the cohort base are executed.

Defined in:

Parameter:

#number Range

Range in NM. Default 150 NM.

Return value:

self

Set modex.

Defined in:

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

Set radio frequency and modulation the cohort uses.

Defined in:

Parameters:

#number Frequency

Radio frequency in MHz. Default 251 MHz.

#number Modulation

Radio modulation. Default 0=AM.

Return value:

self

Set skill level of all cohort team members.

Defined in:

Parameter:

#string Skill

Skill of all flights.

Return value:

self

Usage:

mycohort:SetSkill(AI.Skill.EXCELLENT)

Set turnover and repair time.

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

Defined in:

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

Set verbosity level.

Defined in:

Parameter:

#number VerbosityLevel

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

Return value:

self

Triggers the FSM event "Start".

Starts the COHORT.

Defined in:

Triggers the FSM event "Status".

Defined in:

Triggers the FSM event "Unpause".

Defined in:

Check ammo.

Defined in:

Return value:

Check asset status.

Defined in:

Returns a name of a missile category.

Defined in:

Parameter:

#number categorynumber

Number of missile category from weapon missile category enumerator. See https://wiki.hoggitworld.com/view/DCS_Class_Weapon

Return value:

#string:

Missile category name.

Triggers the FSM event "Pause" after a delay.

Defined in:

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Relocate" after a delay.

Defined in:

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Relocated" after a delay.

Defined in:

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Start" after a delay.

Starts the COHORT.

Defined in:

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Status" after a delay.

Defined in:

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Stop" after a delay.

Stops the COHORT and all its event handlers.

Defined in:

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Unpause" after a delay.

Defined in:

Parameter:

#number delay

Delay in seconds.

On after Start event.

Starts the FLIGHTGROUP FSM and event handlers.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Stop" event.

Defined in:

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.

#table SQUADRON.assets

Squadron assets.

#string SQUADRON.attribute

Generalized attribute of the squadron template group.

#string SQUADRON.callsignName

Callsign name.

#number SQUADRON.callsigncounter

Counter to increase callsign names for new assets.

#boolean SQUADRON.despawnAfterHolding

Aircraft are despawned after holding.

#boolean SQUADRON.despawnAfterLanding

Aircraft are despawned after landing.

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

#boolean SQUADRON.isAir

Is air.

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

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

#table SQUADRON.parkingIDs

Parking IDs for this squadron.

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

#string SQUADRON.takeoffType

Take of type.

#number SQUADRON.tankerSystem

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

#string SQUADRON.templatename

Name of the template group.

#number SQUADRON.verbose

Verbosity level.

#string SQUADRON.version

SQUADRON class version.

Function(s)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

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

Defined in:

Parameters:

#table From

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

#string Event

The Event name.

An sub-process FSM.

#table ReturnEvents

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

Return value:

The SubFSM.

Adds a score for the FSM to be achieved.

Defined in:

Parameters:

#string State

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

#string ScoreText

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

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Adds a score for the FSM_PROCESS to be achieved.

Defined in:

Parameters:

#string From

is the From State of the main process.

#string Event

is the Event of the main process.

#string State

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

#string ScoreText

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

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Add a new transition rule to the FSM.

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

Defined in:

Parameters:

#table From

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

#string Event

The Event name.

#string To

The To state.

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

Returns the End states.

Defined in:

Return value:

#table:

End states.

Defined in:

Parameters:

From

Event

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

Defined in:

Return value:

#table:

Sub processes.

Returns a table with the scores defined.

Defined in:

Return value:

#table:

Scores.

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

Returns a table with the Subs defined.

Defined in:

Return value:

#table:

Sub processes.

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

Defined in:

Return value:

#table:

Transitions.

Check if FSM is in state.

Defined in:

Parameter:

#string State

State name.

Return value:

#boolean:

If true, FSM is in this state.

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

Creates a new FSM object.

Defined in:

Return value:

#FSM:

Defined in:

Parameters:

From

Event

Fsm

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

Add to map.

Defined in:

Parameters:

#table Map

Map.

#table Event

Event table.

Call handler.

Defined in:

Parameters:

#string step

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

#string trigger

Trigger.

#table params

Parameters.

#string EventName

Event name.

Return value:

Value.

Create transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

Delayed transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

Event map.

Defined in:

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

Check if can do an event.

Defined in:

Parameter:

#string e

Event name.

Return values:

#boolean:

If true, FSM can do the event.

#string:

To state.

Check if cannot do an event.

Defined in:

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

Check if FSM is in state.

Defined in:

Parameters:

#string State

State name.

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.

#table SQUADRON.assets

Squadron assets.

#string SQUADRON.attribute

Generalized attribute of the squadron template group.

#string SQUADRON.callsignName

Callsign name.

#number SQUADRON.callsigncounter

Counter to increase callsign names for new assets.

#boolean SQUADRON.despawnAfterHolding

Aircraft are despawned after holding.

#boolean SQUADRON.despawnAfterLanding

Aircraft are despawned after landing.

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

#boolean SQUADRON.isAir

Is air.

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

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

#table SQUADRON.parkingIDs

Parking IDs for this squadron.

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

#string SQUADRON.takeoffType

Take of type.

#number SQUADRON.tankerSystem

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

#string SQUADRON.templatename

Name of the template group.

#number SQUADRON.verbose

Verbosity level.

#string SQUADRON.version

SQUADRON class version.

Function(s)

Clear the state of an object.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

StateName

The key that is should be cleared.

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

#string IniUnitName

The initiating unit name.

place

subplace

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

IniObjectCategory

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Defined in:

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The aircraft unit the player entered.

Creation of a Remove Unit Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Takeoff Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Returns the event dispatcher

Defined in:

Return value:

Remove all subscribed events

Defined in:

Return value:

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

Get the ClassName + ClassID of the class instance.

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

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

Get the Class Event processing Priority.

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

Defined in:

Return value:

#number:

The Event processing Priority.

This is the worker method to retrieve the Parent class.

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

self:GetParent(self):ParentMethod()


Defined in:

Parameters:

#BASE Child

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

#BASE FromClass

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

Return value:

Get a Value given a Key from the Object.

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

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

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

Return value:

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

Subscribe to a DCS Event.

Defined in:

Parameters:

Event ID.

#function EventFunction

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

Return value:

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

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

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

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

Examples:

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

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

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

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

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

Defined in:

Parameter:

ClassName

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

Return value:

#boolean:

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

BASE constructor.

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

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

Defined in:

Return value:

Occurs when an Event for an object is triggered.

Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that triggered the event.

Defined in:

Parameter:

The EventData structure.

BDA.

Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

Defined in:

Parameter:

The EventData structure.

Occurs when any object is spawned into the mission.

Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that was spawned

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that has crashed

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that is dead.

Defined in:

Parameter:

The EventData structure.

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

Will update this page when new information become available.

  • initiator: The unit that had the failure.

Defined in:

Parameter:

The EventData structure.

Discard chair after ejection.

Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when a pilot ejects from an aircraft Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

initiator : The unit that has ejected

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that is stopping its engines.

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that is starting its engines.

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.

Defined in:

Parameter:

The EventData structure.

Occurs when any system fails on a human controlled aircraft.

Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that had the failure

Defined in:

Parameter:

The EventData structure.

Occurs on the death of a unit.

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs. Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

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

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

initiator : The unit that has landed place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

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

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker. Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

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

Defined in:

Parameter:

The EventData structure.

Landing quality mark.

Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when a new mark was added.

Have a look at the class Core.EVENT#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

Have a look at the class Core.EVENT#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

Have a look at the class Core.EVENT#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission ends Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission starts Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Weapon add.

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when the pilot of an aircraft is killed.

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that the pilot has died in.

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.EVENT#EVENT as these are just the prototypes. 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:

The EventData structure.

Occurs when any player assumes direct control of a unit.

Note - not Mulitplayer safe. Use PlayerEnterAircraft. Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that the player left.

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that is receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that was receiving fuel.

Defined in:

Parameter:

The EventData structure.

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

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard. Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

Event will always correspond with a shooting start event. Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that was doing the shooting.

Defined in:

Parameter:

The EventData structure.

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

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that is doing the shooting. target: The unit that is being targeted.

Defined in:

Parameter:

The EventData structure.

Occurs whenever any unit in a mission fires a weapon.

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

Trigger zone.

Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when the game thinks an object is destroyed.

Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

  • initiator: The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#function SchedulerFunction

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

#table ...

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

Return value:

#string:

The Schedule ID of the planned schedule.

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#number Repeat

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

#number RandomizeFactor

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

#number Stop

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

#function SchedulerFunction

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

#table ...

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

Return value:

#string:

The Schedule ID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.

Set the Class Event processing Priority.

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

Defined in:

Parameter:

#number EventPriority

The Event processing Priority.

Return value:

self

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

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

Defined in:

Parameters:

Object

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

Key

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

Value

The value to is stored in the object.

Return value:

The Value set.

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

Set tracing for a class

Defined in:

Parameter:

#string Class

Class name.

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

Class name.

#string Method

Method.

Set trace level

Defined in:

Parameter:

#number Level

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

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

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

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:

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

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

UnSubscribe to a DCS event.

Defined in:

Parameter:

Event ID.

Return value:

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

The main event handling function...

This function captures all events generated for the class.

Defined in:

Parameter:

DCS#Event event