Rename type druid_instance to druid.instance

This commit is contained in:
Insality 2025-03-01 15:54:14 +02:00
parent dd5f619345
commit 3a559d7ac2
71 changed files with 78 additions and 78 deletions

View File

@ -6,7 +6,7 @@ local helper = require("druid.helper")
---@field context table
---@field nodes table<hash, node>|nil
---@field style table|nil
---@field druid druid_instance
---@field druid druid.instance
---@field input_enabled boolean
---@field children table
---@field parent druid.base_component|nil
@ -20,7 +20,7 @@ local helper = require("druid.helper")
---@field _uid number
---@class druid.base_component
---@field druid druid_instance Druid instance to create inner components
---@field druid druid.instance Druid instance to create inner components
---@field init fun(self:druid.base_component, ...)|nil
---@field update fun(self:druid.base_component, dt:number)|nil
---@field on_remove fun(self:druid.base_component)|nil
@ -134,7 +134,7 @@ end
---Get Druid instance for inner component creation.
---@param template string|nil
---@param nodes table<hash, node>|nil
---@return druid_instance
---@return druid.instance
function M:get_druid(template, nodes)
local context = { _context = self }
local druid_instance = setmetatable(context, { __index = self._meta.druid })
@ -239,7 +239,7 @@ end
--- Setup component context and his style table
---@param druid_instance table The parent druid instance
---@param druid_instance druid.instance The parent druid instance
---@param context table Druid context. Usually it is self of script
---@param style table Druid style module
---@param instance_class table The component instance class

View File

@ -12,7 +12,7 @@ local M = {}
---Create a new Druid instance for creating GUI components.
---@param context table The Druid context. Usually, this is the self of the gui_script. It is passed into all Druid callbacks.
---@param style table|nil The Druid style table to override style parameters for this Druid instance.
---@return druid_instance druid_instance The new Druid instance
---@return druid.instance druid_instance The new Druid instance
function M.new(context, style)
if settings.default_style == nil then
M.set_default_style(default_style)

View File

@ -17,7 +17,7 @@ local event = require("event.event")
---@class druid.container: druid.base_component
---@field node node
---@field druid druid_instance
---@field druid druid.instance
---@field node_offset vector4
---@field origin_size vector3
---@field size vector3

View File

@ -1,5 +1,5 @@
---@class druid.widget: druid.base_component
---@field druid druid_instance Ready to use druid instance
---@field druid druid.instance Ready to use druid instance
---@field root node
---@class GUITextMetrics

View File

