diff --git a/Moose Development/Moose/Core/Settings.lua b/Moose Development/Moose/Core/Settings.lua index 36047beb4..85498104d 100644 --- a/Moose Development/Moose/Core/Settings.lua +++ b/Moose Development/Moose/Core/Settings.lua @@ -1,4 +1,4 @@ ---- **Core** -- **SETTINGS** classe defines the format settings management for measurement. +--- **Core** -- Manages various settings for MOOSE classes. -- -- ![Banner Image](..\Presentations\SETTINGS\Dia1.JPG) -- @@ -20,15 +20,13 @@ --- @type SETTINGS --- @field #number LL_Accuracy --- @field #boolean LL_DMS --- @field #number MGRS_Accuracy --- @field #string A2GSystem --- @field #string A2ASystem -- @extends Core.Base#BASE --- # SETTINGS class, extends @{Base#BASE} --- +-- The SETTINGS class takes care of various settings that influence the behaviour of certain functionalities and classes within the MOOSE framework. +-- +-- === +-- -- ![Banner Image](..\Presentations\SETTINGS\Dia1.JPG) -- -- === @@ -41,29 +39,29 @@ -- -- 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. -- --- ## \_SETTINGS object +-- ## 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. -- --- ## SETTINGS Menu +-- ## 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. -- --- ### Default settings menu +-- ### 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. -- --- ### Player settings menu +-- ### 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. -- --- ### Switch off the setting menus +-- ### 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. @@ -77,14 +75,14 @@ -- -- But only when a player exits and reenters the slot these settings will have effect! -- -- --- --- --- ## Setting Types +-- ## 3. Settings -- -- There are different settings that are managed and applied within the MOOSE framework. -- See below a comprehensive description of each. -- --- ### **A2G coordinates** display formatting +-- ### 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. -- @@ -93,7 +91,11 @@ -- - 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. -- @@ -102,11 +104,15 @@ -- - @{#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, -- but there isn't any player context (no player unit to reference from), the MGRS formatting will be applied! -- --- ### **A2A coordinates** formatting +-- ### 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)). @@ -115,8 +121,12 @@ -- - 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. @@ -125,24 +135,34 @@ -- - @{#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, -- but there isn't any player context (no player unit to reference from), the MGRS formatting will be applied! -- --- ### **Measurements** formatting +-- ### 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) ... -- +-- #### 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. -- --- ### **Message** display times +-- ### 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. -- @@ -152,6 +172,8 @@ -- - **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. @@ -159,12 +181,15 @@ -- 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. -- -- === +-- -- @field #SETTINGS SETTINGS = { ClassName = "SETTINGS",