Merge branch 'FF/Develop' into FF/Fox2

Moose Development/Moose/Core/Settings.lua

@@ -1,9 +1,9 @@
 --- **Core** - Manages various settings for running missions, consumed by moose classes and provides a menu system for players to tweak settings in running missions.
 --
 -- ===
--- 
+--
 -- ## Features:
--- 
+--
 --   * Provide a settings menu system to the players.
 --   * Provide a player settings menu and an overall mission settings menu.
 --   * Mission settings provide default settings, while player settings override mission settings.
@@ -11,19 +11,19 @@
 --   * Provide a menu to select between different coordinate formats for A2A coordinates.
 --   * Provide a menu to select between different message time duration options.
 --   * Provide a menu to select between different metric systems.
--- 
+--
 -- ===
--- 
+--
 -- The documentation of the SETTINGS class can be found further in this document.
--- 
+--
 -- ===
--- 
+--
 -- # **AUTHORS and CONTRIBUTIONS**
--- 
--- ### Contributions: 
--- 
--- ### Authors: 
--- 
+--
+-- ### Contributions:
+--
+-- ### Authors:
+--
 --   * **FlightControl**: Design & Programming
 --
 -- @module Core.Settings
@@ -34,168 +34,181 @@
 -- @extends Core.Base#BASE
 
 --- Takes care of various settings that influence the behaviour of certain functionalities and classes within the MOOSE framework.
--- 
+--
 -- ===
--- 
+--
 -- The SETTINGS class takes care of various settings that influence the behaviour of certain functionalities and classes within the MOOSE framework.
 -- SETTINGS can work on 2 levels:
--- 
---   - **Default settings**: A running mission has **Default settings**. 
+--
+--   - **Default settings**: A running mission has **Default settings**.
 --   - **Player settings**: For each player its own **Player settings** can be defined, overriding the **Default settings**.
--- 
+--
 -- So, when there isn't any **Player setting** defined for a player for a specific setting, or, the player cannot be identified, the **Default setting** will be used instead.
--- 
+--
 -- # 1) \_SETTINGS object
--- 
+--
 -- MOOSE defines by default a singleton object called **\_SETTINGS**. Use this object to modify all the **Default settings** for a running mission.
 -- For each player, MOOSE will automatically allocate also a **player settings** object, and will expose a radio menu to allow the player to adapt the settings to his own preferences.
--- 
+--
 -- # 2) SETTINGS Menu
--- 
+--
 -- Settings can be adapted by the Players and by the Mission Administrator through **radio menus, which are automatically available in the mission**.
 -- These menus can be found **on level F10 under "Settings"**. There are two kinds of menus generated by the system.
--- 
+--
 -- ## 2.1) Default settings menu
--- 
+--
 -- A menu is created automatically per Command Center that allows to modify the **Default** settings.
 -- So, when joining a CC unit, a menu will be available that allows to change the settings parameters **FOR ALL THE PLAYERS**!
 -- Note that the **Default settings** will only be used when a player has not choosen its own settings.
--- 
+--
 -- ## 2.2) Player settings menu
--- 
+--
 -- A menu is created automatically per Player Slot (group) that allows to modify the **Player** settings.
 -- So, when joining a slot, a menu wil be available that allows to change the settings parameters **FOR THE PLAYER ONLY**!
 -- Note that when a player has not chosen a specific setting, the **Default settings** will be used.
--- 
+--
 -- ## 2.3) Show or Hide the Player Setting menus
