2018-11-26 03:07:03 +02:00
|
|
|
local Token = require 'utils.token'
|
2018-05-20 17:28:54 +02:00
|
|
|
local Event = require 'utils.event'
|
2018-09-23 00:25:13 +02:00
|
|
|
local Game = require 'utils.game'
|
2018-12-16 03:28:00 +02:00
|
|
|
local Global = require 'utils.global'
|
2018-05-20 17:28:54 +02:00
|
|
|
|
|
|
|
local Gui = {}
|
|
|
|
|
2018-12-16 03:28:00 +02:00
|
|
|
local data = {}
|
|
|
|
|
|
|
|
Global.register(
|
2018-12-16 12:58:28 +02:00
|
|
|
data,
|
2018-12-16 03:28:00 +02:00
|
|
|
function(tbl)
|
2018-12-16 12:58:28 +02:00
|
|
|
data = tbl
|
2018-12-16 03:28:00 +02:00
|
|
|
end
|
|
|
|
)
|
|
|
|
|
2018-12-16 12:58:28 +02:00
|
|
|
local top_elements = {}
|
2018-12-22 01:39:18 +02:00
|
|
|
local on_visible_handlers = {}
|
2018-12-16 03:28:00 +02:00
|
|
|
local on_pre_hidden_handlers = {}
|
2018-05-20 17:28:54 +02:00
|
|
|
|
|
|
|
function Gui.uid_name()
|
2019-01-31 00:16:44 +02:00
|
|
|
return tostring(Token.uid())
|
2018-05-20 17:28:54 +02:00
|
|
|
end
|
|
|
|
|
|
|
|
-- Associates data with the LuaGuiElement. If data is nil then removes the data
|
2018-12-16 03:28:00 +02:00
|
|
|
function Gui.set_data(element, value)
|
|
|
|
data[element.player_index * 0x100000000 + element.index] = value
|
2018-05-20 17:28:54 +02:00
|
|
|
end
|
|
|
|
|
|
|
|
-- Gets the Associated data with this LuaGuiElement if any.
|
|
|
|
function Gui.get_data(element)
|
2018-12-16 03:28:00 +02:00
|
|
|
return data[element.player_index * 0x100000000 + element.index]
|
2018-05-20 17:28:54 +02:00
|
|
|
end
|
|
|
|
|
2018-12-22 01:39:18 +02:00
|
|
|
-- Removes data associated with LuaGuiElement and its children recursively.
|
2018-12-01 23:06:24 +02:00
|
|
|
function Gui.remove_data_recursively(element)
|
2018-05-20 17:28:54 +02:00
|
|
|
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
|
2018-12-01 23:06:24 +02:00
|
|
|
Gui.remove_data_recursively(child)
|
2018-05-20 17:28:54 +02:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2018-06-27 15:48:04 +02:00
|
|
|
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)
|
2018-12-01 23:06:24 +02:00
|
|
|
Gui.remove_data_recursively(element)
|
2018-06-28 19:28:39 +02:00
|
|
|
element.destroy()
|
2018-06-27 15:48:04 +02:00
|
|
|
end
|
|
|
|
|
|
|
|
function Gui.clear(element)
|
|
|
|
Gui.remove_children_data(element)
|
|
|
|
element.clear()
|
|
|
|
end
|
|
|
|
|
2018-06-21 18:11:52 +02:00
|
|
|
local function handler_factory(event_id)
|
|
|
|
local handlers
|
2018-05-20 17:28:54 +02:00
|
|
|
|
2018-06-21 18:11:52 +02:00
|
|
|
local function on_event(event)
|
|
|
|
local element = event.element
|
|
|
|
if not element or not element.valid then
|
|
|
|
return
|
|
|
|
end
|
2018-05-20 17:28:54 +02:00
|
|
|
|
2018-06-21 18:11:52 +02:00
|
|
|
local handler = handlers[element.name]
|
|
|
|
if not handler then
|
|
|
|
return
|
|
|
|
end
|
2018-05-20 17:28:54 +02:00
|
|
|
|
2018-09-23 12:46:58 +02:00
|
|
|
local player = Game.get_player_by_index(event.player_index)
|
2018-06-21 18:11:52 +02:00
|
|
|
if not player or not player.valid then
|
|
|
|
return
|
|
|
|
end
|
|
|
|
event.player = player
|
2018-05-20 17:28:54 +02:00
|
|
|
|
2018-06-21 18:11:52 +02:00
|
|
|
handler(event)
|
2018-06-20 18:15:48 +02:00
|
|
|
end
|
|
|
|
|
2018-06-21 18:11:52 +02:00
|
|
|
return function(element_name, handler)
|
|
|
|
if not handlers then
|
|
|
|
handlers = {}
|
|
|
|
Event.add(event_id, on_event)
|
|
|
|
end
|
2018-06-20 18:15:48 +02:00
|
|
|
|
2018-06-21 18:11:52 +02:00
|
|
|
handlers[element_name] = handler
|
2018-06-20 18:15:48 +02:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2018-12-16 03:28:00 +02:00
|
|
|
local function custom_handler_factory(handlers)
|
|
|
|
return function(element_name, handler)
|
|
|
|
handlers[element_name] = handler
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
local function custom_raise(handlers, element, player)
|
|
|
|
local handler = handlers[element.name]
|
|
|
|
if not handler then
|
|
|
|
return
|
|
|
|
end
|
|
|
|
|
|
|
|
handler({element = element, player = player})
|
|
|
|
end
|
|
|
|
|
2018-06-21 18:11:52 +02:00
|
|
|
-- Register a handler for the on_gui_checked_state_changed event for LuaGuiElements with element_name.
|
2018-06-20 18:15:48 +02:00
|
|
|
-- 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.
|
2018-06-21 18:11:52 +02:00
|
|
|
Gui.on_checked_state_changed = handler_factory(defines.events.on_gui_checked_state_changed)
|
2018-06-20 18:15:48 +02:00
|
|
|
|
2018-06-21 18:11:52 +02:00
|
|
|
-- 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(defines.events.on_gui_click)
|
2018-05-21 19:22:07 +02:00
|
|
|
|
2018-06-21 18:11:52 +02:00
|
|
|
-- 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(defines.events.on_gui_closed)
|
2018-05-21 19:22:07 +02:00
|
|
|
|
2018-06-21 18:11:52 +02:00
|
|
|
-- 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(defines.events.on_gui_elem_changed)
|
2018-05-21 19:22:07 +02:00
|
|
|
|
2018-06-21 18:11:52 +02:00
|
|
|
-- 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(defines.events.on_gui_selection_state_changed)
|
2018-05-21 19:22:07 +02:00
|
|
|
|
2018-06-21 18:11:52 +02:00
|
|
|
-- Register a handler for the on_gui_text_changed event for LuaGuiElements with element_name.
|
2018-05-21 19:22:07 +02:00
|
|
|
-- 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.
|
2018-06-21 18:11:52 +02:00
|
|
|
Gui.on_text_changed = handler_factory(defines.events.on_gui_text_changed)
|
2018-05-21 19:22:07 +02:00
|
|
|
|
2018-06-21 18:11:52 +02:00
|
|
|
-- 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(defines.events.on_gui_value_changed)
|
2018-05-21 19:22:07 +02:00
|
|
|
|
2018-12-16 03:39:19 +02:00
|
|
|
-- Register a handler for when the player shows the top LuaGuiElements with element_name.
|
2018-12-16 03:28:00 +02:00
|
|
|
-- Assuming the element_name has been added with Gui.allow_player_to_toggle_top_element_visibility.
|
|
|
|
-- 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.
|
2018-12-22 01:39:18 +02:00
|
|
|
Gui.on_player_show_top = custom_handler_factory(on_visible_handlers)
|
2018-12-16 03:28:00 +02:00
|
|
|
|
2018-12-16 03:39:19 +02:00
|
|
|
-- Register a handler for when the player hides the top LuaGuiElements with element_name.
|
2018-12-16 03:28:00 +02:00
|
|
|
-- Assuming the element_name has been added with Gui.allow_player_to_toggle_top_element_visibility.
|
|
|
|
-- 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_pre_player_hide_top = custom_handler_factory(on_pre_hidden_handlers)
|
|
|
|
|
|
|
|
--- Allows the player to show / hide this element.
|
|
|
|
-- The element must be part in gui.top.
|
2018-12-16 12:58:28 +02:00
|
|
|
-- This function must be called in the control stage, i.e not inside an event.
|
2018-12-16 03:28:00 +02:00
|
|
|
-- @param element_name<string> This name must be globally unique.
|
|
|
|
function Gui.allow_player_to_toggle_top_element_visibility(element_name)
|
2019-02-18 08:43:59 +02:00
|
|
|
if _LIFECYCLE ~= _STAGE.control then
|
2019-02-11 05:36:44 +02:00
|
|
|
error('can only be called during the control stage', 2)
|
2019-02-04 23:17:00 +02:00
|
|
|
end
|
2018-12-16 03:28:00 +02:00
|
|
|
top_elements[#top_elements + 1] = element_name
|
|
|
|
end
|
|
|
|
|
|
|
|
local toggle_button_name = Gui.uid_name()
|
|
|
|
|
|
|
|
Event.add(
|
|
|
|
defines.events.on_player_created,
|
|
|
|
function(event)
|
|
|
|
local player = Game.get_player_by_index(event.player_index)
|
|
|
|
|
|
|
|
if not player or not player.valid then
|
|
|
|
return
|
|
|
|
end
|
|
|
|
|
|
|
|
local b =
|
|
|
|
player.gui.top.add {
|
|
|
|
type = 'button',
|
|
|
|
name = toggle_button_name,
|
|
|
|
caption = '<',
|
|
|
|
tooltip = 'Shows / hides the Redmew Gui buttons.'
|
|
|
|
}
|
|
|
|
local style = b.style
|
|
|
|
style.width = 18
|
|
|
|
style.height = 38
|
|
|
|
style.left_padding = 0
|
|
|
|
style.top_padding = 0
|
|
|
|
style.right_padding = 0
|
|
|
|
style.bottom_padding = 0
|
|
|
|
style.font = 'default-small-bold'
|
|
|
|
end
|
|
|
|
)
|
|
|
|
|
|
|
|
Gui.on_click(
|
|
|
|
toggle_button_name,
|
|
|
|
function(event)
|
|
|
|
local button = event.element
|
|
|
|
local player = event.player
|
|
|
|
local top = player.gui.top
|
|
|
|
|
|
|
|
if button.caption == '<' then
|
|
|
|
for i = 1, #top_elements do
|
|
|
|
local name = top_elements[i]
|
|
|
|
local ele = top[name]
|
|
|
|
if ele and ele.valid then
|
|
|
|
local style = ele.style
|
|
|
|
|
|
|
|
-- if visible is not set it has the value of nil.
|
|
|
|
-- Hence nil is treated as is visible.
|
|
|
|
local v = style.visible
|
|
|
|
if v or v == nil then
|
|
|
|
custom_raise(on_pre_hidden_handlers, ele, player)
|
|
|
|
style.visible = false
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
button.caption = '>'
|
|
|
|
button.style.height = 24
|
|
|
|
else
|
|
|
|
for i = 1, #top_elements do
|
|
|
|
local name = top_elements[i]
|
|
|
|
local ele = top[name]
|
|
|
|
if ele and ele.valid then
|
|
|
|
local style = ele.style
|
|
|
|
|
|
|
|
if not style.visible then
|
|
|
|
style.visible = true
|
2018-12-22 01:39:18 +02:00
|
|
|
custom_raise(on_visible_handlers, ele, player)
|
2018-12-16 03:28:00 +02:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
button.caption = '<'
|
|
|
|
button.style.height = 38
|
|
|
|
end
|
|
|
|
end
|
|
|
|
)
|
|
|
|
|
2019-01-31 00:16:44 +02:00
|
|
|
if _DEBUG then
|
|
|
|
local concat = table.concat
|
|
|
|
|
|
|
|
local names = {}
|
|
|
|
Gui.names = names
|
|
|
|
|
|
|
|
function Gui.uid_name()
|
|
|
|
local info = debug.getinfo(2, 'Sl')
|
|
|
|
local filepath = info.source:match('^.+/currently%-playing/(.+)$'):sub(1, -5)
|
|
|
|
local line = info.currentline
|
|
|
|
|
|
|
|
local token = tostring(Token.uid())
|
|
|
|
|
|
|
|
local name = concat {token, ' - ', filepath, ':line:', line}
|
|
|
|
names[token] = name
|
|
|
|
|
|
|
|
return token
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2018-05-20 17:28:54 +02:00
|
|
|
return Gui
|