Module Ops.Cohort

The warehouse asset.

Return value:

self

COHORT:AddMissionCapability(MissionTypes, Performance)

Set mission types this cohort is able to perform.

Defined in:

COHORT

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

COHORT:AddTacanChannel(ChannelMin, ChannelMax)

Add TACAN channels to the cohort.

Note that channels can only range from 1 to 126.

Defined in:

COHORT

Parameters:

#number ChannelMin

Channel.

#number ChannelMax

Channel.

Return value:

self

Usage:

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

COHORT:AddWeaponRange(RangeMin, RangeMax, BitType)

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

Defined in:

COHORT

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

COHORT:CanMission(Mission)

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

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

Defined in:

COHORT

Parameter:

Ops.Auftrag#AUFTRAG Mission

The mission.

Return value:

#boolean:

If true, Cohort can do that type of mission.

COHORT:CheckAttribute(Attributes)

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

Defined in:

COHORT

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.

COHORT:CountAssets(InStock, MissionTypes, Attributes)

Count assets in legion warehouse stock.

Defined in:

COHORT

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.

Defined in:

COHORT

Parameter:

The asset.

Return value:

self

Defined in:

COHORT

Parameter:

#string GroupName

Name of the asset group.

Return value:

self

Defined in:

COHORT

Return value:

#number:

TACAN channel or nil if no channel is free.

Defined in:

COHORT

Return value:

#string:

Generalized attribute, e.g. GROUP.Attribute.Ground_Infantry.

Defined in:

COHORT

Parameter:

The warehouse asset.

Return value:

Ops.Auftrag#AUFTRAG.Capability:

self

Defined in:

COHORT

Return value:

#string:

Group category

COHORT:GetMissionCapabilities()

Get mission capabilities of this cohort.

Defined in:

COHORT

Return value:

#table:

Table of mission capabilities.

COHORT:GetMissionCapability(MissionType)

Get missin capability for a given mission type.

Defined in:

COHORT

Parameter:

#string MissionType

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

Return value:

Capability table or nil if the capability does not exist.

COHORT:GetMissionPeformance(MissionType)

Get mission performance for a given type of misson.

Defined in:

COHORT

Parameter:

#string MissionType

Type of mission.

Return value:

#number:

Performance or -1.

COHORT:GetMissionRange(WeaponTypes)

Get max mission range.

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

Defined in:

COHORT

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.

COHORT:GetMissionTypes()

Get mission types this cohort is able to perform.

Defined in:

COHORT

Return value:

#table:

Table of mission types. Could be empty {}.

Defined in:

COHORT

Parameter:

The warehouse asset.

Return value:

self

Defined in:

COHORT

Return value:

#string:

Name of the cohort.

COHORT:GetOpsGroups(MissionTypes, Attributes)

Get OPSGROUPs.

Defined in:

COHORT

Parameters:

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

Core.Set#SET_OPSGROUP:

Ops groups set.

Defined in:

COHORT

Return value:

#table:

Properties table.

Defined in:

COHORT

Return values:

#number:

Radio frequency in MHz.

#number:

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

COHORT:GetRepairTime(Asset)

Get the time an asset needs to be repaired.

Defined in:

COHORT

Parameter:

Ops.OpsGroup#OPSGROUP.WeaponData:

The asset.

Return value:

#number:

Time in seconds until asset is repaired.

Defined in:

COHORT

Parameter:

#number BitType

Bit mask of weapon type.

Return value:

Weapon data.

COHORT:HasProperty(Property)

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

Defined in:

COHORT

Parameter:

#string Property

The property.

Return value:

#boolean:

If true, cohort assets have the attribute.

Defined in:

COHORT

Return value:

#boolean:

If true, cohort is in state "OnDuty".

Defined in:

COHORT

Return value:

#boolean:

If true, cohort is in state "Paused".

Defined in:

COHORT

Return value:

#boolean:

If true, cohort is relocating.

COHORT:IsRepaired(Asset)

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

Defined in:

COHORT

Parameter:

The asset.

Return value:

#boolean:

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

Defined in:

COHORT

Return value:

#boolean:

If true, cohort is in state "Stopped".

COHORT:New(TemplateGroupName, Ngroups, CohortName)

Create a new COHORT object and start the FSM.

Defined in:

COHORT

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

COHORT:OnAfterPause(From, Event, To)

On after "Pause" event.

Defined in:

COHORT

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

COHORT:OnAfterRelocate(From, Event, To)

On after "Relocate" event.

