Ticket #4145: autocomplete_hotkey_tooltips_v2.patch

binaries/data/mods/public/gui/common/color.js

@@ -142 +142 @@
             "[color=\"" + g_HotkeyColor + "\"]" +
             "\\[" + key + "]" +
             "[/color]"
     });
 }
+
+/**
+ * The autocomplete hotkey is hardcoded in SDLK_TAB of CInput.cpp,
+ * as we don't want hotkeys interfering with typing text.
+ */
+function colorizeAutocompleteHotkey()
+{
+    return sprintf(translate("Press %(hotkey)s to autocomplete playernames."), {
+        "hotkey":
+            "[color=\"" + g_HotkeyColor + "\"]" +
+            "\\[" + translateWithContext("hotkey", "Tab") + "]" +
+            "[/color]"
+    });
+}

binaries/data/mods/public/gui/common/functions_utility_loadsave.js

@@ -73 +73 @@
         error("Could not delete saved game: " + gameID);
 
     // Run init again to refresh saved game list
     init();
 }
+
+function deleteTooltip()
+{
+    let deleteTooltip = colorizeHotkey(
+        translate("Delete the selected entry using %(hotkey)s."),
+        "session.savedgames.delete");
+
+    if (deleteTooltip)
+        deleteTooltip += colorizeHotkey(
+            " "  + translate("Hold %(hotkey)s to delete without confirmation."),
+            "session.savedgames.noconfirmation");
+
+    return deleteTooltip;
+}

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

@@ -292 +292 @@
     initMultiplayerSettings();
     initPlayerAssignments();
 
     resizeMoreOptionsWindow();
 
+    Engine.GetGUIObjectByName("chatInput").tooltip = colorizeAutocompleteHotkey();
+
     if (g_IsNetworked)
         Engine.GetGUIObjectByName("chatInput").focus();
 
     if (g_IsController)
     {

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

@@ -222 +222 @@
 
     // When rejoining the lobby after a game, we don't need to process presence changes
     Engine.LobbyClearPresenceUpdates();
     updatePlayerList();
     updateSubject(Engine.LobbyGetRoomSubject());
+
+    Engine.GetGUIObjectByName("chatInput").tooltip = colorizeAutocompleteHotkey();
 }
 
 function returnToMainMenu()
 {
     Engine.StopXmppClient();

binaries/data/mods/public/gui/replaymenu/replay_menu.js

@@ -65 +65 @@
     {
         Engine.SwitchGuiPage("page_pregame.xml");
         return;
     }
 
+    initHotkeyTooltips();
     displayReplayList();
 }
 
 /**
  * Store the list of replays loaded in C++ in g_Replays.
@@ -183 +184 @@
         if (!pData.Name)
             pData.Name = "";
     });
 }
 
+function initHotkeyTooltips()
+{
+    Engine.GetGUIObjectByName("playersFilter").tooltip =
+        translate("Filter replays by typing one or more, partial or complete playernames.") +
+        " " + colorizeAutocompleteHotkey();
+
+    Engine.GetGUIObjectByName("deleteReplayButton").tooltip = deleteTooltip();
+}
+
 /**
  * Filter g_Replays, fill the GUI list with that data and show the description of the current replay.
  */
 function displayReplayList()
 {

binaries/data/mods/public/gui/replaymenu/replay_menu.xml

@@ -10 +10 @@
     <script file="gui/common/settings.js" />
 
     <!-- Used to display message boxes. -->
     <script file="gui/common/functions_global_object.js" />
 
-    <!-- Used for engine + mod version checks. -->
+    <!-- Used for engine + mod version checks and deleteTooltip -->
     <script file="gui/common/functions_utility_loadsave.js" />
 
     <!-- Actual replay scripts after settings.js, as it initializes g_Settings. -->
     <script file="gui/replaymenu/replay_menu.js" />
     <script file="gui/replaymenu/replay_actions.js" />

binaries/data/mods/public/gui/savedgames/load.js

@@ -32 +32 @@
         gameSelection.selected = 0;
     else if (gameSelection.selected >= savedGames.length) // happens when deleting the last saved game
         gameSelection.selected = savedGames.length - 1;
     else
         selectionChanged();
+
+    Engine.GetGUIObjectByName("deleteGameButton").tooltip = deleteTooltip();
 }
 
 function selectionChanged()
 {
     let gameSelection = Engine.GetGUIObjectByName("gameSelection");

binaries/data/mods/public/gui/savedgames/save.js

@@ -35 +35 @@
         g_Descriptions[game.id] = game.metadata.description || "";
 
     gameSelection.list = savedGames.map(game => generateLabel(game.metadata));
     gameSelection.list_data = savedGames.map(game => game.id);
     gameSelection.selected = -1;
+
+    Engine.GetGUIObjectByName("deleteGameButton").tooltip = deleteTooltip();
 }
 
 function saveGame()
 {
     let gameSelection = Engine.GetGUIObjectByName("gameSelection");

binaries/data/mods/public/gui/savedgames/save.xml

@@ -1 +1 @@
 <?xml version="1.0" encoding="utf-8"?>
 
 <objects>
 
+    <script file="gui/common/color.js"/>
     <script file="gui/common/functions_global_object.js" />
     <script file="gui/common/functions_utility_loadsave.js" />
     <script file="gui/savedgames/save.js" />
 
     <!-- Add a translucent black background to fade out the page -->

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

@@ -291 +291 @@
 
     // If in Atlas editor, disable the exit button
     if (Engine.IsAtlasRunning())
         Engine.GetGUIObjectByName("menuExitButton").enabled = false;
 
-    initHotkeyTooltips();
-
     if (hotloadData)
         g_Selection.selected = hotloadData.selection;
 
     sendLobbyPlayerlistUpdate();
     onSimulationUpdate();
@@ -311 +309 @@
     // and it generates a massive amount of data to transmit and store
     //setTimeout(function() { reportPerformance(5); }, 5000);
     //setTimeout(function() { reportPerformance(60); }, 60000);
 }
 
-function initHotkeyTooltips()
+/**
+ * Depends on the current player (g_IsObserver).
+ */
+function updateHotkeyTooltips()
 {
+    Engine.GetGUIObjectByName("chatInput").tooltip = colorizeAutocompleteHotkey() +
+        colorizeHotkey("\n" + translate("Press %(hotkey)s to open the public chat."), "chat") +
+        colorizeHotkey(
+            "\n" + (g_IsObserver ?
+                translate("Press %(hotkey)s to open the observer chat.") :
+                translate("Press %(hotkey)s to open the ally chat.")),
+            "teamchat");
+
     Engine.GetGUIObjectByName("idleWorkerButton").tooltip =
         colorizeHotkey("%(hotkey)s" + " ", "selection.idleworker") +
         translate("Find idle worker");
 
     Engine.GetGUIObjectByName("tradeHelp").tooltip =
@@ -387 +396 @@
     }
 
     Engine.SetViewedPlayer(g_ViewedPlayer);
 
     updateTopPanel();
-
     updateChatAddressees();
+    updateHotkeyTooltips();
 
     // Update GUI and clear player-dependent cache
     onSimulationUpdate();
 
     if (g_IsDiplomacyOpen)