Partydeck/Druid-Extension
3
0
Fork 0
mirror of https://github.com/Insality/druid synced 2025-09-27 18:12:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

Inline helper.is_enabled, remove unused code, documentation fixes, remove formats and druid_input files, add more tests

Browse Source
This commit is contained in:
Insality
2023-07-15 11:53:07 +03:00
parent c01ee189b4
commit 38c117b9d8
20 changed files with 275 additions and 134 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
druid/annotations.lua
View File

@@ -189,7 +189,7 @@ local druid__button = {}
---@return hash The action_id of the input key
function druid__button.get_key_trigger(self) end
--- @{Button} constructor
--- The @{Button} constructor
---@param self druid.button @{Button}
---@param node string|Node Node name or GUI Node itself
---@param callback function On click button callback

4
druid/base/back_handler.lua
View File

@@ -20,7 +20,7 @@
-- @within BaseComponent
-- @alias druid.back_handler
--- @{DruidEvent} Event on back handler action.
--- The @{DruidEvent} Event on back handler action.
--
-- Trigger on input action ACTION_BACK or ACTION_BACKSPACE
-- @usage
@@ -43,7 +43,7 @@ local component = require("druid.component")
local BackHandler = component.create("back_handler")
--- @{BackHandler} constructor
--- The @{BackHandler} constructor
-- @tparam BackHandler self @{BackHandler}
-- @tparam callback callback On back button
-- @tparam[opt] any custom_args Button events custom arguments

22
druid/base/button.lua
View File

