Changeset 6718 for code/branches/gamestates2/data/gui/scripts

Timestamp:

Apr 13, 2010, 3:55:30 PM (15 years ago)

Author:

rgrieder

Message:

Moved BasicGUI.lua to GUISheet.lua and derived MenuSheet.lua as well as HUDSheet.lua from it.
Also, to make a new GUI sheet, use either createHUDSheet or createMenuSheet.
Also removed bShowCursor from the showGUI function. This is now always a value directed by the GUI sheet.

Location:

code/branches/gamestates2/data/gui/scripts

Files:

• AudioMenu.lua (modified) (1 diff)
• ControlsMenu.lua (modified) (1 diff)
• CreditsMenu.lua (modified) (1 diff)
• DecisionPopup.lua (modified) (1 diff)
• GUISheet.lua (moved) (moved from code/branches/gamestates2/data/gui/scripts/BasicGUI.lua) (3 diffs)
• GUITools.lua (modified) (1 diff)
• GameplayMenu.lua (modified) (1 diff)
• GraphicsMenu.lua (modified) (1 diff)
• HUDSheet.lua (added)
• InGameMenu.lua (modified) (1 diff)
• InfoPopup.lua (modified) (1 diff)
• InitialiseGUI.lua (modified) (9 diffs)
• KeyBindMenu.lua (modified) (1 diff)
• MainMenu.lua (modified) (1 diff)
• MenuSheet.lua (added)
• MouseControlsMenu.lua (modified) (1 diff)
• MultiplayerMenu.lua (modified) (1 diff)
• MultiplayerOptionsMenu.lua (modified) (1 diff)
• PickupInventory.lua (modified) (1 diff)
• QuestGUI.lua (modified) (1 diff)
• SettingsMenu.lua (modified) (1 diff)
• SingleplayerMenu.lua (modified) (1 diff)

code/branches/gamestates2/data/gui/scripts/AudioMenu.lua

@@ -1 +1 @@
 -- AudioMenu.lua
 
-local P = createSheet("AudioMenu")
+local P = createMenuSheet("AudioMenu")
 
 function P.init()

code/branches/gamestates2/data/gui/scripts/ControlsMenu.lua

@@ -1 +1 @@
 -- ControlsMenu.lua
 
-local P = createSheet("ControlsMenu")
+local P = createMenuSheet("ControlsMenu")
 
 function P.ControlsMouseControlsButton_clicked(e)

code/branches/gamestates2/data/gui/scripts/CreditsMenu.lua

@@ -1 +1 @@
 -- CreditsMenu.lua
 
-local P = createSheet("CreditsMenu")
+local P = createMenuSheet("CreditsMenu")
 
 function P.CreditsBackButton_clicked(e)

code/branches/gamestates2/data/gui/scripts/DecisionPopup.lua

@@ -1 +1 @@
 -- DecisionPopup.lua
 
-local P = createSheet("DecisionPopup")
+local P = createMenuSheet("DecisionPopup")
 
 function P.setCallback(functionPtr)

code/branches/gamestates2/data/gui/scripts/GUISheet.lua

@@ -1 @@
--- BasicGUI.lua
+-- GUISheet.lua
 
 local P = {}
-_G[_REQUIREDNAME or "BasicGUI"] = P
+_G[_REQUIREDNAME or "GUISheet"] = P
+P.__index = P
 
--- useless, even wrong? P is the class, not the object..
-P.overlay = nil
-
--- constructor of the GUI
-function P:new(_name, _gui, _visible)
-    local newElement = {
-        name = _name,
-        gui = _gui,
-        visible = _visible or false
-    } or {}
-    setmetatable(newElement, self) -- connects new element with class
-    self.__index = self
-    return newElement
+-- Don't use directly --> use HUDSheet.new or MenuSheet.new
+function P.new(_name)
+    local newSheet = { name = _name }
+    setmetatable(newSheet, P)
+    return newSheet
 end
 
--- Override this function if you need to
+-- Override this function if you need to do work on load
+-- TODO: rename to onLoad
 function P:init()
-end
-
--- Override this function if you want to change one of the three input parameters:
--- showCursor = true, useKeyboard = true and blockJoyStick = false
--- But don't forget to stick to the naming convention ("GUI_" .. self.name)
-function P:createInputState()
-    self.inputState = guiMgr:createInputState("GUI_" .. self.name)
 end
 
