Ticket #2087: patch.tmp

diff --git a/binaries/data/mods/public/gui/loading/loading.js b/binaries/data/mods/public/gui/loading/loading.js
index 8ca3191..55f3331 100644
--- a/binaries/data/mods/public/gui/loading/loading.js
+++ b/binaries/data/mods/public/gui/loading/loading.js
@@ -1,4 +1,6 @@
 var g_Data;
+var current_tip_num;
+
 const END_PIECE_WIDTH = 16;

 function init(data)
@@ -6,36 +8,11 @@ function init(data)
    g_Data = data;

    // Set to "hourglass" cursor.
-   setCursor("cursor-wait");
-
-   // Get tip image and corresponding tip text
-   var tipTextLoadingArray = buildDirEntList("gui/text/tips/", "*.txt", false);
-
-   if (tipTextLoadingArray.length > 0)
-   {
-       // Set tip text
-       var tipTextFilePath = tipTextLoadingArray[getRandom (0, tipTextLoadingArray.length-1)];
-       var tipText = readFile(tipTextFilePath);
+    // TODO: Disabled for now as this disabled clicking next/prev buttons
+   // setCursor("cursor-wait");

-       if (tipText)
-       {
-           var index = tipText.indexOf("\n");
-           tipTextTitle = tipText.substring(0, index);
-           tipTextMessage = tipText.substring(index);
-           getGUIObjectByName("tipTitle").caption = tipTextTitle? tipTextTitle : "";
-           getGUIObjectByName("tipText").caption = tipTextMessage? tipTextMessage : "";
-       }
-
-       // Set tip image
-       var fileName = tipTextFilePath.substring(tipTextFilePath.lastIndexOf("/")+1).replace(".txt", ".png");
-       var tipImageFilePath = "loading/tips/" + fileName;
-       var sprite = "stretched:" + tipImageFilePath;
-       getGUIObjectByName("tipImage").sprite = sprite? sprite : "";
-   }
-   else
-   {
-       error("Failed to find any matching tips for the loading screen.")
-   }
+    // Setting the tip is now handled by getTip, setTip, nextTip and prevTip
+    nextTip();

    // janwas: main loop now sets progress / description, but that won't
    // happen until the first timeslice completes, so set initial values.
@@ -68,6 +45,116 @@ function init(data)
 }

 // ====================================================================