Defined in:

COHORT

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

COHORT:OnAfterRelocated(From, Event, To)

On after "Relocated" event.

Defined in:

COHORT

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

COHORT:OnAfterUnpause(From, Event, To)

On after "Unpause" event.

Defined in:

COHORT

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Defined in:

COHORT

COHORT:RecruitAssets(MissionType, Npayloads)

Get assets for a mission.

Defined in:

COHORT

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.

Defined in:

COHORT

Defined in:

COHORT

Defined in:

COHORT

Parameter:

#number channel

The channel that is available again.

COHORT:SetAttribute(Attribute)

Set generalized attribute.

Defined in:

COHORT

Parameter:

#string Attribute

Generalized attribute, e.g. GROUP.Attribute.Ground_Infantry.

Return value:

self

COHORT:SetCallsign(Callsign, Index)

Set call sign.

Defined in:

COHORT

Parameters:

#number Callsign

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

#number Index

Callsign index, Chevy-1.

Return value:

self

Defined in:

COHORT

Parameter:

#number nunits

Number of units. Default 2.

Return value:

self

Defined in:

COHORT

Parameter:

Ops.Legion#LEGION Legion

The Legion.

Return value:

self

COHORT:SetLivery(LiveryName)

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:

COHORT

Parameter:

#string LiveryName

Name of the livery.

Return value:

self

COHORT:SetMissionRange(Range)

Set max mission range.

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

Defined in:

COHORT

Parameter:

#number Range

Range in NM. Default 150 NM.

Return value:

self

COHORT:SetModex(Modex, Prefix, Suffix)

Set modex.

Defined in:

COHORT

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

COHORT:SetRadio(Frequency, Modulation)

Set radio frequency and modulation the cohort uses.

Defined in:

COHORT

Parameters:

#number Frequency

Radio frequency in MHz. Default 251 MHz.

#number Modulation

Radio modulation. Default 0=AM.

Return value:

self

COHORT:SetSkill(Skill)

Set skill level of all cohort team members.

Defined in:

COHORT

Parameter:

#string Skill

Skill of all flights.

Return value:

self

Usage:

mycohort:SetSkill(AI.Skill.EXCELLENT)

COHORT:SetTurnoverTime(MaintenanceTime, RepairTime)

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:

COHORT

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

COHORT:SetVerbosity(VerbosityLevel)

Set verbosity level.

Defined in:

COHORT

Parameter:

#number VerbosityLevel

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

Return value:

self

COHORT:Start()

Triggers the FSM event "Start".

Starts the COHORT.

Defined in:

COHORT

Defined in:

COHORT

Defined in:

COHORT

COHORT:_AddOperation(Operation)

Add an OPERATION.

Defined in:

COHORT

Parameter:

Ops.Operation#OPERATION Operation

The operation this cohort is part of.

Return value:

Ops.OpsGroup#OPSGROUP.Ammo:

self

Defined in:

COHORT

Return value:

Ammo.

Defined in:

COHORT

COHORT:_MissileCategoryName(categorynumber)

Returns a name of a missile category.

Defined in:

COHORT

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.

COHORT:__Pause(delay)

Triggers the FSM event "Pause" after a delay.

Defined in:

COHORT

Parameter:

#number delay

Delay in seconds.

COHORT:__Relocate(delay)

Triggers the FSM event "Relocate" after a delay.

Defined in:

COHORT

Parameter:

#number delay

Delay in seconds.

COHORT:__Relocated(delay)

Triggers the FSM event "Relocated" after a delay.

Defined in:

COHORT

Parameter:

#number delay

Delay in seconds.

COHORT:__Start(delay)

Triggers the FSM event "Start" after a delay.

Starts the COHORT.

Defined in:

COHORT

Parameter:

#number delay

Delay in seconds.

COHORT:__Status(delay)

Triggers the FSM event "Status" after a delay.

Defined in:

COHORT

Parameter:

#number delay

Delay in seconds.

COHORT:__Stop(delay)

Triggers the FSM event "Stop" after a delay.

Stops the COHORT and all its event handlers.

Defined in:

COHORT

Parameter:

#number delay

Delay in seconds.

COHORT:__Unpause(delay)

Triggers the FSM event "Unpause" after a delay.

Defined in:

COHORT

Parameter:

#number delay

Delay in seconds.

COHORT:onafterStart(From, Event, To)

On after Start event.

Starts the FLIGHTGROUP FSM and event handlers.

Defined in:

COHORT

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

COHORT:onafterStop(From, Event, To)