@@ -33 +20 @@
 function P:hide()
     self.window:hide()
-    self.visible = false
+    self.bVisible = false
 end
 
@@ -39 +26 @@
 function P:show()
     self.window:show()
-    self.visible = true
+    self.bVisible = true
 end
 
 function P:load()
+    -- Load the layout that describes the sheet
     self.window = winMgr:loadWindowLayout(self.name .. ".layout")
-    self:createInputState()
+    if self.window == nil then
+        error("Could not load layout file for GUI sheet '"..self.name.."'")
+    end
+    -- Hide it at first
+    self:hide()
+    -- Allow sheets to do some work upon loading
     self:init()
     return self

code/branches/gamestates2/data/gui/scripts/GUITools.lua

@@ -1 @@
-function createSheet(sheetName)
-    -- Create object of type BasicGUI and make it global
-    local basicGUI = require("BasicGUI")
-    if basicGUI == nil then
-        error("Loading BasicGUI.lua failed")
-    end
-    local sheet = basicGUI:new(sheetName)
-    _G[sheetName] = sheet
+-- Returns a new menu sheet
+-- See MenuSheet.new for details about the parameters
+function createMenuSheet(name, bHidePrevious, tShowCursor, tUseKeyboard, bBlockJoyStick)
+    local sheet = require("MenuSheet").new(name, bHidePrevious, tShowCursor, tUseKeyboard, bBlockJoyStick)
+    _G[sheet.name] = sheet -- Global access required because of the event handlers
+    return sheet
+end
+
+-- Returns a new HUD sheet
+function createHUDSheet(name)
+    local sheet = require("HUDSheet").new(name)
+    _G[sheet.name] = sheet -- Global access required because of the event handlers
     return sheet
 end

code/branches/gamestates2/data/gui/scripts/GameplayMenu.lua

@@ -1 +1 @@
 -- GameplayMenu.lua
 
-local P = createSheet("GameplayMenu")
+local P = createMenuSheet("GameplayMenu")
 
 function P.init()

code/branches/gamestates2/data/gui/scripts/GraphicsMenu.lua

@@ -1 +1 @@
 -- GraphicsMenu.lua
 
-local P = createSheet("GraphicsMenu")
+local P = createMenuSheet("GraphicsMenu")
 
 function P.init()

code/branches/gamestates2/data/gui/scripts/InGameMenu.lua

@@ -1 +1 @@
 -- InGameMenu.lua
 
-local P = createSheet("InGameMenu")
+local P = createMenuSheet("InGameMenu")
 
 -- events for ingamemenu

code/branches/gamestates2/data/gui/scripts/InfoPopup.lua

@@ -1 +1 @@
 -- InfoPopup.lua
 
-local P = createSheet("InfoPopup")
+local P = createMenuSheet("InfoPopup")
 
 function P.execute(functionPtr, arguments)

code/branches/gamestates2/data/gui/scripts/InitialiseGUI.lua

@@ -30 +30 @@
 
 local loadedSheets = {}
-local activeMenuSheets = {size = 0, topSheet = nil}
---activeHUDSheets  = {size = 0, topSheet = nil}
+local activeMenuSheets = {size = 0, topSheetTuple = nil}
+--activeHUDSheets  = {size = 0, topSheetTuple = nil}
 local root = nil
 
@@ -51 +51 @@
         -- Load the sheet
         sheet = require(name)
-        if sheet == nil then
-            return
-        end
         sheet:load()
         loadedSheets[name] = sheet
-        -- Hide new GUI as we do not want to show it accidentally
-        sheet:hide()
     end
     return sheet
@@ -80 +75 @@
 
 -- ?
-function showGUI(name, bHidePrevious, bShowCursor, ptr)
-    gui = showGUI(name, bHidePrevious, bShowCursor)
-    gui.overlay = ptr
+function showGUI(name, bHidePrevious, ptr)
+    local sheet = showGUI(name, bHidePrevious)
+    sheet.overlay = ptr
+    return sheet
 end
 
 -- Shows the specified menu sheet and loads it if neccessary
