Show the cursor as a slot in the surveillance header

The cursor was a line of text under the camera, which read as an
afterthought next to the framed header. It is now a slot button in the
header after the zoom buttons: the item sprite with its count, greyed out
for a ghost, an empty slot for an empty cursor, and the item name in the
tooltip. The window keeps its shape whatever the item is called.

exp_scenario/module/gui/surveillance.lua

@@ -6,8 +6,6 @@ local Gui = require("modules/exp_gui")
 local ElementsExtra = require("modules/exp_scenario/gui/elements")
 local Roles = require("modules/exp_roles")
 
-local format_string = string.format
-
 --- @class ExpGui_Surveillance.elements
 local Elements = {}
 
@@ -208,57 +206,75 @@ function Elements.camera.refresh_online()
     end
 end
 
---- Label showing what the player a camera follows holds in their cursor
+--- Slot in the header showing what the player a camera follows holds in their cursor
---- @class ExpGui_Surveillance.elements.cursor_label: ExpElement
+--- @class ExpGui_Surveillance.elements.cursor_slot: ExpElement
---- @field data table<LuaGuiElement, LuaGuiElement> The camera the label belongs to
+--- @field data table<LuaGuiElement, LuaGuiElement> The camera the slot belongs to
 --- @overload fun(parent: LuaGuiElement, camera: LuaGuiElement): LuaGuiElement
-Elements.cursor_label = Gui.define("surveillance/cursor_label")
+Elements.cursor_slot = Gui.define("surveillance/cursor_slot")
     :track_all_elements()
     :draw{
-        type = "label",
+        type = "sprite-button",
-        caption = { "exp-gui_surveillance.caption-cursor-empty" },
+        style = "slot_button",
+        tooltip = { "exp-gui_surveillance.tooltip-cursor-empty" },
     }
     :style{
-        width = 480,
+        height = 24,
+        width = 24,
+        padding = 0,
     }
     :element_data(
         Gui.from_argument(1)
     ) --[[@as any]]
 
---- Calculate the caption describing the cursor of a player
+--- @class ExpGui_Surveillance.elements.cursor_slot.display_data
+--- @field sprite SpritePath? Nil when the cursor is empty
+--- @field number number? Nil for a ghost, which has no count
+--- @field tooltip LocalisedString
+
+--- Calculate what a slot shows for the cursor of a player
 --- @param player LuaPlayer
---- @return LocalisedString
+--- @return ExpGui_Surveillance.elements.cursor_slot.display_data
-function Elements.cursor_label.calculate_caption(player)
+function Elements.cursor_slot.calculate_display_data(player)
     local cursor_stack = player.cursor_stack
     if cursor_stack and cursor_stack.valid_for_read then
-        local item = format_string("[item=%s,quality=%s]", cursor_stack.name, cursor_stack.quality.name)
+        return {
-        return { "exp-gui_surveillance.caption-cursor", item, cursor_stack.count }
+            sprite = "item/" .. cursor_stack.name,
+            number = cursor_stack.count,
+            tooltip = { "exp-gui_surveillance.tooltip-cursor", cursor_stack.prototype.localised_name, cursor_stack.count },
+        }
     end
 
     local cursor_ghost = player.cursor_ghost --[[@as ItemIDAndQualityIDPair?]]
     if cursor_ghost then
         local prototype = cursor_ghost.name --[[@as LuaItemPrototype]]
-        return { "exp-gui_surveillance.caption-cursor-ghost", "[item=" .. prototype.name .. "]" }
+        return {
+            sprite = "item/" .. prototype.name,
+            tooltip = { "exp-gui_surveillance.tooltip-cursor-ghost", prototype.localised_name },
+        }
     end
 
-    return { "exp-gui_surveillance.caption-cursor-empty" }
+    return { tooltip = { "exp-gui_surveillance.tooltip-cursor-empty" } }
 end
 
---- Refresh a label, hidden when the camera is not following a player
+--- Refresh a slot, a ghost is shown greyed out and the slot is hidden when the camera is not following a player
---- @param cursor_label LuaGuiElement
+--- @param cursor_slot LuaGuiElement
 --- @param target_player LuaPlayer?
