Module Functional.Stratego
Functional - Stratego.
Main Features:
- Helper class for mission designers to support classic capture-the-base scenarios.
- Creates a network of possible connections between bases (airbases, FARPs, Ships), Ports (defined as zones) and POIs (defined as zones).
- Assigns a strategic value to each of the resulting nodes.
- Can create a list of targets for your next mission move, both strategic and consolidation targets.
- Can be used with budgets to limit the target selection.
- Highly configureable.
Author: applevangelist
Global(s)
Global STRATEGO |
If you see what is right and fail to act on it, you lack courage --- Confucius The STRATEGO ConceptSTRATEGO is a helper class for mission designers. |
If you see what is right and fail to act on it, you lack courage --- Confucius
The STRATEGO Concept
STRATEGO is a helper class for mission designers.
The basic idea is to create a network of nodes (bases) on the map, which each have a number of connections to other nodes. The base value of each node is the number of runways of the base (the bigger the more important), or in the case of Ports and POIs, the assigned value points. The strategic value of each base is determined by the number of routes going in and out of the node, where connections between more strategic nodes add a higher value to the strategic value than connections to less valueable nodes.
Setup
Setup is map indepent and works automatically. All airbases, FARPS, and ships on the map are considered. Note: Later spawned objects are not considered at the moment.
-- Setup and start STRATGEO for the blue side, maximal node distance is 100km
local Bluecher = STRATEGO:New("Bluecher",coalition.side.BLUE,100)
-- use budgets
Bluecher:SetUsingBudget(true,500)
-- draw on the map
Bluecher:SetDebug(true,true,true)
-- Start
Bluecher:Start()
Helper
STRATEGO.SetWeights(): Set weights for nodes and routes to determine their importance.
Hint
Each node is its own Ops.OpsZone#OPSZONE object to manage the coalition alignment of that node and how it can be conquered.
Distance
The node distance factor determines how many connections are there on the map. The smaller the lighter is the resulting net. The higher the thicker it gets, with more strategic options. Play around with the distance to get an optimal map for your scenario.
One some maps, e.g. Syria, lower distance factors can create "islands" of unconnected network parts on the map. FARPs and POIs can bridge those gaps, or you can add routes manually.
STRATEGO.AddRoutesManually(): Add a route manually.
Ports and POIs
Ports and POIs are Core.Zone#ZONE objects on the map with specfic values. Zones with the keywords "Port" or "POI" in the name are automatically considered at setup time.
Get next possible targets
There are two types of possible target lists, strategic and consolidation. Targets closer to the start node are chosen as possible targets.
* Strategic targets are of higher or equal base weight from a given start point. Can also be obtained for the whole net.
* Consoliation targets are of smaller or equal base weight from a given start point. Can also be obtained for the whole net.
STRATEGO.UpdateNodeCoalitions(): Update alls node's coalition data before takign a decision.
STRATEGO.FindStrategicTargets(): Find a list of possible strategic targets in the network of the enemy or neutral coalition.
STRATEGO.FindConsolidationTargets(): Find a list of possible strategic targets in the network of the enemy or neutral coalition.
STRATEGO.FindAffordableStrategicTarget(): When using budgets, find one strategic target you can afford.
STRATEGO.FindAffordableConsolidationTarget(): When using budgets, find one consolidation target you can afford.
STRATEGO.FindClosestStrategicTarget(): Find closest strategic target from a given start point.
STRATEGO.FindClosestConsolidationTarget(): Find closest consolidation target from a given start point.
STRATEGO.GetHighestWeightNodes(): Get a list of the nodes with the highest weight. Coalition independent.
STRATEGO.GetNextHighestWeightNodes(): Get a list of the nodes a weight less than the give parameter. Coalition independent.
How you act on these suggestions is again totally up to your mission design.
Using budgets
Set up STRATEGO to use budgets to limit the target selection. How your side actually earns budgets is up to your mission design. However, when using budgets, a target will only be selected, when you have more budget points available than the value points of the targeted base.
-- use budgets
Bluecher:SetUsingBudget(true,500)
Helpers:
STRATEGO.GetBudget(): Get the current budget points.
STRATEGO.AddBudget(): Add a number of budget points.
STRATEGO.SubtractBudget(): Subtract a number of budget points.
STRATEGO.SetNeutralBenefit(): Set neutral benefit, i.e. how many points it is cheaper to decide for a neutral vs an enemy node when taking decisions.
Functions to query a node's data
STRATEGO.GetNodeBaseWeight(): Get the base weight of a node by its name.
STRATEGO.GetNodeCoalition(): Get the COALITION of a node by its name.
STRATEGO.GetNodeType(): Get the TYPE of a node by its name.
STRATEGO.GetNodeZone(): Get the ZONE of a node by its name.
STRATEGO.GetNodeOpsZone(): Get the OPSZONE of a node by its name.
STRATEGO.GetNodeCoordinate(): Get the COORDINATE of a node by its name.
STRATEGO.IsAirbase(): Check if the TYPE of a node is AIRBASE.
STRATEGO.IsPort(): Check if the TYPE of a node is PORT.
STRATEGO.IsPOI(): Check if the TYPE of a node is POI.
STRATEGO.IsFARP(): Check if the TYPE of a node is FARP.
STRATEGO.IsShip(): Check if the TYPE of a node is SHIP.
Various
STRATEGO.FindNeighborNodes(): Get neighbor nodes of a named node.
STRATEGO.FindRoute(): Find a route between two nodes.
STRATEGO.SetCaptureOptions(): Set how many units of which minimum threat level are needed to capture one node (i.e. the underlying OpsZone).
STRATEGO.SetDebug(): Set debug and draw options.
STRATEGO.SetStrategoZone(): Set a zone to restrict STRATEGO analytics to, can be any kind of ZONE Object.
Visualisation example code for the Syria map:
local Bluecher = STRATEGO:New("Bluecher",coalition.side.BLUE,100)
Bluecher:SetDebug(true,true,true)
Bluecher:Start()
Bluecher:AddRoutesManually(AIRBASE.Syria.Beirut_Rafic_Hariri,AIRBASE.Syria.Larnaca)
Bluecher:AddRoutesManually(AIRBASE.Syria.Incirlik,AIRBASE.Syria.Hatay)
Bluecher:AddRoutesManually(AIRBASE.Syria.Incirlik,AIRBASE.Syria.Minakh)
Bluecher:AddRoutesManually(AIRBASE.Syria.King_Hussein_Air_College,AIRBASE.Syria.H4)
Bluecher:AddRoutesManually(AIRBASE.Syria.Sayqal,AIRBASE.Syria.At_Tanf)
local route = Bluecher:FindRoute(AIRBASE.Syria.Rosh_Pina,AIRBASE.Syria.Incirlik,5,true)
UTILS.PrintTableToLog(route,1)
Type(s)
| Fields and Methods inherited from STRATEGO | Description |
|---|---|
|
[USER] Add budget points. |
|
STRATEGO:AddRoutesManually(Startpoint, Endpoint, Color, Linetype, Draw) |
[USER] Manually add a route, for e.g. |
|
[INTERNAL] Analyse airbase setups |
|
|
[INTERNAL] Analyse POI setups |
|
|
[INTERNAL] Analyse routes |
|
|
[INTERNAL] Analyse non-connected points. |
|
|
[USER] Find one affordable consolidation target. |
|
|
[USER] Find one affordable strategic target. |
|
STRATEGO:FindClosestConsolidationTarget(Startpoint, BaseWeight) |
[USER] Get the next best consolidation target node with a lower BaseWeight. |
|
[USER] Get the next best strategic target node with same or higher Consolidated Weight. |
|
|
[USER] Get the next best consolidation target nodes in the network. |
|
|
[USER] Get neighbor nodes of a named node. |
|
|
[USER] Find a route between two nodes. |
|
|
[USER] Get the next best strategic target nodes in the network. |
|
|
[USER] Get budget points. |
|
|
[USER] Get a list of the nodes with the highest weight. |
|
|
[INTERNAL] Get an OpsZone from a Zone object. |
|
|
[USER] Get a list of the nodes a weight less than the given parameter. |
|
|
[USER] Get the base weight of a node by its name. |
|
|
[USER] Get the COALITION of a node by its name. |
|
|
[USER] Get the COORDINATE of a node by its name. |
|
|
[USER] Get the OPSZONE of a node by its name. |
|
|
[USER] Get the TYPE of a node by its name. |
|
|
[USER] Get the aggregated weight of a node by its name. |
|
|
[USER] Get the ZONE of a node by its name. |
|
|
[INTERNAL] Get nice route text |
|
|
[USER] Check if the TYPE of a node is AIRBASE. |
|
|
[USER] Check if the TYPE of a node is FARP. |
|
|
[USER] Check if the TYPE of a node is POI. |
|
|
[USER] Check if the TYPE of a node is PORT. |
|
|
[USER] Check if the TYPE of a node is SHIP. |
|
|
[USER] Create a new STRATEGO object and start it up. |
|
STRATEGO:OnAfterNodeEvent(From, Event, To, OpsZone, Coalition) |
FSM Function OnAfterNodeEvent. |
STRATEGO:SetCaptureOptions(CaptureUnits, CaptureThreatlevel) |
[USER] Set how many units of which minimum threat level are needed to capture one node (i.e. |
|
[USER] Set debugging. |
|
|
[USER] Set neutral benefit, i.e. |
|
|
[USER] Set the base weight of a single node found by its name manually. |
|
|
[USER] Set the aggregated weight of a single node found by its name manually. |
|
|
[USER] Restrict Stratego to analyse this zone only. |
|
|
[USER] Set up usage of budget and set an initial budget in points. |
|
STRATEGO:SetWeights(MaxRunways, PortWeight, POIWeight, RouteFactor) |
[USER] Set weights for nodes and routes to determine their importance. |
|
Triggers the FSM event "Start". |
|
|
Triggers the FSM event "Stop". |
|
|
[USER] Subtract budget points. |
|
|
[INTERNAL] Update node coalitions |
|
|
Triggers the FSM event "Start" after a delay. |
|
|
Triggers the FSM event "Stop" after a delay. |
|
|
[INTERNAL] FSM function for initial setup and getting ready. |
|
|
[INTERNAL] Update knot association |
|
| 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. |
|
STRATEGO:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) |
Creation of a Birth Event. |
STRATEGO:CreateEventCrash(EventTime, Initiator, IniObjectCategory) |
Creation of a Crash Event. |
STRATEGO:CreateEventDead(EventTime, Initiator, IniObjectCategory) |
Creation of a Dead Event. |
|
Creation of a |
|
|
Creation of a Remove Unit Event. |
|
|
Creation of a Takeoff Event. |
|
|
Creation of a Crash Event. |
|
|
Log an exception which will be traced always. |
|
|
Returns the event dispatcher |
|
|
Remove all subscribed events |
|
|
Trace a function call. |
|
|
Trace a function call level 2. |
|
|
Trace a function call level 3. |
|
|
Get the ClassID of the class instance. |
|
|
Get the ClassName of the class instance. |
|
|
Get the ClassName + ClassID of the class instance. |
|
|
Get the Class Core.Event processing Priority. |
|
|
This is the worker method to retrieve the Parent class. |
|
|
Get a Value given a Key from the Object. |
|
|
Subscribe to a DCS Event. |
|
|
Log an information which will be traced always. |
|
|
This is the worker method to inherit from a parent class. |
|
|
This is the worker method to check if an object is an (sub)instance of a class. |
|
|
Enquires if tracing is on (for the class). |
|
|
BASE constructor. |
|
|
Occurs when an Event for an object is triggered. |
|
|
BDA. |
|
|
Occurs when a ground unit captures either an airbase or a farp. |
|
|
Occurs when any object is spawned into the mission. |
|
|
Occurs when any aircraft crashes into the ground and is completely destroyed. |
|
|
Occurs when an object is dead. |
|
|
Unknown precisely what creates this event, likely tied into newer damage model. |
|
|
Discard chair after ejection. |
|
|
Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs when any aircraft shuts down its engines. |
|
|
Occurs when any aircraft starts its engines. |
|
|
Occurs whenever an object is hit by a weapon. |
|
|
Occurs when any system fails on a human controlled aircraft. |
|
|
Occurs on the death of a unit. |
|
|
Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up. |
|
|
Landing quality mark. |
|
|
Occurs when a new mark was added. |
|
|
Occurs when a mark text was changed. |
|
|
Occurs when a mark was removed. |
|
|
Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Weapon add. |
|
|
Occurs when the pilot of an aircraft is killed. |
|
|
Occurs when a player enters a slot and takes control of an aircraft. |
|
|
Occurs when any player assumes direct control of a unit. |
|
|
Occurs when any player relieves control of a unit to the AI. |
|
|
Occurs when an aircraft connects with a tanker and begins taking on fuel. |
|
|
Occurs when an aircraft is finished taking fuel. |
|
|
Occurs when any modification to the "Score" as seen on the debrief menu would occur. |
|
|
Occurs when any unit stops firing its weapon. |
|
|
Occurs when any unit begins firing a weapon that has a high rate of fire. |
|
|
Occurs whenever any unit in a mission fires a weapon. |
|
|
Occurs when an aircraft takes off from an airbase, farp, or ship. |
|
|
Trigger zone. |
|
|
Occurs when the game thinks an object is destroyed. |
|
|
Schedule a new time event. |
|
STRATEGO:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...) |
Schedule a new time event. |
|
Stops the Schedule. |
|
|
Set the Class Core.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. |
|
STRATEGO:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function call. |
|
(Internal) Serialize arguments |
|
STRATEGO:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function logic. |
|
The main event handling function... |
| Fields and Methods inherited from STRATEGO.Data | Description |
|---|---|
| Fields and Methods inherited from STRATEGO.DistData | Description |
|---|---|
| Fields and Methods inherited from STRATEGO.Target | Description |
|---|---|
|
|
|
| Fields and Methods inherited from STRATEGO.Type | Description |
|---|---|
- STRATEGO class, extends Core.Base#BASE
Field(s)
Function(s)
[USER] Add budget points.
[USER] Manually add a route, for e.g.
Island hopping or to connect isolated networks. Use after STRATEGO has been started!
Defined in:
STRATEGO
Parameters:
#string Startpoint
Starting Point, e.g. AIRBASE.Syria.Hatay
#string Endpoint
End Point, e.g. AIRBASE.Syria.H4
#table Color
(Optional) RGB color table {r, g, b}, e.g. {1,0,0} for red. Defaults to lila.
#number Linetype
(Optional) Line type: 0=No line, 1=Solid, 2=Dashed, 3=Dotted, 4=Dot dash, 5=Long dash, 6=Two dash. Default 5.
#boolean Draw
(Optional) If true, draw route on the F10 map. Defaukt false.
Return value:
self
[INTERNAL] Analyse airbase setups
[INTERNAL] Analyse POI setups
[INTERNAL] Analyse routes
[INTERNAL] Analyse non-connected points.
[USER] Find one affordable consolidation target.
Defined in:
STRATEGO
Return value:
#table:
Target Table with #STRATEGO.Target data or nil if none found.
[USER] Find one affordable strategic target.
Defined in:
STRATEGO
Return value:
#table:
Target Table with #STRATEGO.Target data or nil if none found.
[USER] Get the next best consolidation target node with a lower BaseWeight.
Defined in:
STRATEGO
Parameters:
#string Startpoint
Name of start point.
#number BaseWeight
Base weight of the node, i.e. the number of runways of an airbase or the weight of ports or POIs.
Return values:
#number:
ShortestDist Shortest distance found.
#string:
Name Name of the target node.
#number:
Weight Consolidated weight of the target node, zero if none found.
#number:
Coalition Coaltion of the target.
[USER] Get the next best strategic target node with same or higher Consolidated Weight.
Defined in:
STRATEGO
Parameters:
#string Startpoint
Name of start point.
#number Weight
Consolidated Weight of the node, i.e. the calculated weight of the node based on number of runways, connections and a weight factor.
Return values:
#number:
ShortestDist Shortest distance found.
#string:
Name Name of the target node.
#number:
Weight Consolidated weight of the target node, zero if none found.
#number:
Coalition Coaltion of the target.
[USER] Get the next best consolidation target nodes in the network.
Defined in:
STRATEGO
Return value:
#table:
of #STRATEGO.Target data points
[USER] Get neighbor nodes of a named node.
Defined in:
STRATEGO
Parameters:
#string Name
The name to search the neighbors for.
#boolean Enemies
(optional) If true, find only enemy neighbors.
#boolean Friends
(optional) If true, find only friendly or neutral neighbors.
Return values:
#table:
Neighbors Table of #STRATEGO.DistData entries indexed by neighbor node names.
#string:
Nearest Name of the nearest node.
#number:
Distance Distance of the nearest node.
[USER] Find a route between two nodes.
Defined in:
STRATEGO
Parameters:
#string Start
The name of the start node.
#string End
The name of the end node.
#number Hops
Max iterations to find a route.
#boolean Draw
If true, draw the route on the map.
#table Color
(Optional) RGB color table {r, g, b}, e.g. {1,0,0} for red. Defaults to black.
#number LineType
(Optional) Line type: 0=No line, 1=Solid, 2=Dashed, 3=Dotted, 4=Dot dash, 5=Long dash, 6=Two dash. Default 6.
Return values:
#table:
Route Table of #string name entries of the route
#boolean:
Complete If true, the route was found end-to-end.
[USER] Get the next best strategic target nodes in the network.
Defined in:
STRATEGO
Return value:
#table:
of #STRATEGO.Target data points
[USER] Get a list of the nodes with the highest weight.
Defined in:
STRATEGO
Parameter:
#number Coalition
(Optional) Find for this coalition only. E.g. coalition.side.BLUE.
Return values:
#table:
Table of nodes.
#number:
Weight The consolidated weight associated with the nodes.
[INTERNAL] Get an OpsZone from a Zone object.
[USER] Get a list of the nodes a weight less than the given parameter.
Defined in:
STRATEGO
Parameters:
#number Weight
Weight - nodes need to have less than this weight.
#number Coalition
(Optional) Find for this coalition only. E.g. coalition.side.BLUE.
Return values:
#table:
Table of nodes.
#number:
Weight The consolidated weight associated with the nodes.
[USER] Get the base weight of a node by its name.
Defined in:
STRATEGO
Parameter:
#string Name
The name to look for.
Return value:
#number:
Weight The base weight or 0 if not found.
[USER] Get the COALITION of a node by its name.
Defined in:
STRATEGO
Parameters:
#string The
name to look for.
Name
Return value:
#number:
Coalition The coalition.
[USER] Get the COORDINATE of a node by its name.
Defined in:
STRATEGO
Parameters:
#string The
name to look for.
Name
Return value:
Coordinate The Coordinate of the node or nil if not found.
[USER] Get the OPSZONE of a node by its name.
Defined in:
STRATEGO
Parameters:
#string The
name to look for.
Name
Return value:
OpsZone The OpsZone of the node or nil if not found.
[USER] Get the TYPE of a node by its name.
Defined in:
STRATEGO
Parameters:
#string The
name to look for.
Name
Return value:
#string:
Type Type of the node, e.g. STRATEGO.Type.AIRBASE or nil if not found.
[USER] Get the aggregated weight of a node by its name.
Defined in:
STRATEGO
Parameter:
#string Name
The name to look for.
Return value:
#number:
Weight The weight or 0 if not found.
[USER] Get the ZONE of a node by its name.
Defined in:
STRATEGO
Parameters:
#string The
name to look for.
Name
Return value:
Zone The Zone of the node or nil if not found.
[INTERNAL] Get nice route text
[USER] Check if the TYPE of a node is AIRBASE.
Defined in:
STRATEGO
Parameters:
#string The
name to look for.
Name
Return value:
#boolean:
Outcome
[USER] Check if the TYPE of a node is FARP.
Defined in:
STRATEGO
Parameters:
#string The
name to look for.
Name
Return value:
#boolean:
Outcome
[USER] Check if the TYPE of a node is POI.
Defined in:
STRATEGO
Parameters:
#string The
name to look for.
Name
Return value:
#boolean:
Outcome
[USER] Check if the TYPE of a node is PORT.
Defined in:
STRATEGO
Parameters:
#string The
name to look for.
Name
Return value:
#boolean:
Outcome
[USER] Check if the TYPE of a node is SHIP.
Defined in:
STRATEGO
Parameters:
#string The
name to look for.
Name
Return value:
#boolean:
Outcome
[USER] Create a new STRATEGO object and start it up.
Defined in:
STRATEGO
Parameters:
#string Name
Name of the Adviser.
#number Coalition
Coalition, e.g. coalition.side.BLUE.
#number MaxDist
Maximum distance of a single route in kilometers, defaults to 150.
Return value:
self
FSM Function OnAfterNodeEvent.
A node changed coalition.
Defined in:
STRATEGO
Parameters:
#string From
State.
#string Event
Trigger.
#string To
State.
Ops.OpsZone#OPSZONE OpsZone
The OpsZone triggering the event.
#number Coalition
The coalition of the new owner.
Return value:
self
[USER] Set how many units of which minimum threat level are needed to capture one node (i.e.
the underlying OpsZone).
Defined in:
STRATEGO
Parameters:
#number CaptureUnits
Number of units needed, defaults to three.
#number CaptureThreatlevel
Threat level needed, can be 0..10, defaults to one.
Return value:
self
[USER] Set debugging.
Defined in:
STRATEGO
Parameters:
#boolean Debug
If true, switch on debugging.
#boolean DrawZones
If true, draw the OpsZones on the F10 map.
#boolean MarkZones
if true, mark the OpsZones on the F10 map (with further information).
[USER] Set neutral benefit, i.e.
how many points it is cheaper to decide for a neutral vs an enemy node when taking decisions.
Defined in:
STRATEGO
Parameter:
#number NeutralBenefit
Pointsm defaults to 100.
Return value:
self
[USER] Set the base weight of a single node found by its name manually.
Defined in:
STRATEGO
Parameters:
#string Name
The name to look for.
#number Weight
The weight to be set.
Return value:
#boolean:
success
[USER] Set the aggregated weight of a single node found by its name manually.
Defined in:
STRATEGO
Parameters:
#string Name
The name to look for.
#number Weight
The weight to be set.
Return value:
#boolean:
success
[USER] Restrict Stratego to analyse this zone only.
Defined in:
STRATEGO
Parameter:
Core.Zone#ZONE Zone
The Zone to restrict Stratego to, can be any kind of ZONE Object.
Return value:
self
[USER] Set up usage of budget and set an initial budget in points.
Defined in:
STRATEGO
Parameters:
#boolean Usebudget
If true, use budget for advisory calculations.
#number StartBudget
Initial budget to be used, defaults to 500.
[USER] Set weights for nodes and routes to determine their importance.
Defined in:
STRATEGO
Parameters:
#number MaxRunways
Set the maximum number of runways the big (equals strategic) airbases on the map have. Defaults to 3. The weight of an airbase node hence equals the number of runways.
#number PortWeight
Set what weight a port node has. Defaults to 3.
#number POIWeight
Set what weight a POI node has. Defaults to 1.
#number RouteFactor
Defines which weight each route between two defined nodes gets: Weight * RouteFactor.
Return value:
self
Triggers the FSM event "Start".
Starts the STRATEGO. Initializes parameters and starts event handlers.
Defined in:
STRATEGO
Triggers the FSM event "Stop".
Stops the STRATEGO and all its event handlers.
Defined in:
STRATEGO
[USER] Subtract budget points.
[INTERNAL] Update node coalitions
Triggers the FSM event "Start" after a delay.
Starts the STRATEGO. Initializes parameters and starts event handlers.
Defined in:
STRATEGO
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Stop" after a delay.
Stops the STRATEGO and all its event handlers.
Defined in:
STRATEGO
Parameter:
#number delay
Delay in seconds.
[INTERNAL] FSM function for initial setup and getting ready.
[INTERNAL] Update knot association
Field(s)
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.
IniObjectCategory
Creation of a Dead Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
IniObjectCategory
Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.
Creation of a Remove Unit Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Creation of a Takeoff Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Creation of a Crash Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Log an exception which will be traced always.
Can be anywhere within the function logic.
Returns the event dispatcher
Remove all subscribed events
Trace a function call.
Must be at the beginning of the function logic.
Trace a function call level 2.
Must be at the beginning of the function logic.
Trace a function call level 3.
Must be at the beginning of the function logic.
Get the ClassID of the class instance.
Get the ClassName of the class instance.
Get the ClassName + ClassID of the class instance.
The ClassName + ClassID is formatted as '%s#%09d'.
Get the Class Core.Event processing Priority.
The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.
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, set to nil, or garbage collected, then the Values and Keys will also be gone.
Defined in:
Parameters:
Object
The object that holds the Value set by the Key.
Key
The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!
Return value:
The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.
Subscribe to a DCS Event.
Defined in:
Parameters:
Core.Event#EVENTS EventID
Event ID.
#function EventFunction
(optional) The function to be called when the event occurs for the unit.
Return value:
Log an information which will be traced always.
Can be anywhere within the function logic.
This is the worker method to inherit from a parent class.
Defined in:
Parameters:
Child
is the Child class that inherits.
#BASE Parent
is the Parent class that the Child inherits from.
Return value:
Child
This is the worker method to check if an object is an (sub)instance of a class.
Examples:
ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false
Defined in:
Parameter:
ClassName
is the name of the class or the class itself to run the check against
Return value:
#boolean:
Enquires if tracing is on (for the class).
BASE constructor.
This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.
function EVENT:New()
local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
return self
end
Occurs when an Event for an object is triggered.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that triggered the event.
Occurs when a ground unit captures either an airbase or a farp.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.
Occurs when any object is spawned into the mission.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was spawned
Occurs when any aircraft crashes into the ground and is completely destroyed.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that has crashed
Occurs when an object is dead.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is dead.
Unknown precisely what creates this event, likely tied into newer damage model.
Will update this page when new information become available.
- initiator: The unit that had the failure.
Discard chair after ejection.
Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.
initiator : The unit that has ejected
Occurs when any aircraft shuts down its engines.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is stopping its engines.
Occurs when any aircraft starts its engines.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is starting its engines.
Occurs whenever an object is hit by a weapon.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.
Occurs when any system fails on a human controlled aircraft.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that had the failure
Occurs on the death of a unit.
Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs. Have a look at the class Core.Event#EVENT as these are just the prototypes.
- initiator: The unit that killed the target
- target: Target Object
- weapon: Weapon Object
Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes.
initiator : The unit that has landed place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships
Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.
Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker. Have a look at the class Core.Event#EVENT as these are just the prototypes.
- initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
- place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
- subplace: is always 0 for unknown reasons.
Occurs when a new mark was added.
Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.
Occurs when a mark text was changed.
Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.
Occurs when a mark was removed.
Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.
Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes.
Weapon add.
Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when the pilot of an aircraft is killed.
Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the pilot has died in.
Occurs when a player enters a slot and takes control of an aircraft.
Have a look at the class Core.Event#EVENT as these are just the prototypes. NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. initiator : The unit that is being taken control of.
Occurs when any player assumes direct control of a unit.
Note - not Mulitplayer safe. Use PlayerEnterAircraft. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is being taken control of.
Occurs when any player relieves control of a unit to the AI.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the player left.
Occurs when an aircraft connects with a tanker and begins taking on fuel.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is receiving fuel.
Occurs when an aircraft is finished taking fuel.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was receiving fuel.
Occurs when any modification to the "Score" as seen on the debrief menu would occur.
There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard. Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when any unit stops firing its weapon.
Event will always correspond with a shooting start event. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was doing the shooting.
Occurs when any unit begins firing a weapon that has a high rate of fire.
Most common with aircraft cannons (GAU-8), autocannons, and machine guns. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is doing the shooting. target: The unit that is being targeted.
Occurs whenever any unit in a mission fires a weapon.
But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when an aircraft takes off from an airbase, farp, or ship.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships
Occurs when the game thinks an object is destroyed.
Have a look at the class Core.Event#EVENT as these are just the prototypes.
- initiator: The unit that is was destroyed.
Schedule a new time event.
Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.
Defined in:
Parameters:
#number Start
Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
#function SchedulerFunction
The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
#table ...
Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
Return value:
#string:
The Schedule ID of the planned schedule.
Schedule a new time event.
Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.
Defined in:
Parameters:
#number Start
Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
#number Repeat
Specifies the interval in seconds when the scheduler will call the event function.
#number RandomizeFactor
Specifies a randomization factor between 0 and 1 to randomize the Repeat.
#number Stop
Specifies the amount of seconds when the scheduler will be stopped.
#function SchedulerFunction
The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
#table ...
Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
Return value:
#string:
The Schedule ID of the planned schedule.
Stops the Schedule.
Defined in:
Parameter:
#string SchedulerID
(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.
Set the Class Core.Event processing Priority.
The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.
Set a state or property of the Object given a Key and a Value.
Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.
Defined in:
Parameters:
Object
The object that will hold the Value set by the Key.
Key
The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!
Value
The value to is stored in the object.
Return value:
The Value set.
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
(Internal) Serialize arguments
Trace a function logic.
Defined in:
Parameters:
Arguments
A #table or any field.
DebugInfoCurrentParam
DebugInfoFromParam
The main event handling function...
This function captures all events generated for the class.
Field(s)
Function(s)
Field(s)
Function(s)
Field(s)