Ticket #2087: loading2.patch

binaries/data/config/default.cfg

@@ -322 +322 @@
 hotkey.chat = Return                        ; Toggle chat window
 hotkey.teamchat = "T"                       ; Toggle chat window in team chat mode
 
+; > LOADING SCREEN TOOLTIP HOTKEYS
+hotkey.loading.previoustip = "LeftArrow"
+hotkey.loading.nexttip = "RightArrow"
+
 ; > GUI TEXTBOX HOTKEYS
 hotkey.text.delete.left = "Ctrl+Backspace"    ; Delete word to the left of cursor
 hotkey.text.delete.right = "Ctrl+Del"         ; Delete word to the right of cursor
@@ -379 +383 @@
 
 ; MOD SETTINGS
 mod.enabledmods = "mod public"
+
+; LOADING SCREEN TIP CONTROLS
+gui.loadingtips.enabled = true

binaries/data/mods/public/gui/gamesetup/gamesetup.js

@@ -1004 +1004 @@
         Engine.SwitchGuiPage("page_loading.xml", {
             "attribs": g_GameAttributes,
             "isNetworked" : g_IsNetworked,
-            "playerAssignments": g_PlayerAssignments
+            "playerAssignments": g_PlayerAssignments,
+            "isController": g_IsController
         });
     }
 }

binaries/data/mods/public/gui/loading/loading.js

@@ -1 @@
-var g_Data;
+let g_Data;
+let tipControlsEnabled;
+let tips;
+let tipIndex;
+
 const END_PIECE_WIDTH = 16;
 
 function init(data)
 {
     g_Data = data;
+    if (!data)
+        return;
 
-    // Set to "hourglass" cursor.
-    Engine.SetCursor("cursor-wait");
+    // janwas: main loop now sets progress / description, but that won't
+    // happen until the first timeslice completes, so set initial values.
+    Engine.GetGUIObjectByName("loadingMapName").caption = translate(sprintf(
+        data.attribs.mapType === "random" ? "Generating “%(map)s”" : "Loading “%(map)s”", 
+        {"map": translate(data.attribs.settings.Name)}));
 
-    // Get tip image and corresponding tip text
-    var tipTextLoadingArray = Engine.BuildDirEntList("gui/text/tips/", "*.txt", false);
+    // Pick a random quote of the day (one quote per line).
+    let quoteArray = Engine.ReadFileLines("gui/text/quotes.txt");
+    Engine.GetGUIObjectByName("quoteText").caption = translate(quoteArray[getRandom(0, quoteArray.length-1)]);
 
-    if (tipTextLoadingArray.length > 0)
-    {
-        // Set tip text
-        var tipTextFilePath = tipTextLoadingArray[getRandom (0, tipTextLoadingArray.length-1)];
-        var tipText = Engine.TranslateLines(Engine.ReadFile(tipTextFilePath));
+    tips = Engine.BuildDirEntList("gui/text/tips/", "*.txt", false);
+    tipControlsEnabled = !data.isNetworked
+        && Engine.ConfigDB_GetValue("user", "gui.loadingtips.enabled") === "true"
+        && tips && tips.length > 0;
 
-        if (tipText)
-        {
-            var index = tipText.indexOf("\n");
-            var tipTextTitle = tipText.substring(0, index);
-            var tipTextMessage = tipText.substring(index);
-            Engine.GetGUIObjectByName("tipTitle").caption = tipTextTitle? tipTextTitle : "";
-            Engine.GetGUIObjectByName("tipText").caption = tipTextMessage? tipTextMessage : "";
-        }
+    Engine.GetGUIObjectByName("prevTipButton").hidden = !tipControlsEnabled;
+    Engine.GetGUIObjectByName("nextTipButton").hidden = !tipControlsEnabled;
 
-        // Set tip image
-        var fileName = tipTextFilePath.substring(tipTextFilePath.lastIndexOf("/")+1).replace(".txt", ".png");
-        var tipImageFilePath = "loading/tips/" + fileName;
-        var sprite = "stretched:" + tipImageFilePath;
-        Engine.GetGUIObjectByName("tipImage").sprite = sprite? sprite : "";
-    }
-    else
-    {
-        error("Failed to find any matching tips for the loading screen.")
-    }
+    if (tips && tips.length > 0)
+        updateTip(getRandom(0, tips.length - 1));
+}
 
