Module Ops.CTLD
Ops -- Combat Troops & Logistics Department.
CTLD - MOOSE based Helicopter CTLD Operations.
Missions:
CTLD - Combat Troop & Logistics Deployment
Main Features:
- MOOSE-based Helicopter CTLD Operations for Players.
Author: Applevangelist (Moose Version), Ciribob (original), Thanks to: Shadowze, Cammel (testing), bbirchnz (additional code!!)
Global(s)
Global CTLD |
Combat Troop & Logistics Deployment (CTLD): Everyone wants to be a POG, until there's POG stuff to be done. (Mil Saying)
CTLD Concept
|
Combat Troop & Logistics Deployment (CTLD): Everyone wants to be a POG, until there's POG stuff to be done. (Mil Saying)
CTLD Concept
- MOOSE-based CTLD for Players.
- Object oriented refactoring of Ciribob's fantastic CTLD script.
- No need for extra MIST loading.
- Additional events to tailor your mission.
- ANY late activated group can serve as cargo, either as troops or crates, which have to be build on-location.
0. Prerequisites
You need to load an .ogg soundfile for the pilot's beacons into the mission, e.g. "beacon.ogg", use a once trigger, "sound to country" for that. Create the late-activated troops, vehicles (no statics at this point!) that will make up your deployable forces.
1. Basic Setup
1.1 Create and start a CTLD instance
A basic setup example is the following:
-- Instantiate and start a CTLD for the blue side, using helicopter groups named "Helicargo" and alias "Lufttransportbrigade I"
local my_ctld = CTLD:New(coalition.side.BLUE,{"Helicargo"},"Lufttransportbrigade I")
my_ctld:__Start(5)
1.2 Add cargo types available
Add generic cargo types that you need for your missions, here infantry units, vehicles and a FOB. These need to be late-activated Wrapper.Group#GROUP objects:
-- add infantry unit called "Anti-Tank Small" using template "ATS", of type TROOP with size 3
-- infantry units will be loaded directly from LOAD zones into the heli (matching number of free seats needed)
my_ctld:AddTroopsCargo("Anti-Tank Small",{"ATS"},CTLD_CARGO.Enum.TROOPS,3)
-- if you want to add weight to your Heli, troops can have a weight in kg **per person**. Currently no max weight checked. Fly carefully.
my_ctld:AddTroopsCargo("Anti-Tank Small",{"ATS"},CTLD_CARGO.Enum.TROOPS,3,80)
-- add infantry unit called "Anti-Tank" using templates "AA" and "AA"", of type TROOP with size 4
my_ctld:AddTroopsCargo("Anti-Air",{"AA","AA2"},CTLD_CARGO.Enum.TROOPS,4)
-- add vehicle called "Humvee" using template "Humvee", of type VEHICLE, size 2, i.e. needs two crates to be build
-- vehicles and FOB will be spawned as crates in a LOAD zone first. Once transported to DROP zones, they can be build into the objects
my_ctld:AddCratesCargo("Humvee",{"Humvee"},CTLD_CARGO.Enum.VEHICLE,2)
-- if you want to add weight to your Heli, crates can have a weight in kg **per crate**. Currently no max weight checked. Fly carefully.
my_ctld:AddCratesCargo("Humvee",{"Humvee"},CTLD_CARGO.Enum.VEHICLE,2,2775)
-- add infantry unit called "Forward Ops Base" using template "FOB", of type FOB, size 4, i.e. needs four crates to be build:
my_ctld:AddCratesCargo("Forward Ops Base",{"FOB"},CTLD_CARGO.Enum.FOB,4)
-- add crates to repair FOB or VEHICLE type units - the 2nd parameter needs to match the template you want to repair
my_ctld:AddCratesRepair("Humvee Repair","Humvee",CTLD_CARGO.Enum.REPAIR,1)
1.3 Add logistics zones
Add zones for loading troops and crates and dropping, building crates
-- Add a zone of type LOAD to our setup. Players can load troops and crates.
-- "Loadzone" is the name of the zone from the ME. Players can load, if they are inside of the zone.
-- Smoke and Flare color for this zone is blue, it is active (can be used) and has a radio beacon.
my_ctld:AddCTLDZone("Loadzone",CTLD.CargoZoneType.LOAD,SMOKECOLOR.Blue,true,true)
-- Add a zone of type DROP. Players can drop crates here.
-- Smoke and Flare color for this zone is blue, it is active (can be used) and has a radio beacon.
-- NOTE: Troops can be unloaded anywhere, also when hovering in parameters.
my_ctld:AddCTLDZone("Dropzone",CTLD.CargoZoneType.DROP,SMOKECOLOR.Red,true,true)
-- Add two zones of type MOVE. Dropped troops and vehicles will move to the nearest one. See options.
-- Smoke and Flare color for this zone is blue, it is active (can be used) and has a radio beacon.
my_ctld:AddCTLDZone("Movezone",CTLD.CargoZoneType.MOVE,SMOKECOLOR.Orange,false,false)
my_ctld:AddCTLDZone("Movezone2",CTLD.CargoZoneType.MOVE,SMOKECOLOR.White,true,true)
2. Options
The following options are available (with their defaults). Only set the ones you want changed:
my_ctld.useprefix = true -- (DO NOT SWITCH THIS OFF UNLESS YOU KNOW WHAT YOU ARE DOING!) Adjust **before** starting CTLD. If set to false, *all* choppers of the coalition side will be enabled for CTLD.
my_ctld.CrateDistance = 30 -- List and Load crates in this radius only.
my_ctld.dropcratesanywhere = false -- Option to allow crates to be dropped anywhere.
my_ctld.maximumHoverHeight = 15 -- Hover max this high to load.
my_ctld.minimumHoverHeight = 4 -- Hover min this low to load.
my_ctld.forcehoverload = true -- Crates (not: troops) can only be loaded while hovering.
my_ctld.hoverautoloading = true -- Crates in CrateDistance in a LOAD zone will be loaded automatically if space allows.
my_ctld.smokedistance = 2000 -- Smoke or flares can be request for zones this far away (in meters).
my_ctld.movetroopstowpzone = true -- Troops and vehicles will move to the nearest MOVE zone...
my_ctld.movetroopsdistance = 5000 -- .. but only if this far away (in meters)
my_ctld.smokedistance = 2000 -- Only smoke or flare zones if requesting player unit is this far away (in meters)
my_ctld.suppressmessages = false -- Set to true if you want to script your own messages.
my_ctld.repairtime = 300 -- Number of seconds it takes to repair a unit.
2.1 User functions
2.1.1 Adjust or add chopper unit-type capabilities
Use this function to adjust what a heli type can or cannot do:
-- E.g. update unit capabilities for testing. Please stay realistic in your mission design.
-- Make a Gazelle into a heavy truck, this type can load both crates and troops and eight of each type:
my_ctld:UnitCapabilities("SA342L", true, true, 8, 8)
Default unit type capabilities are:
["SA342Mistral"] = {type="SA342Mistral", crates=false, troops=true, cratelimit = 0, trooplimit = 4},
["SA342L"] = {type="SA342L", crates=false, troops=true, cratelimit = 0, trooplimit = 2},
["SA342M"] = {type="SA342M", crates=false, troops=true, cratelimit = 0, trooplimit = 4},
["SA342Minigun"] = {type="SA342Minigun", crates=false, troops=true, cratelimit = 0, trooplimit = 2},
["UH-1H"] = {type="UH-1H", crates=true, troops=true, cratelimit = 1, trooplimit = 8},
["Mi-8MT"] = {type="Mi-8MT", crates=true, troops=true, cratelimit = 2, trooplimit = 12},
["Ka-50"] = {type="Ka-50", crates=false, troops=false, cratelimit = 0, trooplimit = 0},
["Mi-24P"] = {type="Mi-24P", crates=true, troops=true, cratelimit = 1, trooplimit = 8},
["Mi-24V"] = {type="Mi-24V", crates=true, troops=true, cratelimit = 1, trooplimit = 8},
2.1.2 Activate and deactivate zones
Activate a zone:
-- Activate zone called Name of type #CTLD.CargoZoneType ZoneType:
my_ctld:ActivateZone(Name,CTLD.CargoZoneType.MOVE)
Deactivate a zone:
-- Deactivate zone called Name of type #CTLD.CargoZoneType ZoneType:
my_ctld:DeactivateZone(Name,CTLD.CargoZoneType.DROP)
3. Events
The class comes with a number of FSM-based events that missions designers can use to shape their mission. These are:
3.1 OnAfterTroopsPickedUp
This function is called when a player has loaded Troops:
function my_ctld:OnAfterTroopsPickedUp(From, Event, To, Group, Unit, Cargo)
... your code here ...
end
3.2 OnAfterCratesPickedUp
This function is called when a player has picked up crates:
function my_ctld:OnAfterCratesPickedUp(From, Event, To, Group, Unit, Cargo)
... your code here ...
end
3.3 OnAfterTroopsDeployed
This function is called when a player has deployed troops into the field:
function my_ctld:OnAfterTroopsDeployed(From, Event, To, Group, Unit, Troops)
... your code here ...
end
3.4 OnAfterTroopsExtracted
This function is called when a player has re-boarded already deployed troops from the field:
function my_ctld:OnAfterTroopsExtracted(From, Event, To, Group, Unit, Troops)
... your code here ...
end
3.5 OnAfterCratesDropped
This function is called when a player has deployed crates to a DROP zone:
function my_ctld:OnAfterCratesDropped(From, Event, To, Group, Unit, Cargotable)
... your code here ...
end
3.6 OnAfterCratesBuild, OnAfterCratesRepaired
This function is called when a player has build a vehicle or FOB:
function my_ctld:OnAfterCratesBuild(From, Event, To, Group, Unit, Vehicle)
... your code here ...
end
function my_ctld:OnAfterCratesRepaired(From, Event, To, Group, Unit, Vehicle)
... your code here ...
end
3.7 A simple SCORING example:
To award player with points, using the SCORING Class (SCORING: my_Scoring, CTLD: CTLD_Cargotransport)
function CTLD_Cargotransport:OnAfterCratesDropped(From, Event, To, Group, Unit, Cargotable)
local points = 10
local PlayerName = Unit:GetPlayerName()
my_scoring:_AddPlayerFromUnit( Unit )
my_scoring:AddGoalScore(Unit, "CTLD", string.format("Pilot %s has been awarded %d points for transporting cargo crates!", PlayerName, points), points)
end
function CTLD_Cargotransport:OnAfterCratesBuild(From, Event, To, Group, Unit, Vehicle)
local points = 5
local PlayerName = Unit:GetPlayerName()
my_scoring:_AddPlayerFromUnit( Unit )
my_scoring:AddGoalScore(Unit, "CTLD", string.format("Pilot %s has been awarded %d points for the construction of Units!", PlayerName, points), points)
end
4. F10 Menu structure
CTLD management menu is under the F10 top menu and called "CTLD"
4.1 Manage Crates
Use this entry to get, load, list nearby, drop, build and repair crates. Also @see options.
4.2 Manage Troops
Use this entry to load, drop and extract troops. NOTE - with extract you can only load troops from the field that were deployed prior. Currently limited CTLD_CARGO troops, which are build from one template. Also, this will heal/complete your units as they are respawned.
4.3 List boarded cargo
Lists what you have loaded. Shows load capabilities for number of crates and number of seats for troops.
4.4 Smoke & Flare zones nearby
Does what it says.
4.5 List active zone beacons
Lists active radio beacons for all zones, where zones are both active and have a beacon. @see CTLD:AddCTLDZone()
4.6 Show hover parameters
Lists hover parameters and indicates if these are curently fulfilled. Also @see options on hover heights.
5. Support for Hercules mod by Anubis
Basic support for the Hercules mod By Anubis has been build into CTLD. Currently this does not cover objects and troops which can be loaded from the Rearm/Refuel menu, i.e. you can drop them into the field, but you cannot use them in functions scripted with this class.
local my_ctld = CTLD:New(coalition.side.BLUE,{"Helicargo", "Hercules"},"Lufttransportbrigade I")
Enable these options for Hercules support:
my_ctld.enableHercules = true
my_ctld.HercMinAngels = 155 -- for troop/cargo drop via chute in meters, ca 470 ft
my_ctld.HercMaxAngels = 2000 -- for troop/cargo drop via chute in meters, ca 6000 ft
my_ctld.HercMaxSpeed = 77 -- 77mps or 270kph or 150kn
Also, the following options need to be set to true:
my_ctld.useprefix = true -- this is true by default and MUST BE ON.
Standard transport capabilities as per the real Hercules are:
["Hercules"] = {type="Hercules", crates=true, troops=true, cratelimit = 7, trooplimit = 64}, -- 19t cargo, 64 paratroopers
Global CTLD_CARGO |
Type(s)
| Fields and Methods inherited from CTLD | Description |
|---|---|
|
User function - Activate Name #CTLD.CargoZone.Type ZoneType for this CTLD instance. |
|
|
User function - Crates and adds a #CTLD.CargoZone zone for this CTLD instance. |
|
CTLD:AddCratesCargo(Name, Templates, Type, NoCrates, PerCrateMass) |
User function - Add generic crate-type loadable as cargo. |
CTLD:AddCratesRepair(Name, Template, Type, NoCrates, PerCrateMass) |
User function - Add generic repair crates loadable as cargo. |
CTLD:AddTroopsCargo(Name, Templates, Type, NoTroops, PerTroopMass) |
User function - Add generic troop type loadable as cargo. |
|
User function - Add a #CTLD.CargoZoneType zone for this CTLD instance. |
|
|
(Internal) Autoload if we can do crates, have capacity free and are in a load zone. |
|
|
(Internal) Check if a unit is in a load zone and is hovering in parameters. |
|
|
(Internal) Run through all pilots and see if we autoload. |
|
|
Name of the class. |
|
|
(Internal) Run through DroppedTroops and capture alive units |
|
|
User function - Deactivate Name #CTLD.CargoZoneType ZoneType for this CTLD instance. |
|
|
(Internal) Check if a Hercules is flying in parameters for air drops. |
|
|
(Internal) Check if a unit is hovering in parameters. |
|
|
(Internal) Function to check if a unit is a Hercules C-130. |
|
|
(Internal) Check if a unit is above ground. |
|
|
(Internal) Function to see if a unit is in a specific zone type. |
|
|
Instantiate a new CTLD. |
|
CTLD:OnAfterCratesBuild(From, Event, To, Group, Unit, Vehicle) |
FSM Function OnAfterCratesBuild. |
CTLD:OnAfterCratesDropped(From, Event, To, Group, Unit, Cargotable) |
FSM Function OnAfterCratesDropped. |
CTLD:OnAfterCratesPickedUp(From, Event, To, Group, Unit, Cargo) |
FSM Function OnAfterCratesPickedUp. |
CTLD:OnAfterCratesRepaired(From, Event, To, Group, Unit, Vehicle) |
FSM Function OnAfterCratesRepaired. |
CTLD:OnAfterTroopsDeployed(From, Event, To, Group, Unit, Troops) |
FSM Function OnAfterTroopsDeployed. |
CTLD:OnAfterTroopsExtracted(From, Event, To, Group, Unit, Cargo) |
FSM Function OnAfterTroopsExtracted. |
CTLD:OnAfterTroopsPickedUp(From, Event, To, Group, Unit, Cargo) |
FSM Function OnAfterTroopsPickedUp. |
|
FSM Function OnAfterTroopsRTB. |
|
|
User function - Start smoke in a zone close to the Unit. |
|
|
Triggers the FSM event "Start". |
|
|
Triggers the FSM event "Status". |
|
CTLD:UnitCapabilities(Unittype, Cancrates, Cantroops, Cratelimit, Trooplimit) |
User - Function to add/adjust unittype capabilities. |
|
(Internal) Add radio beacon to zone. |
|
|
(Internal) Function to build nearby crates. |
|
CTLD:_BuildObjectFromCrates(Group, Unit, Build, Repair, Coordinate, RepairLocation) |
(Internal) Function to actually SPAWN buildables in the mission. |
|
(Internal) Housekeeping - Cleanup crates when build |
|
|
(Internal) Event handler function |
|
|
(Internal) Function to extract (load from the field) troops into a heli. |
|
|
(Internal) Function to find and return nearby crates. |
|
|
(Internal) Function to generate valid FM Frequencies |
|
|
(Internal) Function to generate valid UHF Frequencies |
|
|
(Internal) Populate table with available VHF beacon frequencies. |
|
|
(Internal) Function to spawn crates in front of the heli. |
|
|
(Internal) Return distance in meters between two coordinates. |
|
|
(Internal) Function to obtain a valid FM frequency. |
|
|
(Internal) Function to obtain a valid UHF frequency. |
|
|
(Internal) Function to get capabilities of a chopper |
|
|
(Internal) Function to get current loaded mass |
|
|
(Internal) Function to obtain a valid VHF frequency. |
|
|
(Internal) Function to list loaded cargo. |
|
|
(Internal) Function to find and list nearby crates. |
|
|
(Internal) Function to show list of radio beacons |
|
|
(Internal) Function to get and load nearby crates. |
|
|
(Internal) Function to load troops into a heli. |
|
|
(Internal) Function to move group to WP zone. |
|
|
(Internal) Housekeeping - Function to refresh F10 menus. |
|
|
(Internal) Function to refresh radio beacons |
|
|
(Internal) Function to repair nearby vehicles / FOBs |
|
CTLD:_RepairObjectFromCrates(Group, Unit, Crates, Build, Number) |
(Internal) Function to repair an object. |
|
(Internal) Function to message a group. |
|
|
(Internal) List if a Herc unit is flying in parameters. |
|
|
(Internal) List if a unit is hovering in parameters. |
|
|
(Internal) Function to unload crates from heli. |
|
|
(Internal) Function to unload troops from heli. |
|
|
(Internal) Function to calculate and set Unit internal cargo mass |
|
|
Triggers the FSM event "Start" after a delay. |
|
|
Triggers the FSM event "Status" after a delay. |
|
|
Triggers the FSM event "Stop" after a delay. |
|
|
Coalition side number, e.g. |
|
|
Class id string for output to DCS log file. |
|
|
(Internal) FSM Function onafterStart. |
|
|
(Internal) FSM Function onafterStatus. |
|
|
(Internal) FSM Function onafterStop. |
|
CTLD:onbeforeCratesBuild(From, Event, To, Group, Unit, Vehicle) |
(Internal) FSM Function onbeforeCratesBuild. |
CTLD:onbeforeCratesDropped(From, Event, To, Group, Unit, Cargotable) |
(Internal) FSM Function onbeforeCratesDropped. |
CTLD:onbeforeCratesPickedUp(From, Event, To, Group, Unit, Cargo) |
(Internal) FSM Function onbeforeCratesPickedUp. |
|
(Internal) FSM Function onbeforeStatus. |
|
CTLD:onbeforeTroopsDeployed(From, Event, To, Group, Unit, Troops) |
(Internal) FSM Function onbeforeTroopsDeployed. |
CTLD:onbeforeTroopsExtracted(From, Event, To, Group, Unit, Troops) |
(Internal) FSM Function onbeforeTroopsExtracted. |
CTLD:onbeforeTroopsPickedUp(From, Event, To, Group, Unit, Cargo) |
(Internal) FSM Function onbeforeTroopsPickedUp. |
|
(Internal) FSM Function onbeforeTroopsRTB. |
|
|
Verbosity level. |
|
|
CTLD class version. |
|
| 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. |
|
|
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. |
|
CTLD: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. |
|
|
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 object is completely destroyed. |
|
|
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 initiator : The unit that has ejected |
|
|
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 initiator : The unit that has landed place: Object that the unit landed on. |
|
|
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 |
|
|
Occurs when a mission starts |
|
|
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. |
|
CTLD: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. |
|
CTLD:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function call. |
CTLD:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function logic. |
| Fields and Methods inherited from CTLD.Buildable | Description |
|---|---|
|
Is buildable or not. |
|
|
Found crates. |
|
|
Name of the object. |
|
|
Required crates. |
|
|
Template names for this build. |
|
|
Type enumerator (for moves). |
| Fields and Methods inherited from CTLD.CargoZone | Description |
|---|---|
|
Active or not. |
|
|
Smoke color for zone, e.g. SMOKECOLOR.Red. |
|
|
Beacon info as #CTLD.ZoneBeacon |
|
|
Create and run radio beacons if active. |
|
|
Name of Zone. |
|
|
Type of zone, i.e. load,drop,move |
|
|
Beacon info as #CTLD.ZoneBeacon |
|
|
Beacon info as #CTLD.ZoneBeacon |
| Fields and Methods inherited from CTLD.CargoZoneType | Description |
|---|---|
| Fields and Methods inherited from CTLD.LoadedCargo | Description |
|---|---|
| Fields and Methods inherited from CTLD.UnitCapabilities | Description |
|---|---|
|
Number of crates transportable. |
|
|
Can transport crate. |
|
|
Number of troop units transportable. |
|
|
Can transport troops. |
|
|
Unit type. |
| Fields and Methods inherited from CTLD.ZoneBeacon | Description |
|---|---|
|
-- in mHz |
|
|
-- i.e.radio.modulation.FM or radio.modulation.AM |
|
|
-- Name of zone for the coordinate |
| Fields and Methods inherited from CTLD_CARGO | Description |
|---|---|
|
Query directly loadable. |
|
|
Crates needed to build. |
|
|
Query number of crates or troopsize. |
|
|
Query ID. |
|
|
Query Name. |
|
|
Query type. |
|
|
Query Templates. |
|
|
Query type. |
|
|
True if dropped from heli. |
|
|
Flag for moving. |
|
|
Query has moved. |
|
|
ID of this cargo. |
|
|
Query crate type for REPAIR |
|
|
Query if cargo has been loaded. |
|
|
Flag for direct loading. |
|
|
Name for menu. |
|
|
Function to create new CTLD_CARGO object. |
|
|
Mass in kg |
|
|
Representation of cargo in the mission. |
|
|
Set HasMoved. |
|
|
Set WasDropped. |
|
|
Table of #POSITIONABLE objects. |
|
|
Enumerator of Type. |
|
|
Query was dropped. |
| 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. |
|
CTLD_CARGO: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. |
|
CTLD_CARGO: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. |
|
|
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 object is completely destroyed. |
|
|
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 initiator : The unit that has ejected |
|
|
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 initiator : The unit that has landed place: Object that the unit landed on. |
|
|
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 |
|
|
Occurs when a mission starts |
|
|
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. |
|
CTLD_CARGO: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. |
|
CTLD_CARGO:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function call. |
CTLD_CARGO:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function logic. |
| Fields and Methods inherited from CTLD_CARGO.Enum | Description |
|---|---|
|
Type of Cargo. |
|
- CTLD class, extends Core.Base#BASE, Core.Fsm#FSM
Field(s)
Cargo
Name of the class.
list/load crates in this radius
factor for troops extraction, i.e. CrateDistance * Extractfactor
for troop/cargo drop via chute
280 kph or 150kn eq 77 mps
for troop/cargo drop via chute
tables
radio beacons
Coalition side number, e.g. coalition.side.RED.
#1570
added support Hercules Mod
Class id string for output to DCS log file.
zones stuff
time to repair a unit/group
message suppression
self.I({prefixes = self.prefixes})
Verbosity level.
CTLD class version.
Function(s)
User function - Activate Name #CTLD.CargoZone.Type ZoneType for this CTLD instance.
Defined in:
CTLD
Parameters:
#string Name
Name of the zone to change in the ME.
#CTLD.CargoZoneTyp ZoneType
Type of zone this belongs to.
#boolean NewState
(Optional) Set to true to activate, false to switch off.
User function - Crates and adds a #CTLD.CargoZone zone for this CTLD instance.
Zones of type LOAD: Players load crates and troops here.
Zones of type DROP: Players can drop crates here. Note that troops can be unloaded anywhere.
Zone of type MOVE: Dropped troops and vehicles will start moving to the nearest zone of this type (also see options).
Defined in:
CTLD
Parameters:
#string Name
Name of this zone, as in Mission Editor.
#string Type
Type of this zone, #CTLD.CargoZoneType
#number Color
Smoke/Flare color e.g. #SMOKECOLOR.Red
#string Active
Is this zone currently active?
#string HasBeacon
Does this zone have a beacon if it is active?
Return value:
self
User function - Add generic crate-type loadable as cargo.
This type will create crates that need to be loaded, moved, dropped and built.
Defined in:
CTLD
Parameters:
#string Name
Unique name of this type of cargo. E.g. "Humvee".
#table Templates
Table of #string names of late activated Wrapper.Group#GROUP building this cargo.
#CTLD_CARGO.Enum Type
Type of cargo. I.e. VEHICLE or FOB. VEHICLE will move to destination zones when dropped/build, FOB stays put.
#number NoCrates
Number of crates needed to build this cargo.
#number PerCrateMass
Mass in kg of each crate
User function - Add generic repair crates loadable as cargo.
This type will create crates that need to be loaded, moved, dropped and built.
Defined in:
CTLD
Parameters:
#string Name
Unique name of this type of cargo. E.g. "Humvee".
#string Template
Template of VEHICLE or FOB cargo that this can repair.
#CTLD_CARGO.Enum Type
Type of cargo, here REPAIR.
#number NoCrates
Number of crates needed to build this cargo.
#number PerCrateMass
Mass in kg of each crate
User function - Add generic troop type loadable as cargo.
This type will load directly into the heli without crates.
Defined in:
CTLD
Parameters:
#string Name
Unique name of this type of troop. E.g. "Anti-Air Small".
#table Templates
Table of #string names of late activated Wrapper.Group#GROUP making up this troop.
#CTLD_CARGO.Enum Type
Type of cargo, here TROOPS - these will move to a nearby destination zone when dropped/build.
#number NoTroops
Size of the group in number of Units across combined templates (for loading).
#number PerTroopMass
Mass in kg of each soldier
User function - Add a #CTLD.CargoZoneType zone for this CTLD instance.
(Internal) Autoload if we can do crates, have capacity free and are in a load zone.
(Internal) Check if a unit is in a load zone and is hovering in parameters.
(Internal) Run through all pilots and see if we autoload.
(Internal) Run through DroppedTroops and capture alive units
User function - Deactivate Name #CTLD.CargoZoneType ZoneType for this CTLD instance.
Defined in:
CTLD
Parameters:
#string Name
Name of the zone to change in the ME.
#CTLD.CargoZoneTyp ZoneType
Type of zone this belongs to.
(Internal) Check if a Hercules is flying in parameters for air drops.
(Internal) Check if a unit is hovering in parameters.
(Internal) Function to check if a unit is a Hercules C-130.
(Internal) Check if a unit is above ground.
(Internal) Function to see if a unit is in a specific zone type.
Defined in:
CTLD
Parameters:
Wrapper.Unit#UNIT Unit
Unit
#CTLD.CargoZoneType Zonetype
Zonetype
Return values:
#boolean:
Outcome Is in zone or not
#string:
name Closest zone name
#string:
zone Closest Core.Zone#ZONE object
#number:
distance Distance to closest zone
Instantiate a new CTLD.
Defined in:
CTLD
Parameters:
#string Coalition
Coalition of this CTLD. I.e. coalition.side.BLUE or coalition.side.RED or coalition.side.NEUTRAL
#table Prefixes
Table of pilot prefixes.
#string Alias
Alias of this CTLD for logging.
Return value:
self
FSM Function OnAfterCratesBuild.
Defined in:
CTLD
Parameters:
#string From
State.
#string Event
Trigger.
#string To
State.
Wrapper.Group#GROUP Group
Group Object.
Wrapper.Unit#UNIT Unit
Unit Object.
Wrapper.Group#GROUP Vehicle
The #GROUP object of the vehicle or FOB build.
Return value:
self
FSM Function OnAfterCratesDropped.
Defined in:
CTLD
Parameters:
#string From
State.
#string Event
Trigger.
#string To
State.
Wrapper.Group#GROUP Group
Group Object.
Wrapper.Unit#UNIT Unit
Unit Object.
#table Cargotable
Table of #CTLD_CARGO objects dropped.
Return value:
self
FSM Function OnAfterCratesPickedUp.
Defined in:
CTLD
Parameters:
#string From
State .
#string Event
Trigger.
#string To
State.
Wrapper.Group#GROUP Group
Group Object.
Wrapper.Unit#UNIT Unit
Unit Object.
#CTLD_CARGO Cargo
Cargo crate.
Return value:
self
FSM Function OnAfterCratesRepaired.
Defined in:
CTLD
Parameters:
#string From
State.
#string Event
Trigger.
#string To
State.
Wrapper.Group#GROUP Group
Group Object.
Wrapper.Unit#UNIT Unit
Unit Object.
Wrapper.Group#GROUP Vehicle
The #GROUP object of the vehicle or FOB repaired.
Return value:
self
FSM Function OnAfterTroopsDeployed.
Defined in:
CTLD
Parameters:
#string From
State.
#string Event
Trigger.
#string To
State.
Wrapper.Group#GROUP Group
Group Object.
Wrapper.Unit#UNIT Unit
Unit Object.
Wrapper.Group#GROUP Troops
Troops #GROUP Object.
Return value:
self
FSM Function OnAfterTroopsExtracted.
Defined in:
CTLD
Parameters:
#string From
State.
#string Event
Trigger.
#string To
State.
Wrapper.Group#GROUP Group
Group Object.
Wrapper.Unit#UNIT Unit
Unit Object.
#CTLD_CARGO Cargo
Cargo troops.
Return value:
self
FSM Function OnAfterTroopsPickedUp.
Defined in:
CTLD
Parameters:
#string From
State.
#string Event
Trigger.
#string To
State.
Wrapper.Group#GROUP Group
Group Object.
Wrapper.Unit#UNIT Unit
Unit Object.
#CTLD_CARGO Cargo
Cargo troops.
Return value:
self
FSM Function OnAfterTroopsRTB.
Defined in:
CTLD
Parameters:
#string From
State.
#string Event
Trigger.
#string To
State.
Wrapper.Group#GROUP Group
Group Object.
Wrapper.Unit#UNIT Unit
Unit Object.
User function - Start smoke in a zone close to the Unit.
Defined in:
CTLD
Parameters:
Wrapper.Unit#UNIT Unit
The Unit.
#boolean Flare
If true, flare instead.
Triggers the FSM event "Start".
Starts the CTLD. Initializes parameters and starts event handlers.
Defined in:
CTLD
User - Function to add/adjust unittype capabilities.
Defined in:
CTLD
Parameters:
#string Unittype
The unittype to adjust. If passed as Wrapper.Unit#UNIT, it will search for the unit in the mission.
#boolean Cancrates
Unit can load crates.
#boolean Cantroops
Unit can load troops.
#number Cratelimit
Unit can carry number of crates.
#number Trooplimit
Unit can carry number of troops.
(Internal) Add radio beacon to zone.
Runs 30 secs.
Defined in:
CTLD
Parameters:
#string Name
Name of zone.
#string Sound
Name of soundfile.
#number Mhz
Frequency in Mhz.
#number Modulation
Modulation AM or FM.
(Internal) Function to build nearby crates.
(Internal) Function to actually SPAWN buildables in the mission.
Defined in:
CTLD
Parameters:
Wrapper.Group#GROUP Group
Wrapper.Group#UNIT Unit
#CTLD.Buildable Build
#boolean Repair
If true this is a repair and not a new build
Core.Point#COORDINATE Coordinate
Location for repair (e.g. where the destroyed unit was)
RepairLocation
(Internal) Housekeeping - Cleanup crates when build
Defined in:
CTLD
Parameters:
#table Crates
Table of #CTLD_CARGO objects near the unit.
#CTLD.Buildable Build
Table build object.
#number Number
Number of objects in Crates (found) to limit search.
(Internal) Event handler function
(Internal) Function to extract (load from the field) troops into a heli.
(Internal) Function to find and return nearby crates.
Defined in:
CTLD
Parameters:
Wrapper.Group#GROUP _group
Group
Wrapper.Unit#UNIT _unit
Unit
#number _dist
Distance
Return values:
#table:
Table of crates
#number:
Number Number of crates found
Defined in:
CTLD
Parameters:
Group
Unit
Repairtype
(Internal) Function to generate valid UHF Frequencies
Defined in:
CTLD
(Internal) Populate table with available VHF beacon frequencies.
Defined in:
CTLD
(Internal) Function to spawn crates in front of the heli.
Defined in:
CTLD
Parameters:
Wrapper.Group#GROUP Group
Wrapper.Unit#UNIT Unit
#CTLD_CARGO Cargo
#number number
Number of crates to generate (for dropping)
#boolean drop
If true we're dropping from heli rather than loading.
(Internal) Return distance in meters between two coordinates.
Defined in:
CTLD
Parameters:
Core.Point#COORDINATE _point1
Coordinate one
Core.Point#COORDINATE _point2
Coordinate two
Return value:
#number:
Distance in meters
(Internal) Function to obtain a valid FM frequency.
Defined in:
CTLD
Parameter:
#string Name
Name of zone.
Return value:
Beacon Beacon table.
(Internal) Function to obtain a valid UHF frequency.
Defined in:
CTLD
Parameter:
#string Name
Name of zone.
Return value:
Beacon Beacon table.
(Internal) Function to get capabilities of a chopper
Defined in:
CTLD
Parameter:
Wrapper.Unit#UNIT Unit
The unit
Return value:
#table:
Capabilities Table of caps
(Internal) Function to get current loaded mass
(Internal) Function to obtain a valid VHF frequency.
Defined in:
CTLD
Parameter:
#string Name
Name of zone.
Return value:
Beacon Beacon table.
(Internal) Function to list loaded cargo.
(Internal) Function to find and list nearby crates.
Defined in:
CTLD
Parameters:
Wrapper.Group#GROUP Group
Wrapper.Unit#UNIT Unit
_group
_unit
Return value:
self
(Internal) Function to show list of radio beacons
(Internal) Function to get and load nearby crates.
(Internal) Function to load troops into a heli.
(Internal) Function to move group to WP zone.
(Internal) Housekeeping - Function to refresh F10 menus.
(Internal) Function to repair nearby vehicles / FOBs
(Internal) Function to repair an object.
Defined in:
CTLD
Parameters:
Wrapper.Group#GROUP Group
Wrapper.Unit#UNIT Unit
#table Crates
Table of #CTLD_CARGO objects near the unit.
#CTLD.Buildable Build
Table build object.
#number Number
Number of objects in Crates (found) to limit search.
(Internal) Function to message a group.
Defined in:
CTLD
Parameters:
#string Text
The text to display.
#number Time
Number of seconds to display the message.
#boolean Clearscreen
Clear screen or not.
Wrapper.Group#GROUP Group
The group receiving the message.
(Internal) List if a Herc unit is flying in parameters.
(Internal) List if a unit is hovering in parameters.
(Internal) Function to unload crates from heli.
(Internal) Function to unload troops from heli.
(Internal) Function to calculate and set Unit internal cargo mass
Triggers the FSM event "Start" after a delay.
Starts the CTLD. Initializes parameters and starts event handlers.
Defined in:
CTLD
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Status" after a delay.
Defined in:
CTLD
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Stop" after a delay.
Stops the CTLD and all its event handlers.
Defined in:
CTLD
Parameter:
#number delay
Delay in seconds.
(Internal) FSM Function onafterStart.
Defined in:
CTLD
Parameters:
#string From
State.
#string Event
Trigger.
#string To
State.
Return value:
self
(Internal) FSM Function onafterStatus.
Defined in:
CTLD
Parameters:
#string From
State.
#string Event
Trigger.
#string To
State.
Return value:
self
(Internal) FSM Function onafterStop.
Defined in:
CTLD
Parameters:
#string From
State.
#string Event
Trigger.
#string To
State.
Return value:
self
(Internal) FSM Function onbeforeCratesBuild.
Defined in:
CTLD
Parameters:
#string From
State.
#string Event
Trigger.
#string To
State.
Wrapper.Group#GROUP Group
Group Object.
Wrapper.Unit#UNIT Unit
Unit Object.
Wrapper.Group#GROUP Vehicle
The #GROUP object of the vehicle or FOB build.
Return value:
self
(Internal) FSM Function onbeforeCratesDropped.
Defined in:
CTLD
Parameters:
#string From
State.
#string Event
Trigger.
#string To
State.
Wrapper.Group#GROUP Group
Group Object.
Wrapper.Unit#UNIT Unit
Unit Object.
#table Cargotable
Table of #CTLD_CARGO objects dropped.
Return value:
self
(Internal) FSM Function onbeforeCratesPickedUp.
Defined in:
CTLD
Parameters:
#string From
State .
#string Event
Trigger.
#string To
State.
Wrapper.Group#GROUP Group
Group Object.
Wrapper.Unit#UNIT Unit
Unit Object.
#CTLD_CARGO Cargo
Cargo crate.
Return value:
self
(Internal) FSM Function onbeforeStatus.
Defined in:
CTLD
Parameters:
#string From
State.
#string Event
Trigger.
#string To
State.
Return value:
self
(Internal) FSM Function onbeforeTroopsDeployed.
Defined in:
CTLD
Parameters:
#string From
State.
#string Event
Trigger.
#string To
State.
Wrapper.Group#GROUP Group
Group Object.
Wrapper.Unit#UNIT Unit
Unit Object.
Wrapper.Group#GROUP Troops
Troops #GROUP Object.
Return value:
self
(Internal) FSM Function onbeforeTroopsExtracted.
Defined in:
CTLD
Parameters:
#string From
State.
#string Event
Trigger.
#string To
State.
Wrapper.Group#GROUP Group
Group Object.
Wrapper.Unit#UNIT Unit
Unit Object.
Wrapper.Group#GROUP Troops
Troops #GROUP Object.
Return value:
self
(Internal) FSM Function onbeforeTroopsPickedUp.
Defined in:
CTLD
Parameters:
#string From
State.
#string Event
Trigger.
#string To
State.
Wrapper.Group#GROUP Group
Group Object.
Wrapper.Unit#UNIT Unit
Unit Object.
#CTLD_CARGO Cargo
Cargo crate.
Return value:
self
(Internal) FSM Function onbeforeTroopsRTB.
Defined in:
CTLD
Parameters:
#string From
State.
#string Event
Trigger.
#string To
State.
Wrapper.Group#GROUP Group
Group Object.
Wrapper.Unit#UNIT Unit
Unit Object.
Return value:
self
Field(s)
Cargo
Name of the class.
list/load crates in this radius
factor for troops extraction, i.e. CrateDistance * Extractfactor
for troop/cargo drop via chute
280 kph or 150kn eq 77 mps
for troop/cargo drop via chute
tables
radio beacons
Coalition side number, e.g. coalition.side.RED.
#1570
added support Hercules Mod
Class id string for output to DCS log file.
zones stuff
time to repair a unit/group
message suppression
self.I({prefixes = self.prefixes})
Verbosity level.
CTLD 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:
Parameters:
#string State
State name.
#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.
#boolean If
true, FSM is in this state.
state
Field(s)
Cargo
Name of the class.
list/load crates in this radius
factor for troops extraction, i.e. CrateDistance * Extractfactor
for troop/cargo drop via chute
280 kph or 150kn eq 77 mps
for troop/cargo drop via chute
tables
radio beacons
Coalition side number, e.g. coalition.side.RED.
#1570
added support Hercules Mod
Class id string for output to DCS log file.
zones stuff
time to repair a unit/group
message suppression
self.I({prefixes = self.prefixes})
Verbosity level.
CTLD 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.
Log an exception which will be traced always.
Can be anywhere within the function logic.
Returns the event dispatcher
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 object is completely destroyed.
initiator : The unit that is was destroyed.
BDA.
Occurs when a ground unit captures either an airbase or a farp.
initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.
Occurs when any object is spawned into the mission.
initiator : The unit that was spawned
Occurs when any aircraft crashes into the ground and is completely destroyed.
initiator : The unit that has crashed
Occurs when an object is dead.
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.
Occurs when a pilot ejects from an aircraft initiator : The unit that has ejected
Occurs when any aircraft shuts down its engines.
initiator : The unit that is stopping its engines.
Occurs when any aircraft starts its engines.
initiator : The unit that is starting its engines.
Occurs whenever an object is hit by a weapon.
initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.
Occurs when any system fails on a human controlled aircraft.
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.
- initiator: The unit that killed the target
- target: Target Object
- weapon: Weapon Object
Occurs when an aircraft lands at an airbase, farp or ship initiator : The unit that has landed place: Object that the unit landed on.
Can be an Airbase Object, FARP, or Ships
Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.
Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker.
- initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
- place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
- subplace: is always 0 for unknown reasons.
Landing quality mark.
Occurs when a new mark was added.
MarkID: ID of the mark.
Occurs when a mark text was changed.
MarkID: ID of the mark.
Occurs when a mark was removed.
MarkID: ID of the mark.
Occurs when a mission ends
Occurs when a mission starts
Weapon add.
Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.
Occurs when the pilot of an aircraft is killed.
Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. initiator : The unit that the pilot has died in.
Occurs when a player enters a slot and takes control of an aircraft.
NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. initiator : The unit that is being taken control of.
Occurs when any player assumes direct control of a unit.
initiator : The unit that is being taken control of.
Occurs when any player relieves control of a unit to the AI.
initiator : The unit that the player left.
Occurs when an aircraft connects with a tanker and begins taking on fuel.
initiator : The unit that is receiving fuel.
Occurs when an aircraft is finished taking fuel.
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.
Occurs when any unit stops firing its weapon.
Event will always correspond with a shooting start event. initiator : The unit that was doing the shooting.
Occurs when any unit begins firing a weapon that has a high rate of fire.
Most common with aircraft cannons (GAU-8), autocannons, and machine guns. initiator : The unit that is doing the shooting. target: The unit that is being targeted.
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.
Occurs when an aircraft takes off from an airbase, farp, or ship.
initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships
Trigger zone.
Occurs when the game thinks an object is destroyed.
- 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:
#number:
The ScheduleID 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:
#number:
The ScheduleID of the planned schedule.
Stops the Schedule.
Defined in:
Parameter:
#function SchedulerFunction
The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
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 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
TODO: Complete DCS#Event structure.
- The main event handling function... This function captures all events generated for the class.
@param #BASE self
@param DCS#Event event
Buildable table info.
Field(s)
Is buildable or not.
Found crates.
Name of the object.
Required crates.
Template names for this build.
Function(s)
Zone Info.
Field(s)
Active or not.
Smoke color for zone, e.g. SMOKECOLOR.Red.
Beacon info as #CTLD.ZoneBeacon
Create and run radio beacons if active.
Name of Zone.
Type of zone, i.e. load,drop,move
Beacon info as #CTLD.ZoneBeacon
Beacon info as #CTLD.ZoneBeacon
Function(s)
Zone Type Info.
Field(s)
Function(s)
Field(s)
Function(s)
Unit capabilities.
Field(s)
Number of crates transportable.
Can transport crate.
Number of troop units transportable.
Can transport troops.
Unit type.
Function(s)
Radio Beacons
Field(s)
-- in mHz
-- i.e.radio.modulation.FM or radio.modulation.AM
-- Name of zone for the coordinate
Function(s)
- CTLD_CARGO class, extends #Core.Base#BASE
Field(s)
Crates needed to build.
True if dropped from heli.
Flag for moving.
ID of this cargo.
Flag for direct loading.
Name for menu.
Mass in kg
Table of #POSITIONABLE objects.
Function(s)
Query directly loadable.
Defined in:
CTLD_CARGO
Return value:
#boolean:
loadable
Query number of crates or troopsize.
Defined in:
CTLD_CARGO
Return value:
#number:
Crates or size of troops.
Query type.
Query if cargo has been loaded.
Defined in:
CTLD_CARGO
Parameter:
#boolean loaded
Function to create new CTLD_CARGO object.
Defined in:
CTLD_CARGO
Parameters:
#number ID
ID of this #CTLD_CARGO
#string Name
Name for menu.
#table Templates
Table of #POSITIONABLE objects.
#CTLD_CARGO.Enum Sorte
Enumerator of Type.
#boolean HasBeenMoved
Flag for moving.
#boolean LoadDirectly
Flag for direct loading.
#number CratesNeeded
Crates needed to build.
Wrapper.Positionable#POSITIONABLE Positionable
Representation of cargo in the mission.
#boolean Dropped
Cargo/Troops have been unloaded from a chopper.
#number PerCrateMass
Mass in kg
Return value:
self
Set WasDropped.
Defined in:
CTLD_CARGO
Parameter:
#boolean dropped
Query was dropped.
Defined in:
CTLD_CARGO
Return value:
#boolean:
Has been dropped.
Field(s)
Crates needed to build.
True if dropped from heli.
Flag for moving.
ID of this cargo.
Flag for direct loading.
Name for menu.
Mass in kg
Table of #POSITIONABLE objects.
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:
Parameters:
#string State
State name.
#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.
#boolean If
true, FSM is in this state.
state
Field(s)
Crates needed to build.
True if dropped from heli.
Flag for moving.
ID of this cargo.
Flag for direct loading.
Name for menu.
Mass in kg
Table of #POSITIONABLE objects.
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.
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 object is completely destroyed.
initiator : The unit that is was destroyed.
BDA.
Occurs when a ground unit captures either an airbase or a farp.
initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.
Occurs when any object is spawned into the mission.
initiator : The unit that was spawned
Occurs when any aircraft crashes into the ground and is completely destroyed.
initiator : The unit that has crashed
Occurs when an object is dead.
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.
Occurs when a pilot ejects from an aircraft initiator : The unit that has ejected
Occurs when any aircraft shuts down its engines.
initiator : The unit that is stopping its engines.
Occurs when any aircraft starts its engines.
initiator : The unit that is starting its engines.
Occurs whenever an object is hit by a weapon.
initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.
Occurs when any system fails on a human controlled aircraft.
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.
- initiator: The unit that killed the target
- target: Target Object
- weapon: Weapon Object
Occurs when an aircraft lands at an airbase, farp or ship initiator : The unit that has landed place: Object that the unit landed on.
Can be an Airbase Object, FARP, or Ships
Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.
Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker.
- initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
- place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
- subplace: is always 0 for unknown reasons.
Landing quality mark.
Occurs when a new mark was added.
MarkID: ID of the mark.
Occurs when a mark text was changed.
MarkID: ID of the mark.
Occurs when a mark was removed.
MarkID: ID of the mark.
Occurs when a mission ends
Occurs when a mission starts
Weapon add.
Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.
Occurs when the pilot of an aircraft is killed.
Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. initiator : The unit that the pilot has died in.
Occurs when a player enters a slot and takes control of an aircraft.
NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. initiator : The unit that is being taken control of.
Occurs when any player assumes direct control of a unit.
initiator : The unit that is being taken control of.
Occurs when any player relieves control of a unit to the AI.
initiator : The unit that the player left.
Occurs when an aircraft connects with a tanker and begins taking on fuel.
initiator : The unit that is receiving fuel.
Occurs when an aircraft is finished taking fuel.
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.
Occurs when any unit stops firing its weapon.
Event will always correspond with a shooting start event. initiator : The unit that was doing the shooting.
Occurs when any unit begins firing a weapon that has a high rate of fire.
Most common with aircraft cannons (GAU-8), autocannons, and machine guns. initiator : The unit that is doing the shooting. target: The unit that is being targeted.
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.
Occurs when an aircraft takes off from an airbase, farp, or ship.
initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships
Trigger zone.
Occurs when the game thinks an object is destroyed.
- 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:
#number:
The ScheduleID 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:
#number:
The ScheduleID of the planned schedule.
Stops the Schedule.
Defined in:
Parameter:
#function SchedulerFunction
The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
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
TODO: Complete DCS#Event structure.
- The main event handling function... This function captures all events generated for the class.
@param #BASE self
@param DCS#Event event
Define cargo types.
Field(s)
Type of Cargo.