On after "Stop" event.

Defined in:

COHORT

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Field(s)

#string COHORT.ClassName

Name of the class.

#number COHORT.Ngroups

Number of asset OPS groups this cohort has.

#number COHORT.Nkilled

Number of destroyed asset groups.

#string COHORT.aircrafttype

Type of the units the cohort is using.

#table COHORT.assets

Cohort assets.

#string COHORT.attribute

Generalized attribute of the cohort template group.

COHORT.callsignIndex

COHORT.callsignName

#number COHORT.cargobayLimit

Cargo bay capacity in kg.

#number COHORT.category

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

#table COHORT.descriptors

DCS descriptors.

#number COHORT.engageRange

Mission range in meters.

#boolean COHORT.isAir

#boolean COHORT.isGround

Is ground.

#boolean COHORT.isNaval

Is naval.

Ops.Legion#LEGION COHORT.legion

The LEGION object the cohort belongs to.

#string COHORT.lid

Class id string for output to DCS log file.

#string COHORT.livery

Livery of the cohort.

#number COHORT.maintenancetime

Time in seconds needed for maintenance of a returned flight.

#table COHORT.missiontypes

Capabilities (mission types and performances) of the cohort.

COHORT.modex

COHORT.modexPrefix

COHORT.modexSuffix

#string COHORT.name

Name of the cohort.

#table COHORT.operations

Operations this cohort is part of.

#table COHORT.properties

DCS attributes.

#number COHORT.radioFreq

Radio frequency in MHz the cohort uses.

#number COHORT.radioModu

Radio modulation the cohort uses.

#number COHORT.repairtime

Time in seconds for each

#number COHORT.skill

Skill of cohort members.

#table COHORT.tacanChannel

List of TACAN channels available to the cohort.

Wrapper.Group#GROUP COHORT.templategroup

Template group.

#string COHORT.templatename

Name of the template group.

#number COHORT.verbose

Verbosity level.

#string COHORT.version

COHORT class version.

#number COHORT.weightAsset

Weight of one assets group in kg.

Function(s)

Defined in:

Parameter:

#string State

The FSM state.

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

Set the default #FSM_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.

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

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

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

Defined in:

Return value:

#string:

Current FSM state.

Defined in:

Return value:

#table:

End states.

COHORT:GetProcess(From, Event)

Defined in:

Parameters:

From

Event

COHORT:GetProcesses()

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

Defined in:

Return value:

#table:

Sub processes.

COHORT:GetScores()

Returns a table with the scores defined.

Defined in:

Return value:

#table:

Scores.

Defined in:

Return value:

#string:

A string containing the start state.

Defined in:

Return value:

#string:

Current FSM state.

Defined in:

Return value:

#table:

Sub processes.

COHORT:GetTransitions()

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

Defined in:

Return value:

#table:

Transitions.

Defined in:

Parameter:

#string State

State name.

Return value:

#boolean:

If true, FSM is in this state.

COHORT:LoadCallBacks(CallBackTable)

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

Defined in:

Return value:

#FSM:

COHORT:SetProcess(From, Event, Fsm)

Defined in:

Parameters:

From

Event

Fsm

Defined in:

Parameter:

#string State

A string defining the start state.

COHORT:_add_to_map(Map, Event)

Add to map.

Defined in:

Parameters:

#table Map

Map.

#table Event

Event table.

COHORT:_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.

COHORT:_create_transition(EventName)

Create transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

COHORT:_delayed_transition(EventName)

Delayed transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

COHORT:_eventmap(Events, EventStructure)

Event map.

Defined in:

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

COHORT:_gosub(ParentFrom, ParentEvent)

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

COHORT:_handler(EventName, ...)

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

COHORT:_submap(subs, sub, name)

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

Defined in:

Parameter:

#string e

Event name.

Return values:

#boolean:

If true, FSM can do the event.

#string:

To state.

Defined in:

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

Defined in:

Parameters:

#string State

State name.

state

Return value:

#boolean:

If true, FSM is in this state.

Field(s)

#string COHORT.ClassName

Name of the class.

#number COHORT.Ngroups

Number of asset OPS groups this cohort has.

#number COHORT.Nkilled

Number of destroyed asset groups.

#string COHORT.aircrafttype

Type of the units the cohort is using.

#table COHORT.assets

Cohort assets.

#string COHORT.attribute

Generalized attribute of the cohort template group.

COHORT.callsignIndex

COHORT.callsignName

#number COHORT.cargobayLimit