-function Elements.cursor_label.refresh(cursor_label, target_player)
+function Elements.cursor_slot.refresh(cursor_slot, target_player)
-    cursor_label.visible = target_player ~= nil
+    cursor_slot.visible = target_player ~= nil
-    if target_player then
+    if not target_player then return end
-        cursor_label.caption = Elements.cursor_label.calculate_caption(target_player)
+
-    end
+    local display_data = Elements.cursor_slot.calculate_display_data(target_player)
+    cursor_slot.sprite = display_data.sprite or ""
+    cursor_slot.number = display_data.number
+    cursor_slot.tooltip = display_data.tooltip
+    cursor_slot.enabled = display_data.sprite == nil or display_data.number ~= nil
 end
 
---- Refresh the labels of all online cameras
+--- Refresh the slots of all online cameras
-function Elements.cursor_label.refresh_online()
+function Elements.cursor_slot.refresh_online()
-    for _, cursor_label in Elements.cursor_label:online_elements() do
+    for _, cursor_slot in Elements.cursor_slot:online_elements() do
-        local camera = Elements.cursor_label.data[cursor_label]
+        local camera = Elements.cursor_slot.data[cursor_slot]
-        Elements.cursor_label.refresh(cursor_label, Elements.camera.data[camera])
+        Elements.cursor_slot.refresh(cursor_slot, Elements.camera.data[camera])
     end
 end
 
@@ -270,7 +286,6 @@ Elements.container = Gui.define("surveillance/container")
 
         local target_player = Gui.get_player(parent)
         local camera = Elements.camera(screen_frame, target_player)
-        Elements.cursor_label(screen_frame, camera)
 
         local type_dropdown_data = {
             camera = camera,
@@ -281,6 +296,7 @@ Elements.container = Gui.define("surveillance/container")
         Elements.type_dropdown(button_flow, type_dropdown_data)
         Elements.zoom_out_button(button_flow, camera)
         Elements.zoom_in_button(button_flow, camera)
+        Elements.cursor_slot(button_flow, camera)
 
         return Gui.elements.screen_frame.get_root_element(screen_frame)
     end)
@@ -305,7 +321,7 @@ return {
         [e.on_tick] = Elements.camera.refresh_online,
     },
     on_nth_tick = {
-        [10] = Elements.cursor_label.refresh_online,
+        [10] = Elements.cursor_slot.refresh_online,
         [600] = Elements.type_dropdown.refresh_online,
     }
 }

exp_scenario/module/locale/en.cfg

@@ -489,9 +489,9 @@ caption-set-location=Set
 type-player=Player
 type-static=Static
 type-loop=Loop
-caption-cursor=Cursor: __1__ x__2__
+tooltip-cursor=__1__ x__2__
-caption-cursor-ghost=Cursor: __1__ (ghost)
+tooltip-cursor-ghost=__1__ (ghost)
-caption-cursor-empty=Cursor: empty
+tooltip-cursor-empty=Empty cursor
 
 [exp-gui_task-list]
 caption-main=Task List [img=info]

exp_scenario/module/locale/zh-CN.cfg

@@ -474,9 +474,9 @@ caption-set-location=設
 type-player=用戶
 type-static=靜態
 type-loop=循環
-caption-cursor=游標: __1__ x__2__
+tooltip-cursor=__1__ x__2__
-caption-cursor-ghost=游標: __1__ (幻影)
+tooltip-cursor-ghost=__1__ (幻影)
-caption-cursor-empty=游標: 空
+tooltip-cursor-empty=游標為空
 
 [exp-gui_task-list]
 caption-main=工作流程 [img=info]

exp_scenario/module/locale/zh-TW.cfg

@@ -474,9 +474,9 @@ caption-set-location=設
 type-player=用戶
 type-static=靜態
 type-loop=循環
-caption-cursor=游標: __1__ x__2__
+tooltip-cursor=__1__ x__2__
-caption-cursor-ghost=游標: __1__ (幻影)
+tooltip-cursor-ghost=__1__ (幻影)
-caption-cursor-empty=游標: 空
+tooltip-cursor-empty=游標為空
 
 [exp-gui_task-list]
 caption-main=工作流程 [img=info]