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

Update API pages

Browse Source
This commit is contained in:
Insality
2025-04-20 12:15:31 +03:00
parent 6e1998b822
commit c33dbd5942
24 changed files with 82 additions and 460 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
druid/extended/data_list.lua
View File

@@ -18,9 +18,9 @@ local event = require("event.event")
---@class druid.data_list: druid.component
---@field scroll druid.scroll The scroll instance for Data List component
---@field grid druid.grid The StaticGrid or DynamicGrid instance for Data List component
---@field on_scroll_progress_change event The event triggered when the scroll progress changes
---@field on_element_add event The event triggered when a new element is added
---@field on_element_remove event The event triggered when an element is removed
---@field on_scroll_progress_change event fun(self: druid.data_list, progress: number) The event triggered when the scroll progress changes
---@field on_element_add event fun(self: druid.data_list, index: number, node: node, instance: druid.component, data: table) The event triggered when a new element is added
---@field on_element_remove event fun(self: druid.data_list, index: number, node: node, instance: druid.component, data: table) The event triggered when an element is removed
---@field top_index number The top index of the visible elements
---@field last_index number The last index of the visible elements
---@field scroll_progress number The scroll progress

2
druid/extended/lang_text.lua
View File

@@ -15,7 +15,7 @@ local settings = require("druid.system.settings")
---@class druid.lang_text: druid.component
---@field text druid.text The text component
---@field node node The node of the text component
---@field on_change event The event triggered when the text is changed
---@field on_change event fun(self: druid.lang_text) The event triggered when the text is changed
---@field private last_locale_args table The last locale arguments
---@field private last_locale string The last locale
local M = component.create("lang_text")

2
druid/extended/layout.lua
View File

@@ -42,7 +42,7 @@ local component = require("druid.component")
---@field is_resize_width boolean True if the layout should resize the width of the node
---@field is_resize_height boolean True if the layout should resize the height of the node
---@field is_justify boolean True if the layout should justify the nodes
---@field on_size_changed event.on_size_changed The event triggered when the size of the layout is changed
---@field on_size_changed event.on_size_changed fun(self: druid.layout, size: vector3) The event triggered when the size of the layout is changed
local M = component.create("layout")

2
druid/extended/progress.lua
View File

@@ -19,7 +19,7 @@ local component = require("druid.component")
---- If you have glitchy or dark texture bugs with progress bar, try to disable mipmaps in your texture profiles
---@class druid.progress: druid.component
---@field node node The progress bar node
---@field on_change event Event triggered when progress value changes
---@field on_change event fun(self: druid.progress, value: number) Event triggered when progress value changes
---@field style druid.progress.style Component style parameters
---@field key string Progress bar direction: "x" or "y"
---@field prop hash Property for scaling the progress bar

2
druid/extended/slider.lua
View File

@@ -16,7 +16,7 @@ local component = require("druid.component")
---- To catch input across all slider, you can setup input node via `slider:set_input_node`
---@class druid.slider: druid.component
---@field node node The node to manage the slider
---@field on_change_value event The event triggered when the slider value changes
---@field on_change_value event fun(self: druid.slider, value: number) The event triggered when the slider value changes
---@field style table The style of the slider
---@field private start_pos vector3 The start position of the slider
---@field private pos vector3 The current position of the slider