mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
1451 lines
51 KiB
Lua
1451 lines
51 KiB
Lua
--- **Core** - The base class within the framework.
|
|
--
|
|
-- ===
|
|
--
|
|
-- ## Features:
|
|
--
|
|
-- * The construction and inheritance of MOOSE classes.
|
|
-- * The class naming and numbering system.
|
|
-- * The class hierarchy search system.
|
|
-- * The tracing of information or objects during mission execution for debugging purposes.
|
|
-- * The subscription to DCS events for event handling in MOOSE objects.
|
|
-- * Object inspection.
|
|
--
|
|
-- ===
|
|
--
|
|
-- All classes within the MOOSE framework are derived from the BASE class.
|
|
-- Note: The BASE class is an abstract class and is not meant to be used directly.
|
|
--
|
|
-- ===
|
|
--
|
|
-- ### Author: **FlightControl**
|
|
-- ### Contributions:
|
|
--
|
|
-- ===
|
|
--
|
|
-- @module Core.Base
|
|
-- @image Core_Base.JPG
|
|
|
|
local _TraceOnOff = false -- default to no tracing
|
|
local _TraceLevel = 1
|
|
local _TraceAll = false
|
|
local _TraceClass = {}
|
|
local _TraceClassMethod = {}
|
|
|
|
local _ClassID = 0
|
|
|
|
---
|
|
-- @type BASE
|
|
-- @field ClassName The name of the class.
|
|
-- @field ClassID The ID number of the class.
|
|
-- @field ClassNameAndID The name of the class concatenated with the ID number of the class.
|
|
|
|
--- BASE class
|
|
--
|
|
-- # 1. BASE constructor.
|
|
--
|
|
-- Any class derived from BASE, will use the @{Core.Base#BASE.New} constructor embedded in the @{Core.Base#BASE.Inherit} method.
|
|
-- See an example at the @{Core.Base#BASE.New} method how this is done.
|
|
--
|
|
-- # 2. Trace information for debugging.
|
|
--
|
|
-- The BASE class contains trace methods to trace progress within a mission execution of a certain object.
|
|
-- These trace methods are inherited by each MOOSE class inheriting BASE, thus all objects created from
|
|
-- a class derived from BASE can use the tracing methods to trace its execution.
|
|
--
|
|
-- Any type of information can be passed to these tracing methods. See the following examples:
|
|
--
|
|
-- self:E( "Hello" )
|
|
--
|
|
-- Result in the word "Hello" in the dcs.log.
|
|
--
|
|
-- local Array = { 1, nil, "h", { "a","b" }, "x" }
|
|
-- self:E( Array )
|
|
--
|
|
-- Results with the text [1]=1,[3]="h",[4]={[1]="a",[2]="b"},[5]="x"} in the dcs.log.
|
|
--
|
|
-- local Object1 = "Object1"
|
|
-- local Object2 = 3
|
|
-- local Object3 = { Object 1, Object 2 }
|
|
-- self:E( { Object1, Object2, Object3 } )
|
|
--
|
|
-- Results with the text [1]={[1]="Object",[2]=3,[3]={[1]="Object",[2]=3}} in the dcs.log.
|
|
--
|
|
-- local SpawnObject = SPAWN:New( "Plane" )
|
|
-- local GroupObject = GROUP:FindByName( "Group" )
|
|
-- self:E( { Spawn = SpawnObject, Group = GroupObject } )
|
|
--
|
|
-- Results with the text [1]={Spawn={....),Group={...}} in the dcs.log.
|
|
--
|
|
-- Below a more detailed explanation of the different method types for tracing.
|
|
--
|
|
-- ## 2.1. Tracing methods categories.
|
|
--
|
|
-- There are basically 3 types of tracing methods available:
|
|
--
|
|
-- * @{#BASE.F}: Used to trace the entrance of a function and its given parameters. An F is indicated at column 44 in the DCS.log file.
|
|
-- * @{#BASE.T}: Used to trace further logic within a function giving optional variables or parameters. A T is indicated at column 44 in the DCS.log file.
|
|
-- * @{#BASE.E}: Used to always trace information giving optional variables or parameters. An E is indicated at column 44 in the DCS.log file.
|
|
--
|
|
-- ## 2.2 Tracing levels.
|
|
--
|
|
-- There are 3 tracing levels within MOOSE.
|
|
-- These tracing levels were defined to avoid bulks of tracing to be generated by lots of objects.
|
|
--
|
|
-- As such, the F and T methods have additional variants to trace level 2 and 3 respectively:
|
|
--
|
|
-- * @{#BASE.F2}: Trace the beginning of a function and its given parameters with tracing level 2.
|
|
-- * @{#BASE.F3}: Trace the beginning of a function and its given parameters with tracing level 3.
|
|
-- * @{#BASE.T2}: Trace further logic within a function giving optional variables or parameters with tracing level 2.
|
|
-- * @{#BASE.T3}: Trace further logic within a function giving optional variables or parameters with tracing level 3.
|
|
--
|
|
-- ## 2.3. Trace activation.
|
|
--
|
|
-- Tracing can be activated in several ways:
|
|
--
|
|
-- * Switch tracing on or off through the @{#BASE.TraceOnOff}() method.
|
|
-- * Activate all tracing through the @{#BASE.TraceAll}() method.
|
|
-- * Activate only the tracing of a certain class (name) through the @{#BASE.TraceClass}() method.
|
|
-- * Activate only the tracing of a certain method of a certain class through the @{#BASE.TraceClassMethod}() method.
|
|
-- * Activate only the tracing of a certain level through the @{#BASE.TraceLevel}() method.
|
|
--
|
|
-- ## 2.4. Check if tracing is on.
|
|
--
|
|
-- The method @{#BASE.IsTrace}() will validate if tracing is activated or not.
|
|
--
|
|
-- # 3. DCS simulator Event Handling.
|
|
--
|
|
-- The BASE class provides methods to catch DCS Events. These are events that are triggered from within the DCS simulator,
|
|
-- and handled through lua scripting. MOOSE provides an encapsulation to handle these events more efficiently.
|
|
--
|
|
-- ## 3.1. Subscribe / Unsubscribe to DCS Events.
|
|
--
|
|
-- At first, the mission designer will need to **Subscribe** to a specific DCS event for the class.
|
|
-- So, when the DCS event occurs, the class will be notified of that event.
|
|
-- There are two methods which you use to subscribe to or unsubscribe from an event.
|
|
--
|
|
-- * @{#BASE.HandleEvent}(): Subscribe to a DCS Event.
|
|
-- * @{#BASE.UnHandleEvent}(): Unsubscribe from a DCS Event.
|
|
--
|
|
-- ## 3.2. Event Handling of DCS Events.
|
|
--
|
|
-- Once the class is subscribed to the event, an **Event Handling** method on the object or class needs to be written that will be called
|
|
-- when the DCS event occurs. The Event Handling method receives an @{Core.Event#EVENTDATA} structure, which contains a lot of information
|
|
-- about the event that occurred.
|
|
--
|
|
-- Find below an example of the prototype how to write an event handling function for two units:
|
|
--
|
|
-- local Tank1 = UNIT:FindByName( "Tank A" )
|
|
-- local Tank2 = UNIT:FindByName( "Tank B" )
|
|
--
|
|
-- -- Here we subscribe to the Dead events. So, if one of these tanks dies, the Tank1 or Tank2 objects will be notified.
|
|
-- Tank1:HandleEvent( EVENTS.Dead )
|
|
-- Tank2:HandleEvent( EVENTS.Dead )
|
|
--
|
|
-- --- This function is an Event Handling function that will be called when Tank1 is Dead.
|
|
-- -- @param Wrapper.Unit#UNIT self
|
|
-- -- @param Core.Event#EVENTDATA EventData
|
|
-- function Tank1:OnEventDead( EventData )
|
|
--
|
|
-- self:SmokeGreen()
|
|
-- end
|
|
--
|
|
-- --- This function is an Event Handling function that will be called when Tank2 is Dead.
|
|
-- -- @param Wrapper.Unit#UNIT self
|
|
-- -- @param Core.Event#EVENTDATA EventData
|
|
-- function Tank2:OnEventDead( EventData )
|
|
--
|
|
-- self:SmokeBlue()
|
|
-- end
|
|
--
|
|
-- See the @{Core.Event} module for more information about event handling.
|
|
--
|
|
-- # 4. Class identification methods.
|
|
--
|
|
-- BASE provides methods to get more information of each object:
|
|
--
|
|
-- * @{#BASE.GetClassID}(): Gets the ID (number) of the object. Each object created is assigned a number, that is incremented by one.
|
|
-- * @{#BASE.GetClassName}(): Gets the name of the object, which is the name of the class the object was instantiated from.
|
|
-- * @{#BASE.GetClassNameAndID}(): Gets the name and ID of the object.
|
|
--
|
|
-- # 5. All objects derived from BASE can have "States".
|
|
--
|
|
-- A mechanism is in place in MOOSE, that allows to let the objects administer **states**.
|
|
-- States are essentially properties of objects, which are identified by a **Key** and a **Value**.
|
|
--
|
|
-- The method @{#BASE.SetState}() can be used to set a Value with a reference Key to the object.
|
|
-- To **read or retrieve** a state Value based on a Key, use the @{#BASE.GetState} method.
|
|
--
|
|
-- These two methods provide a very handy way to keep state at long lasting processes.
|
|
-- Values can be stored within the objects, and later retrieved or changed when needed.
|
|
-- There is one other important thing to note, the @{#BASE.SetState}() and @{#BASE.GetState} methods
|
|
-- receive as the **first parameter the object for which the state needs to be set**.
|
|
-- Thus, if the state is to be set for the same object as the object for which the method is used, then provide the same
|
|
-- object name to the method.
|
|
--
|
|
-- # 6. Inheritance.
|
|
--
|
|
-- The following methods are available to implement inheritance
|
|
--
|
|
-- * @{#BASE.Inherit}: Inherits from a class.
|
|
-- * @{#BASE.GetParent}: Returns the parent object from the object it is handling, or nil if there is no parent object.
|
|
--
|
|
-- ===
|
|
--
|
|
-- @field #BASE
|
|
BASE = {
|
|
ClassName = "BASE",
|
|
ClassID = 0,
|
|
Events = {},
|
|
States = {},
|
|
Debug = debug,
|
|
Scheduler = nil,
|
|
}
|
|
|
|
-- @field #BASE.__
|
|
BASE.__ = {}
|
|
|
|
-- @field #BASE._
|
|
BASE._ = {
|
|
Schedules = {}, --- Contains the Schedulers Active
|
|
}
|
|
|
|
--- The Formation Class
|
|
-- @type FORMATION
|
|
-- @field Cone A cone formation.
|
|
FORMATION = {
|
|
Cone = "Cone",
|
|
Vee = "Vee",
|
|
}
|
|
|
|
--- 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
|
|
--
|
|
-- @param #BASE self
|
|
-- @return #BASE
|
|
function BASE:New()
|
|
--local self = UTILS.DeepCopy( self ) -- Create a new self instance
|
|
local self = UTILS.DeepCopy(self)
|
|
|
|
_ClassID = _ClassID + 1
|
|
self.ClassID = _ClassID
|
|
|
|
-- This is for "private" methods...
|
|
-- When a __ is passed to a method as "self", the __index will search for the method on the public method list too!
|
|
-- if rawget( self, "__" ) then
|
|
-- setmetatable( self, { __index = self.__ } )
|
|
-- end
|
|
|
|
return self
|
|
end
|
|
|
|
--- This is the worker method to inherit from a parent class.
|
|
-- @param #BASE self
|
|
-- @param Child is the Child class that inherits.
|
|
-- @param #BASE Parent is the Parent class that the Child inherits from.
|
|
-- @return #BASE Child
|
|
function BASE:Inherit( Child, Parent )
|
|
|
|
-- Create child.
|
|
local Child = UTILS.DeepCopy( Child )
|
|
|
|
if Child ~= nil then
|
|
|
|
-- This is for "private" methods...
|
|
-- When a __ is passed to a method as "self", the __index will search for the method on the public method list of the same object too!
|
|
if rawget( Child, "__" ) then
|
|
setmetatable( Child, { __index = Child.__ } )
|
|
setmetatable( Child.__, { __index = Parent } )
|
|
else
|
|
setmetatable( Child, { __index = Parent } )
|
|
end
|
|
|
|
-- Child:_SetDestructor()
|
|
end
|
|
|
|
return Child
|
|
end
|
|
|
|
local function getParent( Child )
|
|
local Parent = nil
|
|
|
|
if Child.ClassName == 'BASE' then
|
|
Parent = nil
|
|
else
|
|
if rawget( Child, "__" ) then
|
|
Parent = getmetatable( Child.__ ).__index
|
|
else
|
|
Parent = getmetatable( Child ).__index
|
|
end
|
|
end
|
|
return Parent
|
|
end
|
|
|
|
--- 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()
|
|
--
|
|
--
|
|
-- @param #BASE self
|
|
-- @param #BASE Child This is the Child class from which the Parent class needs to be retrieved.
|
|
-- @param #BASE FromClass (Optional) The class from which to get the parent.
|
|
-- @return #BASE
|
|
function BASE:GetParent( Child, FromClass )
|
|
|
|
local Parent
|
|
-- BASE class has no parent
|
|
if Child.ClassName == 'BASE' then
|
|
Parent = nil
|
|
else
|
|
|
|
-- self:E({FromClass = FromClass})
|
|
-- self:E({Child = Child.ClassName})
|
|
if FromClass then
|
|
while (Child.ClassName ~= "BASE" and Child.ClassName ~= FromClass.ClassName) do
|
|
Child = getParent( Child )
|
|
-- self:E({Child.ClassName})
|
|
end
|
|
end
|
|
if Child.ClassName == 'BASE' then
|
|
Parent = nil
|
|
else
|
|
Parent = getParent( Child )
|
|
end
|
|
end
|
|
-- self:E({Parent.ClassName})
|
|
return Parent
|
|
end
|
|
|
|
--- 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
|
|
--
|
|
-- @param #BASE self
|
|
-- @param ClassName is the name of the class or the class itself to run the check against
|
|
-- @return #boolean
|
|
function BASE:IsInstanceOf( ClassName )
|
|
|
|
-- Is className NOT a string ?
|
|
if type( ClassName ) ~= 'string' then
|
|
|
|
-- Is className a Moose class ?
|
|
if type( ClassName ) == 'table' and ClassName.ClassName ~= nil then
|
|
|
|
-- Get the name of the Moose class as a string
|
|
ClassName = ClassName.ClassName
|
|
|
|
-- className is neither a string nor a Moose class, throw an error
|
|
else
|
|
|
|
-- I'm not sure if this should take advantage of MOOSE logging function, or throw an error for pcall
|
|
local err_str = 'className parameter should be a string; parameter received: ' .. type( ClassName )
|
|
self:E( err_str )
|
|
-- error( err_str )
|
|
return false
|
|
|
|
end
|
|
end
|
|
|
|
ClassName = string.upper( ClassName )
|
|
|
|
if string.upper( self.ClassName ) == ClassName then
|
|
return true
|
|
end
|
|
|
|
local Parent = getParent( self )
|
|
|
|
while Parent do
|
|
|
|
if string.upper( Parent.ClassName ) == ClassName then
|
|
return true
|
|
end
|
|
|
|
Parent = getParent( Parent )
|
|
|
|
end
|
|
|
|
return false
|
|
|
|
end
|
|
--- Get the ClassName + ClassID of the class instance.
|
|
-- The ClassName + ClassID is formatted as '%s#%09d'.
|
|
-- @param #BASE self
|
|
-- @return #string The ClassName + ClassID of the class instance.
|
|
function BASE:GetClassNameAndID()
|
|
return string.format( '%s#%09d', self.ClassName, self.ClassID )
|
|
end
|
|
|
|
--- Get the ClassName of the class instance.
|
|
-- @param #BASE self
|
|
-- @return #string The ClassName of the class instance.
|
|
function BASE:GetClassName()
|
|
return self.ClassName
|
|
end
|
|
|
|
--- Get the ClassID of the class instance.
|
|
-- @param #BASE self
|
|
-- @return #string The ClassID of the class instance.
|
|
function BASE:GetClassID()
|
|
return self.ClassID
|
|
end
|
|
|
|
do -- Event Handling
|
|
|
|
--- Returns the event dispatcher
|
|
-- @param #BASE self
|
|
-- @return Core.Event#EVENT
|
|
function BASE:EventDispatcher()
|
|
|
|
return _EVENTDISPATCHER
|
|
end
|
|
|
|
--- 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.
|
|
-- @param #BASE self
|
|
-- @return #number The @{Core.Event} processing Priority.
|
|
function BASE:GetEventPriority()
|
|
return self._.EventPriority or 5
|
|
end
|
|
|
|
--- 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.
|
|
-- @param #BASE self
|
|
-- @param #number EventPriority The @{Core.Event} processing Priority.
|
|
-- @return #BASE self
|
|
function BASE:SetEventPriority( EventPriority )
|
|
self._.EventPriority = EventPriority
|
|
end
|
|
|
|
--- Remove all subscribed events
|
|
-- @param #BASE self
|
|
-- @return #BASE
|
|
function BASE:EventRemoveAll()
|
|
|
|
self:EventDispatcher():RemoveAll( self )
|
|
|
|
return self
|
|
end
|
|
|
|
--- Subscribe to a DCS Event.
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTS EventID Event ID.
|
|
-- @param #function EventFunction (optional) The function to be called when the event occurs for the unit.
|
|
-- @return #BASE
|
|
function BASE:HandleEvent( EventID, EventFunction )
|
|
|
|
self:EventDispatcher():OnEventGeneric( EventFunction, self, EventID )
|
|
|
|
return self
|
|
end
|
|
|
|
--- UnSubscribe to a DCS event.
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTS EventID Event ID.
|
|
-- @return #BASE
|
|
function BASE:UnHandleEvent( EventID )
|
|
|
|
self:EventDispatcher():RemoveEvent( self, EventID )
|
|
|
|
return self
|
|
end
|
|
|
|
-- Event handling function prototypes - Have a look at the class @{Core.Event#EVENT} as these are just the prototypes.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEventShot
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEventHit
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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
|
|
-- @function [parent=#BASE] OnEventTakeoff
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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
|
|
-- @function [parent=#BASE] OnEventLand
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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
|
|
-- @function [parent=#BASE] OnEventCrash
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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
|
|
-- @function [parent=#BASE] OnEventEjection
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEventRefueling
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEventDead
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEvent
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEventPilotDead
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEventBaseCaptured
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- Occurs when a mission starts
|
|
-- Have a look at the class @{Core.Event#EVENT} as these are just the prototypes.
|
|
-- @function [parent=#BASE] OnEventMissionStart
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- Occurs when a mission ends
|
|
-- Have a look at the class @{Core.Event#EVENT} as these are just the prototypes.
|
|
-- @function [parent=#BASE] OnEventMissionEnd
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEventRefuelingStop
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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
|
|
-- @function [parent=#BASE] OnEventBirth
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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
|
|
-- @function [parent=#BASE] OnEventHumanFailure
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEventEngineStartup
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEventEngineShutdown
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEventPlayerEnterUnit
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEventPlayerLeaveUnit
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEventShootingStart
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEventShootingEnd
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEventMarkAdded
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEventMarkRemoved
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEventMarkChange
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
--
|
|
-- @function [parent=#BASE] OnEventDetailedFailure
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEventScore
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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
|
|
--
|
|
-- @function [parent=#BASE] OnEventKill
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEventScore
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
--
|
|
-- @function [parent=#BASE] OnEventUnitLost
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
--
|
|
-- @function [parent=#BASE] OnEventLandingAfterEjection
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- Paratrooper landing.
|
|
-- Have a look at the class @{Core.Event#EVENT} as these are just the prototypes.
|
|
-- @function [parent=#BASE] OnEventParatrooperLanding
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- Discard chair after ejection.
|
|
-- Have a look at the class @{Core.Event#EVENT} as these are just the prototypes.
|
|
-- @function [parent=#BASE] OnEventDiscardChairAfterEjection
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEventParatrooperLanding
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- Trigger zone.
|
|
-- Have a look at the class @{Core.Event#EVENT} as these are just the prototypes.
|
|
-- @function [parent=#BASE] OnEventTriggerZone
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- Landing quality mark.
|
|
-- Have a look at the class @{Core.Event#EVENT} as these are just the prototypes.
|
|
-- @function [parent=#BASE] OnEventLandingQualityMark
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- BDA.
|
|
-- Have a look at the class @{Core.Event#EVENT} as these are just the prototypes.
|
|
-- @function [parent=#BASE] OnEventBDA
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- 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.
|
|
-- @function [parent=#BASE] OnEventPlayerEnterAircraft
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.
|
|
-- *** NOTE *** this is a workarounf for DCS not creating these events as of Aug 2024.
|
|
-- @function [parent=#BASE] OnEventNewDynamicCargo
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.
|
|
-- *** NOTE *** this is a workarounf for DCS not creating these events as of Aug 2024.
|
|
-- @function [parent=#BASE] OnEventDynamicCargoLoaded
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.
|
|
-- *** NOTE *** this is a workarounf for DCS not creating these events as of Aug 2024.
|
|
-- @function [parent=#BASE] OnEventDynamicCargoUnloaded
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
--- Occurs when a dynamic cargo crate is removed.
|
|
-- *** NOTE *** this is a workarounf for DCS not creating these events as of Aug 2024.
|
|
-- @function [parent=#BASE] OnEventDynamicCargoRemoved
|
|
-- @param #BASE self
|
|
-- @param Core.Event#EVENTDATA EventData The EventData structure.
|
|
|
|
end
|
|
|
|
--- Creation of a Birth Event.
|
|
-- @param #BASE self
|
|
-- @param DCS#Time EventTime The time stamp of the event.
|
|
-- @param DCS#Object Initiator The initiating object of the event.
|
|
-- @param #string IniUnitName The initiating unit name.
|
|
-- @param place
|
|
-- @param subplace
|
|
function BASE:CreateEventBirth( EventTime, Initiator, IniUnitName, place, subplace )
|
|
self:F( { EventTime, Initiator, IniUnitName, place, subplace } )
|
|
|
|
local Event = {
|
|
id = world.event.S_EVENT_BIRTH,
|
|
time = EventTime,
|
|
initiator = Initiator,
|
|
IniUnitName = IniUnitName,
|
|
place = place,
|
|
subplace = subplace,
|
|
}
|
|
|
|
world.onEvent( Event )
|
|
end
|
|
|
|
--- Creation of a Crash Event.
|
|
-- @param #BASE self
|
|
-- @param DCS#Time EventTime The time stamp of the event.
|
|
-- @param DCS#Object Initiator The initiating object of the event.
|
|
function BASE:CreateEventCrash( EventTime, Initiator, IniObjectCategory )
|
|
self:F( { EventTime, Initiator } )
|
|
|
|
local Event = {
|
|
id = world.event.S_EVENT_CRASH,
|
|
time = EventTime,
|
|
initiator = Initiator,
|
|
IniObjectCategory = IniObjectCategory,
|
|
}
|
|
|
|
world.onEvent( Event )
|
|
end
|
|
|
|
--- Creation of a Crash Event.
|
|
-- @param #BASE self
|
|
-- @param DCS#Time EventTime The time stamp of the event.
|
|
-- @param DCS#Object Initiator The initiating object of the event.
|
|
function BASE:CreateEventUnitLost(EventTime, Initiator)
|
|
self:F( { EventTime, Initiator } )
|
|
|
|
local Event = {
|
|
id = world.event.S_EVENT_UNIT_LOST,
|
|
time = EventTime,
|
|
initiator = Initiator,
|
|
}
|
|
|
|
world.onEvent( Event )
|
|
end
|
|
|
|
--- Creation of a Dead Event.
|
|
-- @param #BASE self
|
|
-- @param DCS#Time EventTime The time stamp of the event.
|
|
-- @param DCS#Object Initiator The initiating object of the event.
|
|
function BASE:CreateEventDead( EventTime, Initiator, IniObjectCategory )
|
|
self:F( { EventTime, Initiator, IniObjectCategory } )
|
|
|
|
local Event = {
|
|
id = world.event.S_EVENT_DEAD,
|
|
time = EventTime,
|
|
initiator = Initiator,
|
|
IniObjectCategory = IniObjectCategory,
|
|
}
|
|
|
|
world.onEvent( Event )
|
|
end
|
|
|
|
--- Creation of a Remove Unit Event.
|
|
-- @param #BASE self
|
|
-- @param DCS#Time EventTime The time stamp of the event.
|
|
-- @param DCS#Object Initiator The initiating object of the event.
|
|
function BASE:CreateEventRemoveUnit( EventTime, Initiator )
|
|
self:F( { EventTime, Initiator } )
|
|
|
|
local Event = {
|
|
id = EVENTS.RemoveUnit,
|
|
time = EventTime,
|
|
initiator = Initiator,
|
|
}
|
|
|
|
world.onEvent( Event )
|
|
end
|
|
|
|
--- Creation of a Takeoff Event.
|
|
-- @param #BASE self
|
|
-- @param DCS#Time EventTime The time stamp of the event.
|
|
-- @param DCS#Object Initiator The initiating object of the event.
|
|
function BASE:CreateEventTakeoff( EventTime, Initiator )
|
|
self:F( { EventTime, Initiator } )
|
|
|
|
local Event = {
|
|
id = world.event.S_EVENT_TAKEOFF,
|
|
time = EventTime,
|
|
initiator = Initiator,
|
|
}
|
|
|
|
world.onEvent( Event )
|
|
end
|
|
|
|
--- Creation of a `S_EVENT_PLAYER_ENTER_AIRCRAFT` event.
|
|
-- @param #BASE self
|
|
-- @param Wrapper.Unit#UNIT PlayerUnit The aircraft unit the player entered.
|
|
function BASE:CreateEventPlayerEnterAircraft( PlayerUnit )
|
|
self:F( { PlayerUnit } )
|
|
|
|
local Event = {
|
|
id = EVENTS.PlayerEnterAircraft,
|
|
time = timer.getTime(),
|
|
initiator = PlayerUnit:GetDCSObject()
|
|
}
|
|
|
|
world.onEvent(Event)
|
|
end
|
|
|
|
--- Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.
|
|
-- @param #BASE self
|
|
-- @param Wrapper.DynamicCargo#DYNAMICCARGO DynamicCargo the dynamic cargo object
|
|
function BASE:CreateEventNewDynamicCargo(DynamicCargo)
|
|
self:F({DynamicCargo})
|
|
local Event = {
|
|
id = EVENTS.NewDynamicCargo,
|
|
time = timer.getTime(),
|
|
dynamiccargo = DynamicCargo,
|
|
initiator = DynamicCargo:GetDCSObject(),
|
|
}
|
|
world.onEvent( Event )
|
|
end
|
|
|
|
--- Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.
|
|
-- @param #BASE self
|
|
-- @param Wrapper.DynamicCargo#DYNAMICCARGO DynamicCargo the dynamic cargo object
|
|
function BASE:CreateEventDynamicCargoLoaded(DynamicCargo)
|
|
self:F({DynamicCargo})
|
|
local Event = {
|
|
id = EVENTS.DynamicCargoLoaded,
|
|
time = timer.getTime(),
|
|
dynamiccargo = DynamicCargo,
|
|
initiator = DynamicCargo:GetDCSObject(),
|
|
}
|
|
world.onEvent( Event )
|
|
end
|
|
|
|
--- Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.
|
|
-- @param #BASE self
|
|
-- @param Wrapper.DynamicCargo#DYNAMICCARGO DynamicCargo the dynamic cargo object
|
|
function BASE:CreateEventDynamicCargoUnloaded(DynamicCargo)
|
|
self:F({DynamicCargo})
|
|
local Event = {
|
|
id = EVENTS.DynamicCargoUnloaded,
|
|
time = timer.getTime(),
|
|
dynamiccargo = DynamicCargo,
|
|
initiator = DynamicCargo:GetDCSObject(),
|
|
}
|
|
world.onEvent( Event )
|
|
end
|
|
|
|
--- Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.
|
|
-- @param #BASE self
|
|
-- @param Wrapper.DynamicCargo#DYNAMICCARGO DynamicCargo the dynamic cargo object
|
|
function BASE:CreateEventDynamicCargoRemoved(DynamicCargo)
|
|
self:F({DynamicCargo})
|
|
local Event = {
|
|
id = EVENTS.DynamicCargoRemoved,
|
|
time = timer.getTime(),
|
|
dynamiccargo = DynamicCargo,
|
|
initiator = DynamicCargo:GetDCSObject(),
|
|
}
|
|
world.onEvent( Event )
|
|
end
|
|
|
|
--- The main event handling function... This function captures all events generated for the class.
|
|
-- @param #BASE self
|
|
-- @param DCS#Event event
|
|
function BASE:onEvent( event )
|
|
|
|
if self then
|
|
|
|
for EventID, EventObject in pairs( self.Events ) do
|
|
if EventObject.EventEnabled then
|
|
|
|
if event.id == EventObject.Event then
|
|
|
|
if self == EventObject.Self then
|
|
|
|
if event.initiator and event.initiator:isExist() then
|
|
event.IniUnitName = event.initiator:getName()
|
|
end
|
|
|
|
if event.target and event.target:isExist() then
|
|
event.TgtUnitName = event.target:getName()
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
do -- Scheduling
|
|
|
|
--- 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.
|
|
-- @param #BASE self
|
|
-- @param #number Start Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
|
|
-- @param #function SchedulerFunction The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
|
|
-- @param #table ... Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
|
|
-- @return #string The Schedule ID of the planned schedule.
|
|
function BASE:ScheduleOnce( Start, SchedulerFunction, ... )
|
|
|
|
-- Object name.
|
|
local ObjectName = "-"
|
|
ObjectName = self.ClassName .. self.ClassID
|
|
|
|
-- Debug info.
|
|
self:F3( { "ScheduleOnce: ", ObjectName, Start } )
|
|
|
|
if not self.Scheduler then
|
|
self.Scheduler = SCHEDULER:New( self )
|
|
end
|
|
|
|
-- FF this was wrong!
|
|
--[[
|
|
local ScheduleID = _SCHEDULEDISPATCHER:AddSchedule(
|
|
self,
|
|
SchedulerFunction,
|
|
{ ... },
|
|
Start,
|
|
nil,
|
|
nil,
|
|
nil
|
|
)
|
|
]]
|
|
|
|
-- NOTE: MasterObject (first parameter) needs to be nil or it will be the first argument passed to the SchedulerFunction!
|
|
local ScheduleID = self.Scheduler:Schedule(nil, SchedulerFunction, {...}, Start)
|
|
|
|
self._.Schedules[#self._.Schedules+1] = ScheduleID
|
|
|
|
return self._.Schedules[#self._.Schedules]
|
|
end
|
|
|
|
--- 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.
|
|
-- @param #BASE self
|
|
-- @param #number Start Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
|
|
-- @param #number Repeat Specifies the interval in seconds when the scheduler will call the event function.
|
|
-- @param #number RandomizeFactor Specifies a randomization factor between 0 and 1 to randomize the Repeat.
|
|
-- @param #number Stop Specifies the amount of seconds when the scheduler will be stopped.
|
|
-- @param #function SchedulerFunction The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
|
|
-- @param #table ... Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
|
|
-- @return #string The Schedule ID of the planned schedule.
|
|
function BASE:ScheduleRepeat( Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ... )
|
|
self:F2( { Start } )
|
|
self:T3( { ... } )
|
|
|
|
local ObjectName = "-"
|
|
ObjectName = self.ClassName .. self.ClassID
|
|
|
|
self:F3( { "ScheduleRepeat: ", ObjectName, Start, Repeat, RandomizeFactor, Stop } )
|
|
|
|
if not self.Scheduler then
|
|
self.Scheduler = SCHEDULER:New( self )
|
|
end
|
|
|
|
-- NOTE: MasterObject (first parameter) should(!) be nil as it will be the first argument passed to the SchedulerFunction!
|
|
local ScheduleID = self.Scheduler:Schedule(
|
|
nil,
|
|
SchedulerFunction,
|
|
{ ... },
|
|
Start,
|
|
Repeat,
|
|
RandomizeFactor,
|
|
Stop,
|
|
4
|
|
)
|
|
|
|
self._.Schedules[#self._.Schedules+1] = ScheduleID
|
|
|
|
return self._.Schedules[#self._.Schedules]
|
|
end
|
|
|
|
--- Stops the Schedule.
|
|
-- @param #BASE self
|
|
-- @param #string SchedulerID (Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.
|
|
function BASE:ScheduleStop( SchedulerID )
|
|
self:F3( { "ScheduleStop:" } )
|
|
|
|
if self.Scheduler then
|
|
--_SCHEDULEDISPATCHER:Stop( self.Scheduler, self._.Schedules[SchedulerFunction] )
|
|
_SCHEDULEDISPATCHER:Stop(self.Scheduler, SchedulerID)
|
|
end
|
|
end
|
|
|
|
end
|
|
|
|
--- 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.
|
|
-- @param #BASE self
|
|
-- @param Object The object that will hold the Value set by the Key.
|
|
-- @param 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!
|
|
-- @param Value The value to is stored in the object.
|
|
-- @return The Value set.
|
|
function BASE:SetState( Object, Key, Value )
|
|
|
|
local ClassNameAndID = Object:GetClassNameAndID()
|
|
|
|
self.States[ClassNameAndID] = self.States[ClassNameAndID] or {}
|
|
self.States[ClassNameAndID][Key] = Value
|
|
|
|
return self.States[ClassNameAndID][Key]
|
|
end
|
|
|
|
--- 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.
|
|
-- @param #BASE self
|
|
-- @param Object The object that holds the Value set by the Key.
|
|
-- @param 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 The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.
|
|
function BASE:GetState( Object, Key )
|
|
|
|
local ClassNameAndID = Object:GetClassNameAndID()
|
|
|
|
if self.States[ClassNameAndID] then
|
|
local Value = self.States[ClassNameAndID][Key] or false
|
|
return Value
|
|
end
|
|
|
|
return nil
|
|
end
|
|
|
|
--- Clear the state of an object.
|
|
-- @param #BASE self
|
|
-- @param Object The object that holds the Value set by the Key.
|
|
-- @param StateName The key that is should be cleared.
|
|
function BASE:ClearState( Object, StateName )
|
|
|
|
local ClassNameAndID = Object:GetClassNameAndID()
|
|
if self.States[ClassNameAndID] then
|
|
self.States[ClassNameAndID][StateName] = nil
|
|
end
|
|
end
|
|
|
|
-- Trace section
|
|
|
|
-- Log a trace (only shown when trace is on)
|
|
-- TODO: Make trace function using variable parameters.
|
|
|
|
--- Set trace on.
|
|
-- @param #BASE self
|
|
-- @usage
|
|
-- -- Switch the tracing On
|
|
-- BASE:TraceOn()
|
|
function BASE:TraceOn()
|
|
self:TraceOnOff( true )
|
|
end
|
|
|
|
--- Set trace off.
|
|
-- @param #BASE self
|
|
-- @usage
|
|
-- -- Switch the tracing Off
|
|
-- BASE:TraceOff()
|
|
function BASE:TraceOff()
|
|
self:TraceOnOff( false )
|
|
end
|
|
|
|
--- 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.
|
|
-- @param #BASE self
|
|
-- @param #boolean TraceOnOff Switch the tracing on or off.
|
|
-- @usage
|
|
--
|
|
-- -- Switch the tracing On
|
|
-- BASE:TraceOnOff( true )
|
|
--
|
|
-- -- Switch the tracing Off
|
|
-- BASE:TraceOnOff( false )
|
|
--
|
|
function BASE:TraceOnOff( TraceOnOff )
|
|
if TraceOnOff == false then
|
|
self:I( "Tracing in MOOSE is OFF" )
|
|
_TraceOnOff = false
|
|
else
|
|
self:I( "Tracing in MOOSE is ON" )
|
|
_TraceOnOff = true
|
|
end
|
|
end
|
|
|
|
--- Enquires if tracing is on (for the class).
|
|
-- @param #BASE self
|
|
-- @return #boolean
|
|
function BASE:IsTrace()
|
|
|
|
if BASE.Debug and (_TraceAll == true) or (_TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName]) then
|
|
return true
|
|
else
|
|
return false
|
|
end
|
|
end
|
|
|
|
--- Set trace level
|
|
-- @param #BASE self
|
|
-- @param #number Level
|
|
function BASE:TraceLevel( Level )
|
|
_TraceLevel = Level or 1
|
|
self:I( "Tracing level " .. _TraceLevel )
|
|
end
|
|
|
|
--- Trace all methods in MOOSE
|
|
-- @param #BASE self
|
|
-- @param #boolean TraceAll true = trace all methods in MOOSE.
|
|
function BASE:TraceAll( TraceAll )
|
|
|
|
if TraceAll == false then
|
|
_TraceAll = false
|
|
else
|
|
_TraceAll = true
|
|
end
|
|
|
|
if _TraceAll then
|
|
self:I( "Tracing all methods in MOOSE " )
|
|
else
|
|
self:I( "Switched off tracing all methods in MOOSE" )
|
|
end
|
|
end
|
|
|
|
--- Set tracing for a class
|
|
-- @param #BASE self
|
|
-- @param #string Class Class name.
|
|
function BASE:TraceClass( Class )
|
|
_TraceClass[Class] = true
|
|
_TraceClassMethod[Class] = {}
|
|
self:I( "Tracing class " .. Class )
|
|
end
|
|
|
|
--- Set tracing for a specific method of class
|
|
-- @param #BASE self
|
|
-- @param #string Class Class name.
|
|
-- @param #string Method Method.
|
|
function BASE:TraceClassMethod( Class, Method )
|
|
if not _TraceClassMethod[Class] then
|
|
_TraceClassMethod[Class] = {}
|
|
_TraceClassMethod[Class].Method = {}
|
|
end
|
|
_TraceClassMethod[Class].Method[Method] = true
|
|
self:I( "Tracing method " .. Method .. " of class " .. Class )
|
|
end
|
|
|
|
--- (Internal) Serialize arguments
|
|
-- @param #BASE self
|
|
-- @param #table Arguments
|
|
-- @return #string Text
|
|
function BASE:_Serialize(Arguments)
|
|
local text = UTILS.PrintTableToLog({Arguments}, 0, true)
|
|
text = string.gsub(text,"(\n+)","")
|
|
text = string.gsub(text,"%(%(","%(")
|
|
text = string.gsub(text,"%)%)","%)")
|
|
text = string.gsub(text,"(%s+)"," ")
|
|
return text
|
|
end
|
|
|
|
----- (Internal) Serialize arguments
|
|
---- @param #BASE self
|
|
---- @param #table Arguments
|
|
---- @return #string Text
|
|
--function BASE:_Serialize(Arguments)
|
|
-- local text=UTILS.BasicSerialize(Arguments)
|
|
-- return text
|
|
--end
|
|
|
|
--- Trace a function call. This function is private.
|
|
-- @param #BASE self
|
|
-- @param Arguments A #table or any field.
|
|
function BASE:_F( Arguments, DebugInfoCurrentParam, DebugInfoFromParam )
|
|
|
|
if BASE.Debug and (_TraceAll == true) or (_TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName]) then
|
|
|
|
local DebugInfoCurrent = DebugInfoCurrentParam and DebugInfoCurrentParam or BASE.Debug.getinfo( 2, "nl" )
|
|
local DebugInfoFrom = DebugInfoFromParam and DebugInfoFromParam or BASE.Debug.getinfo( 3, "l" )
|
|
|
|
local Function = "function"
|
|
if DebugInfoCurrent.name then
|
|
Function = DebugInfoCurrent.name
|
|
end
|
|
|
|
if _TraceAll == true or _TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName].Method[Function] then
|
|
local LineCurrent = 0
|
|
if DebugInfoCurrent.currentline then
|
|
LineCurrent = DebugInfoCurrent.currentline
|
|
end
|
|
local LineFrom = 0
|
|
if DebugInfoFrom then
|
|
LineFrom = DebugInfoFrom.currentline
|
|
end
|
|
env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s(%s)", LineCurrent, LineFrom, "F", self.ClassName, self.ClassID, Function, BASE:_Serialize(Arguments) ) )
|
|
end
|
|
end
|
|
end
|
|
|
|
--- Trace a function call. Must be at the beginning of the function logic.
|
|
-- @param #BASE self
|
|
-- @param Arguments A #table or any field.
|
|
function BASE:F( Arguments )
|
|
|
|
if BASE.Debug and _TraceOnOff == true then
|
|
local DebugInfoCurrent = BASE.Debug.getinfo( 2, "nl" )
|
|
local DebugInfoFrom = BASE.Debug.getinfo( 3, "l" )
|
|
|
|
if _TraceLevel >= 1 then
|
|
self:_F( Arguments, DebugInfoCurrent, DebugInfoFrom )
|
|
end
|
|
end
|
|
end
|
|
|
|
--- Trace a function call level 2. Must be at the beginning of the function logic.
|
|
-- @param #BASE self
|
|
-- @param Arguments A #table or any field.
|
|
function BASE:F2( Arguments )
|
|
|
|
if BASE.Debug and _TraceOnOff == true and _TraceLevel >= 2 then
|
|
local DebugInfoCurrent = BASE.Debug.getinfo( 2, "nl" )
|
|
local DebugInfoFrom = BASE.Debug.getinfo( 3, "l" )
|
|
|
|
if _TraceLevel >= 2 then
|
|
self:_F( Arguments, DebugInfoCurrent, DebugInfoFrom )
|
|
end
|
|
end
|
|
end
|
|
|
|
--- Trace a function call level 3. Must be at the beginning of the function logic.
|
|
-- @param #BASE self
|
|
-- @param Arguments A #table or any field.
|
|
function BASE:F3( Arguments )
|
|
|
|
if BASE.Debug and _TraceOnOff == true and _TraceLevel >= 3 then
|
|
local DebugInfoCurrent = BASE.Debug.getinfo( 2, "nl" )
|
|
local DebugInfoFrom = BASE.Debug.getinfo( 3, "l" )
|
|
|
|
if _TraceLevel >= 3 then
|
|
self:_F( Arguments, DebugInfoCurrent, DebugInfoFrom )
|
|
end
|
|
end
|
|
end
|
|
|
|
--- Trace a function logic.
|
|
-- @param #BASE self
|
|
-- @param Arguments A #table or any field.
|
|
function BASE:_T( Arguments, DebugInfoCurrentParam, DebugInfoFromParam )
|
|
|
|
if BASE.Debug and (_TraceAll == true) or (_TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName]) then
|
|
|
|
local DebugInfoCurrent = DebugInfoCurrentParam and DebugInfoCurrentParam or BASE.Debug.getinfo( 2, "nl" )
|
|
local DebugInfoFrom = DebugInfoFromParam and DebugInfoFromParam or BASE.Debug.getinfo( 3, "l" )
|
|
|
|
local Function = "function"
|
|
if DebugInfoCurrent.name then
|
|
Function = DebugInfoCurrent.name
|
|
end
|
|
|
|
if _TraceAll == true or _TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName].Method[Function] then
|
|
local LineCurrent = 0
|
|
if DebugInfoCurrent.currentline then
|
|
LineCurrent = DebugInfoCurrent.currentline
|
|
end
|
|
local LineFrom = 0
|
|
if DebugInfoFrom then
|
|
LineFrom = DebugInfoFrom.currentline
|
|
end
|
|
env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s", LineCurrent, LineFrom, "T", self.ClassName, self.ClassID, BASE:_Serialize(Arguments) ) )
|
|
end
|
|
end
|
|
end
|
|
|
|
--- Trace a function logic level 1. Can be anywhere within the function logic.
|
|
-- @param #BASE self
|
|
-- @param Arguments A #table or any field.
|
|
function BASE:T( Arguments )
|
|
|
|
if BASE.Debug and _TraceOnOff == true then
|
|
local DebugInfoCurrent = BASE.Debug.getinfo( 2, "nl" )
|
|
local DebugInfoFrom = BASE.Debug.getinfo( 3, "l" )
|
|
|
|
if _TraceLevel >= 1 then
|
|
self:_T( Arguments, DebugInfoCurrent, DebugInfoFrom )
|
|
end
|
|
end
|
|
end
|
|
|
|
--- Trace a function logic level 2. Can be anywhere within the function logic.
|
|
-- @param #BASE self
|
|
-- @param Arguments A #table or any field.
|
|
function BASE:T2( Arguments )
|
|
|
|
if BASE.Debug and _TraceOnOff == true and _TraceLevel >= 2 then
|
|
local DebugInfoCurrent = BASE.Debug.getinfo( 2, "nl" )
|
|
local DebugInfoFrom = BASE.Debug.getinfo( 3, "l" )
|
|
|
|
if _TraceLevel >= 2 then
|
|
self:_T( Arguments, DebugInfoCurrent, DebugInfoFrom )
|
|
end
|
|
end
|
|
end
|
|
|
|
--- Trace a function logic level 3. Can be anywhere within the function logic.
|
|
-- @param #BASE self
|
|
-- @param Arguments A #table or any field.
|
|
function BASE:T3( Arguments )
|
|
|
|
if BASE.Debug and _TraceOnOff == true and _TraceLevel >= 3 then
|
|
local DebugInfoCurrent = BASE.Debug.getinfo( 2, "nl" )
|
|
local DebugInfoFrom = BASE.Debug.getinfo( 3, "l" )
|
|
|
|
if _TraceLevel >= 3 then
|
|
self:_T( Arguments, DebugInfoCurrent, DebugInfoFrom )
|
|
end
|
|
end
|
|
end
|
|
|
|
--- Log an exception which will be traced always. Can be anywhere within the function logic.
|
|
-- @param #BASE self
|
|
-- @param Arguments A #table or any field.
|
|
function BASE:E( Arguments )
|
|
|
|
if BASE.Debug then
|
|
local DebugInfoCurrent = BASE.Debug.getinfo( 2, "nl" )
|
|
local DebugInfoFrom = BASE.Debug.getinfo( 3, "l" )
|
|
|
|
local Function = "function"
|
|
if DebugInfoCurrent.name then
|
|
Function = DebugInfoCurrent.name
|
|
end
|
|
|
|
local LineCurrent = DebugInfoCurrent.currentline
|
|
local LineFrom = -1
|
|
if DebugInfoFrom then
|
|
LineFrom = DebugInfoFrom.currentline
|
|
end
|
|
|
|
env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s(%s)", LineCurrent, LineFrom, "E", self.ClassName, self.ClassID, Function, UTILS.BasicSerialize( Arguments ) ) )
|
|
else
|
|
env.info( string.format( "%1s:%30s%05d(%s)", "E", self.ClassName, self.ClassID, BASE:_Serialize(Arguments) ) )
|
|
end
|
|
|
|
end
|
|
|
|
--- Log an information which will be traced always. Can be anywhere within the function logic.
|
|
-- @param #BASE self
|
|
-- @param Arguments A #table or any field.
|
|
function BASE:I( Arguments )
|
|
|
|
if BASE.Debug then
|
|
local DebugInfoCurrent = BASE.Debug.getinfo( 2, "nl" )
|
|
local DebugInfoFrom = BASE.Debug.getinfo( 3, "l" )
|
|
|
|
local Function = "function"
|
|
if DebugInfoCurrent.name then
|
|
Function = DebugInfoCurrent.name
|
|
end
|
|
|
|
local LineCurrent = DebugInfoCurrent.currentline
|
|
local LineFrom = -1
|
|
if DebugInfoFrom then
|
|
LineFrom = DebugInfoFrom.currentline
|
|
end
|
|
|
|
env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s(%s)", LineCurrent, LineFrom, "I", self.ClassName, self.ClassID, Function, UTILS.BasicSerialize( Arguments ) ) )
|
|
else
|
|
env.info( string.format( "%1s:%30s%05d(%s)", "I", self.ClassName, self.ClassID, BASE:_Serialize(Arguments)) )
|
|
end
|
|
|
|
end
|
|
|