Cargo bay capacity in kg.

#number COHORT.category

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

#table COHORT.descriptors

DCS descriptors.

#number COHORT.engageRange

Mission range in meters.

#boolean COHORT.isAir

#boolean COHORT.isGround

Is ground.

#boolean COHORT.isNaval

Is naval.

Ops.Legion#LEGION COHORT.legion

The LEGION object the cohort belongs to.

#string COHORT.lid

Class id string for output to DCS log file.

#string COHORT.livery

Livery of the cohort.

#number COHORT.maintenancetime

Time in seconds needed for maintenance of a returned flight.

#table COHORT.missiontypes

Capabilities (mission types and performances) of the cohort.

COHORT.modex

COHORT.modexPrefix

COHORT.modexSuffix

#string COHORT.name

Name of the cohort.

#table COHORT.operations

Operations this cohort is part of.

#table COHORT.properties

DCS attributes.

#number COHORT.radioFreq

Radio frequency in MHz the cohort uses.

#number COHORT.radioModu

Radio modulation the cohort uses.

#number COHORT.repairtime

Time in seconds for each

#number COHORT.skill

Skill of cohort members.

#table COHORT.tacanChannel

List of TACAN channels available to the cohort.

Wrapper.Group#GROUP COHORT.templategroup

Template group.

#string COHORT.templatename

Name of the template group.

#number COHORT.verbose

Verbosity level.

#string COHORT.version

COHORT class version.

#number COHORT.weightAsset

Weight of one assets group in kg.

Function(s)

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

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

COHORT:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

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.

IniObjectCategory

COHORT:CreateEventDead(EventTime, Initiator, IniObjectCategory)

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

COHORT:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Defined in:

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The aircraft unit the player entered.

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

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

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

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

Defined in:

Return value:

Core.Event#EVENT:

Defined in:

Return value:

COHORT:F(Arguments)

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

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

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

Defined in:

Return value:

#string:

The ClassID of the class instance.

COHORT:GetClassName()

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

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

COHORT:GetEventPriority()

Get the Class Core.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 Core.Event processing Priority.

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

COHORT:GetState(Object, Key)

Get a Value given a Key from the Object.

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

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

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

Return value:

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

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

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

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

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

COHORT:IsTrace()

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

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

COHORT:OnEvent(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventBDA(EventData)

BDA.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventBaseCaptured(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventBirth(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventCrash(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventDead(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

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

COHORT:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

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

initiator : The unit that has ejected

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventEngineShutdown(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventEngineStartup(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventHit(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventHumanFailure(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

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

Core.Event#EVENTDATA EventData

The EventData structure.

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

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.

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

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventLandingQualityMark(EventData)

Landing quality mark.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventMarkAdded(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventMarkChange(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventMarkRemoved(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventMissionEnd(EventData)

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventMissionStart(EventData)

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventParatrooperLanding(EventData)

Weapon add.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

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

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventPlayerEnterAircraft(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventPlayerEnterUnit(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventPlayerLeaveUnit(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventRefueling(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventRefuelingStop(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventShootingEnd(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

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

Core.Event#EVENTDATA EventData

The EventData structure.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventTakeoff(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventTriggerZone(EventData)

Trigger zone.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

COHORT:OnEventUnitLost(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

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

#string:

The Schedule ID of the planned schedule.

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

#string:

The Schedule ID of the planned schedule.

COHORT:ScheduleStop(SchedulerID)

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

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

COHORT:SetEventPriority(EventPriority)

Set the Class Core.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 Core.Event processing Priority.

Return value:

self

COHORT:SetState(Object, Key, Value)

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

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

Defined in:

Parameters:

Object

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

Key

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

Value

The value to is stored in the object.

Return value:

The Value set.

COHORT:T(Arguments)

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

COHORT:T2(Arguments)

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

COHORT:T3(Arguments)

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

COHORT:TraceAll(TraceAll)

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

COHORT:TraceClass(Class)

Set tracing for a class

Defined in:

Parameter:

#string Class

Class name.

COHORT:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

Class name.

#string Method

Method.

COHORT:TraceLevel(Level)

Set trace level

Defined in:

Parameter:

#number Level

COHORT:TraceOff()

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

COHORT:TraceOn()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

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

COHORT:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS EventID

Event ID.

Return value:

COHORT:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

COHORT:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

COHORT:onEvent(event)

The main event handling function...

This function captures all events generated for the class.

Defined in: