From 9fed91b16f2a1ee87fac6f8a961e3096bef7fd13 Mon Sep 17 00:00:00 2001
From: Frank <frank@inter-zone.de>
Date: Sun, 2 Jun 2019 23:12:08 +0200
Subject: [PATCH] AIRBOSS v1.0.2

- Added skipper menu.
- Added turn help waypoints.
---
 Moose Development/Moose/Ops/Airboss.lua | 232 +++++++++++++++++++++++-
 1 file changed, 229 insertions(+), 3 deletions(-)

diff --git a/Moose Development/Moose/Ops/Airboss.lua b/Moose Development/Moose/Ops/Airboss.lua
index e0337906c..654f9d22e 100644
--- a/Moose Development/Moose/Ops/Airboss.lua	
+++ b/Moose Development/Moose/Ops/Airboss.lua	
@@ -229,6 +229,11 @@
 -- @field #string trapprefix File prefix for trap sheet files.
 -- @field #number initialmaxalt Max altitude in meters to register in the inital zone.
 -- @field #boolean welcome If true, display welcome message to player.
+-- @field #boolean skipperMenu If true, add skipper menu.
+-- @field #number skipperSpeed Speed in knots for manual recovery start.
+-- @field #number skipperCase Manual recovery case.
+-- @field #boolean skipperUturn U-turn on/off via menu.
+-- @field #number skipperTime Recovery time in min for manual recovery.
 -- @extends Core.Fsm#FSM
 
 --- Be the boss!
@@ -1229,6 +1234,10 @@ AIRBOSS = {
   trapprefix     = nil,
   initialmaxalt  = nil,
   welcome        = nil,
+  skipperMenu    = nil,
+  skipperSpeed   = nil,
+  skipperTime    = nil,
+  skipperUturn   = nil,
 }
 
 --- Aircraft types capable of landing on carrier (human+AI).
@@ -1675,7 +1684,7 @@ AIRBOSS.MenuF10Root=nil
 
 --- Airboss class version.
 -- @field #string version
-AIRBOSS.version="1.0.1"
+AIRBOSS.version="1.0.2"
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- TODO list
@@ -2312,6 +2321,26 @@ function AIRBOSS:SetHoldingOffsetAngle(offset)
   return self
 end
 
+--- Enable F10 menu to manually start recoveries.
+-- @param #AIRBOSS self
+-- @param #number duration Default duration of the recovery in minutes. Default 30 min.
+-- @param #number windondeck Default wind on deck in knots. Default 25 knots.
+-- @param #boolean uturn U-turn after recovery window closes on=true or off=false/nil. Default off.
+-- @return #AIRBOSS self
+function AIRBOSS:SetMenuRecovery(duration, windondeck, uturn)
+
+  self.skipperMenu=true
+  self.skipperTime=duration or 30
+  self.skipperSpeed=windondeck or 25
+  if uturn then
+    self.skipperUturn=true
+  else
+    self.skipperUturn=false
+  end
+  
+  return self
+end
+
 --- Add aircraft recovery time window and recovery case.
 -- @param #AIRBOSS self
 -- @param #string starttime Start time, e.g. "8:00" for eight o'clock. Default now.
@@ -13478,15 +13507,46 @@ function AIRBOSS._ResumeRoute(group, airboss, gotocoord)
   -- Waypoints array.
   local waypoints={}
   
+  -- Current position.
+  local c0=group:GetCoordinate()
+  
   -- Current positon as first waypoint.
-  local wp0=group:GetCoordinate():WaypointGround(speedkmh)
+  local wp0=c0:WaypointGround(speedkmh)
   table.insert(waypoints, wp0)
   
   -- First goto this coordinate.
   if gotocoord then
+  
     --gotocoord:MarkToAll(string.format("Goto waypoint speed=%.1f km/h", speedkmh))
+    
+    local headingto=c0:HeadingTo(gotocoord)
+    
+    local hdg1=airboss:GetHeading()
+    local hdg2=c0:HeadingTo(gotocoord)
+    local delta=airboss:_GetDeltaHeading(hdg1, hdg2)
+    
+    --env.info(string.format("FF hdg1=%d, hdg2=%d, delta=%d", hdg1, hdg2, delta))
+
+  
+    if delta>90 then
+
+      local gotocoordh=c0:Translate(2500, hdg1+45)
+      --gotocoordh:MarkToAll(string.format("Goto help waypoint 1 speed=%.1f km/h", speedkmh))
+      
+      local wp=gotocoordh:WaypointGround(speedkmh)
+      table.insert(waypoints, wp)
+
+      gotocoordh=c0:Translate(5000, hdg1+90)
+      --gotocoordh:MarkToAll(string.format("Goto help waypoint 2 speed=%.1f km/h", speedkmh))
+      
+      wp=gotocoordh:WaypointGround(speedkmh)
+      table.insert(waypoints, wp)
+          
+    end
+    
     local wp1=gotocoord:WaypointGround(speedkmh)
-    table.insert(waypoints, wp1)  
+    table.insert(waypoints, wp1)    
+    
   end
   
   -- Debug message.
@@ -15280,6 +15340,29 @@ function AIRBOSS:_AddF10Commands(_unitName)
         missionCommands.addCommandForGroup(gid, "Greenie Board", _resultsPath, self._DisplayScoreBoard,   self, _unitName) -- F1
         missionCommands.addCommandForGroup(gid, "My LSO Grades", _resultsPath, self._DisplayPlayerGrades, self, _unitName) -- F2
         missionCommands.addCommandForGroup(gid, "Last Debrief",  _resultsPath, self._DisplayDebriefing,   self, _unitName) -- F3
+      
+        -- F10/Airboss/<Carrier>/F2 Kneeboard/F2 Skipper/
+        if self.skipperMenu then
+          local _skipperPath =missionCommands.addSubMenuForGroup(gid, "Skipper", _kneeboardPath)
+          local _menusetspeed=missionCommands.addSubMenuForGroup(gid, "Set Speed", _skipperPath)
+          missionCommands.addCommandForGroup(gid, "10 knots",   _menusetspeed, self._SkipperRecoverySpeed, self, _unitName, 10)
+          missionCommands.addCommandForGroup(gid, "15 knots",   _menusetspeed, self._SkipperRecoverySpeed, self, _unitName, 15)
+          missionCommands.addCommandForGroup(gid, "20 knots",   _menusetspeed, self._SkipperRecoverySpeed, self, _unitName, 20)
+          missionCommands.addCommandForGroup(gid, "25 knots",   _menusetspeed, self._SkipperRecoverySpeed, self, _unitName, 25)
+          missionCommands.addCommandForGroup(gid, "30 knots",   _menusetspeed, self._SkipperRecoverySpeed, self, _unitName, 30)
+          local _menusetrtime=missionCommands.addSubMenuForGroup(gid, "Set Time",  _skipperPath)
+          missionCommands.addCommandForGroup(gid, "15 min", _menusetrtime, self._SkipperRecoveryTime, self, _unitName, 15)
+          missionCommands.addCommandForGroup(gid, "30 min", _menusetrtime, self._SkipperRecoveryTime, self, _unitName, 30)
+          missionCommands.addCommandForGroup(gid, "45 min", _menusetrtime, self._SkipperRecoveryTime, self, _unitName, 45)
+          missionCommands.addCommandForGroup(gid, "60 min", _menusetrtime, self._SkipperRecoveryTime, self, _unitName, 60)
+          missionCommands.addCommandForGroup(gid, "90 min", _menusetrtime, self._SkipperRecoveryTime, self, _unitName, 90)
+          missionCommands.addCommandForGroup(gid, "U-turn On/Off", _skipperPath, self._SkipperRecoveryUturn, self, _unitName)
+          missionCommands.addCommandForGroup(gid, "Start CASE I",  _skipperPath, self._SkipperStartRecovery, self, _unitName, 1)
+          missionCommands.addCommandForGroup(gid, "Start CASE II", _skipperPath, self._SkipperStartRecovery, self, _unitName, 2)
+          missionCommands.addCommandForGroup(gid, "Start CASE III",_skipperPath, self._SkipperStartRecovery, self, _unitName, 3)
+          missionCommands.addCommandForGroup(gid, "Stop Recovery", _skipperPath, self._SkipperStopRecovery,  self, _unitName)
+        end          
+              
         -- F10/Airboss/<Carrier/F2 Kneeboard/
         missionCommands.addCommandForGroup(gid, "Carrier Info",     _kneeboardPath, self._DisplayCarrierInfo,    self, _unitName) -- F2
         missionCommands.addCommandForGroup(gid, "Weather Report",   _kneeboardPath, self._DisplayCarrierWeather, self, _unitName) -- F3