@@ -35,7 +35,7 @@
-- @alias druid.button
--- @{DruidEvent}: Event on successful release action over button.
--- The @{DruidEvent}: Event on successful release action over button.
-- @usage
-- -- Custom args passed in Button constructor
-- button.on_click:subscribe(function(self, custom_args, button_instance)
@@ -44,7 +44,7 @@
-- @tfield DruidEvent on_click @{DruidEvent}
--- @{DruidEvent}: Event on repeated action over button.
--- The @{DruidEvent}: Event on repeated action over button.
--
-- This callback will be triggered if user hold the button. The repeat rate pick from `input.repeat_interval` in game.project
-- @usage
@@ -55,7 +55,7 @@
-- @tfield DruidEvent on_repeated_click @{DruidEvent}
--- @{DruidEvent}: Event on long tap action over button.
--- The @{DruidEvent}: Event on long tap action over button.
--
-- This callback will be triggered if user pressed the button and hold the some amount of time.
-- The amount of time picked from button style param: LONGTAP_TIME
@@ -67,7 +67,7 @@
-- @tfield DruidEvent on_long_click @{DruidEvent}
--- @{DruidEvent}: Event on double tap action over button.
--- The @{DruidEvent}: Event on double tap action over button.
--
-- If secondary click was too fast after previous one, the double
-- click will be called instead usual click (if on_double_click subscriber exists)
@@ -79,7 +79,7 @@
-- @tfield DruidEvent on_double_click @{DruidEvent}
--- @{DruidEvent}: Event calls every frame before on_long_click event.
--- The @{DruidEvent}: Event calls every frame before on_long_click event.
--
-- If long_click subscriber exists, the on_hold_callback will be called before long_click trigger.
--
@@ -92,7 +92,7 @@
-- @tfield DruidEvent on_hold_callback @{DruidEvent}
--- @{DruidEvent}: Event calls if click event was outside of button.
--- The @{DruidEvent}: Event calls if click event was outside of button.
--
-- This event will be triggered for each button what was not clicked on user click action
--
@@ -105,7 +105,7 @@
-- @tfield DruidEvent on_click_outside @{DruidEvent}
--- @{DruidEvent}: Event triggered if button was pressed by user.
--- The @{DruidEvent}: Event triggered if button was pressed by user.
-- @usage
-- -- Custom args passed in Button constructor
-- button.on_pressed:subscribe(function(self, custom_args, button_instance)
@@ -128,7 +128,7 @@
---Custom args for any Button event. Setup in Button constructor
-- @tfield any params
--- @{Hover}: Button Hover component
--- The @{Hover}: Button Hover component
-- @tfield Hover hover @{Hover}
--- Additional button click area, defined by another GUI Node
@@ -276,7 +276,7 @@ function Button.on_style_change(self, style)
end
--- @{Button} constructor
--- The @{Button} constructor
-- @tparam Button self @{Button}
-- @tparam string|Node node Node name or GUI Node itself
-- @tparam function callback On click button callback
@@ -329,7 +329,7 @@ function Button.on_input(self, action_id, action)
return false
end
if not helper.is_enabled(self.node) then
if not gui.is_enabled(self.node, true) then
return false
end
@@ -414,7 +414,7 @@ end
function Button.on_message_input(self, node_id, message)
if node_id ~= self.node_id or self.disabled or not helper.is_enabled(self.node) then
if node_id ~= self.node_id or self.disabled or not gui.is_enabled(self.node) then
return false
end

8
druid/base/drag.lua
View File

@@ -73,7 +73,11 @@ end
local function end_touch(self)
if self.is_drag then
self.on_drag_end:trigger(self:get_context(), self.x - self.touch_start_pos.x, self.y - self.touch_start_pos.y)
self.on_drag_end:trigger(
self:get_context(),
self.x - self.touch_start_pos.x,
self.y - self.touch_start_pos.y
)
end
self.is_drag = false
@@ -229,7 +233,7 @@ function Drag.on_input(self, action_id, action)
return false
end
if not helper.is_enabled(self.node) or self._is_disabled then
if not gui.is_enabled(self.node, true) or self._is_disabled then
return false
end

2
druid/base/hover.lua
View File

@@ -58,7 +58,7 @@ function Hover.on_input(self, action_id, action)
return false
end
if not helper.is_enabled(self.node) or not self._is_enabled then
if not gui.is_enabled(self.node, true) or not self._is_enabled then
self:set_hover(false)
self:set_mouse_hover(false)
return false

9
druid/base/static_grid.lua
View File

@@ -1,16 +1,17 @@
-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
--- Component to handle component's position by row and columns.
-- ## Overview ##
-- <b># Overview #</b>
--
-- The Static Grid component allows for positioning components in rows and columns.
-- It provides a static grid layout with constant node sizes, allowing for pre-calculated
-- node positions and the option to include gaps between nodes.
--
-- ## Notes ##
-- <b># Notes #</b>
--
-- • In a static grid, the node size remains constant, enabling the calculation of node
-- positions before placement. Nodes can be placed with gaps between them.
-- positions before placement. If you want add gaps between nodes, increase the root prefab size,
-- including the padding and margin.
--
-- • The static grid can automatically shift elements when nodes are added or removed.
--
@@ -110,7 +111,7 @@ function StaticGrid.on_style_change(self, style)
end
--- @{StaticGrid} constructor
--- The @{StaticGrid} constructor
-- @tparam StaticGrid self @{StaticGrid}
-- @tparam string|Node parent The GUI Node container, where grid's items will be placed
-- @tparam node element Element prefab. Need to get it size

2
druid/extended/swipe.lua
View File

@@ -116,7 +116,7 @@ function Swipe.on_input(self, action_id, action)
return false
end
if not helper.is_enabled(self.node) then
if not gui.is_enabled(self.node, true) then
return false
end

10
druid/extended/timer.lua
View File

@@ -31,13 +31,19 @@
---
local Event = require("druid.event")
local formats = require("druid.helper.formats")
local helper = require("druid.helper")
local component = require("druid.component")
local Timer = component.create("timer")
local function second_string_min(sec)
local mins = math.floor(sec / 60)
local seconds = math.floor(sec - mins * 60)
return string.format("%.2d:%.2d", mins, seconds)
end
--- Component init function
-- @tparam Timer self @{Timer}
-- @tparam node node Gui text node
@@ -98,7 +104,7 @@ end
-- @tparam number set_to Value in seconds
function Timer.set_to(self, set_to)
self.last_value = set_to
gui.set_text(self.node, formats.second_string_min(set_to))
gui.set_text(self.node, second_string_min(set_to))
end

24
druid/helper.lua
View File

@@ -10,7 +10,6 @@
local const = require("druid.const")
local M = {}
M._some = { pepepe = true }
local function get_text_width(text_node)
@@ -261,17 +260,6 @@ function M.get_scaled_size(node)
end
--- Check if node is enabled in GUI hierarchy.
--
-- Return false, if node or any his parent is disabled
-- @function helper.is_enabled
-- @tparam node node GUI node
-- @treturn bool Is enabled in hierarchy
function M.is_enabled(node)
return gui.is_enabled(node, true)
end
--- Get cumulative parent's node scale
-- @function helper.get_scene_scale
-- @tparam node node Gui node
@@ -394,7 +382,7 @@ end
--- Get text metric from GUI node.
-- @function helper.get_text_metrics_from_node
-- @tparam Node text_node
-- @treturn pepepe
-- @treturn GUITextMetrics
-- @usage
-- type GUITextMetrics = {
-- width: number,
@@ -498,12 +486,14 @@ function M.deprecated(message)
end
--- Show message to require extended component
--- Show message to require component
-- @local
function M.extended_component(component_name)
print(string.format("[Druid]: The component %s is extended component. You have to register it via druid.register to use it", component_name))
function M.require_component_message(component_name, component_type)
component_type = component_type or "extended"
print(string.format("[Druid]: The component %s is %s component. You have to register it via druid.register to use it", component_name, component_type))
print("[Druid]: Use next code:")
print(string.format('local %s = require("druid.extended.%s")', component_name, component_name))
print(string.format('local %s = require("druid.%s.%s")', component_name, component_type, component_name))
print(string.format('druid.register("%s", %s)', component_name, component_name))
end

24
druid/helper/druid_input.lua
View File

@@ -1,24 +0,0 @@
-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
--- Druid inner module to acquire/release input
-- @module helper.input
-- @local
local M = {}
local ADD_FOCUS = hash("acquire_input_focus")
local REMOVE_FOCUS = hash("release_input_focus")
local PATH_OBJ = "."
function M.focus()
msg.post(PATH_OBJ, ADD_FOCUS)
end
function M.remove()
msg.post(PATH_OBJ, REMOVE_FOCUS)
end
return M

47
druid/helper/formats.lua
View File

@@ -1,47 +0,0 @@
-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
--- Druid module with utils on string formats
-- @local
-- @module helper.formats
local const = require("druid.const")
local M = {}
--- Return number with zero number prefix
-- @function formats.add_prefix_zeros
-- @tparam number num Number for conversion
-- @tparam number count Count of numerals
-- @return string with need count of zero (1,3) -> 001
function M.add_prefix_zeros(num, count)
local result = tostring(num)
for i = string.len(result), count - 1 do
result = const.ZERO .. result
end
return result
end
--- Convert seconds to string minutes:seconds
-- @function formats.second_string_min
-- @tparam number sec Seconds
-- @return string minutes:seconds
function M.second_string_min(sec)
local mins = math.floor(sec / 60)
local seconds = math.floor(sec - mins * 60)
return string.format("%.2d:%.2d", mins, seconds)
end
--- Interpolate string with named Parameters in Table
-- @function formats.second_string_min
-- @tparam string s Target string
-- @tparam table tab Table with parameters
-- @return string with replaced parameters
function M.interpolate_string(s, tab)
return (s:gsub('($%b{})', function(w) return tab[w:sub(3, -2)] or w end))
end
return M

45
druid/system/druid_instance.lua
View File

@@ -71,7 +71,6 @@ local helper = require("druid.helper")
local class = require("druid.system.middleclass")
local settings = require("druid.system.settings")
local base_component = require("druid.component")
local druid_input = require("druid.helper.druid_input")
local drag = require("druid.base.drag")
local text = require("druid.base.text")
@@ -97,6 +96,9 @@ local back_handler = require("druid.base.back_handler")
local DruidInstance = class("druid.druid_instance")
local PATH_OBJ = "."
local MSG_ADD_FOCUS = hash("acquire_input_focus")
local MSG_REMOVE_FOCUS = hash("release_input_focus")
local IS_NO_AUTO_INPUT = sys.get_config_int("druid.no_auto_input", 0) == 1
local function set_input_state(self, is_input_inited)
@@ -106,9 +108,9 @@ local function set_input_state(self, is_input_inited)
self.input_inited = is_input_inited
if is_input_inited then
druid_input.focus()
msg.post(PATH_OBJ, MSG_ADD_FOCUS)
else
druid_input.remove()
msg.post(PATH_OBJ, MSG_REMOVE_FOCUS)
end
end
@@ -659,7 +661,7 @@ end
-- @tparam function on_swipe_callback Swipe callback for on_swipe_end event
-- @treturn Swipe @{Swipe} component
function DruidInstance.new_swipe(self, node, on_swipe_callback)
return helper.extended_component("swipe")
return helper.require_component_message("swipe")
end
@@ -668,7 +670,7 @@ end
-- @tparam node parent The gui node parent, where items will be placed
-- @treturn DynamicGrid @{DynamicGrid} component
function DruidInstance.new_dynamic_grid(self, parent)
return helper.extended_component("dynamic_grid")
return helper.require_component_message("dynamic_grid")
end
@@ -679,7 +681,7 @@ end
-- @tparam bool no_adjust If true, will not correct text size
-- @treturn LangText @{LangText} component
function DruidInstance.new_lang_text(self, node, locale_id, no_adjust)
return helper.extended_component("lang_text")
return helper.require_component_message("lang_text")
end
@@ -690,7 +692,7 @@ end
-- @tparam[opt] function callback On slider change callback
-- @treturn Slider @{Slider} component
function DruidInstance.new_slider(self, node, end_pos, callback)
return helper.extended_component("slider")
return helper.require_component_message("slider")
end
@@ -702,7 +704,7 @@ end
-- @tparam[opt=false] boolean initial_state The initial state of checkbox, default - false
-- @treturn Checkbox @{Checkbox} component
function DruidInstance.new_checkbox(self, node, callback, click_node, initial_state)
return helper.extended_component("checkbox")
return helper.require_component_message("checkbox")
end
@@ -713,7 +715,7 @@ end
-- @tparam[opt] number keyboard_type Gui keyboard type for input field
-- @treturn Input @{Input} component
function DruidInstance.new_input(self, click_node, text_node, keyboard_type)
return helper.extended_component("input")
return helper.require_component_message("input")
end
@@ -724,7 +726,7 @@ end
-- @tparam[opt=node] node[] click_nodes Array of trigger nodes, by default equals to nodes
-- @treturn CheckboxGroup @{CheckboxGroup} component
function DruidInstance.new_checkbox_group(self, nodes, callback, click_nodes)
return helper.extended_component("checkbox_group")
return helper.require_component_message("checkbox_group")
end
@@ -735,7 +737,7 @@ end
-- @tparam function create_function The create function callback(self, data, index, data_list). Function should return (node, [component])
-- @treturn DataList @{DataList} component
function DruidInstance.new_data_list(self, druid_scroll, druid_grid, create_function)
return helper.extended_component("data_list")
return helper.require_component_message("data_list")
end
@@ -746,7 +748,7 @@ end
-- @tparam[opt=node] node[] click_nodes Array of trigger nodes, by default equals to nodes
-- @treturn RadioGroup @{RadioGroup} component
function DruidInstance.new_radio_group(self, nodes, callback, click_nodes)
return helper.extended_component("radio_group")
return helper.require_component_message("radio_group")
end
@@ -758,7 +760,7 @@ end
-- @tparam[opt] function callback Function on timer end
-- @treturn Timer @{Timer} component
function DruidInstance.new_timer(self, node, seconds_from, seconds_to, callback)
return helper.extended_component("timer")
return helper.require_component_message("timer")
end
@@ -769,7 +771,7 @@ end
-- @tparam[opt=1] number init_value Initial value of progress bar
-- @treturn Progress @{Progress} component
function DruidInstance.new_progress(self, node, key, init_value)
return helper.extended_component("progress")
return helper.require_component_message("progress")
end
@@ -779,7 +781,7 @@ end
-- @tparam string mode The layout mode
-- @treturn Layout @{Layout} component
function DruidInstance.new_layout(self, node, mode)
return helper.extended_component("layout")
return helper.require_component_message("layout")
end
@@ -790,7 +792,18 @@ end
-- @tparam[opt] value params Button callback params
-- @treturn Hotkey @{Hotkey} component
function DruidInstance.new_hotkey(self, keys_array, callback, params)
return helper.extended_component("hotkey")
return helper.require_component_message("hotkey")
end
--- Create @{RichText} component.
-- As a template please check rich_text.gui layout.
-- @tparam DruidInstance self
-- @tparam[opt] string template Template name if used
-- @tparam[opt] table<hash, node> nodes Nodes table from gui.clone_tree
-- @treturn Hotkey @{RichText} component
function DruidInstance.new_hotkey(self, template, nodes)
return helper.require_component_message("rich_text", "custom")
end