-    // janwas: main loop now sets progress / description, but that won't
-    // happen until the first timeslice completes, so set initial values.
-    var loadingMapName = Engine.GetGUIObjectByName ("loadingMapName");
+function nextTip()
+{
+    updateTip((tipIndex + 1) % tips.length);
+}
 
-    if (data)
+function prevTip()
+{
+    updateTip((tips.length + tipIndex - 1) % tips.length);
+}
+
+function updateTip(nextTipIndex)
+{
+    // Set tip text
+    tipIndex = nextTipIndex;
+    let tipTextFilePath = tips[tipIndex];
+    let tipText = Engine.TranslateLines(Engine.ReadFile(tipTextFilePath));
+    if (!tipText)
     {
-        var mapName = translate(data.attribs.settings.Name);
-        switch (data.attribs.mapType)
-        {
-        case "skirmish":
-        case "scenario":
-            loadingMapName.caption = sprintf(translate("Loading “%(map)s”"), {map: mapName});
-            break;
-
-        case "random":
-            loadingMapName.caption = sprintf(translate("Generating “%(map)s”"), {map: mapName});
-            break;
-
-        default:
-            error(sprintf("Unknown map type: %(mapType)s", { mapType: data.attribs.mapType }));
-        }
+        error("Failed to read tip text for the loading screen.");
+        return;
     }
 
-    Engine.GetGUIObjectByName("progressText").caption = "";
-    Engine.GetGUIObjectByName("progressbar").caption = 0;
+    let index = tipText.indexOf("\n");
+    let fileName = tipTextFilePath.substring(tipTextFilePath.lastIndexOf("/")+1).replace(".txt", ".png");
 
-    // Pick a random quote of the day (each line is a separate tip).
-    var quoteArray = Engine.ReadFileLines("gui/text/quotes.txt");
-    Engine.GetGUIObjectByName("quoteText").caption = translate(quoteArray[getRandom(0, quoteArray.length-1)]);
+    Engine.GetGUIObjectByName("tipTitle").caption = tipText.substring(0, index);
+    Engine.GetGUIObjectByName("tipText").caption = tipText.substring(index);
+    Engine.GetGUIObjectByName("tipImage").sprite = "stretched:" + "loading/tips/" + fileName;
 }
 
-// ====================================================================
 function displayProgress()
 {
     // Make the progessbar finish a little early so that the user can actually see it finish
-    if (g_Progress < 100)
-    {
-        // Show 100 when it is really 99
-        var progress = g_Progress + 1;
+    if (g_Progress >= 100)
+        return;
 
-        Engine.GetGUIObjectByName("progressbar").caption = progress; // display current progress
-        Engine.GetGUIObjectByName("progressText").caption = progress + "%";
+    // Show 100 when it is really 99
+    let progress = g_Progress + 1;
 
-        // Displays detailed loading info rather than a percent
-        // Engine.GetGUIObjectByName("progressText").caption = g_LoadDescription; // display current progess details
+    Engine.GetGUIObjectByName("progressbar").caption = progress; // display current progress
+    Engine.GetGUIObjectByName("progressText").caption = progress + "%";
 
-        // Keep curved right edge of progress bar in sync with the rest of the progress bar
-        var middle = Engine.GetGUIObjectByName("progressbar");
-        var rightSide = Engine.GetGUIObjectByName("progressbar_right");
+    // Keep curved right edge of progress bar in sync with the rest of the progress bar
+    let middle = Engine.GetGUIObjectByName("progressbar");
+    let rightSide = Engine.GetGUIObjectByName("progressbar_right");
 
-        var middleLength = (middle.size.right - middle.size.left) - (END_PIECE_WIDTH / 2);
-        var increment = Math.round(progress * middleLength / 100);
+    let middleLength = (middle.size.right - middle.size.left) - (END_PIECE_WIDTH / 2);
+    let increment = Math.round(progress * middleLength / 100);
 
-        var size = rightSide.size;
-        size.left = increment;
-        size.right = increment + END_PIECE_WIDTH;
-        rightSide.size = size;
-    }
+    let size = rightSide.size;
+    size.left = increment;
+    size.right = increment + END_PIECE_WIDTH;
+    rightSide.size = size;
 }
 