@@ -15307,6 +15390,149 @@ function AIRBOSS:_AddF10Commands(_unitName)
 
 end
 
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- SKIPPER MENU
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Reset player status. Player is removed from all queues and its status is set to undefined.
+-- @param #AIRBOSS self
+-- @param #string _unitName Name fo the player unit.
+-- @param #number case Recovery case.
+function AIRBOSS:_SkipperStartRecovery(_unitName, case)
+
+  -- Get player unit and name.
+  local _unit, _playername = self:_GetPlayerUnitAndName(_unitName)
+    
+  -- Check if we have a unit which is a player.
+  if _unit and _playername then
+    local playerData=self.players[_playername] --#AIRBOSS.PlayerData
+        
+    if playerData then
+      
+      -- Inform player.
+      local text=string.format("affirm, Case %d recovery will start in 5 min for %d min. Wind on deck %d knots. U-turn=%s.", case, self.skipperTime, self.skipperSpeed, tostring(self.skipperUturn))
+      if self:IsRecovering() then
+        text="negative, carrier is already recovering."
+        self:MessageToPlayer(playerData, text, "AIRBOSS")
+        return
+      end
+      self:MessageToPlayer(playerData, text, "AIRBOSS")
+
+      -- Recovery staring in 5 min for 30 min.
+      local t0=timer.getAbsTime()+5*60
+      local t9=t0+self.skipperTime*60
+      local C0=UTILS.SecondsToClock(t0)
+      local C9=UTILS.SecondsToClock(t9)
+    
+      -- Carrier will turn into the wind. Wind on deck 25 knots. U-turn on.
+      self:AddRecoveryWindow(C0, C9, case, 30, true, self.skipperSpeed, self.skipperUturn)
+      
+    end
+  end
+end
+
+--- Skipper Stop recovery function.
+-- @param #AIRBOSS self
+-- @param #string _unitName Name fo the player unit.
+function AIRBOSS:_SkipperStopRecovery(_unitName)
+
+  -- Get player unit and name.
+  local _unit, _playername = self:_GetPlayerUnitAndName(_unitName)
+    
+  -- Check if we have a unit which is a player.
+  if _unit and _playername then
+    local playerData=self.players[_playername] --#AIRBOSS.PlayerData
+        
+    if playerData then
+      
+      -- Inform player.
+      local text="roger, stopping recovery right away."
+      if not self:IsRecovering() then
+        text="negative, carrier is currently not recovering."
+        self:MessageToPlayer(playerData, text, "AIRBOSS")
+        return        
+      end
+      self:MessageToPlayer(playerData, text, "AIRBOSS")
+      
+      self:RecoveryStop()
+    end
+  end
+end
+
+--- Skipper set recovery time.
+-- @param #AIRBOSS self
+-- @param #string _unitName Name fo the player unit.
+-- @param #number time Recovery time in minutes.
+function AIRBOSS:_SkipperRecoveryTime(_unitName, time)
+
+  -- Get player unit and name.
+  local _unit, _playername = self:_GetPlayerUnitAndName(_unitName)
+    
+  -- Check if we have a unit which is a player.
+  if _unit and _playername then
+    local playerData=self.players[_playername] --#AIRBOSS.PlayerData
+        
+    if playerData then
+      
+      -- Inform player.
+      local text=string.format("roger, manual recovery time set to %d min.", time)
+      self:MessageToPlayer(playerData, text, "AIRBOSS")
+      
+      self.skipperTime=time
+      
+    end
+  end
+end
+
+--- Skipper set recovery speed.
+-- @param #AIRBOSS self
+-- @param #string _unitName Name fo the player unit.
+-- @param #number speed Recovery speed in knots.
+function AIRBOSS:_SkipperRecoverySpeed(_unitName, speed)
+
+  -- Get player unit and name.
+  local _unit, _playername = self:_GetPlayerUnitAndName(_unitName)
+    
+  -- Check if we have a unit which is a player.
+  if _unit and _playername then
+    local playerData=self.players[_playername] --#AIRBOSS.PlayerData
+        
+    if playerData then
+      
+      -- Inform player.
+      local text=string.format("roger, wind on deck set to %d knots.", speed)
+      self:MessageToPlayer(playerData, text, "AIRBOSS")
+      
+      self.skipperSpeed=speed
+    end
+  end
+end  
+
+--- Skipper set recovery speed.
+-- @param #AIRBOSS self
+-- @param #string _unitName Name fo the player unit.
+function AIRBOSS:_SkipperRecoveryUturn(_unitName)
+
+  -- Get player unit and name.
+  local _unit, _playername = self:_GetPlayerUnitAndName(_unitName)
+    
+  -- Check if we have a unit which is a player.
+  if _unit and _playername then
+    local playerData=self.players[_playername] --#AIRBOSS.PlayerData
+        
+    if playerData then
+    
+      self.skipperUturn=not self.skipperUturn
+      
+      -- Inform player.
+      local text=string.format("roger, U-turn is now %s.", tostring(self.skipperUturn))
+      self:MessageToPlayer(playerData, text, "AIRBOSS")
+      
+    end
+  end
+end  
+
+
 -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- ROOT MENU
 -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------