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

Add generics annotations to component set_style/nodes/template

Browse Source
This commit is contained in:
Insality
2024-10-23 00:43:03 +03:00
parent aff4412677
commit 62384f36b3
4 changed files with 53 additions and 139 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
druid/annotations.lua
View File

@@ -126,27 +126,6 @@ function druid__base_component.set_input_enabled(self, state) end
---@return number The component input priority
function druid__base_component.set_input_priority(self, value, is_temporary) end
--- Set current component nodes.
--- Use if your component nodes was cloned with `gui.clone_tree` and you got the node tree.
---@param self druid.base_component @{BaseComponent}
---@param nodes table BaseComponent nodes table
---@return druid.base_component @{BaseComponent}
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.
--- 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 template string BaseComponent template name
---@return druid.base_component @{BaseComponent}
function druid__base_component.set_template(self, template) end
---@class druid.blocker : druid.base_component
---@field node node Blocker node
@@ -1896,4 +1875,28 @@ function helper.table_to_string(t) end
---@param component T Component module
---@param ... any Other component params to pass it to component:init function
---@return T Component instance
function druid_instance.new(self, component, ...) end
function druid_instance.new(self, component, ...) 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
---@generic T: druid.base_component
---@param self T @{BaseComponent}
---@param druid_style table|nil Druid style module
---@return T @{BaseComponent}
function druid__base_component.set_style(self, druid_style) end
--- 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()
---@generic T: druid.base_component
---@param self T @{BaseComponent}
---@param template string BaseComponent template name
---@return T @{BaseComponent}
function druid__base_component.set_template(self, template) end
--- Set current component nodes.
--- Use if your component nodes was cloned with `gui.clone_tree` and you got the node tree.
---@generic T: druid.base_component
---@param self T @{BaseComponent}
---@param nodes table BaseComponent nodes table
---@return T @{BaseComponent}
function druid__base_component.set_nodes(self, nodes) end

3
druid/component.lua
View File

@@ -76,6 +76,7 @@ end
-- @tparam BaseComponent self @{BaseComponent}
-- @tparam table|nil druid_style Druid style module
-- @treturn BaseComponent @{BaseComponent}
-- @local
function BaseComponent.set_style(self, druid_style)
self._meta.style = druid_style or {}
local component_style = self._meta.style[self._component.name] or {}
@@ -95,6 +96,7 @@ end
-- @tparam BaseComponent self @{BaseComponent}
-- @tparam string template BaseComponent template name
-- @treturn BaseComponent @{BaseComponent}
-- @local
function BaseComponent.set_template(self, template)
template = template or ""
@@ -131,6 +133,7 @@ end
-- local nodes = gui.clone_tree(self.prefab)
-- ... In your component:
-- self:set_nodes(nodes)
-- @local
function BaseComponent.set_nodes(self, nodes)
self._meta.nodes = nodes