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

Update annotations

Browse Source
This commit is contained in:
Insality 2023-12-05 14:55:58 +02:00
parent 01d1445511
commit bdd9efb892
2 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
druid/annotations.lua
View File

@ -50,13 +50,6 @@ local druid__back_handler = {}
---@class druid.base_component ---@class druid.base_component
local druid__base_component = {} local druid__base_component = {}
--- Set current component style table.
--- Invoke `on_style_change` on component, if exist. Component should handle their style changing and store all style params
---@param self druid.base_component @{BaseComponent}
---@param druid_style table|nil Druid style module
---@return druid.base_component @{BaseComponent}
function druid__base_component.component:set_style(self, druid_style) end
--- Return all children components, recursive --- Return all children components, recursive
---@param self druid.base_component @{BaseComponent} ---@param self druid.base_component @{BaseComponent}
---@return table Array of childrens if the Druid component instance ---@return table Array of childrens if the Druid component instance
@ -138,6 +131,13 @@ function druid__base_component.set_input_priority(self, value, is_temporary) end
---@return druid.base_component @{BaseComponent} ---@return druid.base_component @{BaseComponent}
function druid__base_component.set_nodes(self, nodes) end function druid__base_component.set_nodes(self, nodes) end
--- Set current component style table.
--- Invoke `on_style_change` on component, if exist. Component should handle their style changing and store all style params
---@param self druid.base_component @{BaseComponent}
---@param druid_style table|nil Druid style module
---@return druid.base_component @{BaseComponent}
function druid__base_component.set_style(self, druid_style) end
--- Set component template name. --- Set component template name.
--- Use on all your custom components with GUI layouts used as templates. It will check parent template name to build full template name in self:get_node() --- Use on all your custom components with GUI layouts used as templates. It will check parent template name to build full template name in self:get_node()
---@param self druid.base_component @{BaseComponent} ---@param self druid.base_component @{BaseComponent}
@ -562,14 +562,15 @@ local druid__hotkey = {}
--- Add hotkey for component callback --- Add hotkey for component callback
---@param self druid.hotkey @{Hotkey} ---@param self druid.hotkey @{Hotkey}
---@param keys string[]|hash[]|string|hash that have to be pressed before key pressed to activate ---@param keys string[]|hash[]|string|hash that have to be pressed before key pressed to activate
---@param callback_argument value The argument to pass into the callback function ---@param callback_argument any|nil The argument to pass into the callback function
---@return druid.hotkey Current instance
function druid__hotkey.add_hotkey(self, keys, callback_argument) end function druid__hotkey.add_hotkey(self, keys, callback_argument) end
--- Component init function --- The @{Hotkey} constructor
---@param self druid.hotkey @{Hotkey} ---@param self druid.hotkey @{Hotkey}
---@param keys string[]|string The keys to be pressed for trigger callback. Should contains one key and any modificator keys ---@param keys string[]|string The keys to be pressed for trigger callback. Should contains one key and any modificator keys
---@param callback function The callback function ---@param callback function The callback function
---@param callback_argument value The argument to pass into the callback function ---@param callback_argument any|nil The argument to pass into the callback function
function druid__hotkey.init(self, keys, callback, callback_argument) end function druid__hotkey.init(self, keys, callback, callback_argument) end
--- If true, the callback will be triggered on action.repeated --- If true, the callback will be triggered on action.repeated

1
druid/component.lua
View File

@ -74,7 +74,6 @@ end
-- --
-- Invoke `on_style_change` on component, if exist. Component should handle -- Invoke `on_style_change` on component, if exist. Component should handle
-- their style changing and store all style params -- their style changing and store all style params
-- @function component:set_style
-- @tparam BaseComponent self @{BaseComponent} -- @tparam BaseComponent self @{BaseComponent}
-- @tparam table|nil druid_style Druid style module -- @tparam table|nil druid_style Druid style module
-- @treturn BaseComponent @{BaseComponent} -- @treturn BaseComponent @{BaseComponent}