--- 
+--
 -- Of course, it may be requried not to show any setting menus. In this case, a method is available on the **\_SETTINGS object**.
 -- Use @{#SETTINGS.SetPlayerMenuOff}() to hide the player menus, and use @{#SETTINGS.SetPlayerMenuOn}() show the player menus.
 -- Note that when this method is used, any player already in a slot will not have its menus visibility changed.
--- The option will only have effect when a player enters a new slot or changes a slot. 
--- 
+-- The option will only have effect when a player enters a new slot or changes a slot.
+--
 -- Example:
--- 
+--
 --      _SETTINGS:SetPlayerMenuOff() -- will disable the player menus.
 --      _SETTINGS:SetPlayerMenuOn() -- will enable the player menus.
 --      -- But only when a player exits and reenters the slot these settings will have effect!
--- 
--- 
+--
+--
 -- # 3) Settings
--- 
+--
 -- There are different settings that are managed and applied within the MOOSE framework.
 -- See below a comprehensive description of each.
--- 
+--
 -- ## 3.1) **A2G coordinates** display formatting
--- 
+--
 -- ### 3.1.1) A2G coordinates setting **types**
--- 
+--
 -- Will customize which display format is used to indicate A2G coordinates in text as part of the Command Center communications.
--- 
+--
 --   - A2G BR: [Bearing Range](https://en.wikipedia.org/wiki/Bearing_(navigation)).
 --   - A2G MGRS: The [Military Grid Reference System](https://en.wikipedia.org/wiki/Military_Grid_Reference_System). The accuracy can also be adapted.
 --   - A2G LL DMS: Lattitude Longitude [Degrees Minutes Seconds](https://en.wikipedia.org/wiki/Geographic_coordinate_conversion). The accuracy can also be adapted.
 --   - A2G LL DDM: Lattitude Longitude [Decimal Degrees Minutes](https://en.wikipedia.org/wiki/Decimal_degrees). The accuracy can also be adapted.
--- 
+--
 -- ### 3.1.2) A2G coordinates setting **menu**
--- 
+--
 -- The settings can be changed by using the **Default settings menu** on the Command Center or the **Player settings menu** on the Player Slot.
--- 
+--
 -- ### 3.1.3) A2G coordinates setting **methods**
---   
+--
 -- There are different methods that can be used to change the **System settings** using the \_SETTINGS object.
--- 
+--
 --   - @{#SETTINGS.SetA2G_BR}(): Enable the BR display formatting by default.
 --   - @{#SETTINGS.SetA2G_MGRS}(): Enable the MGRS display formatting by default. Use @{SETTINGS.SetMGRS_Accuracy}() to adapt the accuracy of the MGRS formatting.
---   - @{#SETTINGS.SetA2G_LL_DMS}(): Enable the LL DMS display formatting by default. Use @{SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting. 
+--   - @{#SETTINGS.SetA2G_LL_DMS}(): Enable the LL DMS display formatting by default. Use @{SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting.
 --   - @{#SETTINGS.SetA2G_LL_DDM}(): Enable the LL DDM display formatting by default. Use @{SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting.
--- 
+--
 -- ### 3.1.4) A2G coordinates setting - additional notes
--- 
--- One additional note on BR. In a situation when a BR coordinate should be given, 
+--
+-- One additional note on BR. In a situation when a BR coordinate should be given,
 -- but there isn't any player context (no player unit to reference from), the MGRS formatting will be applied!
--- 
+--
 -- ## 3.2) **A2A coordinates** formatting
---   
+--
 -- ### 3.2.1) A2A coordinates setting **types**
--- 
+--
 -- Will customize which display format is used to indicate A2A coordinates in text as part of the Command Center communications.
--- 
+--
 --   - A2A BRAA: [Bearing Range Altitude Aspect](https://en.wikipedia.org/wiki/Bearing_(navigation)).
 --   - A2A MGRS: The [Military Grid Reference System](https://en.wikipedia.org/wiki/Military_Grid_Reference_System). The accuracy can also be adapted.
 --   - A2A LL DMS: Lattitude Longitude [Degrees Minutes Seconds](https://en.wikipedia.org/wiki/Geographic_coordinate_conversion). The accuracy can also be adapted.
 --   - A2A LL DDM: Lattitude Longitude [Decimal Degrees and Minutes](https://en.wikipedia.org/wiki/Decimal_degrees). The accuracy can also be adapted.
 --   - A2A BULLS: [Bullseye](http://falcon4.wikidot.com/concepts:bullseye).
---   
+--
 -- ### 3.2.2) A2A coordinates setting **menu**
--- 
+--
 -- The settings can be changed by using the **Default settings menu** on the Command Center or the **Player settings menu** on the Player Slot.
--- 
+--
 -- ### 3.2.3) A2A coordinates setting **methods**
---   
+--
 -- There are different methods that can be used to change the **System settings** using the \_SETTINGS object.
--- 
+--
 --   - @{#SETTINGS.SetA2A_BRAA}(): Enable the BR display formatting by default.
 --   - @{#SETTINGS.SetA2A_MGRS}(): Enable the MGRS display formatting by default. Use @{SETTINGS.SetMGRS_Accuracy}() to adapt the accuracy of the MGRS formatting.
---   - @{#SETTINGS.SetA2A_LL_DMS}(): Enable the LL DMS display formatting by default. Use @{SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting. 
+--   - @{#SETTINGS.SetA2A_LL_DMS}(): Enable the LL DMS display formatting by default. Use @{SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting.
 --   - @{#SETTINGS.SetA2A_LL_DDM}(): Enable the LL DDM display formatting by default. Use @{SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting.
 --   - @{#SETTINGS.SetA2A_BULLS}(): Enable the BULLSeye display formatting by default.
--- 
+--
 -- ### 3.2.4) A2A coordinates settings - additional notes
--- 
--- One additional note on BRAA. In a situation when a BRAA coordinate should be given, 
+--
+-- One additional note on BRAA. In a situation when a BRAA coordinate should be given,
 -- but there isn't any player context (no player unit to reference from), the MGRS formatting will be applied!
--- 
+--
 -- ## 3.3) **Measurements** formatting
--- 
+--
 -- ### 3.3.1) Measurements setting **types**
--- 
+--
 -- Will customize the measurements system being used as part as part of the Command Center communications.
--- 
+--
 --   - **Metrics** system: Applies the [Metrics system](https://en.wikipedia.org/wiki/Metric_system) ...
---   - **Imperial** system: Applies the [Imperial system](https://en.wikipedia.org/wiki/Imperial_units) ...  
--- 
+--   - **Imperial** system: Applies the [Imperial system](https://en.wikipedia.org/wiki/Imperial_units) ...
+--
 -- ### 3.3.2) Measurements setting **menu**
--- 
+--
 -- The settings can be changed by using the **Default settings menu** on the Command Center or the **Player settings menu** on the Player Slot.
--- 
+--
 -- ### 3.3.3) Measurements setting **methods**
---   
+--
 -- There are different methods that can be used to change the **Default settings** using the \_SETTINGS object.
--- 
+--
 --   - @{#SETTINGS.SetMetric}(): Enable the Metric system.
 --   - @{#SETTINGS.SetImperial}(): Enable the Imperial system.
---   
+--
 -- ## 3.4) **Message** display times
--- 
+--
 -- ### 3.4.1) Message setting **types**
--- 
+--
 -- There are various **Message Types** that will influence the duration how long a message will appear as part of the Command Center communications.
--- 
+--
 --   - **Update** message: A short update message.
 --   - **Information** message: Provides new information **while** executing a mission.
 --   - **Briefing** message: Provides a complete briefing **before** executing a mission.
 --   - **Overview report**: Provides a short report overview, the summary of the report.
 --   - **Detailed report**: Provides a complete report.
---   
+--
 -- ### 3.4.2) Message setting **menu**
--- 
+--
 -- The settings can be changed by using the **Default settings menu** on the Command Center or the **Player settings menu** on the Player Slot.
--- 
+--
 -- Each Message Type has specific timings that will be applied when the message is displayed.
 -- The Settings Menu will provide for each Message Type a selection of proposed durations from which can be choosen.
 -- So the player can choose its own amount of seconds how long a message should be displayed of a certain type.
 -- Note that **Update** messages can be chosen not to be displayed at all!
--- 
+--
 -- ### 3.4.3) Message setting **methods**
---   
+--
 -- There are different methods that can be used to change the **System settings** using the \_SETTINGS object.
--- 
---   - @{#SETTINGS.SetMessageTime}(): Define for a specific @{Message.MESSAGE.MessageType} the duration to be displayed in seconds. 
---   - @{#SETTINGS.GetMessageTime}(): Retrieves for a specific @{Message.MESSAGE.MessageType} the duration to be displayed in seconds. 
---   
+--
+--   - @{#SETTINGS.SetMessageTime}(): Define for a specific @{Message.MESSAGE.MessageType} the duration to be displayed in seconds.
+--   - @{#SETTINGS.GetMessageTime}(): Retrieves for a specific @{Message.MESSAGE.MessageType} the duration to be displayed in seconds.
+--
+-- ## 3.5) **Era** of the battle
+--
+-- The threat level metric is scaled according the era of the battle. A target that is AAA, will pose a much greather threat in WWII than on modern warfare.
+-- Therefore, there are 4 era that are defined within the settings:
+--
+--   - **WWII** era: Use for warfare with equipment during the world war II time.
+--   - **Korea** era: Use for warfare with equipment during the Korea war time.
+--   - **Cold War** era: Use for warfare with equipment during the cold war time.
+--   - **Modern** era: Use for warfare with modern equipment in the 2000s.
+--
+-- There are different API defined that you can use with the _SETTINGS object to configure your mission script to work in one of the 4 era:
+-- @{#SETTINGS.SetEraWWII}(), @{#SETTINGS.SetEraKorea}(), @{#SETTINGS.SetEraCold}(), @{#SETTINGS.SetEraModern}()
+--
 -- ===
--- 
+--
 -- @field #SETTINGS
 SETTINGS = {
   ClassName = "SETTINGS",
@@ -204,6 +217,19 @@ SETTINGS = {
   MenuStatic     = true,
 }
 
+SETTINGS.__Enum = {}
+
+--- @type SETTINGS.__Enum.Era
+-- @field #number WWII
+-- @field #number Korea
+-- @field #number Cold
+-- @field #number Modern
+SETTINGS.__Enum.Era = {
+  WWII = 1,
+  Korea = 2,
+  Cold = 3,
+  Modern = 4,
+}
 
 
 do -- SETTINGS
@@ -211,7 +237,7 @@ do -- SETTINGS
   --- SETTINGS constructor.
   -- @param #SETTINGS self
   -- @return #SETTINGS
-  function SETTINGS:Set( PlayerName ) 
+  function SETTINGS:Set( PlayerName )
 
     if PlayerName == nil then
       local self = BASE:Inherit( self, BASE:New() ) -- #SETTINGS
@@ -225,6 +251,7 @@ do -- SETTINGS
       self:SetMessageTime( MESSAGE.Type.Information, 30 )
       self:SetMessageTime( MESSAGE.Type.Overview, 60 )
       self:SetMessageTime( MESSAGE.Type.Update, 15 )
+      self:SetEraModern()
       self:SetMenutextShort(true)
       self:SetMenuStatic(true)
       return self
@@ -245,20 +272,20 @@ do -- SETTINGS
   function SETTINGS:SetMenutextShort(onoff)
     self.MenuShort = onoff
   end
-  
+
   --- Set menu to be static.
   -- @param #SETTINGS self
   -- @param #boolean onoff If *true* menu is static. If *false* menu will be updated after changes (default).
   function SETTINGS:SetMenuStatic(onoff)
     self.MenuStatic = onoff
-  end   
- 
+  end
+
   --- Sets the SETTINGS metric.
   -- @param #SETTINGS self
   function SETTINGS:SetMetric()
     self.Metric = true
   end
- 
+
   --- Gets if the SETTINGS is metric.
   -- @param #SETTINGS self
   -- @return #boolean true if metric.
@@ -271,7 +298,7 @@ do -- SETTINGS
   function SETTINGS:SetImperial()
     self.Metric = false
   end
- 
+
   --- Gets if the SETTINGS is imperial.
   -- @param #SETTINGS self
   -- @return #boolean true if imperial.
@@ -308,7 +335,7 @@ do -- SETTINGS
   function SETTINGS:GetMGRS_Accuracy()
     return self.MGRS_Accuracy or _SETTINGS:GetMGRS_Accuracy()
   end
-  
+
   --- Sets the SETTINGS Message Display Timing of a MessageType
   -- @param #SETTINGS self
   -- @param Core.Message#MESSAGE MessageType The type of the message.
@@ -317,8 +344,8 @@ do -- SETTINGS
     self.MessageTypeTimings = self.MessageTypeTimings or {}
     self.MessageTypeTimings[MessageType] = MessageTime
   end
-  
-  
+
+
   --- Gets the SETTINGS Message Display Timing of a MessageType
   -- @param #SETTINGS self
   -- @param Core.Message#MESSAGE MessageType The type of the message.
@@ -460,9 +487,9 @@ do -- SETTINGS
   function SETTINGS:SetSystemMenu( MenuGroup, RootMenu )
 
     local MenuText = "System Settings"
-    
+
     local MenuTime = timer.getTime()
-    
+
     local SettingsMenu = MENU_GROUP:New( MenuGroup, MenuText, RootMenu ):SetTime( MenuTime )
 
     -------
@@ -472,9 +499,9 @@ do -- SETTINGS
     local text="A2G Coordinate System XXX"
     if self.MenuShort then
       text="A2G Coordinates"
-    end           
+    end
     local A2GCoordinateMenu = MENU_GROUP:New( MenuGroup, text, SettingsMenu ):SetTime( MenuTime )
-      
+
     -- Set LL DMS
     if not self:IsA2G_LL_DMS() then
       local text="Lat/Lon Degree Min Sec (LL DMS)"
@@ -483,16 +510,16 @@ do -- SETTINGS
       end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2GCoordinateMenu, self.A2GMenuSystem, self, MenuGroup, RootMenu, "LL DMS" ):SetTime( MenuTime )
     end
-    
+
     -- Set LL DDM
     if not self:IsA2G_LL_DDM() then
       local text="Lat/Lon Degree Dec Min (LL DDM)"
       if self.MenuShort then
         text="LL DDM"
-      end    
+      end
       MENU_GROUP_COMMAND:New( MenuGroup, "Lat/Lon Degree Dec Min (LL DDM)", A2GCoordinateMenu, self.A2GMenuSystem, self, MenuGroup, RootMenu, "LL DDM" ):SetTime( MenuTime )
     end
-    
+
     -- Set LL DMS accuracy.
     if self:IsA2G_LL_DDM() then
       local text1="LL DDM Accuracy 1"
@@ -500,30 +527,30 @@ do -- SETTINGS
       local text3="LL DDM Accuracy 3"
       if self.MenuShort then
         text1="LL DDM"
-      end        
+      end
       MENU_GROUP_COMMAND:New( MenuGroup, "LL DDM Accuracy 1", A2GCoordinateMenu, self.MenuLL_DDM_Accuracy, self, MenuGroup, RootMenu, 1 ):SetTime( MenuTime )
       MENU_GROUP_COMMAND:New( MenuGroup, "LL DDM Accuracy 2", A2GCoordinateMenu, self.MenuLL_DDM_Accuracy, self, MenuGroup, RootMenu, 2 ):SetTime( MenuTime )
       MENU_GROUP_COMMAND:New( MenuGroup, "LL DDM Accuracy 3", A2GCoordinateMenu, self.MenuLL_DDM_Accuracy, self, MenuGroup, RootMenu, 3 ):SetTime( MenuTime )
     end
-    
+
     -- Set BR.
     if not self:IsA2G_BR() then
       local text="Bearing, Range (BR)"
       if self.MenuShort then
         text="BR"
-      end                
+      end
       MENU_GROUP_COMMAND:New( MenuGroup, text , A2GCoordinateMenu, self.A2GMenuSystem, self, MenuGroup, RootMenu, "BR" ):SetTime( MenuTime )
     end
-    
+
     -- Set MGRS.
     if not self:IsA2G_MGRS() then
       local text="Military Grid (MGRS)"
       if self.MenuShort then
         text="MGRS"
-      end                    
+      end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2GCoordinateMenu, self.A2GMenuSystem, self, MenuGroup, RootMenu, "MGRS" ):SetTime( MenuTime )
     end
-    
+
     -- Set MGRS accuracy.
     if self:IsA2G_MGRS() then
       MENU_GROUP_COMMAND:New( MenuGroup, "MGRS Accuracy 1", A2GCoordinateMenu, self.MenuMGRS_Accuracy, self, MenuGroup, RootMenu, 1 ):SetTime( MenuTime )
@@ -532,22 +559,22 @@ do -- SETTINGS
       MENU_GROUP_COMMAND:New( MenuGroup, "MGRS Accuracy 4", A2GCoordinateMenu, self.MenuMGRS_Accuracy, self, MenuGroup, RootMenu, 4 ):SetTime( MenuTime )
       MENU_GROUP_COMMAND:New( MenuGroup, "MGRS Accuracy 5", A2GCoordinateMenu, self.MenuMGRS_Accuracy, self, MenuGroup, RootMenu, 5 ):SetTime( MenuTime )
     end
-    
+
     -------
     -- A2A Coordinate System
     -------
-    
+
     local text="A2A Coordinate System"
     if self.MenuShort then
       text="A2A Coordinates"
-    end                    
+    end
     local A2ACoordinateMenu = MENU_GROUP:New( MenuGroup, text, SettingsMenu ):SetTime( MenuTime )
 
     if not self:IsA2A_LL_DMS() then
       local text="Lat/Lon Degree Min Sec (LL DMS)"
       if self.MenuShort then
         text="LL DMS"
-      end                        
+      end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2ACoordinateMenu, self.A2AMenuSystem, self, MenuGroup, RootMenu, "LL DMS" ):SetTime( MenuTime )
     end
 
@@ -555,7 +582,7 @@ do -- SETTINGS
       local text="Lat/Lon Degree Dec Min (LL DDM)"
       if self.MenuShort then
         text="LL DDM"
-      end                            
+      end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2ACoordinateMenu, self.A2AMenuSystem, self, MenuGroup, RootMenu, "LL DDM" ):SetTime( MenuTime )
     end
 
@@ -563,7 +590,7 @@ do -- SETTINGS
       MENU_GROUP_COMMAND:New( MenuGroup, "LL DDM Accuracy 1", A2ACoordinateMenu, self.MenuLL_DDM_Accuracy, self, MenuGroup, RootMenu, 1 ):SetTime( MenuTime )
       MENU_GROUP_COMMAND:New( MenuGroup, "LL DDM Accuracy 2", A2ACoordinateMenu, self.MenuLL_DDM_Accuracy, self, MenuGroup, RootMenu, 2 ):SetTime( MenuTime )
       MENU_GROUP_COMMAND:New( MenuGroup, "LL DDM Accuracy 3", A2ACoordinateMenu, self.MenuLL_DDM_Accuracy, self, MenuGroup, RootMenu, 3 ):SetTime( MenuTime )
-    end    
+    end
 
     if not self:IsA2A_BULLS() then
       local text="Bullseye (BULLS)"
@@ -572,20 +599,20 @@ do -- SETTINGS
       end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2ACoordinateMenu, self.A2AMenuSystem, self, MenuGroup, RootMenu, "BULLS" ):SetTime( MenuTime )
     end
-    
+
     if not self:IsA2A_BRAA() then
       local text="Bearing Range Altitude Aspect (BRAA)"
       if self.MenuShort then
         text="BRAA"
-      end    
+      end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2ACoordinateMenu, self.A2AMenuSystem, self, MenuGroup, RootMenu, "BRAA" ):SetTime( MenuTime )
     end
-    
+
     if not self:IsA2A_MGRS() then
       local text="Military Grid (MGRS)"
       if self.MenuShort then
         text="MGRS"
-      end    
+      end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2ACoordinateMenu, self.A2AMenuSystem, self, MenuGroup, RootMenu, "MGRS" ):SetTime( MenuTime )
     end
 
@@ -596,33 +623,33 @@ do -- SETTINGS
       MENU_GROUP_COMMAND:New( MenuGroup, "MGRS Accuracy 4", A2ACoordinateMenu, self.MenuMGRS_Accuracy, self, MenuGroup, RootMenu, 4 ):SetTime( MenuTime )
       MENU_GROUP_COMMAND:New( MenuGroup, "MGRS Accuracy 5", A2ACoordinateMenu, self.MenuMGRS_Accuracy, self, MenuGroup, RootMenu, 5 ):SetTime( MenuTime )
     end
-            
+
     local text="Measures and Weights System"
     if self.MenuShort then
       text="Unit System"
     end
     local MetricsMenu = MENU_GROUP:New( MenuGroup, text, SettingsMenu ):SetTime( MenuTime )
-    
+
     if self:IsMetric() then
       local text="Imperial (Miles,Feet)"
       if self.MenuShort then
         text="Imperial"
-      end    
+      end
       MENU_GROUP_COMMAND:New( MenuGroup, text, MetricsMenu, self.MenuMWSystem, self, MenuGroup, RootMenu, false ):SetTime( MenuTime )
     end
-    
+
     if self:IsImperial() then
       local text="Metric (Kilometers,Meters)"
       if self.MenuShort then
         text="Metric"
-      end        
+      end
       MENU_GROUP_COMMAND:New( MenuGroup, text, MetricsMenu, self.MenuMWSystem, self, MenuGroup, RootMenu, true ):SetTime( MenuTime )
-    end    
+    end
 
     local text="Messages and Reports"
     if self.MenuShort then
       text="Messages & Reports"
-    end            
+    end
     local MessagesMenu = MENU_GROUP:New( MenuGroup, text, SettingsMenu ):SetTime( MenuTime )
 
     local UpdateMessagesMenu = MENU_GROUP:New( MenuGroup, "Update Messages", MessagesMenu ):SetTime( MenuTime )
@@ -661,10 +688,10 @@ do -- SETTINGS
     MENU_GROUP_COMMAND:New( MenuGroup, "1 minute", DetailedReportsMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.DetailedReportsMenu, 60 ):SetTime( MenuTime )
     MENU_GROUP_COMMAND:New( MenuGroup, "2 minutes", DetailedReportsMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.DetailedReportsMenu, 120 ):SetTime( MenuTime )
     MENU_GROUP_COMMAND:New( MenuGroup, "3 minutes", DetailedReportsMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.DetailedReportsMenu, 180 ):SetTime( MenuTime )
-    
+
 
     SettingsMenu:Remove( MenuTime )
-    
+
     return self
   end
 
@@ -697,24 +724,24 @@ do -- SETTINGS
   function SETTINGS:SetPlayerMenu( PlayerUnit )
 
     if _SETTINGS.ShowPlayerMenu == true then
-    
+
       local PlayerGroup = PlayerUnit:GetGroup()
       local PlayerName = PlayerUnit:GetPlayerName()
       local PlayerNames = PlayerGroup:GetPlayerNames()
-  
+
       local PlayerMenu = MENU_GROUP:New( PlayerGroup, 'Settings "' .. PlayerName .. '"' )
-      
+
       self.PlayerMenu = PlayerMenu
-      
+
       self:I(string.format("FF Setting menu for player %s", tostring(PlayerName)))
-      
+
       local submenu = MENU_GROUP:New( PlayerGroup, "LL Accuracy", PlayerMenu )
       MENU_GROUP_COMMAND:New( PlayerGroup, "0 Decimal Places", submenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 0 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "1 Decimal Places", submenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 1 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "2 Decimal Places", submenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 2 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "3 Decimal Places", submenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 3 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "4 Decimal Places", submenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 4 )      
- 
+      MENU_GROUP_COMMAND:New( PlayerGroup, "4 Decimal Places", submenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 4 )
+
       local submenu = MENU_GROUP:New( PlayerGroup, "MGRS Accuracy", PlayerMenu )
       MENU_GROUP_COMMAND:New( PlayerGroup, "Accuracy 0", submenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 0 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "Accuracy 1", submenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 1 )
@@ -722,7 +749,7 @@ do -- SETTINGS
       MENU_GROUP_COMMAND:New( PlayerGroup, "Accuracy 3", submenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 3 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "Accuracy 4", submenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 4 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "Accuracy 5", submenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 5 )
-      
+
       ------
       -- A2G Coordinate System
       ------
@@ -730,118 +757,118 @@ do -- SETTINGS
       local text="A2G Coordinate System"
       if self.MenuShort then
         text="A2G Coordinates"
-      end  
+      end
       local A2GCoordinateMenu = MENU_GROUP:New( PlayerGroup, text, PlayerMenu )
-    
+
       if not self:IsA2G_LL_DMS() or self.MenuStatic then
         local text="Lat/Lon Degree Min Sec (LL DMS)"
         if self.MenuShort then
           text="LL DMS"
-        end      
+        end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DMS" )
       end
-    
+
       if not self:IsA2G_LL_DDM() or self.MenuStatic then
         local text="Lat/Lon Degree Dec Min (LL DDM)"
         if self.MenuShort then
           text="LL DDM"
-        end            
+        end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DDM" )
       end
-          
+
       if not self:IsA2G_BR() or self.MenuStatic then
         local text="Bearing, Range (BR)"
         if self.MenuShort then
           text="BR"
-        end                  
+        end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "BR" )
       end
-      
+
       if not self:IsA2G_MGRS() or self.MenuStatic then
         local text="Military Grid (MGRS)"
         if self.MenuShort then
           text="MGRS"
-        end      
+        end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "MGRS" )
-      end    
-    
+      end
+
       ------
       -- A2A Coordinates Menu
       ------
-  
+
       local text="A2A Coordinate System"
       if self.MenuShort then
         text="A2A Coordinates"
-      end        
+      end
       local A2ACoordinateMenu = MENU_GROUP:New( PlayerGroup, text, PlayerMenu )
-  
-  
+
+
       if not self:IsA2A_LL_DMS() or self.MenuStatic then
         local text="Lat/Lon Degree Min Sec (LL DMS)"
         if self.MenuShort then
           text="LL DMS"
-        end      
+        end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2ACoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DMS" )
       end
-    
+
       if not self:IsA2A_LL_DDM() or self.MenuStatic then
         local text="Lat/Lon Degree Dec Min (LL DDM)"
         if self.MenuShort then
           text="LL DDM"
-        end        
+        end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DDM" )
       end
-  
+
       if not self:IsA2A_BULLS() or self.MenuStatic then
         local text="Bullseye (BULLS)"
         if self.MenuShort then
           text="BULLS"
-        end      
+        end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "BULLS" )
       end
-      
+
       if not self:IsA2A_BRAA() or self.MenuStatic then
         local text="Bearing Range Altitude Aspect (BRAA)"
         if self.MenuShort then
           text="BRAA"
-        end 
+        end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "BRAA" )
       end
-      
+
       if not self:IsA2A_MGRS() or self.MenuStatic then
         local text="Military Grid (MGRS)"
         if self.MenuShort then
           text="MGRS"
-        end      
+        end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "MGRS" )
       end
-      
+
       ---
       -- Unit system
-      --- 
- 
+      ---
+
       local text="Measures and Weights System"
       if self.MenuShort then
         text="Unit System"
-      end       
+      end
       local MetricsMenu = MENU_GROUP:New( PlayerGroup, text, PlayerMenu )
-      
+
       if self:IsMetric() or self.MenuStatic then
         local text="Imperial (Miles,Feet)"
         if self.MenuShort then
           text="Imperial"
-        end             
+        end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, MetricsMenu, self.MenuGroupMWSystem, self, PlayerUnit, PlayerGroup, PlayerName, false )
       end
-      
+
       if self:IsImperial() or self.MenuStatic then
         local text="Metric (Kilometers,Meters)"
         if self.MenuShort then
           text="Metric"
-        end                   
+        end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, MetricsMenu, self.MenuGroupMWSystem, self, PlayerUnit, PlayerGroup, PlayerName, true )
-      end    
-  
+      end
+
       ---
       -- Messages and Reports
       ---
@@ -849,9 +876,9 @@ do -- SETTINGS
       local text="Messages and Reports"
       if self.MenuShort then
         text="Messages & Reports"
-      end  
+      end
       local MessagesMenu = MENU_GROUP:New( PlayerGroup, text, PlayerMenu )
-  
+
       local UpdateMessagesMenu = MENU_GROUP:New( PlayerGroup, "Update Messages", MessagesMenu )
       MENU_GROUP_COMMAND:New( PlayerGroup, "Off", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 0 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "5 seconds", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 5 )
@@ -859,7 +886,7 @@ do -- SETTINGS
       MENU_GROUP_COMMAND:New( PlayerGroup, "15 seconds", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 15 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "30 seconds", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 30 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "1 minute", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 60 )
-  
+
       local InformationMessagesMenu = MENU_GROUP:New( PlayerGroup, "Information Messages", MessagesMenu )
       MENU_GROUP_COMMAND:New( PlayerGroup, "5 seconds", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 5 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "10 seconds", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 10 )
@@ -867,30 +894,30 @@ do -- SETTINGS
       MENU_GROUP_COMMAND:New( PlayerGroup, "30 seconds", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 30 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "1 minute", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 60 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "2 minutes", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 120 )
-  
+
       local BriefingReportsMenu = MENU_GROUP:New( PlayerGroup, "Briefing Reports", MessagesMenu )
       MENU_GROUP_COMMAND:New( PlayerGroup, "15 seconds", BriefingReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Briefing, 15 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "30 seconds", BriefingReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Briefing, 30 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "1 minute", BriefingReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Briefing, 60 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "2 minutes", BriefingReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Briefing, 120 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "3 minutes", BriefingReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Briefing, 180 )
-  
+
       local OverviewReportsMenu = MENU_GROUP:New( PlayerGroup, "Overview Reports", MessagesMenu )
       MENU_GROUP_COMMAND:New( PlayerGroup, "15 seconds", OverviewReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Overview, 15 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "30 seconds", OverviewReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Overview, 30 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "1 minute", OverviewReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Overview, 60 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "2 minutes", OverviewReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Overview, 120 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "3 minutes", OverviewReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Overview, 180 )
-  
+
       local DetailedReportsMenu = MENU_GROUP:New( PlayerGroup, "Detailed Reports", MessagesMenu )
       MENU_GROUP_COMMAND:New( PlayerGroup, "15 seconds", DetailedReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.DetailedReportsMenu, 15 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "30 seconds", DetailedReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.DetailedReportsMenu, 30 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "1 minute", DetailedReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.DetailedReportsMenu, 60 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "2 minutes", DetailedReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.DetailedReportsMenu, 120 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "3 minutes", DetailedReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.DetailedReportsMenu, 180 )
-    
-    end  
-    
+
+    end
+
     return self
   end
 
@@ -904,7 +931,7 @@ do -- SETTINGS
       self.PlayerMenu:Remove()
       self.PlayerMenu = nil
     end
-    
+
     return self
   end
 
@@ -961,7 +988,7 @@ do -- SETTINGS
         self:SetPlayerMenu(PlayerUnit)
       end
     end
-  
+
     --- @param #SETTINGS self
     function SETTINGS:MenuGroupA2ASystem( PlayerUnit, PlayerGroup, PlayerName, A2ASystem )
       self.A2ASystem = A2ASystem
@@ -971,7 +998,7 @@ do -- SETTINGS
         self:SetPlayerMenu(PlayerUnit)
       end
     end
-  
+
     --- @param #SETTINGS self
     function SETTINGS:MenuGroupLL_DDM_AccuracySystem( PlayerUnit, PlayerGroup, PlayerName, LL_Accuracy )
       self.LL_Accuracy = LL_Accuracy
@@ -981,7 +1008,7 @@ do -- SETTINGS
         self:SetPlayerMenu(PlayerUnit)
       end
     end
-  
+
     --- @param #SETTINGS self
     function SETTINGS:MenuGroupMGRS_AccuracySystem( PlayerUnit, PlayerGroup, PlayerName, MGRS_Accuracy )
       self.MGRS_Accuracy = MGRS_Accuracy
@@ -1007,9 +1034,48 @@ do -- SETTINGS
       self:SetMessageTime( MessageType, MessageTime )
       MESSAGE:New( string.format( "Settings: Default message time set for %s to %d.", MessageType, MessageTime ), 5 ):ToGroup( PlayerGroup )
     end
-  
+
   end
 
+  --- Configures the era of the mission to be WWII.
+  -- @param #SETTINGS self
+  -- @return #SETTINGS self
+  function SETTINGS:SetEraWWII()
+
+    self.Era = SETTINGS.__Enum.Era.WWII
+
+  end
+
+  --- Configures the era of the mission to be Korea.
+  -- @param #SETTINGS self
+  -- @return #SETTINGS self
+  function SETTINGS:SetEraKorea()
+
+    self.Era = SETTINGS.__Enum.Era.Korea
+
+  end
+
+
+  --- Configures the era of the mission to be Cold war.
+  -- @param #SETTINGS self
+  -- @return #SETTINGS self
+  function SETTINGS:SetEraCold()
+
+    self.Era = SETTINGS.__Enum.Era.Cold
+
+  end
+
+
+  --- Configures the era of the mission to be Modern war.
+  -- @param #SETTINGS self
+  -- @return #SETTINGS self
+  function SETTINGS:SetEraModern()
+
+    self.Era = SETTINGS.__Enum.Era.Modern
+
+  end
+
+
+
+
 end
-
-