Add functionality for arbitrary item names in the inventory panel and drop-down menus

Author: tseykovets

CHANGELOG.md

@@ -10,6 +10,7 @@
 	+ Added: Ability to execute JavaScript code from URQL code and retrieve its result using the javascript system variable.
 	+ Added: Ability to read any file from the game package and get its contents as text using the fileread system variable.
 	+ Added: System variables image_caption, time, date (only when urq_mode specific rules are absent), urqw_title, urqw_game_ifid, urqw_game_lang, urqw_version.
+	+ Added: Ability to set arbitrary names for inventory items, for inventory item usage options, and for drop-down menu items of links in text instead of names based on variable and labels names (special variables with the `display_` prefix are used).
 	+ Added: The clst operator to clear the screen of text.
 	+ Added: The varkill operator (a direct counterpart of the perkill operator).
 	+ Added: Support for custom alternative text descriptions for images added using either the image system variable or the image operator.
@@ -48,6 +49,7 @@
 	+ Added: Titles for save and load game dialog boxes.
 	+ Added: Support for opening .qsz format games.
 	+ Changed: Inventory item usage options are displayed when the item receives system focus, not just when the mouse is hovering over it.
+	+ Changed: Inventory item usage options generated from use labels names are displayed with spaces instead of underscores.
 	+ Changed: Keypress tracking by key code instead of character code.
 	+ Changed: Minor adjustment to informative window indentation.
 	+ Fixed: Links disappear from the text when loading a saved game.

docs/urql.html

@@ -64,6 +64,11 @@
         :use_предмет
         :use_предмет_
         hide_use_
+        display_use_
+
+        [[ссылка|метка|действие1, действие2]]
+        hide_метка_действие1
+        display_метка_действие1
 
 -->
 

js/Client.js

@@ -302,7 +302,13 @@ Client.prototype.drawItem = function (itemName, quantity) {
         }
     });
 
-    var itemDisplayName = itemName.replace(/_/g, ' ');
+    var displayName = Game.getVar('display_use_' + itemName);
+    var itemDisplayName;
+    if (displayName) {
+        itemDisplayName = displayName;
+    } else {
+        itemDisplayName = itemName.replace(/_/g, ' ');
+    }
 
     // Some items and actions need to be inserted with language markup,
     // for this the following two variables are needed
@@ -365,13 +371,21 @@ var ul = $('<ul role="presentation" class="dropdown-menu">');
             }
 
             if (Game.getVar('hide_use_' + itemName + '_' + actions[i][0]) == 0) {
-                li2link = $('<a href="#" class="item_use">');
+                displayName = Game.getVar('display_use_' + itemName + '_' + actions[i][0]);
+                var actionDisplayName;
+                if (displayName) {
+                    actionDisplayName = displayName;
+                } else {
+                    actionDisplayName = actions[i][0].replace(/_/g, ' ');
+                }
+                
+li2link = $('<a href="#" class="item_use">');
                 li2link.attr('data-label', actions[i][1]);
                 if (htmlContent) {
-                    li2link.html(actions[i][0]);
+                    li2link.html(actionDisplayName);
                     htmlContent = false;
                 } else {
-                    li2link.text(actions[i][0]);
+                    li2link.text(actionDisplayName);
                 }
                 // A11Y modification: Place links in elements with the list item role
                 li2link = $('<span role="listitem">').append(li2link);

js/Parser.js

@@ -269,8 +269,16 @@ Parser.prototype.openLinks = function(line) {
                             // action = `pln You cannot ${command2[i].trim()} ${command}!`;
                         }
 
+                        var displayName = Game.getVar('display_' + label);
+                        var actionDisplayName;
+                        if (displayName) {
+                            actionDisplayName = displayName;
+                        } else {
+                            actionDisplayName = command2[i].replace(/_/g, ' ').trim();
+                        }
+
                         var actionNum = GlobalPlayer.link(action);
-                        links.push(`<li><a data-action="${actionNum}" class="button" href="#">${command2[i].replace(/_/g, ' ').trim()}</a></li>`);
+                        links.push(`<li><a data-action="${actionNum}" class="button" href="#">${actionDisplayName}</a></li>`);
                     }
 
                     if (links.length == 0) {

md/ru/other/changelog.md

@@ -10,6 +10,7 @@
 	+ Добавлено: Возможность выполнить код JavaScript из кода URQL и получить его результат с помощью системной переменной javascript.
 	+ Добавлено: Возможность прочитать любой файл из пакета игры и получить его содержимое как текст с помощью системной переменной fileread.
 	+ Добавлено: Системные переменные image_caption, time, date (только при отсутствии специальных правил urq_mode), urqw_title, urqw_game_ifid, urqw_game_lang, urqw_version.
+	+ Добавлено: Возможность задать произвольные названия для предметов инвентаря, вариантов использования предметов инвентаря и пунктов выпадающих меню у ссылок в тексте вместо названий, основанных на именах переменных и меток (используются специальные переменные с префиксом `display_`).
 	+ Добавлено: Оператор clst для очистки экрана от текста.
 	+ Добавлено: Оператор varkill (прямой аналог perkill).
 	+ Добавлено: Поддержка пользовательских альтернативных текстовых описаний для изображений, добавляемых с помощью системной переменной image или оператора image.
@@ -48,6 +49,7 @@
 	+ Добавлено: Заголовки в диалоговых окнах сохранения и загрузки игры.
 	+ Добавлено: Поддержка открытия игр в формате .qsz.
 	+ Изменено: Варианты использования предмета в инвенторе отображаются, когда предмет принимает системный фокус, а не только когда на него наводится мышь.
+	+ Изменено: Варианты использования предмета в инвенторе, формируемые из названий меток использования, отображаются с пробелами вместо подчёркиваний.
 	+ Изменено: Отслеживание нажатий клавиш не по коду символа, а по коду клавиши.
 	+ Изменено: Небольшая правка отступа информативного окна.
 	+ Исправлено: Ссылки исчезают из текста при загрузке сохранённой игры.