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 ConceptA SQUADRON is essential part of an AIRWING and consists of one type of aircraft. |
Type(s)
| Fields and Methods inherited from SQUADRON | Description |
|---|---|
|
Name of the class. |
|
|
Get airwing. |
|
|
Create a new SQUADRON object and start the FSM. |
|
|
Number of asset flight groups this squadron has. |
|
|
Set airwing. |
|
|
Set if low fuel threshold is reached, flight tries to refuel at the neares tanker. |
|
|
Set low fuel threshold. |
|
|
Set number of units in groups. |
|
|
Set valid parking spot IDs. |
|
|
Set takeoff type cold (default). |
|
|
Set takeoff type hot. |
|
|
Set takeoff type. |
|
|
Type of the airframe the squadron is using. |
|
|
Squadron assets. |
|
|
Generalized attribute of the squadron template group. |
|
|
Callsign name. |
|
|
Counter to increase callsign names for new assets. |
|
|
Mission range in meters. |
|
|
Low fuel threshold. |
|
|
If |
|
|
Class id string for output to DCS log file. |
|
|
Livery of the squadron. |
|
|
Time in seconds needed for maintenance of a returned flight. |
|
|
Capabilities (mission types and performances) of the squadron. |
|
|
Modex. |
|
|
Counter to incease modex number for assets. |
|
|
Name of the squadron. |
|
|
User defined number of units in the asset group. |
|
|
On after Start event. |
|
|
On after "Status" event. |
|
|
Parking IDs for this squadron. |
|
|
Radio frequency in MHz the squad uses. |
|
|
Radio modulation the squad uses. |
|
|
For refuelable squads, the refuel system used (boom=0 or probe=1). Default nil. |
|
|
Time in seconds for each |
|
|
Skill of squadron members. |
|
|
List of TACAN channels available to the squadron. |
|
|
Take of type. |
|
|
For tanker squads, the refuel system used (boom=0 or probpe=1). Default nil. |
|
|
Template group. |
|
|
Name of the template group. |
|
|
Verbosity level. |
|
|
SQUADRON class version. |
| Fields and Methods inherited from COHORT | Description |
|---|---|
|
Add asset to cohort. |
|
|
Set mission types this cohort is able to perform. |
|
|
Add TACAN channels to the cohort. |
|
|
Check if there is a cohort that can execute a given mission. |
|
|
Check if the cohort attribute matches the given attribute(s). |
|
|
Name of the class. |
|
|
Count assets in legion warehouse stock. |
|
|
Remove asset from chort. |
|
|
Remove asset group from cohort. |
|
|
Get an unused TACAN channel. |
|
|
Create a callsign for the asset. |
|
|
Get mission capabilities of this cohort. |
|
|
Get mission performance for a given type of misson. |
|
|
Get mission types this cohort is able to perform. |
|
|
Create a modex for the asset. |
|
|
Get name of the cohort. |
|
|
Get radio frequency and modulation. |
|
|
Get the time an asset needs to be repaired. |
|
|
Check if cohort is "OnDuty". |
|
|
Check if cohort is "Paused". |
|
|
Checks if a mission type is contained in a table of possible types. |
|
|
Check if cohort is "Stopped". |
|
|
Create a new COHORT object and start the FSM. |
|
|
Number of asset OPS groups this cohort has. |
|
|
Get assets for a mission. |
|
|
"Return" a used TACAN channel. |
|
|
Set call sign. |
|
|
Set number of units in groups. |
|
|
Set Legion. |
|
|
Set livery painted on all cohort units. |
|
|
Set max mission range. |
|
|
Set modex. |
|
|
Set radio frequency and modulation the cohort uses. |
|
|
Set skill level of all cohort team members. |
|
|
Set turnover and repair time. |
|
|
Set verbosity level. |
|
|
Triggers the FSM event "Start". |
|
|
Triggers the FSM event "Status". |
|
|
Check asset status. |
|
|
Triggers the FSM event "Start" after a delay. |
|
|
Triggers the FSM event "Status" after a delay. |
|
|
Triggers the FSM event "Stop" after a delay. |
|
|
Type of the units the cohort is using. |
|
|
Cohort assets. |
|
|
Generalized attribute of the cohort template group. |
|
|
Cargo bay capacity in kg. |
|
|
Group category of the assets: |
|
|
Mission range in meters. |
|
|
The LEGION object the cohort belongs to. |
|
|
Class id string for output to DCS log file. |
|
|
Livery of the cohort. |
|
|
Time in seconds needed for maintenance of a returned flight. |
|
|
Capabilities (mission types and performances) of the cohort. |
|
|
Name of the cohort. |
|
|
On after Start event. |
|
|
On after "Stop" event. |
|
|
Radio frequency in MHz the cohort uses. |
|
|
Radio modulation the cohort uses. |
|
|
Time in seconds for each |
|
|
Skill of cohort members. |
|
|
List of TACAN channels available to the cohort. |
|
|
Template group. |
|
|
Name of the template group. |
|
|
Verbosity level. |
|
|
COHORT class version. |
|
|
Weight of one assets group in kg. |
| Fields and Methods inherited from FSM | Description |
|---|---|
|
Adds an End 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. |
|
|
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. |
|
Add a new transition rule to the FSM. |
|
|
Call scheduler. |
|
|
Name of the class. |
|
|
Get current state. |
|
|
Returns the End states. |
|
|
Returns a table of the SubFSM rules defined within the FSM. |
|
|
Returns a table with the scores defined. |
|
|
Returns the start state of the FSM. |
|
|
Get current state. |
|
|
Returns a table with the Subs defined. |
|
|
Returns a table of the transition rules defined within the FSM. |
|
|
Check if FSM is in state. |
|
|
Load call backs. |
|
|
Creates a new FSM object. |
|
|
Scores. |
|
|
Sets the start state of the FSM. |
|
|
Add to map. |
|
|
Call handler. |
|
|
Create transition. |
|
|
Delayed transition. |
|
|
Event map. |
|
|
Go sub. |
|
|
Handler. |
|
|
Is end state. |
|
|
Sub maps. |
|
|
Check if can do an event. |
|
|
Check if cannot do an event. |
|
|
Current state name. |
|
|
Check if FSM is in state. |
|
|
Options. |
|
|
Subs. |
| Fields and Methods inherited from BASE | Description |
|---|---|
|
The ID number of the class. |
|
|
The name of the class. |
|
|
The name of the class concatenated with the ID number of the class. |
|
|
Clear the state of an object. |
|
SQUADRON:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) |
Creation of a Birth Event. |
|
Creation of a Crash Event. |
|
|
Creation of a Dead Event. |
|
|
Creation of a |
|
|
Creation of a Remove Unit Event. |
|
|
Creation of a Takeoff Event. |
|
|
Creation of a Crash Event. |
|
|
Log an exception which will be traced always. |
|
|
Returns the event dispatcher |
|
|
Remove all subscribed events |
|
|
Trace a function call. |
|
|
Trace a function call level 2. |
|
|
Trace a function call level 3. |
|
|
Get the ClassID of the class instance. |
|
|
Get the ClassName of the class instance. |
|
|
Get the ClassName + ClassID of the class instance. |
|
|
Get the Class Event processing Priority. |
|
|
This is the worker method to retrieve the Parent class. |
|
|
Get a Value given a Key from the Object. |
|
|
Subscribe to a DCS Event. |
|
|
Log an information which will be traced always. |
|
|
This is the worker method to inherit from a parent class. |
|
|
This is the worker method to check if an object is an (sub)instance of a class. |
|
|
Enquires if tracing is on (for the class). |
|
|
BASE constructor. |
|
|
Occurs when an Event for an object is triggered. |
|
|
BDA. |
|
|
Occurs when a ground unit captures either an airbase or a farp. |
|
|
Occurs when any object is spawned into the mission. |
|
|
Occurs when any aircraft crashes into the ground and is completely destroyed. |
|
|
Occurs when an object is dead. |
|
|
Unknown precisely what creates this event, likely tied into newer damage model. |
|
|
Discard chair after ejection. |
|
|
Occurs when a pilot ejects from an aircraft Have a look at the class Core.EVENT#EVENT as these are just the prototypes. |
|
|
Occurs when any aircraft shuts down its engines. |
|
|
Occurs when any aircraft starts its engines. |
|
|
Occurs whenever an object is hit by a weapon. |
|
|
Occurs when any system fails on a human controlled aircraft. |
|
|
Occurs on the death of a unit. |
|
|
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. |
|
|
Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up. |
|
|
Landing quality mark. |
|
|
Occurs when a new mark was added. |
|
|
Occurs when a mark text was changed. |
|
|
Occurs when a mark was removed. |
|
|
Occurs when a mission ends Have a look at the class Core.EVENT#EVENT as these are just the prototypes. |
|
|
Occurs when a mission starts Have a look at the class Core.EVENT#EVENT as these are just the prototypes. |
|
|
Weapon add. |
|
|
Occurs when the pilot of an aircraft is killed. |
|
|
Occurs when a player enters a slot and takes control of an aircraft. |
|
|
Occurs when any player assumes direct control of a unit. |
|
|
Occurs when any player relieves control of a unit to the AI. |
|
|
Occurs when an aircraft connects with a tanker and begins taking on fuel. |
|
|
Occurs when an aircraft is finished taking fuel. |
|
|
Occurs when any modification to the "Score" as seen on the debrief menu would occur. |
|
|
Occurs when any unit stops firing its weapon. |
|
|
Occurs when any unit begins firing a weapon that has a high rate of fire. |
|
|
Occurs whenever any unit in a mission fires a weapon. |
|
|
Occurs when an aircraft takes off from an airbase, farp, or ship. |
|
|
Trigger zone. |
|
|
Occurs when the game thinks an object is destroyed. |
|
|
Schedule a new time event. |
|
SQUADRON:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...) |
Schedule a new time event. |
|
Stops the Schedule. |
|
|
Set the Class Event processing Priority. |
|
|
Set a state or property of the Object given a Key and a Value. |
|
|
Trace a function logic level 1. |
|
|
Trace a function logic level 2. |
|
|
Trace a function logic level 3. |
|
|
Trace all methods in MOOSE |
|
|
Set tracing for a class |
|
|
Set tracing for a specific method of class |
|
|
Set trace level |
|
|
Set trace off. |
|
|
Set trace on. |
|
|
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. |
|
|
UnSubscribe to a DCS event. |
|
SQUADRON:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function call. |
SQUADRON:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function logic. |
|
The main event handling function... |
SQUADRON class.
Field(s)
Name of the class.
Number of asset flight groups this squadron has.
Type of the airframe the squadron is using.
Squadron assets.
Generalized attribute of the squadron template group.
Callsign name.
Counter to increase callsign names for new assets.
Mission range in meters.
Low fuel threshold.
If true, flight tries to refuel at the nearest tanker.
Class id string for output to DCS log file.
Livery of the squadron.
Time in seconds needed for maintenance of a returned flight.
Capabilities (mission types and performances) of the squadron.
Modex.
Counter to incease modex number for assets.
Name of the squadron.
User defined number of units in the asset group.
Parking IDs for this squadron.
Radio frequency in MHz the squad uses.
Radio modulation the squad uses.
For refuelable squads, the refuel system used (boom=0 or probe=1). Default nil.
Time in seconds for each
Skill of squadron members.
List of TACAN channels available to the squadron.
Take of type.
For tanker squads, the refuel system used (boom=0 or probpe=1). Default nil.
Name of the template group.
Verbosity level.
SQUADRON class version.
Function(s)
Get 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.
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 cold (default).
All assets of this squadron will be spawned with engines off (cold).
Set takeoff type hot.
All assets of this squadron will be spawned with engines on (hot).
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.
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)
Name of the class.
Number of asset flight groups this squadron has.
Type of the airframe the squadron is using.
Squadron assets.
Generalized attribute of the squadron template group.
Callsign name.
Counter to increase callsign names for new assets.
Mission range in meters.
Low fuel threshold.
If true, flight tries to refuel at the nearest tanker.
Class id string for output to DCS log file.
Livery of the squadron.
Time in seconds needed for maintenance of a returned flight.
Capabilities (mission types and performances) of the squadron.
Modex.
Counter to incease modex number for assets.
Name of the squadron.
User defined number of units in the asset group.
Parking IDs for this squadron.
Radio frequency in MHz the squad uses.
Radio modulation the squad uses.
For refuelable squads, the refuel system used (boom=0 or probe=1). Default nil.
Time in seconds for each
Skill of squadron members.
List of TACAN channels available to the squadron.
Take of type.
For tanker squads, the refuel system used (boom=0 or probpe=1). Default nil.
Name of the template group.
Verbosity level.
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, 69Check if there is a cohort that can execute a given mission.
We check the mission type, the refuelling system, mission range.
Defined in:
Parameter:
Ops.Auftrag#AUFTRAG Mission
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:
The asset.
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.
Create a callsign for the asset.
Defined in:
Parameter:
The warehouse asset.
Return value:
self
Get mission capabilities of this cohort.
Get mission performance for a given type of misson.
Defined in:
Parameter:
#string MissionType
Type of mission.
Return value:
#number:
Performance or -1.
Get mission types this cohort is able to perform.
Create a modex for the asset.
Defined in:
Parameter:
The warehouse asset.
Return value:
self
Get 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:
The asset.
Return value:
#number:
Time in seconds until asset is repaired.
Check if cohort is "OnDuty".
Check if cohort is "Paused".
Checks if a mission type is contained in a table of possible types.
Defined in:
Parameter:
The asset.
Return value:
#boolean:
If true, the requested mission type is part of the possible mission types.
Check if cohort is "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
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.
"Return" a used TACAN channel.
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. Must be >=1 and <=4. Default 2.
Return value:
self
Set Legion.
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. Initializes parameters and starts event handlers.
Defined in:
Triggers the FSM event "Start" after a delay.
Starts the COHORT. Initializes parameters and starts event handlers.
Triggers the FSM event "Status" after a delay.
Triggers the FSM event "Stop" after a delay.
Stops the COHORT and all its event handlers.
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)
Name of the class.
Number of asset flight groups this squadron has.
Type of the airframe the squadron is using.
Squadron assets.
Generalized attribute of the squadron template group.
Callsign name.
Counter to increase callsign names for new assets.
Mission range in meters.
Low fuel threshold.
If true, flight tries to refuel at the nearest tanker.
Class id string for output to DCS log file.
Livery of the squadron.
Time in seconds needed for maintenance of a returned flight.
Capabilities (mission types and performances) of the squadron.
Modex.
Counter to incease modex number for assets.
Name of the squadron.
User defined number of units in the asset group.
Parking IDs for this squadron.
Radio frequency in MHz the squad uses.
Radio modulation the squad uses.
For refuelable squads, the refuel system used (boom=0 or probe=1). Default nil.
Time in seconds for each
Skill of squadron members.
List of TACAN channels available to the squadron.
Take of type.
For tanker squads, the refuel system used (boom=0 or probpe=1). Default nil.
Name of the template group.
Verbosity level.
SQUADRON class version.
Function(s)
Adds an End 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.
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:
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.
Returns the End states.
Returns a table of the SubFSM rules defined within the FSM.
Returns a table with the scores defined.
Returns the start state of the FSM.
Get current state.
Returns a table with the Subs defined.
Returns a table of the transition rules defined within the FSM.
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.
Sets the start state of the FSM.
Add to map.
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.
Go sub.
Defined in:
Parameters:
#string ParentFrom
Parent from state.
#string ParentEvent
Parent event name.
Return value:
#table:
Subs.
Handler.
Is end state.
Defined in:
Parameter:
#string Current
Current state name.
Return values:
#table:
FSM parent.
#string:
Event name.
Sub maps.
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)
Name of the class.
Number of asset flight groups this squadron has.
Type of the airframe the squadron is using.
Squadron assets.
Generalized attribute of the squadron template group.
Callsign name.
Counter to increase callsign names for new assets.
Mission range in meters.
Low fuel threshold.
If true, flight tries to refuel at the nearest tanker.
Class id string for output to DCS log file.
Livery of the squadron.
Time in seconds needed for maintenance of a returned flight.
Capabilities (mission types and performances) of the squadron.
Modex.
Counter to incease modex number for assets.
Name of the squadron.
User defined number of units in the asset group.
Parking IDs for this squadron.
Radio frequency in MHz the squad uses.
Radio modulation the squad uses.
For refuelable squads, the refuel system used (boom=0 or probe=1). Default nil.
Time in seconds for each
Skill of squadron members.
List of TACAN channels available to the squadron.
Take of type.
For tanker squads, the refuel system used (boom=0 or probpe=1). Default nil.
Name of the template group.
Verbosity level.
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.
Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.
Creation of a Remove Unit Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Creation of a Takeoff Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
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.
Returns the event dispatcher
Remove all subscribed events
Trace a function call.
Must be at the beginning of the function logic.
Trace a function call level 2.
Must be at the beginning of the function logic.
Trace a function call level 3.
Must be at the beginning of the function logic.
Get the ClassID of the class instance.
Get the ClassName of the class instance.
Get the ClassName + ClassID of the class instance.
The ClassName + ClassID is formatted as '%s#%09d'.
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.
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()
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:
Core.Event#EVENTS EventID
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.
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).
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
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.
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.
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
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
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.
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.
Discard chair after ejection.
Have a look at the class Core.EVENT#EVENT as these are just the prototypes.
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
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.
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.
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.
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
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
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
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.
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.
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.
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.
Occurs when a mission ends Have a look at the class Core.EVENT#EVENT as these are just the prototypes.
Occurs when a mission starts Have a look at the class Core.EVENT#EVENT as these are just the prototypes.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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
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.
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.
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.
Trace a function logic level 2.
Can be anywhere within the function logic.
Trace a function logic level 3.
Can be anywhere within the function logic.
Trace all methods in MOOSE
Set tracing for a class
Set tracing for a specific method of class
Set trace off.
Set trace on.
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.
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.