+function nextTip()
+{
+    var tips = getTipArray();
+
+    if (tips.length > 0)
+    {
+        // Either generate a random tip number or take the next number
+        // depending on the value of current_tip_num
+        var num = current_tip_num
+            ? current_tip_num + 1
+            : getRandom(0, tips.length - 1);
+
+        // Num should not be larger than the tiptextloadingarray length
+        // Set to 0 if it is longer
+        num = (num > tips.length - 1)
+            ? 0
+            : num;
+
+        // Set global
+        current_tip_num = num;
+    }
+
+    setTip();
+}
+
+// ====================================================================
+function prevTip()
+{
+    var tips = getTipArray();
+
+    if(tips.length > 0)
+    {
+        // Either generate a random tip number or take the previous number
+        // depending on the value of current_tip_num
+        var num = current_tip_num
+            ? current_tip_num - 1
+            : getRandom(0, tips.length - 1);
+
+        // Num should not be smaller than 0
+        // Set to max if it is smaller
+        num = (num < 0)
+            ? tips.length - 1
+            : num;
+
+        // Set global
+        current_tip_num = num;
+    }
+
+    setTip();
+}
+
+// ====================================================================
+function getTipArray()
+{
+    return buildDirEntList("gui/text/tips/", "*.txt", false);
+}
+
+// ====================================================================
+function getTip()
+{
+    var tip;
+
+    // Get tip image and corresponding tip text
+    var tipTextLoadingArray = getTipArray();
+
+    if (tipTextLoadingArray.length > 0)
+    {
+        // Set tip text
+        var tipTextFilePath = tipTextLoadingArray[current_tip_num];
+        var tipText         = readFile(tipTextFilePath);
+
+        if (tipText)
+        {
+            var index = tipText.indexOf("\n");
+
+            // Set tip image
+            var fileName = tipTextFilePath.substring(tipTextFilePath.lastIndexOf("/")+1).replace(".txt", ".png");
+            var tipImageFilePath = "loading/tips/" + fileName;
+            var sprite = "stretched:" + tipImageFilePath;
+
+            tip = {
+                title  : tipText.substring(0, index),
+                text   : tipText.substring(index),
+                sprite : sprite
+            };
+
+            return tip;
+        }
+    }
+
+    // Failed to find tip
+    error("Failed to find any matching tips for the loading screen.")
+
+    return false;
+}
+
+// ====================================================================
+function setTip()
+{
+    var tip = getTip();
+
+    if(tip)
+    {
+        getGUIObjectByName("tipTitle").caption = tip.title   ? tip.title  : "";
+        getGUIObjectByName("tipText").caption  = tip.text    ? tip.text   : "";
+        getGUIObjectByName("tipImage").sprite  = tip.sprite  ? tip.sprite : "";
+    }
+}
+
+// ====================================================================
 function displayProgress()
 {
    // Make the progessbar finish a little early so that the user can actually see it finish
@@ -108,8 +195,19 @@ function reallyStartGame()
    // to start the game (i.e. loading progress has reached 100%).

    // Switch GUI from loading screen to game session.
-   Engine.SwitchGuiPage("page_session.xml", g_Data);
+    //Engine.SwitchGuiPage("page_session.xml", g_Data);
+
+    // Show the start game button
+    getGUIObjectByName("startGameButton").size = "50%-200 75%+80 50%+200 75%+120";

    // Restore default cursor.
    setCursor("arrow-default");
 }
+
+// ====================================================================
+function startGameButtonClick()
+{
+    // Switch GUI from loading screen to game session.
+    Engine.SwitchGuiPage("page_session.xml", g_Data);
+}
+
diff --git a/binaries/data/mods/public/gui/loading/loading.xml b/binaries/data/mods/public/gui/loading/loading.xml
index 7ad8c38..82bb810 100644
--- a/binaries/data/mods/public/gui/loading/loading.xml
+++ b/binaries/data/mods/public/gui/loading/loading.xml
@@ -37,15 +37,31 @@
        </object>

        <!-- LOADING SCREEN TIP TEXT-->
+       <object name="prevTipButton" type="button" size="25%-80 50% 25% 50%+40" style="StoneButton">
+           Previous
+           <action on="Press">prevTip();</action>
+       </object>
+
        <object size="50%+128 50%-193 50%+448 50%+193" type="image" sprite="LoadingTipText">
            <object name="tipTitle" size="30 30 100% 50" type="text" style="LoadingTipTitleText"/>
            <object name="tipText" size="30 50 100%-30 100%" type="text" style="LoadingTipText"/>
        </object>

+       <object name="nextTipButton" type="button" size="75% 50% 75%+80 50%+40" style="StoneButton">
+           Next
+           <action on="Press">nextTip();</action>
+       </object>
+
        <!-- LOADING SCREEN QUOTE (needs increased z value to overcome the transparent area of the tip image above it -->
        <object size="50%-448 50%+230 50%+448 100%-16" z="20">
            <object name="quoteTitleText" size="0 0 100% 30" type="text" style="LoadingTitleText">Quote of the Day:</object>
            <object name="quoteText" size="0 30 100% 100%" type="text" style="LoadingText"></object>
        </object>
+
+       <!-- Initially hidden (needs increased z value to overcome the quote area) -->
+       <object name="startGameButton" type="button" size="0 0 0 0" z="99" style="StoneButton">
+           Start game
+           <action on="Press">startGameButtonClick();</action>
+       </object>
    </object>
 </objects>