-function showGUI(name, bHidePrevious, bShowCursor)
-    -- Handle default value for bShowCursor
-    if bShowCursor == nil then
-        if activeMenuSheets.size > 0 then
-            bShowCursor = activeMenuSheets.topSheet.bShowCursor
-        else
-            bShowCursor = true
-        end
+function showGUI(name, bHidePrevious)
+    -- Get sheet (or load it)
+    local menuSheet = loadSheet(name)
+    if not menuSheet then
+        return nil
+    end
+
+    -- Use sheet's value if nil was provided
+    if bHidePrevious == nil then
+        bHidePrevious = menuSheet.bHidePrevious
+        assert(bHidePrevious ~= nil)
     end
 
@@ -101 +100 @@
     end
 
-    if not root then
-        setBackground("")
-    end
-
-    -- Get sheet (or load it)
-    local menuSheet = loadSheet(name)
-    if not menuSheet then
-        return
-    end
-
-    -- Add sheet to the root window
-    root:addChildWindow(menuSheet.window)
-
-    -- Pause game control if this is the first menu to be displayed
-    -- HUGE HACK?
-    if activeMenuSheets.size == 0 then
-        orxonox.HumanController:pauseControl()
-    end
-
-    -- Handle input distribution
-    orxonox.InputManager:getInstance():enterState(menuSheet.inputState)
-
-    if bShowCursor then
-        showCursor()
-    else
-        hideCursor()
-    end
-
     -- Add the sheet in a tuple of additional information
     local sheetTuple =
     {
-        ["menuSheet"]      = menuSheet,
-        ["name"]           = name,
-        ["bShowCursor"]    = bShowCursor,
+        ["sheet"]          = menuSheet,
         ["bHidePrevious"]  = bHidePrevious
     }
@@ -140 +109 @@
     activeMenuSheets[name] = sheetTuple -- name access
     activeMenuSheets.size = activeMenuSheets.size + 1
-    activeMenuSheets.topSheet = sheetTuple
+    activeMenuSheets.topSheetTuple = sheetTuple
+
+    if not root then
+        setBackground("")
+    end
+
+    -- Add sheet to the root window
+    root:addChildWindow(menuSheet.window)
+
+    -- Pause game control if this is the first menu to be displayed
+    -- HUGE HACK?
+    if activeMenuSheets.size == 0 then
+        orxonox.HumanController:pauseControl()
+    end
+
+    -- Handle input distribution
+    orxonox.InputManager:getInstance():enterState(menuSheet.inputState)
+
+    -- Only change cursor situation if menuSheet.tShowCursor ~= TriBool.Dontcare
+    if menuSheet.tShowCursor == TriBool.True then
+        showCursor()
+    elseif menuSheet.tShowCursor == TriBool.False then
+        hideCursor()
+    end
 
     -- Hide all previous sheets if necessary
     if bHidePrevious then
         for i = 1, activeMenuSheets.size - 1 do
-            activeMenuSheets[i].menuSheet:hide()
+            activeMenuSheets[i].sheet:hide()
         end
     end
 
     menuSheet:show()
+
     return menuSheet
 end
@@ -160 +153 @@
 
     -- Hide the sheet
-    sheetTuple.menuSheet:hide()
+    sheetTuple.sheet:hide()
 
     -- Show sheets that were hidden by the sheet to be removed
     local i = activeMenuSheets.size
     -- Only do something if all sheets on top of sheetTuple
-    -- have bHidePrevious == false and sheetTuple.bHidePrevious == true
+    -- have bHidePrevious == true and sheetTuple.bHidePrevious == true
     while i > 0 do
-        if activeMenuSheets[i].bHidePrevious == true then
+        if activeMenuSheets[i].bHidePrevious then
             if activeMenuSheets[i] == sheetTuple then
                 i = i - 1
                 while i > 0 do
-                    activeMenuSheets[i].menuSheet:show()
-                    if activeMenuSheets[i].bHidePrevious == true then
+                    activeMenuSheets[i].sheet:show()
+                    if activeMenuSheets[i].bHidePrevious then
                         break
                     end
@@ -184 +177 @@
 
     -- Remove sheet with its tuple from the table
-    root:removeChildWindow(sheetTuple.menuSheet.window)
+    root:removeChildWindow(sheetTuple.sheet.window)
     table.remove(activeMenuSheets, table.findIndex(activeMenuSheets, sheetTuple))
     activeMenuSheets[name] = nil
     activeMenuSheets.size = activeMenuSheets.size - 1
-    activeMenuSheets.topSheet = activeMenuSheets[activeMenuSheets.size]
+    activeMenuSheets.topSheetTuple = activeMenuSheets[activeMenuSheets.size]
 
     -- Leave the input state
