Changeset 7831 for code

Timestamp:

Jan 17, 2011, 8:51:15 PM (14 years ago)

Author:

dafrick

Message:

Improvements on QuestGUI, also documented some of the code.

Location:

code/branches/tutoriallevel/data/gui

Files:

• layouts/QuestGUI.layout (modified) (1 diff)
• scripts/QuestGUI.lua (modified) (22 diffs)

code/branches/tutoriallevel/data/gui/layouts/QuestGUI.layout

@@ -41 +41 @@
                 </Window>
 
-                <Window Type="MenuWidgets/ScrollablePane" Name="orxonox/QuestGUI/Quest/Wrapper">
-                    <Property Name="UnifiedAreaRect" Value="{{0,0},{0,30},{1,0},{1,0}}" />
+                <Window Type="MenuWidgets/ScrollablePane" Name="orxonox/QuestGUI/Quest/ScrollWrapper">
+                    <Property Name="UnifiedAreaRect" Value="{{0,0},{0,30},{1,-4},{1,-4}}" />
 
-                    <Window Type="MenuWidgets/StaticText" Name="orxonox/QuestGUI/Quest/Description">
-                        <Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{0,0}}" />
-                        <Property Name="HorzFormatting" Value="WordWrapLeftAligned" />
-                        <Property Name="VertFormatting" Value="TopAligned" />
+                    <Window Type="MenuWidgets/StaticText" Name="orxonox/QuestGUI/Quest/Wrapper">
+                        <Property Name="UnifiedAreaRect" Value="{{0,5},{0,5},{1,-5},{0,0}}" />
                         <Property Name="FrameEnabled" Value="false" />
-                        <Property Name="Text" Value="Quest Description"/>
-                    </Window>
+                        <Property Name="Alpha" Value="0" />
 
-                    <Window Type="MenuWidgets/Listbox" Name="orxonox/QuestGUI/Quest/SubquestsList">
-                        <Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{1,0}}" />
-                        <Event Name="ItemSelectionChanged" Function="QuestGUI.changeToSubquest_clicked"/>
-                    </Window>
+                        <Window Type="MenuWidgets/StaticText" Name="orxonox/QuestGUI/Quest/Description">
+                            <Property Name="UnifiedAreaRect" Value="{{0,5},{0,0},{1,-5},{0,0}}" />
+                            <Property Name="InheritsAlpha" Value="False" />
+                            <Property Name="HorzFormatting" Value="WordWrapLeftAligned" />
+                            <Property Name="VertFormatting" Value="TopAligned" />
+                            <Property Name="FrameEnabled" Value="false" />
+                            <Property Name="Text" Value="Quest Description"/>
+                        </Window>
 
-                    <Window Type="MenuWidgets/StaticText" Name="orxonox/QuestGUI/Quest/Hints">
-                        <Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{0,0}}" />
-                        <Property Name="VertFormatting" Value="TopAligned" />
-                        <Property Name="FrameEnabled" Value="false" />
-                        <Property Name="Text" Value="Hints:" />
+                        <Window Type="MenuWidgets/Listbox" Name="orxonox/QuestGUI/Quest/SubquestsList">
+                            <Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{1,0}}" />
+                            <Property Name="InheritsAlpha" Value="False" />
+                            <Event Name="ItemSelectionChanged" Function="QuestGUI.changeToSubquest_clicked"/>
+                        </Window>
+
+                        <Window Type="MenuWidgets/StaticText" Name="orxonox/QuestGUI/Quest/Hints">
+                            <Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{1,0},{0,0}}" />
+                            <Property Name="InheritsAlpha" Value="False" />
+                            <Property Name="VertFormatting" Value="TopAligned" />
+                            <Property Name="FrameEnabled" Value="false" />
+                            <Property Name="Text" Value="Hints:" />
+                        </Window>
                     </Window>
                 </Window>

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

@@ -16 +16 @@
 P.titleHeight = 26
 
--- old:
-P.rootWindow = nil
-P.detailsWindows = {}
-P.quests = {}
-P.hints = {}
-P.player = nil
-
--- design parameters
-P.indentWidth = 20
-P.buttonHeight = 30
-P.borderWidth = 5
-
 --TODO:
 -- Highlight whether we are currently looking at active or finished quests
--- Distinguish completet from failed quests
--- Add hints
+-- Distinguish completed from failed quests
 
 function P.onLoad()
-    P.questManager = orxonox.QuestManager:getInstance()
+    P.questManager = orxonox.QuestManager:getInstance() -- Store the pointer to the QuestManager as an internal variable to allow for faster access,
 end
 
@@ -45 +32 @@
 end
 
-function P.onHide()
-    --P.cleanup()
-end
-
+-- Loads the list of quests, depending on P.showActive, either the active (P.showActive == true) or the finished, i.e. inactive quests are loaded.
+-- selectQuest is a pointer to a quest that should be selected, if it is nil the first quest is selected.
 function P.loadQuestsList(selectQuest)
     local list = CEGUI.toListbox(winMgr:getWindow("orxonox/QuestGUI/QuestsList"))
