Module Ops.Squadron
Ops - Airwing Squadron.
Main Features:
- Set parameters like livery, skill valid for all squadron members.
- Define modex and callsigns.
- Define mission types, this squadron can perform (see Ops.Auftrag#AUFTRAG).
- Pause/unpause squadron operations.
Author: funkyfranky
Global(s)
Global SQUADRON |
It is unbelievable what a squadron of twelve aircraft did to tip the balance. -- Adolf Galland
The SQUADRON ConceptA SQUADRON is essential part of an AIRWING and consists of one type of aircraft. |
Type(s)
| Fields and Methods inherited from SQUADRON | Description |
|---|---|
|
Add airwing asset to squadron. |
|
|
Set mission types this squadron is able to perform. |
|
|
Check if there is a squadron that can execute a given mission. |
|
|
Check if a mission type is contained in a list of possible capabilities. |
|
|
Checks if a mission type is contained in a table of possible types. |
|
|
Name of the class. |
|
|
Get assets for a mission. |
|
|
Debug mode. Messages to all about status. |
|
|
Remove airwing asset from squadron. |
|
|
Create a callsign for the asset. |
|
|
Get mission capabilities of this squadron. |
|
|
Get mission performance for a given type of misson. |
|
|
Get mission types this squadron is able to perform. |
|
|
Create a modex for the asset. |
|
|
Get radio frequency and modulation. |
|
|
Get an unused TACAN channel. |
|
|
Check if squadron is "OnDuty". |
|
|
Check if squadron is "Paused". |
|
|
Check if squadron is "Stopped". |
|
|
Create a new SQUADRON object and start the FSM. |
|
|
Number of asset flight groups this squadron has. |
|
|
Get assets for a mission. |
|
|
"Return" a used TACAN channel. |
|
|
Set airwing. |
|
|
Set call sign. |
|
|
Set max engagement range. |
|
|
Set livery painted on all squadron aircraft. |
|
|
Set modex. |
|
|
Set radio frequency and modulation the squad uses. |
|
|
Set skill level of all squadron team members. |
|
|
Triggers the FSM event "Start". |
|
|
Triggers the FSM event "Status". |
|
|
TACAN max channel. |
|
|
TACAN min channel. |
|
|
Table of used TACAN channels. |
|
|
Check asset status. |
|
|
Triggers the FSM event "Start" after a delay. |
|
|
Triggers the FSM event "Status" after a delay. |
|
|
Triggers the FSM event "Stop" after a delay. |
|
|
Type of the airframe the squadron is using. |
|
|
The AIRWING object the squadron belongs to. |
|
|
Squadron assets. |
|
|
Generalized attribute of the squadron template group. |
|
|
Callsign name. |
|
|
Counter to increase callsign names for new assets. |
|
|
Engagement range in meters. |
|
|
Class id string for output to DCS log file. |
|
|
Livery of the squadron. |
|
|
Capabilities (mission types and performances) of the squadron. |
|
|
Modex. |
|
|
Counter to incease modex number for assets. |
|
|
Name of the squadron. |
|
|
On after Start event. |
|
|
On after "Status" event. |
|
|
On after "Stop" event. |
|
|
Radio frequency in MHz the squad uses. |
|
|
Radio modulation the squad uses. |
|
|
For refuelable squads, the refuel system used (boom=0 or probpe=1). Default nil. |
|
|
Skill of squadron members. |
|
|
For tanker squads, the refuel system used (boom=0 or probpe=1). Default nil. |
|
|
Template group. |
|
|
Name of the template group. |
|
|
SQUADRON 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. |
|
SQUADRON:AddScoreProcess(From, Event, State, ScoreText, Score) |
Adds a score for the FSM_PROCESS to be achieved. |
|
Add a new transition rule to the FSM. |
|
|
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. |
|
|
Returns a table with the Subs defined. |
|
|
Returns a table of the transition rules defined within the FSM. |
|
|
Creates a new FSM object. |
|
|
Sets the start state of the FSM. |
|
| Fields and Methods inherited from BASE | Description |
|---|---|
|
The ID number of the class. |
|
|
The name of the class. |
|
|
The name of the class concatenated with the ID number of the class. |
|
|
Clear the state of an object. |
|
SQUADRON:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) |
Creation of a Birth Event. |
|
Creation of a Crash Event. |
|
|
Creation of a Dead Event. |
|
|
Creation of a 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. |
|
|
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. |
|
|
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. |
|
|
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 |
|
|
Occurs when the pilot of an aircraft is killed. |
|
|
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. |
|
|
Occurs when the game thinks an object is destroyed. |
|
|
Schedule a new time event. |
|
SQUADRON:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...) |
Schedule a new time event. |
|
Stops the Schedule. |
|
|
Set the Class Event processing Priority. |
|
|
Set a state or property of the Object given a Key and a Value. |
|
|
Trace a function logic level 1. |
|
|
Trace a function logic level 2. |
|
|
Trace a function logic level 3. |
|
|
Trace all methods in MOOSE |
|
|
Set tracing for a class |
|
|
Set tracing for a specific method of class |
|
|
Set trace level |
|
|
Set trace off. |
|
|
Set trace on. |
|
|
Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default. |
|
|
UnSubscribe to a DCS event. |
|
SQUADRON:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function call. |
SQUADRON:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function logic. |
SQUADRON class.
Field(s)
Name of the class.
Debug mode. Messages to all about status.
Number of asset flight groups this squadron has.
TACAN max channel.
TACAN min channel.
Table of used TACAN channels.
Type of the airframe the squadron is using.
Squadron assets.
Generalized attribute of the squadron template group.
Callsign name.
Counter to increase callsign names for new assets.
Engagement range in meters.
Class id string for output to DCS log file.
Livery of the squadron.
Capabilities (mission types and performances) of the squadron.
Modex.
Counter to incease modex number for assets.
Name of the squadron.
Radio frequency in MHz the squad uses.
Radio modulation the squad uses.
For refuelable squads, the refuel system used (boom=0 or probpe=1). Default nil.
Skill of squadron members.
For tanker squads, the refuel system used (boom=0 or probpe=1). Default nil.
Name of the template group.
SQUADRON class version.
Function(s)
Add airwing asset to squadron.
Defined in:
SQUADRON
Parameter:
The airwing asset.
Return value:
self
Set mission types this squadron is able to perform.
Defined in:
SQUADRON
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
Check if there is a squadron that can execute a given mission.
We check the mission type, the refuelling system, engagement range
Defined in:
SQUADRON
Parameter:
Ops.Auftrag#AUFTRAG Mission
The mission.
Return value:
#boolean:
If true, Squadron can do that type of mission.
Check if a mission type is contained in a list of possible capabilities.
Defined in:
SQUADRON
Parameters:
#string MissionType
The requested mission type.
#table Capabilities
A table with possible capabilities.
Return value:
#boolean:
If true, the requested mission type is part of the possible mission types.
Checks if a mission type is contained in a table of possible types.
Defined in:
SQUADRON
Parameters:
#string MissionType
The requested mission type.
#table PossibleTypes
A table with possible mission types.
Return value:
#boolean:
If true, the requested mission type is part of the possible mission types.
Get assets for a mission.
Defined in:
SQUADRON
Return value:
#number:
Assets not spawned.
Remove airwing asset from squadron.
Defined in:
SQUADRON
Parameter:
The airwing asset.
Return value:
self
Create a callsign for the asset.
Defined in:
SQUADRON
Parameter:
The airwing asset.
Return value:
self
Get mission capabilities of this squadron.
Defined in:
SQUADRON
Return value:
#table:
Table of mission capabilities.
Get mission performance for a given type of misson.
Defined in:
SQUADRON
Parameter:
#string MissionType
Type of mission.
Return value:
#number:
Performance or -1.
Get mission types this squadron is able to perform.
Defined in:
SQUADRON
Return value:
#table:
Table of mission types. Could be empty {}.
Create a modex for the asset.
Defined in:
SQUADRON
Parameter:
The airwing asset.
Return value:
self
Get radio frequency and modulation.
Defined in:
SQUADRON
Return values:
#number:
Radio frequency in MHz.
#number:
Radio Modulation (0=AM, 1=FM).
Get an unused TACAN channel.
Defined in:
SQUADRON
Parameter:
The airwing asset.
Return value:
#number:
TACAN channel or nil if no channel is free.
Check if squadron is "OnDuty".
Defined in:
SQUADRON
Return value:
#boolean:
If true, squdron is in state "OnDuty".
Check if squadron is "Paused".
Defined in:
SQUADRON
Return value:
#boolean:
If true, squdron is in state "Paused".
Check if squadron is "Stopped".
Defined in:
SQUADRON
Return value:
#boolean:
If true, squdron is in state "Stopped".
Create a new SQUADRON object and start the FSM.
Defined in:
SQUADRON
Parameters:
#string TemplateGroupName
Name of the template group.
#number Ngroups
Number of asset groups of this squadron. Default 3.
#string SquadronName
Name of the squadron, e.g. "VFA-37".
Return value:
self
Get assets for a mission.
Defined in:
SQUADRON
Parameter:
Ops.Auftrag#AUFTRAG Mission
The mission.
Return value:
#table:
Assets that can do the required mission.
"Return" a used TACAN channel.
Defined in:
SQUADRON
Parameter:
#number channel
The channel that is available again.
Set airwing.
Set call sign.
Defined in:
SQUADRON
Parameters:
#number Callsign
Callsign from CALLSIGN.Aircraft, e.g. "Chevy" for CALLSIGN.Aircraft.CHEVY.
#number Index
Callsign index, Chevy-1.
Return value:
self
Set max engagement range.
Defined in:
SQUADRON
Parameter:
#number EngageRange
Engagement range in NM. Default 80 NM.
Return value:
self
Set livery painted on all squadron aircraft.
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:
SQUADRON
Parameter:
#string LiveryName
Name of the livery.
Return value:
self
Set modex.
Defined in:
SQUADRON
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 squad uses.
Defined in:
SQUADRON
Parameters:
#number Frequency
Radio frequency in MHz. Default 251 MHz.
#number Modulation
Radio modulation. Default 0=AM.
Return value:
self
Usage:
mysquadron:SetSkill(AI.Skill.EXCELLENT)Set skill level of all squadron team members.
Defined in:
SQUADRON
Parameter:
#string Skill
Skill of all flights.
Return value:
self
Usage:
mysquadron:SetSkill(AI.Skill.EXCELLENT)Triggers the FSM event "Start".
Starts the SQUADRON. Initializes parameters and starts event handlers.
Defined in:
SQUADRON
Triggers the FSM event "Start" after a delay.
Starts the SQUADRON. Initializes parameters and starts event handlers.
Defined in:
SQUADRON
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Status" after a delay.
Defined in:
SQUADRON
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Stop" after a delay.
Stops the SQUADRON and all its event handlers.
Defined in:
SQUADRON
Parameter:
#number delay
Delay in seconds.
On after Start event.
Starts the FLIGHTGROUP FSM and event handlers.
Defined in:
SQUADRON
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "Status" event.
Defined in:
SQUADRON
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "Stop" event.
Defined in:
SQUADRON
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Field(s)
Name of the class.
Debug mode. Messages to all about status.
Number of asset flight groups this squadron has.
TACAN max channel.
TACAN min channel.
Table of used TACAN channels.
Type of the airframe the squadron is using.
Squadron assets.
Generalized attribute of the squadron template group.
Callsign name.
Counter to increase callsign names for new assets.
Engagement range in meters.
Class id string for output to DCS log file.
Livery of the squadron.
Capabilities (mission types and performances) of the squadron.
Modex.
Counter to incease modex number for assets.
Name of the squadron.
Radio frequency in MHz the squad uses.
Radio modulation the squad uses.
For refuelable squads, the refuel system used (boom=0 or probpe=1). Default nil.
Skill of squadron members.
For tanker squads, the refuel system used (boom=0 or probpe=1). Default nil.
Name of the template group.
SQUADRON class version.
Function(s)
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.
Defined in:
Returns a table of the SubFSM rules defined within the FSM.
Returns the start state of the FSM.
Defined in:
Returns a table of the transition rules defined within the FSM.
Sets the start state of the FSM.
Field(s)
Name of the class.
Debug mode. Messages to all about status.
Number of asset flight groups this squadron has.
TACAN max channel.
TACAN min channel.
Table of used TACAN channels.
Type of the airframe the squadron is using.
Squadron assets.
Generalized attribute of the squadron template group.
Callsign name.
Counter to increase callsign names for new assets.
Engagement range in meters.
Class id string for output to DCS log file.
Livery of the squadron.
Capabilities (mission types and performances) of the squadron.
Modex.
Counter to incease modex number for assets.
Name of the squadron.
Radio frequency in MHz the squad uses.
Radio modulation the squad uses.
For refuelable squads, the refuel system used (boom=0 or probpe=1). Default nil.
Skill of squadron members.
For tanker squads, the refuel system used (boom=0 or probpe=1). Default nil.
Name of the template group.
SQUADRON class version.
Function(s)
Clear the state of an object.
Defined in:
Parameters:
Object
The object that holds the Value set by the Key.
StateName
The key that is should be cleared.
Creation of a Birth Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
#string IniUnitName
The initiating unit name.
place
subplace
Creation of a Crash Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Creation of a Dead Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Creation of a 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 Event
#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.
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.
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.
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
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 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
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