weyne/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-08-15 10:47:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs build test

Browse Source
This commit is contained in:
Applevangelist 2021-10-28 08:12:23 +02:00
parent 300e3f2f58
commit db231fafeb
1 changed files with 31 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
Moose Development/Moose/Core/Menu.lua
View File

@ -33,15 +33,15 @@
-- --
-- ### To manage **main menus**, the classes begin with **MENU_**: -- ### To manage **main menus**, the classes begin with **MENU_**:
-- --
-- * @{Core.Menu#MENU_MISSION}: Manages main menus for whole mission file. -- * Core.Menu#MENU_MISSION: Manages main menus for whole mission file.
-- * @{Core.Menu#MENU_COALITION}: Manages main menus for whole coalition. -- * Core.Menu#MENU_COALITION: Manages main menus for whole coalition.
-- * @{Core.Menu#MENU_GROUP}: Manages main menus for GROUPs. -- * Core.Menu#MENU_GROUP: Manages main menus for GROUPs.
-- --
-- ### To manage **command menus**, which are menus that allow the player to issue **functions**, the classes begin with **MENU_COMMAND_**: -- ### To manage **command menus**, which are menus that allow the player to issue **functions**, the classes begin with **MENU_COMMAND_**:
-- --
-- * @{Core.Menu#MENU_MISSION_COMMAND}: Manages command menus for whole mission file. -- * Core.Menu#MENU_MISSION_COMMAND: Manages command menus for whole mission file.
-- * @{Core.Menu#MENU_COALITION_COMMAND}: Manages command menus for whole coalition. -- * Core.Menu#MENU_COALITION_COMMAND: Manages command menus for whole coalition.
-- * @{Core.Menu#MENU_GROUP_COMMAND}: Manages command menus for GROUPs. -- * Core.Menu#MENU_GROUP_COMMAND: Manages command menus for GROUPs.
-- --
-- === -- ===
--- ---
@ -206,8 +206,9 @@ end
do -- MENU_BASE do -- MENU_BASE
--- @type MENU_BASE ---
-- @extends Base#BASE -- @type MENU_BASE
-- @extends Core.Base#BASE
--- Defines the main MENU class where other MENU classes are derived from. --- Defines the main MENU class where other MENU classes are derived from.
-- This is an abstract class, so don't use it. -- This is an abstract class, so don't use it.
@ -326,7 +327,8 @@ end
do -- MENU_COMMAND_BASE do -- MENU_COMMAND_BASE
--- @type MENU_COMMAND_BASE ---
-- @type MENU_COMMAND_BASE
-- @field #function MenuCallHandler -- @field #function MenuCallHandler
-- @extends Core.Menu#MENU_BASE -- @extends Core.Menu#MENU_BASE
@ -397,7 +399,8 @@ end
do -- MENU_MISSION do -- MENU_MISSION
--- @type MENU_MISSION ---
-- @type MENU_MISSION
-- @extends Core.Menu#MENU_BASE -- @extends Core.Menu#MENU_BASE
--- Manages the main menus for a complete mission. --- Manages the main menus for a complete mission.
@ -493,7 +496,8 @@ end
do -- MENU_MISSION_COMMAND do -- MENU_MISSION_COMMAND
--- @type MENU_MISSION_COMMAND ---
-- @type MENU_MISSION_COMMAND
-- @extends Core.Menu#MENU_COMMAND_BASE -- @extends Core.Menu#MENU_COMMAND_BASE
--- Manages the command menus for a complete mission, which allow players to execute functions during mission execution. --- Manages the command menus for a complete mission, which allow players to execute functions during mission execution.
@ -579,7 +583,8 @@ end
do -- MENU_COALITION do -- MENU_COALITION
--- @type MENU_COALITION ---
-- @type MENU_COALITION
-- @extends Core.Menu#MENU_BASE -- @extends Core.Menu#MENU_BASE
--- Manages the main menus for @{DCS.coalition}s. --- Manages the main menus for @{DCS.coalition}s.
@ -716,7 +721,8 @@ end
do -- MENU_COALITION_COMMAND do -- MENU_COALITION_COMMAND
--- @type MENU_COALITION_COMMAND ---
-- @type MENU_COALITION_COMMAND
-- @extends Core.Menu#MENU_COMMAND_BASE -- @extends Core.Menu#MENU_COMMAND_BASE
--- Manages the command menus for coalitions, which allow players to execute functions during mission execution. --- Manages the command menus for coalitions, which allow players to execute functions during mission execution.
@ -814,7 +820,8 @@ do
-- These menu classes are handling this logic with this variable. -- These menu classes are handling this logic with this variable.
local _MENUGROUPS = {} local _MENUGROUPS = {}
--- @type MENU_GROUP ---
-- @type MENU_GROUP
-- @extends Core.Menu#MENU_BASE -- @extends Core.Menu#MENU_BASE
@ -845,7 +852,7 @@ do
-- MenuStatus[MenuGroupName]:Remove() -- MenuStatus[MenuGroupName]:Remove()
-- end -- end
-- --
-- --- @param Wrapper.Group#GROUP MenuGroup -- -- @param Wrapper.Group#GROUP MenuGroup
-- local function AddStatusMenu( MenuGroup ) -- local function AddStatusMenu( MenuGroup )
-- local MenuGroupName = MenuGroup:GetName() -- local MenuGroupName = MenuGroup:GetName()
-- -- This would create a menu for the red coalition under the MenuCoalitionRed menu object. -- -- This would create a menu for the red coalition under the MenuCoalitionRed menu object.
@ -971,8 +978,8 @@ do
return self return self
end end
---
--- @type MENU_GROUP_COMMAND -- @type MENU_GROUP_COMMAND
-- @extends Core.Menu#MENU_COMMAND_BASE -- @extends Core.Menu#MENU_COMMAND_BASE
--- The @{Core.Menu#MENU_GROUP_COMMAND} class manages the command menus for coalitions, which allow players to execute functions during mission execution. --- The @{Core.Menu#MENU_GROUP_COMMAND} class manages the command menus for coalitions, which allow players to execute functions during mission execution.
@ -1065,8 +1072,8 @@ end
--- MENU_GROUP_DELAYED --- MENU_GROUP_DELAYED
do do
---
--- @type MENU_GROUP_DELAYED -- @type MENU_GROUP_DELAYED
-- @extends Core.Menu#MENU_BASE -- @extends Core.Menu#MENU_BASE
@ -1200,8 +1207,8 @@ do
return self return self
end end
---
--- @type MENU_GROUP_COMMAND_DELAYED -- @type MENU_GROUP_COMMAND_DELAYED
-- @extends Core.Menu#MENU_COMMAND_BASE -- @extends Core.Menu#MENU_COMMAND_BASE
--- Manages the command menus for coalitions, which allow players to execute functions during mission execution. --- Manages the command menus for coalitions, which allow players to execute functions during mission execution.