Files
MOOSE/Moose Development/Moose/Ops/WingCommander.lua
T
Frank 004591f8ad Ops
2020-02-12 16:44:01 +01:00

229 lines
7.1 KiB
Lua

--- **Ops** - Commander Air Wing.
--
-- **Main Features:**
--
-- * Stuff
--
-- ===
--
-- ### Author: **funkyfranky**
-- @module Ops.WingCommander
-- @image OPS_WingCommander.png
--- WINGCOMMANDER class.
-- @type WINGCOMMANDER
-- @field #string ClassName Name of the class.
-- @field #boolean Debug Debug mode. Messages to all about status.
-- @field #string sid Class id string for output to DCS log file.
-- @field #string livery Livery of the squadron.
-- @field #table flights Table of flight groups.
-- @extends Core.Fsm#FSM
--- Be surprised!
--
-- ===
--
-- ![Banner Image](..\Presentations\CarrierAirWing\WINGCOMMANDER_Main.jpg)
--
-- # The WINGCOMMANDER Concept
--
--
--
-- @field #WINGCOMMANDER
WINGCOMMANDER = {
ClassName = "WINGCOMMANDER",
Debug = nil,
lid = nil,
airwings = {},
}
--- Flight group element.
-- @type WINGCOMMANDER.Flight
-- @field Ops.FlightGroup#FLIGHTGROUP flightgroup The flight group object.
-- @field #string mission Mission assigned to the flight.
--- WINGCOMMANDER class version.
-- @field #string version
WINGCOMMANDER.version="0.0.1"
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-- TODO list
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-- TODO: Add tasks.
-- TODO:
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-- Constructor
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Create a new WINGCOMMANDER object and start the FSM.
-- @param #WINGCOMMANDER self
-- @param Core.Set#SET_UNITS AgentSet Set of agents (units) providing intel.
-- @return #WINGCOMMANDER self
function WINGCOMMANDER:New(AgentSet)
-- Inherit everything from INTEL class.
local self=BASE:Inherit(self, INTEL:New(AgentSet)) --#WINGCOMMANDER
-- Set some string id for output to DCS.log file.
self.lid=string.format("WINGCOMMANDER | ")
-- Start State.
self:SetStartState("Stopped")
-- TODO Tasks?
self.tasks=tasks or {}
-- Add FSM transitions.
-- From State --> Event --> To State
self:AddTransition("Stopped", "Start", "Running") -- Start FSM.
self:AddTransition("*", "Sitrep", "*") -- WINGCOMMANDER status update
------------------------
--- Pseudo Functions ---
------------------------
--- Triggers the FSM event "Start". Starts the WINGCOMMANDER. Initializes parameters and starts event handlers.
-- @function [parent=#WINGCOMMANDER] Start
-- @param #WINGCOMMANDER self
--- Triggers the FSM event "Start" after a delay. Starts the WINGCOMMANDER. Initializes parameters and starts event handlers.
-- @function [parent=#WINGCOMMANDER] __Start
-- @param #WINGCOMMANDER self
-- @param #number delay Delay in seconds.
--- Triggers the FSM event "Stop". Stops the WINGCOMMANDER and all its event handlers.
-- @param #WINGCOMMANDER self
--- Triggers the FSM event "Stop" after a delay. Stops the WINGCOMMANDER and all its event handlers.
-- @function [parent=#WINGCOMMANDER] __Stop
-- @param #WINGCOMMANDER self
-- @param #number delay Delay in seconds.
--- Triggers the FSM event "FlightStatus".
-- @function [parent=#WINGCOMMANDER] WingCommanderStatus
-- @param #WINGCOMMANDER self
--- Triggers the FSM event "SkipperStatus" after a delay.
-- @function [parent=#WINGCOMMANDER] __WingCommanderStatus
-- @param #WINGCOMMANDER self
-- @param #number delay Delay in seconds.
-- Debug trace.
if false then
self.Debug=true
BASE:TraceOnOff(true)
BASE:TraceClass(self.ClassName)
BASE:TraceLevel(1)
end
self.Debug=true
return self
end
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-- User functions
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Set livery.
-- @param #WINGCOMMANDER self
-- @param #string liveryname Name of the livery.
-- @return #WINGCOMMANDER self
function WINGCOMMANDER:SetLivery(liveryname)
self.livery=liveryname
end
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-- Start & Status
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- On after Start event. Starts the FLIGHTGROUP FSM and event handlers.
-- @param #WINGCOMMANDER self
-- @param Wrapper.Group#GROUP Group Flight group.
-- @param #string From From state.
-- @param #string Event Event.
-- @param #string To To state.
function WINGCOMMANDER:onafterStart(From, Event, To)
-- Short info.
local text=string.format("Starting flight group %s.", self.groupname)
self:I(self.sid..text)
-- Start the status monitoring.
self:__SitRep(-1)
end
--- On after "FlightStatus" event.
-- @param #WINGCOMMANDER self
-- @param Wrapper.Group#GROUP Group Flight group.
-- @param #string From From state.
-- @param #string Event Event.
-- @param #string To To state.
function WINGCOMMANDER:onafterSitrep(From, Event, To)
-- FSM state.
local fsmstate=self:GetState()
-- Short info.
local text=string.format("No activities")
self:I(self.sid..text)
if DetectedGroupsUnknown then
for _,_group in pairs(DetectedGroupsUnknown) do
local group=_group --Wrapper.Group#GROUP
if group and group:IsAlive() then
local category=group:GetCategory()
if category==Group.Category.AIRPLANE or category==Group.Category.AIRPLANE then
elseif category==Group.Category.GROUND then
elseif category==Group.Category.SHIP then
end
end
end
end
end
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-- Resources
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Check resources.
-- @param #WINGCOMMANDER self
function WINGCOMMANDER:CheckResources()
for _,_airwing in pairs(self.airwings) do
local airwing=_airwing --Ops.AirWing#AIRWING
airwing:GetFlightsWhoCan()
end
end