-    orxonox.InputManager:getInstance():leaveState(sheetTuple.menuSheet.inputState)
+    orxonox.InputManager:getInstance():leaveState(sheetTuple.sheet.inputState)
     
-    -- See whether to show or hide cursor
-    if activeMenuSheets.size > 0 and activeMenuSheets.topSheet.bShowCursor then
+    -- CURSOR SHOWING
+    local i = activeMenuSheets.size
+    -- Find top most sheet that doesn't have tShowCusor == TriBool.Dontcare
+    while i > 0 and activeMenuSheets[i].sheet.tShowCursor == TriBool.Dontcare do
+        i = i - 1
+    end
+    if i > 0 and activeMenuSheets[i].sheet.tShowCursor == TriBool.True then
         showCursor()
     else
@@ -210 +208 @@
 function hideAllGUIs()
     while activeMenuSheets.size ~= 0 do
-        hideGUI(activeMenuSheets.topSheet.name)
+        hideGUI(activeMenuSheets.topSheetTuple.sheet.name)
     end
 end
@@ -216 +214 @@
 function keyESC()
     -- HUGE, very HUGE hacks!
-    if activeMenuSheets.size == 1 and activeMenuSheets[1].name == "MainMenu" then
+    if activeMenuSheets.size == 1 and activeMenuSheets[1].sheet.name == "MainMenu" then
         orxonox.execute("exit")
     elseif activeMenuSheets.size > 0 then
-        orxonox.execute("hideGUI "..activeMenuSheets.topSheet.name)
+        orxonox.execute("hideGUI "..activeMenuSheets.topSheetTuple.sheet.name)
     else
         showGUI("InGameMenu")

code/branches/gamestates2/data/gui/scripts/KeyBindMenu.lua

@@ -1 +1 @@
 -- KeyBindMenu.lua
 
-local P = createSheet("KeyBindMenu")
+local P = createMenuSheet("KeyBindMenu")
 
 function P.init()

code/branches/gamestates2/data/gui/scripts/MainMenu.lua

@@ -1 +1 @@
 -- MainMenu.lua
 
-local P = createSheet("MainMenu")
+local P = createMenuSheet("MainMenu")
 
 -- events for MainMenu

code/branches/gamestates2/data/gui/scripts/MouseControlsMenu.lua

@@ -1 +1 @@
 -- MouseControlsMenu.lua
 
-local P = createSheet("MouseControlsMenu")
+local P = createMenuSheet("MouseControlsMenu")
 
 function P.init()

code/branches/gamestates2/data/gui/scripts/MultiplayerMenu.lua

@@ -1 +1 @@
 -- MultiplayerMenu.lua
 
-local P = createSheet("MultiplayerMenu")
+local P = createMenuSheet("MultiplayerMenu")
 
 function P.init()

code/branches/gamestates2/data/gui/scripts/MultiplayerOptionsMenu.lua

@@ -1 +1 @@
 -- MultiplayerOptionsMenu.lua
 
-local P = createSheet("MultiplayerOptionsMenu")
+local P = createMenuSheet("MultiplayerOptionsMenu")
 
 function P.MultiplayerOptionsBackButton_clicked(e)

code/branches/gamestates2/data/gui/scripts/PickupInventory.lua

@@ -1 +1 @@
 -- PickupInventory.lua
 
-local P = createSheet("PickupInventory")
+local P = createMenuSheet("PickupInventory")
 
 P.lastEquipmentCount_ = 0

code/branches/gamestates2/data/gui/scripts/QuestGUI.lua

@@ -1 +1 @@
 -- QuestGUI.lua
 
-local P = createSheet("QuestGUI")
+local P = createMenuSheet("QuestGUI")
 
 function P.show()

code/branches/gamestates2/data/gui/scripts/SettingsMenu.lua

@@ -1 +1 @@
 -- SettingsMenu.lua
 
-local P = createSheet("SettingsMenu")
+local P = createMenuSheet("SettingsMenu")
 
 function P.SettingsGameplayButton_clicked(e)

code/branches/gamestates2/data/gui/scripts/SingleplayerMenu.lua

@@ -1 +1 @@
 -- SingleplayerMenu.lua
 
-local P = createSheet("SingleplayerMenu")
+local P = createMenuSheet("SingleplayerMenu")
 
 function P.init()