@@ -64 +49 @@
         while i <= numRootQuests-1 do
             local quest = P.questManager:getRootQuest(P.player, i)
+            -- Insert the current quest into the list.
             local item = P.insertQuest(list, quest)
+            -- If the quest was inserted in the list and is has the same id as the selectQuest (thus it is the same quest) it is selected.
             if selectQuestId ~= nil and item ~= nil and selectQuestId == P.questManager:getId(quest) then
                 list:setItemSelectState(item, true)
             end
+            -- Insert all subquests of this rootquest.
             P.insertSubQuests(list, quest, selectQuestId)
             i = i+1
         end
+        -- If there were quests added to the list but there was no selectQuest specified (i.e. selectQuest was nil), the first item is selected.
         if list:getItemCount() > 0 then
             if selectQuestId == nil then
                 list:setItemSelectState(list:getListboxItemFromIndex(0), true)  -- Select first quest.
             end
+        -- If there werent any quests added the standard "no quests" message is loaded.
         else
             P.loadQuest()
@@ -81 +71 @@
 end
 
+-- Helper function, recursively inserts all the (active or inactive, depending on P.showActive) subquests of the input quest.
+-- list is the list into which the subquests should be insterted.
+-- quest is the quest, whose subquests should be inserted.
+-- selectQuestId is the id of the quest that should be selected.
 function P.insertSubQuests(list, quest, selectQuestId)
     -- Iterate through all sub-quests.
@@ -88 +82 @@
         while i <= numQuests-1 do
             local subquest = P.questManager:getSubQuest(quest, P.player, i)
+            -- Insert the current quest into the list.
             local item = P.insertQuest(list, subquest)
+            -- If the quest was inserted in the list and is has the same id as the selectQuest (thus it is the same quest) it is selected.
             if selectQuestId ~= nil and item ~= nil and selectQuestId == P.questManager:getId(subquest) then
                 list:setItemSelectState(item, true)
@@ -97 +93 @@
 end
 
+-- Helper function, inserts a quest into the list (depending whether active or inactive quests are being shown). Returns nil if the quest was not inserted.
+-- list is the list into which the quets should be inserted.
+-- quest is the quest to be inserted.
 function P.insertQuest(list, quest)
     if P.showActive == quest:isActive(P.player) then
@@ -108 +107 @@
 end
 
+-- Loads the input quest.
+-- quest the quest to be loaded.
 function P.loadQuest(quest)
 
-    P.clearQuest()
-    if quest == nil then
+    P.clearQuest() -- Clear the old quest.
+    if quest == nil then -- If quets is nil there is nothing to display.
         return
     else
@@ -122 +123 @@
         local descriptionWindow = winMgr:getWindow("orxonox/QuestGUI/Quest/Description")
         descriptionWindow:setText(description:getDescription())
-        descriptionWindow:setSize(CEGUI.UVector2(CEGUI.UDim(1, -P.scrollbarWidth-P.borderSize), CEGUI.UDim(1, 0)))
+        descriptionWindow:setSize(CEGUI.UVector2(CEGUI.UDim(1, -P.borderSize), CEGUI.UDim(1, 0)))
         descriptionWindow:setPosition(CEGUI.UVector2(CEGUI.UDim(0, P.borderSize), CEGUI.UDim(0, P.borderSize)))
         local height = getStaticTextWindowHeight(descriptionWindow)
@@ -134 +135 @@
         while i <= numQuests-1 do
             local quest = P.questManager:getSubQuest(quest, P.player, i)
-            --if P.showActive == quest:isActive(P.player) then
-                local item = CEGUI.createListboxTextItem(P.questManager:getDescription(quest):getTitle())
-                item:setSelectionBrushImage(menuImageSet, "MultiListSelectionBrush")
-                list:addItem(item)
-                table.insert(P.subquests, quest)
-            --end
+            local item = CEGUI.createListboxTextItem(P.questManager:getDescription(quest):getTitle())
+            item:setSelectionBrushImage(menuImageSet, "MultiListSelectionBrush")
+            list:addItem(item)
+            table.insert(P.subquests, quest)
             i = i+1
         end
@@ -146 +145 @@
             height = height+P.frameHeigth
         end
-        list:setSize(CEGUI.UVector2(CEGUI.UDim(1, -P.scrollbarWidth-P.borderSize), CEGUI.UDim(0, height)))
+        list:setSize(CEGUI.UVector2(CEGUI.UDim(1, -P.borderSize), CEGUI.UDim(0, height)))
         list:setPosition(CEGUI.UVector2(CEGUI.UDim(0, P.borderSize), CEGUI.UDim(0, offset)))
-        offset = offset + height
+        offset = offset + height + P.borderSize
 
         -- Load hints
         local hintsWindow = winMgr:getWindow("orxonox/QuestGUI/Quest/Hints")
         hintsWindow:setPosition(CEGUI.UVector2(CEGUI.UDim(0, P.borderSize), CEGUI.UDim(0, offset)))
