Changeset 7687 for code/branches/menu/data/gui/scripts/GUITools.lua

Timestamp:

Dec 1, 2010, 2:04:54 PM (14 years ago)

Author:

konrad

Message:

—function to iterate throgh a menusheet by using arrowkeys is added

File:

• code/branches/menu/data/gui/scripts/GUITools.lua (modified) (7 diffs)

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

@@ -55 +55 @@
 end
 
+--function to iterate through a menu sheet by using arrowkeys
 
 --@arguments:
 --  list: 2-dimensional table, arguments are items that contain a button and its function
+--        !!note: each button can only be in the list once!!
 --  code: code of any key on the keyboard
 --  P: menusheet
---  n: number of rows
---  m: number of colums
+--  n: number of rows of the buttontable
+--  m: number of colums of the buttontable
 
 function buttonIteratorHelper(list, code, P, n, m)
+
+    --after a key (down,up,left,right) is pressed the index of the current button has to be updated    
 
     --key down
@@ -72 +76 @@
         else
             P.oldindex = P.index
-            P.index = (P.index + m) % (m*n)
-
-            while list[P.index+1] == nil do
+            P.index = (P.index + m) % (m*n)     --modulo operation works as a "wrap around" in the button menu
+                                                
+            while list[P.index+1] == nil do     
                 P.oldindex = P.index
                 P.index = (P.index + m) % (m*n)
@@ -98 +102 @@
 
             while list[P.index+1] == nil do
-                cout(0,P.index)
                 P.oldindex = P.index
                 P.index = (P.index-m)%(m*n)
@@ -162 +165 @@
     end
        
+    --to update the new current button
     if (code == "208" or code == "200" or code == "203" or code == "205") and P.oldindex~= P.index then
 
@@ -171 +175 @@
 
         --teste ob der Button nicht schon gehighlightet ist
-        cout(0,child:getProperty("NormalImageRightEdge"))
         if child:getProperty("NormalImageRightEdge") == "set:TaharezGreenLook image:ButtonRightHighlight" then
             --nop
@@ -189 +192 @@
         end
 
+        --for every highlighted button check if index is on its position. If not, set imageproperty on "normal"
         local i = 1
         while i < (n*m) do
@@ -220 +224 @@
     end
 
-    cout(0, P.oldindex)
-    cout(0, P.index)
-
-end
-
+end
+
+--write index and oldindex on the console
+--works like buttonIteratorHelper
 function indexTester(list,code,P,n,m)
     --key down