Refactoring

2026-08-12 15:32:43 +00:00 · 2020-05-16 12:58:59 +02:00
parent 5afd5cae27
commit 9b72254ccc
5 changed files with 496 additions and 323 deletions
@@ -196,17 +196,6 @@ FLIGHTGROUP.Attribute = {
 -- @field #number damage Damage of element in percent.
 -- @field Wrapper.Airbase#AIRBASE.ParkingSpot parking The parking spot table the element is parking on.

--- Ammo data.
-- @type FLIGHTGROUP.Ammo
-- @field #number Total Total amount of ammo.
-- @field #number Guns Amount of gun shells.
-- @field #number Bombs Amount of bombs.
-- @field #number Rockets Amount of rockets.
-- @field #number Missiles Amount of missiles.
-- @field #number MissilesAA Amount of air-to-air missiles.
-- @field #number MissilesAG Amount of air-to-ground missiles.
-- @field #number MissilesAS Amount of anti-ship missiles.
-

 --- FLIGHTGROUP class version.
 -- @field #string version
@@ -1054,67 +1043,7 @@ function FLIGHTGROUP:onafterStatus(From, Event, To)
  end
 end

-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-- Queue Update: Missions & Tasks
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

--- On after "QueueUpdate" event. 
-- @param #FLIGHTGROUP self
-- @param #string From From state.
-- @param #string Event Event.
-- @param #string To To state.
-function FLIGHTGROUP:onafterQueueUpdate(From, Event, To)
-
-  ---
-  -- Mission
-  ---
-
-   -- First check if group is alive? Late activated groups are activated and uncontrolled units are started automatically.
-  if self:IsAlive()~=nil then
-  
-    local mission=self:_GetNextMission()
-    
-    if mission then
-    
-      local currentmission=self:GetMissionCurrent()
-      
-      if currentmission then
-      
-        -- Current mission but new mission is urgent with higher prio.
-        if mission.urgent and mission.prio<currentmission.prio then
-          self:MissionCancel(currentmission)
-          self:__MissionStart(1, mission)
-        end
-        
-      else
-        -- No current mission.
-        self:MissionStart(mission)        
-      end
-    end
-  end
-
-  ---
-  -- Tasks
-  ---
-
-  -- Check no current task.
-  if self:IsAirborne() and self.taskcurrent<=0 then
-
-    -- Get task from queue.
-    local task=self:_GetNextTask()
-
-    -- Execute task if any.
-    if task then
-      self:TaskExecute(task)
-    end
-    
-  end
-
-  -- Update queue every ~5 sec.
-  if not self:IsStopped() then
-    self:__QueueUpdate(-5)
-  end
-end

 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- Events
@@ -1553,7 +1482,6 @@ end

 --- On after "Spawned" event. Sets the template, initializes the waypoints.
 -- @param #FLIGHTGROUP self
-- @param Wrapper.Group#GROUP Group Flight group.
 -- @param #string From From state.
 -- @param #string Event Event.
 -- @param #string To To state.
@@ -1563,8 +1491,8 @@ function FLIGHTGROUP:onafterSpawned(From, Event, To)
  if self.ai then
  
    -- Set default ROE and ROT options.
-    self:SetOptionROE()
-    self:SetOptionROT()
+    self:SetOptionROE(self.roe)
+    self:SetOptionROT(self.rot)
    
    -- TODO: make this input.
    self.group:SetOption(AI.Option.Air.id.PROHIBIT_JETT, true)
@@ -1887,7 +1815,7 @@ function FLIGHTGROUP:onafterUpdateRoute(From, Event, To, n)
    -- No waypoints left
    ---
  
-    self:_CheckFlightDone()
+    self:_CheckGroupDone()
          
  end

@@ -1977,7 +1905,7 @@ function FLIGHTGROUP:onafterPassingWaypoint(From, Event, To, n, N)
    -- Check if all tasks/mission are done? If so, RTB or WAIT.
    -- Note, we delay it for a second to let the OnAfterPassingwaypoint function to be executed in case someone wants to add another waypoint there.
    if #taskswp==0 then
-      self:_CheckFlightDone(1)
+      self:_CheckGroupDone(1)
    end

  end
@@ -1994,13 +1922,13 @@ end
 --  
 -- @param #FLIGHTGROUP self
 -- @param #number delay Delay in seconds.
-function FLIGHTGROUP:_CheckFlightDone(delay)
+function FLIGHTGROUP:_CheckGroupDone(delay)

  if self:IsAlive() and self.ai then

    if delay and delay>0 then
      -- Delayed call.
-      self:ScheduleOnce(delay, FLIGHTGROUP._CheckFlightDone, self)
+      self:ScheduleOnce(delay, FLIGHTGROUP._CheckGroupDone, self)
    else
    
      -- First check if there is a paused mission that 
@@ -2424,7 +2352,7 @@ function FLIGHTGROUP:onafterRefueled(From, Event, To)
  self:I(self.lid..text)
  
  -- Check if flight is done.
-  self:_CheckFlightDone(1)
+  self:_CheckGroupDone(1)
  
 end

@@ -3209,7 +3137,7 @@ function FLIGHTGROUP:InitWaypoints(waypoints)
    end
    
    -- Update route (when airborne).
-    --self:_CheckFlightDone(1)
+    --self:_CheckGroupDone(1)
    self:__UpdateRoute(-1)
  end

@@ -3271,7 +3199,7 @@ function FLIGHTGROUP:AddWaypointAir(coordinate, wpnumber, speed, updateroute)
  
  -- Update route.
  if updateroute==nil or updateroute==true then
-    self:_CheckFlightDone(1)
+    self:_CheckGroupDone(1)
    --self:__UpdateRoute(-1)
  end
  
@@ -3366,211 +3294,6 @@ function FLIGHTGROUP:_GetOnboardNumber(unitname)
  return nil
 end

--- Get the number of shells a unit or group currently has. For a group the ammo count of all units is summed up.
-- @param #FLIGHTGROUP self
-- @param #FLIGHTGROUP.Element element The element.
-- @return #FLIGHTGROUP.Ammo Ammo data.
-function FLIGHTGROUP:GetAmmoElement(element)
-  return self:GetAmmoUnit(element.unit)
-end
-
--- Get total amount of ammunition of the whole group.
-- @param #FLIGHTGROUP self
-- @return #FLIGHTGROUP.Ammo Ammo data.
-function FLIGHTGROUP:GetAmmoTot()
-
-  local units=self.group:GetUnits()
-  
-  local Ammo={} --#FLIGHTGROUP.Ammo
-  Ammo.Total=0
-  Ammo.Guns=0
-  Ammo.Rockets=0
-  Ammo.Bombs=0
-  Ammo.Missiles=0
-  Ammo.MissilesAA=0
-  Ammo.MissilesAG=0
-  Ammo.MissilesAS=0
-  
-  for _,_unit in pairs(units) do
-    local unit=_unit --Wrapper.Unit#UNIT
-    
-    if unit and unit:IsAlive()~=nil then
-      
-      -- Get ammo of the unit.
-      local ammo=self:GetAmmoUnit(unit)
-      
-      -- Add up total.
-      Ammo.Total=Ammo.Total+ammo.Total
-      Ammo.Guns=Ammo.Guns+ammo.Guns
-      Ammo.Rockets=Ammo.Rockets+ammo.Rockets
-      Ammo.Bombs=Ammo.Bombs+ammo.Bombs
-      Ammo.Missiles=Ammo.Missiles+ammo.Missiles
-      Ammo.MissilesAA=Ammo.MissilesAA+ammo.MissilesAA
-      Ammo.MissilesAG=Ammo.MissilesAG+ammo.MissilesAG
-      Ammo.MissilesAS=Ammo.MissilesAS+ammo.MissilesAS
-    
-    end
-    
-  end
-
-  return Ammo
-end
-
--- Get the number of shells a unit or group currently has. For a group the ammo count of all units is summed up.
-- @param #FLIGHTGROUP self
-- @param Wrapper.Unit#UNIT unit The unit object.
-- @param #boolean display Display ammo table as message to all. Default false.
-- @return #FLIGHTGROUP.Ammo Ammo data.
-function FLIGHTGROUP:GetAmmoUnit(unit, display)
-
-  -- Default is display false.
-  if display==nil then
-    display=false
-  end
-
-  -- Init counter.
-  local nammo=0
-  local nshells=0
-  local nrockets=0
-  local nmissiles=0
-  local nmissilesAA=0
-  local nmissilesAG=0
-  local nmissilesAS=0
-  local nbombs=0
-
-  -- Output.
-  local text=string.format("FLIGHTGROUP group %s - unit %s:\n", self.groupname, unit:GetName())
-
-  -- Get ammo table.
-  local ammotable=unit:GetAmmo()
-
-  if ammotable then
-
-    local weapons=#ammotable
-
-    -- Loop over all weapons.
-    for w=1,weapons do
-
-      -- Number of current weapon.
-      local Nammo=ammotable[w]["count"]
-
-      -- Type name of current weapon.
-      local Tammo=ammotable[w]["desc"]["typeName"]
-
-      local _weaponString = UTILS.Split(Tammo,"%.")
-      local _weaponName   = _weaponString[#_weaponString]
-
-      -- Get the weapon category: shell=0, missile=1, rocket=2, bomb=3
-      local Category=ammotable[w].desc.category
-
-      -- Get missile category: Weapon.MissileCategory AAM=1, SAM=2, BM=3, ANTI_SHIP=4, CRUISE=5, OTHER=6
-      local MissileCategory=nil
-      if Category==Weapon.Category.MISSILE then
-        MissileCategory=ammotable[w].desc.missileCategory
-      end
-
-      -- We are specifically looking for shells or rockets here.
-      if Category==Weapon.Category.SHELL then
-
-        -- Add up all shells.
-        nshells=nshells+Nammo
-
-        -- Debug info.
-        text=text..string.format("- %d shells of type %s\n", Nammo, _weaponName)
-
-      elseif Category==Weapon.Category.ROCKET then
-
-        -- Add up all rockets.
-        nrockets=nrockets+Nammo
-
-        -- Debug info.
-        text=text..string.format("- %d rockets of type %s\n", Nammo, _weaponName)
-
-      elseif Category==Weapon.Category.BOMB then
-
-        -- Add up all rockets.
-        nbombs=nbombs+Nammo
-
-        -- Debug info.
-        text=text..string.format("- %d bombs of type %s\n", Nammo, _weaponName)
-
-      elseif Category==Weapon.Category.MISSILE then
-
-        -- Add up all cruise missiles (category 5)
-        if MissileCategory==Weapon.MissileCategory.AAM then
-          nmissiles=nmissiles+Nammo
-          nmissilesAA=nmissilesAA+Nammo
-        elseif MissileCategory==Weapon.MissileCategory.ANTI_SHIP then
-          nmissiles=nmissiles+Nammo
-          nmissilesAS=nmissilesAS+Nammo
-        elseif MissileCategory==Weapon.MissileCategory.BM then
-          nmissiles=nmissiles+Nammo
-          nmissilesAG=nmissilesAG+Nammo
-        elseif MissileCategory==Weapon.MissileCategory.OTHER then
-          nmissiles=nmissiles+Nammo
-          nmissilesAG=nmissilesAG+Nammo
-        end
-
-        -- Debug info.
-        text=text..string.format("- %d %s missiles of type %s\n", Nammo, self:_MissileCategoryName(MissileCategory), _weaponName)
-
-      else
-
-        -- Debug info.
-        text=text..string.format("- %d unknown ammo of type %s (category=%d, missile category=%s)\n", Nammo, Tammo, Category, tostring(MissileCategory))
-
-      end
-
-    end
-  end
-
-  -- Debug text and send message.
-  if display then
-    self:I(self.lid..text)
-  else
-    self:T3(self.lid..text)
-  end
-  MESSAGE:New(text, 10):ToAllIf(display)
-
-  -- Total amount of ammunition.
-  nammo=nshells+nrockets+nmissiles+nbombs
-
-  local ammo={} --#FLIGHTGROUP.Ammo
-  ammo.Total=nammo
-  ammo.Guns=nshells
-  ammo.Rockets=nrockets
-  ammo.Bombs=nbombs
-  ammo.Missiles=nmissiles
-  ammo.MissilesAA=nmissilesAA
-  ammo.MissilesAG=nmissilesAG
-  ammo.MissilesAS=nmissilesAS
-
-  return ammo
-end
-
-
--- Returns a name of a missile category.
-- @param #FLIGHTGROUP self
-- @param #number categorynumber Number of missile category from weapon missile category enumerator. See https://wiki.hoggitworld.com/view/DCS_Class_Weapon
-- @return #string Missile category name.
-function FLIGHTGROUP:_MissileCategoryName(categorynumber)
-  local cat="unknown"
-  if categorynumber==Weapon.MissileCategory.AAM then
-    cat="air-to-air"
-  elseif categorynumber==Weapon.MissileCategory.SAM then
-    cat="surface-to-air"
-  elseif categorynumber==Weapon.MissileCategory.BM then
-    cat="ballistic"
-  elseif categorynumber==Weapon.MissileCategory.ANTI_SHIP then
-    cat="anti-ship"
-  elseif categorynumber==Weapon.MissileCategory.CRUISE then
-    cat="cruise"
-  elseif categorynumber==Weapon.MissileCategory.OTHER then
-    cat="other"
-  end
-  return cat
-end
-
 --- Checks if a human player sits in the unit.
 -- @param #FLIGHTGROUP self
 -- @param Wrapper.Unit#UNIT unit Aircraft unit.