@ -6,7 +6,7 @@ local helper = require("druid.helper")
local settings = require("druid.system.settings")
local base_component = require("druid.component")
---@class druid_instance
---@class druid.instance
---@field components_all druid.base_component[] All created components
---@field components_interest table<string, druid.base_component[]> All components sorted by interest
---@field url url
@ -80,7 +80,7 @@ end
local WIDGET_METATABLE = { __index = base_component }
---Create the Druid component instance
---@param self druid_instance
---@param self druid.instance
---@param widget_class druid.base_component
local function create_widget(self, widget_class)
local instance = setmetatable({}, {
@ -124,7 +124,7 @@ end
---Before processing any input check if we need to update input stack
---@param self druid_instance
---@param self druid.instance
---@param components table[]
local function check_sort_input_stack(self, components)
if not components or #components == 0 then
@ -421,7 +421,7 @@ end
---If whitelist is not empty and component not contains in this list,
---component will be not processed on input step
---@param whitelist_components table|druid.base_component[] The array of component to whitelist
---@return druid_instance
---@return druid.instance
function M:set_whitelist(whitelist_components)
if whitelist_components and whitelist_components._component then
whitelist_components = { whitelist_components }
@ -441,7 +441,7 @@ end
---If blacklist is not empty and component contains in this list,
---component will be not processed on input step DruidInstance
---@param blacklist_components table|druid.base_component[] The array of component to blacklist
---@return druid_instance
---@return druid.instance
function M:set_blacklist(blacklist_components)
if blacklist_components and blacklist_components._component then
blacklist_components = { blacklist_components }

View File

@ -6,7 +6,7 @@ local color = require("druid.color")
---@field text_name druid.text
---@field button druid.button
---@field text_button druid.text
---@field druid druid_instance
---@field druid druid.instance
local M = {}
function M:init()

View File

@ -2,7 +2,7 @@ local event = require("event.event")
---@class widget.property_checkbox: druid.widget
---@field root node
---@field druid druid_instance
---@field druid druid.instance
---@field text_name druid.text
---@field button druid.button
---@field selected node

View File

@ -3,7 +3,7 @@
---@field container druid.container
---@field text_name druid.text
---@field button druid.button
---@field druid druid_instance
---@field druid druid.instance
local M = {}
function M:init()

View File

@ -2,7 +2,7 @@ local event = require("event.event")
---@class widget.property_left_right_selector: druid.widget
---@field root node
---@field druid druid_instance
---@field druid druid.instance
---@field text_name druid.text
---@field button druid.button
---@field selected node

View File

@ -4,7 +4,7 @@ local helper = require("druid.helper")
---@class widget.property_slider: druid.widget
---@field root node
---@field container druid.container
---@field druid druid_instance
---@field druid druid.instance
---@field text_name druid.text
---@field text_value druid.text
---@field slider druid.slider

View File

@ -6,7 +6,7 @@ local event = require("event.event")
---@field container druid.container
---@field text_name druid.text
---@field button druid.button
---@field druid druid_instance
---@field druid druid.instance
local M = {}
function M:init()

View File

@ -6,7 +6,7 @@ local druid_logo_panthera = require("example.components.druid_logo.druid_logo_pa
---@class druid_logo: druid.base_component
---@field root druid.container
---@field text_description druid.text
---@field druid druid_instance
---@field druid druid.instance
local DruidLogo = component.create("druid_logo")

View File

@ -4,7 +4,7 @@ local component = require("druid.component")
---@field root druid.container
---@field text_debug_info druid.text
---@field text_gui_path druid.text
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("example_scene")

View File

@ -6,7 +6,7 @@ local examples_list_view_item = require("example.components.examples_list_view.e
---@class examples_list_view: druid.base_component
---@field root druid.container
---@field druid druid_instance
---@field druid druid.instance
---@field scroll druid.scroll
---@field grid druid.grid
local M = component.create("examples_list_view")

View File

@ -3,7 +3,7 @@ local component = require("druid.component")
---@class examples_list_view_item: druid.base_component
---@field root druid.container
---@field text druid.lang_text
---@field druid druid_instance
---@field druid druid.instance
---@field on_click event
local M = component.create("examples_list_view_item")

View File

@ -4,7 +4,7 @@ local component = require("druid.component")
---@field root druid.container
---@field text_header druid.text
---@field scroll druid.scroll
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("output_list")
---@param template string

View File

@ -5,7 +5,7 @@ local component = require("druid.component")
---@class panel_druid_profiler: druid.base_component
---@field root druid.container
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("panel_druid_profiler")
local FPS_SAMPLES = 60

View File

@ -5,7 +5,7 @@ local component = require("druid.component")
---@field root druid.container
---@field text_header druid.lang_text
---@field rich_text druid.rich_text
---@field druid druid_instance
---@field druid druid.instance
local PanelInformation = component.create("panel_information")
---@param template string

View File

@ -5,7 +5,7 @@ local component = require("druid.component")
---@field text_name druid.lang_text
---@field button druid.button
---@field text_button druid.text
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("property_button")
---@param template string

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class property_checkbox: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field root druid.container
---@field text_name druid.lang_text
---@field button druid.button

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class property_slider: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field root druid.container
---@field text_name druid.lang_text
---@field text_value druid.text

View File

@ -8,7 +8,7 @@ local property_button = require("example.components.properties_panel.properties.
---@field root druid.container
---@field text_no_properties druid.lang_text
---@field scroll druid.scroll
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("properties_panel")
---@param template string

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class basic_back_handler: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("basic_back_handler")

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class basic_blocker: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field root node
---@field blocker druid.blocker
local M = component.create("basic_blocker")

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class basic_button: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field button druid.button
local M = component.create("basic_button")

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class basic_button_double_click: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field button druid.button
local M = component.create("basic_button_double_click")

View File

@ -4,7 +4,7 @@ local panthera = require("panthera.panthera")
local animation = require("example.examples.basic.button.basic_button_hold_panthera")
---@class basic_button_hold: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field button druid.button
local M = component.create("basic_button_hold")

View File

@ -2,7 +2,7 @@ local component = require("druid.component")
local event = require("event.event")
---@class checkbox: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field button druid.button
local M = component.create("checkbox")

View File

@ -5,7 +5,7 @@ local component = require("druid.component")
local checkbox = require("example.examples.basic.checkbox.checkbox")
---@class checkbox_group: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field button druid.button
local M = component.create("checkbox_group")

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class drag: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("drag")

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class drag_to_node: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("drag_to_node")

View File

@ -3,7 +3,7 @@ local component = require("druid.component")
---@class grid: druid.base_component
---@field grid druid.grid
---@field text druid.text
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("grid")

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class basic_hotkey: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field root node
---@field text druid.text
local M = component.create("basic_hotkey")

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class hover: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field hover druid.hover
---@field hover_pressed druid.hover
local M = component.create("hover")

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class basic_input: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field input druid.input
local M = component.create("basic_input")

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class input_password: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field root node
local M = component.create("input_password")

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class rich_input: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field rich_input druid.rich_input
local M = component.create("rich_input")

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class basic_progress_bar: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field progress druid.progress
local M = component.create("basic_progress_bar")

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class basic_progress_bar_slice9: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field progress druid.progress
local M = component.create("basic_progress_bar_slice9")

View File

@ -5,7 +5,7 @@ local event = require("event.event")
local checkbox = require("example.examples.basic.checkbox.checkbox")
---@class radio_group: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field button druid.button
local M = component.create("radio_group")

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class basic_rich_text: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field rich_text druid.rich_text
local M = component.create("basic_rich_text")

View File

@ -2,7 +2,7 @@ local component = require("druid.component")
local helper = require("druid.helper")
---@class rich_text_tags: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field rich_text druid.rich_text
local M = component.create("rich_text_tags")

View File

@ -3,7 +3,7 @@ local helper = require("druid.helper")
local event = require("event.event")
---@class rich_text_tags_custom: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field rich_text druid.rich_text
local M = component.create("rich_text_tags_custom")

View File

@ -3,7 +3,7 @@ local component = require("druid.component")
---@class scroll: druid.base_component
---@field root node
---@field scroll druid.scroll
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("scroll")
---@param template string

View File

@ -4,7 +4,7 @@ local component = require("druid.component")
---@field scroll druid.scroll
---@field grid druid.grid
---@field text druid.text
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("scroll_bind_grid")

View File

@ -4,7 +4,7 @@ local component = require("druid.component")
---@field scroll druid.scroll
---@field grid druid.grid
---@field text druid.text
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("scroll_bind_grid_horizontal")

View File

@ -4,7 +4,7 @@ local component = require("druid.component")
---@field scroll druid.scroll
---@field grid druid.grid
---@field text druid.text
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("scroll_bind_grid_points")

View File

@ -4,7 +4,7 @@ local component = require("druid.component")
---@field root node
---@field scroll druid.scroll
---@field slider druid.slider
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("scroll_slider")
---@param template string

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class basic_slider: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field root node
---@field slider druid.slider
local M = component.create("basic_slider")

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class basic_slider_stepped: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field root node
---@field slider druid.slider
local M = component.create("basic_slider_stepped")

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class basic_slider_vertical: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field root node
---@field slider druid.slider
local M = component.create("basic_slider_vertical")

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class basic_swipe: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("basic_swipe")
---@param template string

View File

@ -2,7 +2,7 @@ local helper = require("druid.helper")
local component = require("druid.component")
---@class basic_text: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field text druid.text
local M = component.create("basic_text")

View File

@ -3,7 +3,7 @@ local component = require("druid.component")
---@class multiline_text: druid.base_component
---@field root node
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("multiline_text")
---@param template string

View File

@ -3,7 +3,7 @@ local event = require("event.event")
local component = require("druid.component")
---@class basic_timer: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field root node
---@field text druid.text
local M = component.create("basic_timer")

View File

@ -2,7 +2,7 @@ local event = require("event.event")
local component = require("druid.component")
---@class data_list_add_remove_clear: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field data_list druid.data_list
local M = component.create("data_list_add_remove_clear")

View File

@ -2,7 +2,7 @@ local event = require("event.event")
local component = require("druid.component")
---@class data_list_basic: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("data_list_basic")

View File

@ -1,7 +1,7 @@
local component = require("druid.component")
---@class data_list_horizontal_basic: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("data_list_horizontal_basic")

View File

@ -2,7 +2,7 @@ local component = require("druid.component")
---@class button_component: druid.base_component
---@field root node
---@field druid druid_instance
---@field druid druid.instance
---@field text druid.text
---@field data any
local M = component.create("button_component")

View File

@ -4,7 +4,7 @@ local component = require("druid.component")
local button_component = require("example.examples.data_list.cache_with_component.button_component")
---@class data_list_cache_with_component: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("data_list_cache_with_component")

View File

@ -6,7 +6,7 @@ local component = require("druid.component")
---@field buttons_system druid.button
---@field button_left_bump druid.button
---@field button_right_bump druid.button
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("gamepad_tester")
local STICK_DISTANCE = 50

View File

@ -2,7 +2,7 @@ local component = require("druid.component")
local on_screen_input = require("example.examples.gamepad.on_screen_control.on_screen_input")
---@class on_screen_control: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field on_screen_input on_screen_input
local M = component.create("on_screen_control")

View File

@ -4,7 +4,7 @@ local helper = require("druid.helper")
local component = require("druid.component")
---@class on_screen_input: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field on_action event @()
---@field on_movement event @(x: number, y: number, dt: number) X/Y values are in range -1..1
---@field on_movement_stop event @()

View File

@ -3,7 +3,7 @@ local component = require("druid.component")
local layout = require("druid.extended.layout")
---@class basic_layout: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field root node
local M = component.create("basic_layout")

View File

@ -7,7 +7,7 @@ local character_animation_blend = require("example.examples.panthera.animation_b
---@class animation_blend: druid.base_component
---@field root node
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("animation_blend")

View File

@ -4,7 +4,7 @@ local component = require("druid.component")
local basic_animation_panthera = require("example.examples.panthera.basic_animation.basic_animation_panthera")
---@class basic_animation: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("basic_animation")

View File

@ -3,7 +3,7 @@ local druid_const = require("druid.const")
local component = require("druid.component")
---@class hover_hint: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field root node
---@field panel_hint node
---@field text_hint druid.text

View File

@ -3,7 +3,7 @@ local hover_hint = require("example.examples.widgets.hover_hint.hover_hint")
local component = require("druid.component")
---@class hover_hint_example: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("hover_hint_example")

View File

@ -4,7 +4,7 @@ local panthera = require("panthera.panthera")
local window_animation_panthera = require("example.examples.windows.window_animation_panthera")
---@class window_confirmation: druid.base_component
---@field druid druid_instance
---@field druid druid.instance
---@field text_header druid.lang_text
---@field text_button_accept druid.lang_text
---@field text_button_decline druid.lang_text

View File

@ -8,7 +8,7 @@ local window_animation_panthera = require("example.examples.windows.window_anima
---@field text_button_accept druid.lang_text
---@field text_description druid.lang_text
---@field button_close druid.button
---@field druid druid_instance
---@field druid druid.instance
local M = component.create("window_info")

View File

@ -9,7 +9,7 @@ local window_animation_panthera = require("example.examples.windows.window_anima
---@class window_language: druid.base_component
---@field text_header druid.text
---@field button_close druid.button
---@field druid druid_instance
---@field druid druid.instance
---@field lang_buttons table<string, druid.button>
---@field grid druid.grid
---@field on_language_change event