Move debug GUI out of legacy

2026-07-26 18:36:23 +09:00 · 2026-06-26 15:22:06 +01:00
parent 95bb8ac304
commit 8b3c437847
11 changed files with 31 additions and 29 deletions
@@ -0,0 +1,132 @@
+local Storage = require("modules/exp_util/storage")
+local mod_gui = require "mod-gui"
+
+local Gui = {}
+local data = {}
+local uid = 0
+
+Storage.register(
+    data,
+    function(tbl)
+        data = tbl
+    end
+)
+
+function Gui.uid_name()
+    uid = uid + 1
+    return "Redmew_" .. uid
+end
+
+-- Associates data with the LuaGuiElement. If data is nil then removes the data
+function Gui.set_data(element, value)
+    data[element.player_index * 0x100000000 + element.index] = value
+end
+
+-- Gets the Associated data with this LuaGuiElement if any.
+function Gui.get_data(element)
+    return data[element.player_index * 0x100000000 + element.index]
+end
+
+-- Removes data associated with LuaGuiElement and its children recursively.
+function Gui.remove_data_recursively(element)
+    Gui.set_data(element, nil)
+
+    local children = element.children
+
+    if not children then
+        return
+    end
+
+    for _, child in ipairs(children) do
+        if child.valid then
+            Gui.remove_data_recursively(child)
+        end
+    end
+end
+
+function Gui.remove_children_data(element)
+    local children = element.children
+
+    if not children then
+        return
+    end
+
+    for _, child in ipairs(children) do
+        if child.valid then
+            Gui.set_data(child, nil)
+            Gui.remove_children_data(child)
+        end
+    end
+end
+
+function Gui.destroy(element)
+    Gui.remove_data_recursively(element)
+    element.destroy()
+end
+
+function Gui.clear(element)
+    Gui.remove_children_data(element)
+    element.clear()
+end
+
+Gui.events = {}
+local function handler_factory(event_name)
+    return function(element_name, handler)
+        Gui.events[defines.events[event_name]] = function(event)
+            if event.element and event.element.valid and event.element.name == element_name then
+                event.player = game.players[event.player_index]
+                handler(event)
+            end
+        end
+    end
+end
+
+-- Register a handler for the on_gui_checked_state_changed event for LuaGuiElements with element_name.
+-- Can only have one handler per element name.
+-- Guarantees that the element and the player are valid when calling the handler.
+-- Adds a player field to the event table.
+Gui.on_checked_state_changed = handler_factory("on_gui_checked_state_changed")
+
+-- Register a handler for the on_gui_click event for LuaGuiElements with element_name.
+-- Can only have one handler per element name.
+-- Guarantees that the element and the player are valid when calling the handler.
+-- Adds a player field to the event table.
+Gui.on_click = handler_factory("on_gui_click")
+
+-- Register a handler for the on_gui_closed event for a custom LuaGuiElements with element_name.
+-- Can only have one handler per element name.
+-- Guarantees that the element and the player are valid when calling the handler.
+-- Adds a player field to the event table.
+Gui.on_custom_close = handler_factory("on_gui_closed")
+
+-- Register a handler for the on_gui_elem_changed event for LuaGuiElements with element_name.
+-- Can only have one handler per element name.
+-- Guarantees that the element and the player are valid when calling the handler.
+-- Adds a player field to the event table.
+Gui.on_elem_changed = handler_factory("on_gui_elem_changed")
+
+-- Register a handler for the on_gui_selection_state_changed event for LuaGuiElements with element_name.
+-- Can only have one handler per element name.
+-- Guarantees that the element and the player are valid when calling the handler.
+-- Adds a player field to the event table.
+Gui.on_selection_state_changed = handler_factory("on_gui_selection_state_changed")
+
+-- Register a handler for the on_gui_text_changed event for LuaGuiElements with element_name.
+-- Can only have one handler per element name.
+-- Guarantees that the element and the player are valid when calling the handler.
+-- Adds a player field to the event table.
+Gui.on_text_changed = handler_factory("on_gui_text_changed")
+
+-- Register a handler for the on_gui_value_changed event for LuaGuiElements with element_name.
+-- Can only have one handler per element name.
+-- Guarantees that the element and the player are valid when calling the handler.
+-- Adds a player field to the event table.
+Gui.on_value_changed = handler_factory("on_gui_value_changed")
+
+--- Returns the flow where top elements can be added and will be effected by google visibility
+-- For the toggle to work it must be registed with Gui.allow_player_to_toggle_top_element_visibility(element_name)
+-- @tparam LuaPlayer player pointer to the player who has the gui
+-- @treturn LuaGuiElement the top element flow
+Gui.get_top_element_flow = mod_gui.get_button_flow
+
+return Gui