Module Ops.Flotilla
Ops - Flotilla is a small naval group belonging to a fleet.
Main Features:
- Set parameters like livery, skill valid for all flotilla members.
- Define mission types, this flotilla can perform (see Ops.Auftrag#AUFTRAG).
- Pause/unpause flotilla operations.
Author: funkyfranky
Global(s)
Global FLOTILLA |
No captain can do very wrong if he places his ship alongside that of an enemy. -- Horation Nelson The FLOTILLA ConceptA FLOTILLA is an essential part of a FLEET. |
Type(s)
| Fields and Methods inherited from FLOTILLA | Description |
|---|---|
|
Name of the class. |
|
|
Get fleet of this flotilla. |
|
|
Create a new FLOTILLA object and start the FSM. |
|
|
Set fleet of this flotilla. |
|
|
On after Start event. |
|
|
On after "Status" event. |
|
|
Verbosity level. |
|
|
FLOTILLA class version. |
|
|
Weapon data table with key=BitType. |
| 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. |
|
|
Add a weapon range for ARTY missions (Ops.Auftrag#AUFTRAG). |
|
|
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 specific asset from chort. |
|
|
Remove asset group from cohort. |
|
|
Get an unused TACAN channel. |
|
|
Get generalized attribute. |
|
|
Create a callsign for the asset. |
|
|
Get group category. |
|
|
Get mission capabilities of this cohort. |
|
|
Get missin capability for a given mission type. |
|
|
Get mission performance for a given type of misson. |
|
|
Get max mission range. |
|
|
Get mission types this cohort is able to perform. |
|
|
Create a modex for the asset. |
|
|
Get name of the cohort. |
|
|
Get OPSGROUPs. |
|
|
Get properties, i.e. DCS attributes. |
|
|
Get radio frequency and modulation. |
|
|
Get the time an asset needs to be repaired. |
|
|
Get weapon range for given bit type. |
|
|
Check if cohort assets have a given property (DCS attribute). |
|
|
Check if cohort is "OnDuty". |
|
|
Check if cohort is "Paused". |
|
|
Check if cohort is "Relocating". |
|
|
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. |
|
|
Number of destroyed asset groups. |
|
|
On after "Pause" event. |
|
|
On after "Relocate" event. |
|
|
On after "Relocated" event. |
|
|
On after "Unpause" event. |
|
|
Triggers the FSM event "Pause". |
|
|
Get assets for a mission. |
|
|
Triggers the FSM event "Relocate". |
|
|
Triggers the FSM event "Relocated". |
|
|
Remove assets from pool. |
|
|
"Return" a used TACAN channel. |
|
|
Set generalized attribute. |
|
|
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". |
|
|
Triggers the FSM event "Unpause". |
|
|
Add an OPERATION. |
|
|
Check ammo. |
|
|
Check asset status. |
|
|
Returns a name of a missile category. |
|
|
Triggers the FSM event "Pause" after a delay. |
|
|
Triggers the FSM event "Relocate" after a delay. |
|
|
Triggers the FSM event "Relocated" after a delay. |
|
|
Triggers the FSM event "Start" after a delay. |
|
|
Triggers the FSM event "Status" after a delay. |
|
|
Triggers the FSM event "Stop" after a delay. |
|
|
Triggers the FSM event "Unpause" 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: |
|
|
DCS descriptors. |
|
|
Mission range in meters. |
|
|
Is ground. |
|
|
Is naval. |
|
|
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. |
|
|
Operations this cohort is part of. |
|
|
DCS attributes. |
|
|
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 #FSM_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. |
|
FLOTILLA:AddScoreProcess(From, Event, State, ScoreText, Score) |
Adds a score for the FSM_PROCESS to be achieved. |
|
Add a new transition rule to the FSM. |
|
|
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. |
|
|
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. |
|
|
Check if FSM is in state. |
|
FLOTILLA class.
Field(s)
Name of the class.
Get initial ammo.
Is naval.
Verbosity level.
FLOTILLA class version.
Function(s)
Get fleet of this flotilla.
Create a new FLOTILLA object and start the FSM.
Defined in:
FLOTILLA
Parameters:
#string TemplateGroupName
Name of the template group.
#number Ngroups
Number of asset groups of this flotilla. Default 3.
#string FlotillaName
Name of the flotilla. Must be unique!
Return value:
self
Set fleet of this flotilla.
On after Start event.
Starts the FLIGHTGROUP FSM and event handlers.
Defined in:
FLOTILLA
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "Status" event.
Defined in:
FLOTILLA
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Field(s)
Name of the class.
Get initial ammo.
Is naval.
Verbosity level.
FLOTILLA 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, 69Add 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:
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 specific 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.
Get generalized attribute.
Defined in:
Return value:
#string:
Generalized attribute, e.g. GROUP.Attribute.Ground_Infantry.
Create a callsign for the asset.
Defined in:
Parameter:
The warehouse asset.
Return value:
self
Get group category.
Get mission capabilities of this cohort.
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.
Create a modex for the asset.
Defined in:
Parameter:
The warehouse asset.
Return value:
self
Get name of the cohort.
Get OPSGROUPs.
Defined in:
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:
Ops groups set.
Get properties, i.e. DCS attributes.
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.
Get weapon range for given bit type.
Defined in:
Parameter:
#number BitType
Bit mask of weapon type.
Return value:
Weapon data.
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".
Check if cohort is "Paused".
Check if cohort is "Relocating".
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
On after "Pause" event.
Defined in:
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "Relocate" event.
Defined in:
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "Relocated" event.
Defined in:
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "Unpause" event.
Defined in:
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
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.
Remove assets from pool.
Not that assets must not be spawned or already reserved or requested.
Defined in:
Parameter:
#number N
Number of assets to be removed. Default 1.
Return value:
self
"Return" a used TACAN channel.
Set generalized attribute.
Defined in:
Parameter:
#string Attribute
Generalized attribute, e.g. GROUP.Attribute.Ground_Infantry.
Return value:
self
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.
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
Add an OPERATION.
Defined in:
Parameter:
Ops.Operation#OPERATION Operation
The operation this cohort is part of.
Return value:
self
Check ammo.
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.
Triggers the FSM event "Relocate" after a delay.
Triggers the FSM event "Relocated" after a delay.
Triggers the FSM event "Start" after a delay.
Starts the COHORT.
Triggers the FSM event "Status" after a delay.
Triggers the FSM event "Stop" after a delay.
Stops the COHORT and all its event handlers.
Triggers the FSM event "Unpause" after a delay.
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.
Get initial ammo.
Is naval.
Verbosity level.
FLOTILLA class version.
Function(s)
Adds an End state.
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:
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.