-        hintsWindow:setWidth(CEGUI.UDim(1, -P.scrollbarWidth-P.borderSize))
+        hintsWindow:setSize(CEGUI.UVector2(CEGUI.UDim(1, -P.borderSize), CEGUI.UDim(0, 0)))
         height = P.titleHeight
         local numHints = P.questManager:getNumHints(quest, P.player)
@@ -162 +161 @@
             i = i+1
         end
+        if numHints == 0 then
+            height = 0
+        end
         hintsWindow:setHeight(CEGUI.UDim(0, height))
+        offset = offset + height
+
+        -- Set the size of the wrapper
+        local window = winMgr:getWindow("orxonox/QuestGUI/Quest/Wrapper")
+        window:setSize(CEGUI.UVector2(CEGUI.UDim(1, -P.borderSize-P.scrollbarWidth), CEGUI.UDim(0,offset+P.borderSize)))
     end
 
@@ -168 +175 @@
 end
 
+-- Clear the currently displayed quest.
 function P.clearQuest()
     -- clear title
@@ -200 +208 @@
 end
 
+-- Clear the quests list
 function P.clearQuestList()
     local list = CEGUI.toListbox(winMgr:getWindow("orxonox/QuestGUI/QuestsList"))
@@ -206 +215 @@
 end
 
+-- Select an input quest in the input list.
+-- list is the list in which the input quest is to be selected.
+-- quest is the quest to be selected.
 function P.selectQuest(list, quest)
-    if quest == nil then
+    if quest == nil then -- If the input quest is nil, there is nothing to be selected, an error is output and the first quest is selected instead.
         cout(1, "Error in QuestGUI: selectQuest(), input quest is nil. Selecting first.")
         list:setItemSelectState(list:getListboxItemFromIndex(0), true) -- Select first
@@ -216 +228 @@
     local found = false
     local index = 0
+    -- Iterate over all quests currently in the list.
     for k,v in pairs(P.quests) do
+        -- If the id's are the same we have found the quest.
         if P.questManager:getId(v) == questId then
             found = true
@@ -222 +236 @@
         end
     end
-    cout(0, questId .. " " .. index)
-    if found then
+
+    if found then -- If the quest was found it is selected.
         list:setItemSelectState(list:getListboxItemFromIndex(index), true)
-    else
+    else -- If the quest isn't found an error is output and the first quest is selected instead.
         cout(1, "Error in QuestGUI: selectQuest(), input quest is not in list. Selecting first.")
         list:setItemSelectState(list:getListboxItemFromIndex(0), true) -- Select first
@@ -231 +245 @@
 end
 
+-- Helper function, insert the input hint into the input hintsWindow. Returns the height of the newly inserted hint.
+-- hintsWindow is the window in which the hint is to be inserted.
+-- hint is the hint to be inserted.
+-- index is the index of the hint.
+-- offset is the current offset in the hintsWindow.
 function P.insertHint(hintsWindow, hint, index, offset)
+    -- Create the window for the hint.
     local window = winMgr:createWindow("MenuWidgets/StaticText", "orxonox/QuestGUI/Quest/Hints/" .. index)
     window:setProperty("HorzFormatting", "WordWrapLeftAligned")
@@ -240 +260 @@
     local description = P.questManager:getDescription(hint)
     window:setText(description:getDescription())
-    window:setSize(CEGUI.UVector2(CEGUI.UDim(1, -P.scrollbarWidth-P.borderSize), CEGUI.UDim(1, 0)))
+    window:setSize(CEGUI.UVector2(CEGUI.UDim(1, -P.borderSize), CEGUI.UDim(1, 0)))
     local height = getStaticTextWindowHeight(window)
     window:setHeight(CEGUI.UDim(0, height))
     window:setPosition(CEGUI.UVector2(CEGUI.UDim(0, P.borderSize), CEGUI.UDim(0, offset)))
-    return height+P.borderSize
-end
-
+    return height
+end
+
+-- Show the currently active quests in the quests list.
 function P.showActiveQuestsButton_clicked(e)
     if P.showActive == false then
@@ -254 +275 @@
 end
 
+-- Show the finished (i.e. inactive) quests in the quests list.
 function P.showFinishedQuestsButton_clicked(e)
     if P.showActive == true then
@@ -261 +283 @@
 end
 
+-- Change to a new quest.
 function P.changeQuest_clicked(e)
     local list = CEGUI.toListbox(winMgr:getWindow("orxonox/QuestGUI/QuestsList"))
@@ -273 +296 @@
 end
 
+-- Change to a new subquest.
 function P.changeToSubquest_clicked(e)
     local list = CEGUI.toListbox(winMgr:getWindow("orxonox/QuestGUI/Quest/SubquestsList"))
@@ -281 +305 @@
         local quest = P.subquests[index+1]
         if quest ~= nil then
+            -- If the P.showActive must be changed to display the quest the quests list also has to be regenerated.
             if quest:isActive(P.player) == P.showActive then
                 P.selectQuest(questsList, quest)