-// ====================================================================
 function reallyStartGame()
 {
-    // Stop the music
-//  if (global.curr_music)
-//      global.curr_music.fade(-1, 0.0, 5.0); // fade to 0 over 5 seconds
-
-
     // This is a reserved function name that is executed by the engine when it is ready
     // to start the game (i.e. loading progress has reached 100%).
 
-    // Switch GUI from loading screen to game session.
+    if (!tipControlsEnabled)
+    {
+        startGame();
+        return;
+    }
+
+    // Pause the game so it doesn't run while we read tips
+    Engine.SetPaused(true);
+    Engine.GetGUIObjectByName("startGameButton").hidden = false;
+}
+
+function startGame()
+{
+    Engine.SetPaused(false);
+
+    // Switch GUI from loading screen to game session
     Engine.SwitchGuiPage("page_session.xml", g_Data);
+}
 
-    // Restore default cursor.
-    Engine.SetCursor("arrow-default");
-}

binaries/data/mods/public/gui/loading/loading.xml

@@ -40 +40 @@
         <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"/>
+            
+            <!-- LOADING SCREEN TIP SHOW PREVIOUS -->
+            <object name="prevTipButton" type="button" size="30 100%-80 90 100%-40" z="99" hotkey="loading.previoustip" style="StoneButton">
+                <translatableAttribute id="caption">Previous</translatableAttribute>
+                <action on="Press">prevTip();</action>
+            </object>
+
+            <!-- LOADING SCREEN TIP SHOW NEXT -->
+            <object name="nextTipButton" type="button" size="100%-90 100%-80 100%-30 100%-40" z="99" hotkey="loading.nexttip" style="StoneButton">
+                <translatableAttribute id="caption">Next</translatableAttribute>
+                <action on="Press">nextTip();</action>
+            </object>
+
         </object>
 
         <!-- LOADING SCREEN QUOTE (needs increased z value to overcome the transparent area of the tip image above it -->
@@ -49 +62 @@
             </object>
             <object name="quoteText" size="0 30 100% 100%" type="text" style="LoadingText"></object>
         </object>
+    
     </object>
+
+    <!-- LOADING SCREEN READY (needs increased z value to overcome the quote area -->
+    <object name="startGameButton" type="button" size="50%-200 75%+80 50%+200 75%+120" z="99" hidden="true" hotkey="confirm" style="StoneButton">
+        <translatableAttribute id="caption">I'm ready</translatableAttribute>
+        <action on="Press">startGame();</action>
+    </object>
+
 </objects>

binaries/data/mods/public/gui/options/options.js

@@ -13 +13 @@
         [translate("FPS Overlay"), translate("Show frames per second in top right corner."), {"config":"overlay.fps"}, "boolean"],
         [translate("Realtime Overlay"), translate("Show current system time in top right corner."), {"config":"overlay.realtime"}, "boolean"],
         [translate("Gametime Overlay"), translate("Show current simulation time in top right corner."), {"config":"gui.session.timeelapsedcounter"}, "boolean"],
+        [translate("Tip Controls"), translate("Allow navigating through loading screen tips and wait for the user before entering game."), {"config":"gui.loadingtips.enabled"}, "boolean"],
     ],
     "graphicsSetting":
     [
@@ -108 +109 @@
                     case "config":
                         // Load initial value if not yet loaded.
                         if (!checked || typeof checked != "boolean")
-                            checked = Engine.ConfigDB_GetValue("user", option[2][action]) === "true" ? true : false;
+                            checked = Engine.ConfigDB_GetValue("user", option[2][action]) === "true";
                         // Hacky macro to create the callback.
                         var callback = function(key)
                         {