Update annotations

README.md

@@ -185,7 +185,7 @@ For a complete overview, see: **_[components.md](docs_md/01-components.md)_**.
 
 ## Druid Events
 
-Any **Druid** components as callbacks use [Druid Events](https://insality.github.io/druid/modules/DruidEvent.html). In component API ([button example](https://insality.github.io/druid/modules/Button.html#on_click)) pointed list of component events. You can manually subscribe to these events with the following API:
+Any **Druid** components as callbacks use [Druid Events](https://insality.github.io/druid/modules/druid.event.html). In component API ([button example](https://insality.github.io/druid/modules/Button.html#on_click)) pointed list of component events. You can manually subscribe to these events with the following API:
 
 - **event:subscribe**(callback)
 

druid/base/button.lua

@@ -35,16 +35,16 @@
 -- @alias druid.button
 
 
---- The DruidEvent: Event on successful release action over button.
+--- The druid.event: Event on successful release action over button.
 -- @usage
 -- -- Custom args passed in Button constructor
 -- button.on_click:subscribe(function(self, custom_args, button_instance)
 --     print("On button click!")
 -- end)
--- @tfield DruidEvent on_click DruidEvent
+-- @tfield druid.event on_click druid.event
 
 
---- The DruidEvent: Event on repeated action over button.
+--- The druid.event: 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
@@ -52,10 +52,10 @@
 -- button.on_repeated_click:subscribe(function(self, custom_args, button_instance, click_count)
 --     print("On repeated Button click!")
 -- end)
--- @tfield DruidEvent on_repeated_click DruidEvent
+-- @tfield druid.event on_repeated_click druid.event
 
 
---- The DruidEvent: Event on long tap action over button.
+--- The druid.event: 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
@@ -64,10 +64,10 @@
 -- button.on_long_click:subscribe(function(self, custom_args, button_instance, hold_time)
 --     print("On long Button click!")
 -- end)
--- @tfield DruidEvent on_long_click DruidEvent
+-- @tfield druid.event on_long_click druid.event
 
 
---- The DruidEvent: Event on double tap action over button.
+--- The druid.event: 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)
@@ -76,10 +76,10 @@
 -- button.on_double_click:subscribe(function(self, custom_args, button_instance, click_amount)
 --     print("On double Button click!")
 -- end)
--- @tfield DruidEvent on_double_click DruidEvent
+-- @tfield druid.event on_double_click druid.event
 
 
---- The DruidEvent: Event calls every frame before on_long_click event.
+--- The druid.event: 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.
 --
@@ -89,10 +89,10 @@
 -- button.on_double_click:subscribe(function(self, custom_args, button_instance, time)
 --     print("On hold Button callback!")
 -- end)
--- @tfield DruidEvent on_hold_callback DruidEvent
+-- @tfield druid.event on_hold_callback druid.event
 
 
---- The DruidEvent: Event calls if click event was outside of button.
+--- The druid.event: 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
 --
@@ -102,16 +102,16 @@
 -- button.on_click_outside:subscribe(function(self, custom_args, button_instance)
 --     print("On click Button outside!")
 -- end)
--- @tfield DruidEvent on_click_outside DruidEvent
+-- @tfield druid.event on_click_outside druid.event
 
 
---- The DruidEvent: Event triggered if button was pressed by user.
+--- The druid.event: 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)
 --     print("On Button pressed!")
 -- end)
--- @tfield DruidEvent on_pressed DruidEvent
+-- @tfield druid.event on_pressed druid.event
 
 --- Button trigger node
 -- @tfield node node
@@ -279,17 +279,19 @@ end
 
 
 --- Component style params.
--- You can override this component styles params in Druid styles table
+---You can override this component styles params in Druid styles table
--- or create your own style
+---or create your own style
--- @table style
+---@class druid.button.style
--- @tfield number|nil LONGTAP_TIME Minimum time to trigger on_hold_callback. Default: 0.4
+---@field LONGTAP_TIME number|nil Minimum time to trigger on_hold_callback. Default: 0.4
--- @tfield number|nil AUTOHOLD_TRIGGER Maximum hold time to trigger button release while holding. Default: 0.8
+---@field AUTOHOLD_TRIGGER number|nil Maximum hold time to trigger button release while holding. Default: 0.8
--- @tfield number|nil DOUBLETAP_TIME Time between double taps. Default: 0.4
+---@field DOUBLETAP_TIME number|nil Time between double taps. Default: 0.4
--- @tfield function on_click function(self, node)
+---@field on_click fun(self, node)|nil
--- @tfield function on_click_disabled function(self, node)
+---@field on_click_disabled fun(self, node)|nil
--- @tfield function on_hover function(self, node, hover_state)
+---@field on_hover fun(self, node, hover_state)|nil
--- @tfield function on_mouse_hover function(self, node, hover_state)
+---@field on_mouse_hover fun(self, node, hover_state)|nil
--- @tfield function on_set_enabled function(self, node, enabled_state)
+---@field on_set_enabled fun(self, node, enabled_state)|nil
+
+---@param style druid.button.style
 function M:on_style_change(style)
 	self.style = {}
 	self.style.LONGTAP_TIME = style.LONGTAP_TIME or 0.4
@@ -469,12 +471,8 @@ end
 --- Set button enabled state.
 -- The style.on_set_enabled will be triggered.
 -- Disabled button is not clickable.
--- @tparam Button self Button
 -- @tparam boolean|nil state Enabled state
--- @treturn Button Current button instance
+---@return druid.button self
--- @usage
--- button:set_enabled(false)
--- button:set_enabled(true)
 function M:set_enabled(state)
 	self.disabled = not state
 	self.hover:set_enabled(state)
@@ -487,10 +485,7 @@ end
 --- Get button enabled state.
 --
 -- By default all Buttons is enabled on creating.
--- @tparam Button self Button
+---@return boolean @True, if button is enabled now, False overwise
--- @treturn boolean @True, if button is enabled now, False overwise
--- @usage
--- local is_enabled = button:is_enabled()
 function M:is_enabled()
 	return not self.disabled
 end
@@ -500,11 +495,8 @@ end
 -- Useful to restrict click outside out stencil node or scrollable content.
 --
 -- This functions calls automatically if you don't disable it in game.project: druid.no_stencil_check
--- @tparam Button self Button
 -- @tparam node|string|nil zone Gui node
--- @treturn Button Current button instance
+---@return druid.button self
--- @usage
--- button:set_click_zone("stencil_node")
 function M:set_click_zone(zone)
 	self.click_zone = self:get_node(zone)
 	self.hover:set_click_zone(zone)
@@ -513,12 +505,9 @@ function M:set_click_zone(zone)
 end
 
 
---- Set key name to trigger this button by keyboard.
+---Set key name to trigger this button by keyboard.
--- @tparam Button self Button
+---@param key hash|string The action_id of the input key. Example: "key_space"
--- @tparam hash|string key The action_id of the input key
+---@return druid.button self
--- @treturn Button Current button instance
--- @usage
--- button:set_key_trigger("key_space")
 function M:set_key_trigger(key)
 	self.key_trigger = hash(key)
 
@@ -527,20 +516,16 @@ end
 
 
 --- Get current key name to trigger this button.
--- @tparam Button self
+---@return hash key_trigger The action_id of the input key
--- @treturn hash The action_id of the input key
--- @usage
--- local key_hash = button:get_key_trigger()
 function M:get_key_trigger()
 	return self.key_trigger
 end
 
 
 --- Set function for additional check for button click availability
--- @tparam Button self
 -- @tparam function|nil check_function Should return true or false. If true - button can be pressed.
 -- @tparam function|nil failure_callback Function will be called on button click, if check function return false
--- @treturn Button Current button instance
+---@return druid.button self
 function M:set_check_function(check_function, failure_callback)
 	self._check_function = check_function
 	self._failure_callback = failure_callback
@@ -553,11 +538,8 @@ end
 -- The HTML5 button's doesn't call any events except on_click event.
 --
 -- If the game is not HTML, html mode will be not enabled
--- @tparam Button self
 -- @tparam boolean|nil is_web_mode If true - button will be called inside html5 callback
--- @treturn Button Current button instance
+---@return druid.button self
--- @usage
--- button:set_web_user_interaction(true)
 function M:set_web_user_interaction(is_web_mode)
 	self._is_html5_mode = not not (is_web_mode and html5)
 	return self

druid/base/drag.lua

@@ -14,19 +14,19 @@
 -- @tfield node node
 
 --- Event on touch start callback(self)
--- @tfield DruidEvent on_touch_start DruidEvent
+-- @tfield druid.event on_touch_start druid.event
 
 --- Event on touch end callback(self)
--- @tfield DruidEvent on_touch_end DruidEvent
+-- @tfield druid.event on_touch_end druid.event
 
 --- Event on drag start callback(self, touch)
--- @tfield DruidEvent on_drag_start DruidEvent
+-- @tfield druid.event on_drag_start druid.event
 
 --- on drag progress callback(self, dx, dy, total_x, total_y, touch)
--- @tfield DruidEvent on_drag Event DruidEvent
+-- @tfield druid.event on_drag Event druid.event
 
 --- Event on drag end callback(self, total_x, total_y, touch)
--- @tfield DruidEvent on_drag_end DruidEvent
+-- @tfield druid.event on_drag_end druid.event
 
 --- Is component now touching
 -- @tfield boolean is_touch

druid/base/hover.lua

@@ -9,10 +9,10 @@
 -- @tfield node node
 
 --- On hover callback(self, state, hover_instance)
--- @tfield DruidEvent on_hover DruidEvent
+-- @tfield druid.event on_hover druid.event
 
 --- On mouse hover callback(self, state, hover_instance)
--- @tfield DruidEvent on_mouse_hover DruidEvent
+-- @tfield druid.event on_mouse_hover druid.event
 
 ---
 

druid/base/scroll.lua

@@ -39,13 +39,13 @@
 
 
 --- On scroll move callback(self, position)
--- @tfield DruidEvent on_scroll DruidEvent
+-- @tfield druid.event on_scroll druid.event
 
 --- On scroll_to function callback(self, target, is_instant)
--- @tfield DruidEvent on_scroll_to DruidEvent
+-- @tfield druid.event on_scroll_to druid.event
 
 --- On scroll_to_index function callback(self, index, point)
--- @tfield DruidEvent on_point_scroll DruidEvent
+-- @tfield druid.event on_point_scroll druid.event
 
 --- Scroll view node
 -- @tfield node view_node
@@ -651,7 +651,7 @@ end
 --- Find closer point of interest
 -- if no inert, scroll to next point by scroll direction
 -- if inert, find next point by scroll director
--- @local
+---@private
 function M:_check_points()
 	if not self.points then
 		return

druid/base/static_grid.lua

@@ -37,19 +37,19 @@
 -- @alias druid.static_grid
 
 --- On item add callback(self, node, index)
--- @tfield DruidEvent on_add_item DruidEvent
+-- @tfield druid.event on_add_item druid.event
 
 --- On item remove callback(self, index)
--- @tfield DruidEvent on_remove_item DruidEvent
+-- @tfield druid.event on_remove_item druid.event
 
 --- On item add, remove or change in_row callback(self, index|nil)
--- @tfield DruidEvent on_change_items DruidEvent
+-- @tfield druid.event on_change_items druid.event
 
 --- On grid clear callback(self)
--- @tfield DruidEvent on_clear DruidEvent
+-- @tfield druid.event on_clear druid.event
 
 --- On update item positions callback(self)
--- @tfield DruidEvent on_update_positions DruidEvent
+-- @tfield druid.event on_update_positions druid.event
 
 --- Parent gui node
 -- @tfield node parent
@@ -491,7 +491,7 @@ end
 --- Update grid inner state
 -- @tparam StaticGrid self StaticGrid
 -- @tparam boolean|nil is_instant If true, node position update instantly, otherwise with set_position_function callback
--- @local
+---@private
 function M:_update(is_instant)
 	self:_update_indexes()
 	self:_update_borders()
@@ -501,7 +501,7 @@ end
 
 --- Update first and last indexes of grid nodes
 -- @tparam StaticGrid self StaticGrid
--- @local
+---@private
 function M:_update_indexes()
 	self.first_index = nil
 	self.last_index = nil
@@ -517,7 +517,7 @@ end
 
 --- Update grid content borders, recalculate min and max values
 -- @tparam StaticGrid self StaticGrid
--- @local
+---@private
 function M:_update_borders()
 	if not self.first_index then
 		self.border = vmath.vector4(0)
@@ -537,7 +537,7 @@ end
 --- Update grid nodes position
 -- @tparam StaticGrid self StaticGrid
 -- @tparam boolean|nil is_instant If true, node position update instantly, otherwise with set_position_function callback
--- @local
+---@private
 function M:_update_pos(is_instant)
 	local zero_offset = self:_get_zero_offset()
 
@@ -560,7 +560,7 @@ end
 --- Return elements offset for correct posing nodes. Correct posing at
 -- parent pivot node (0:0) with adjusting of node sizes and anchoring
 -- @treturn vector3 The offset vector
--- @local
+---@private
 function M:_get_zero_offset()
 	if not self.style.IS_DYNAMIC_NODE_POSES then
 		return const.VECTOR_ZERO
@@ -577,7 +577,7 @@ end
 
 --- Return offset x for last row in grid. Used to align this row accorting to grid's anchor
 -- @treturn number The offset x value
--- @local
+---@private
 function M:_get_zero_offset_x(row_index)
 	if not self.style.IS_DYNAMIC_NODE_POSES or not self.style.IS_ALIGN_LAST_ROW then
 		return self._zero_offset.x

druid/base/text.lua

@@ -36,13 +36,13 @@
 -- @alias druid.text
 
 --- On set text callback(self, text)
--- @tfield DruidEvent on_set_text DruidEvent
+-- @tfield druid.event on_set_text druid.event
 
 --- On adjust text size callback(self, new_scale, text_metrics)
--- @tfield DruidEvent on_update_text_scale DruidEvent
+-- @tfield druid.event on_update_text_scale druid.event
 
 --- On change pivot callback(self, pivot)
--- @tfield DruidEvent on_set_pivot DruidEvent
+-- @tfield druid.event on_set_pivot druid.event
 
 --- Text node
 -- @tfield node node

druid/custom/rich_text/module/rt.lua

@@ -2,10 +2,6 @@
 -- Author: Britzl
 -- Modified by: Insality
 
---- RT
--- @module rich_text.rt
--- @local
-
 local helper = require("druid.helper")
 local parser = require("druid.custom.rich_text.module.rt_parse")
 local utf8_lua = require("druid.system.utf8")

druid/druid.lua

@@ -29,6 +29,7 @@ end
 ---Register component just makes the druid:new_{name} function.
 ---For example, if you register a component called "my_component", you can create it using druid:new_my_component(...).
 ---This can be useful if you have your own "basic" components that you don't want to require in every file.
+---The default way to create component is `druid_instance:new(component_class, ...)`.
 ---@param name string Module name
 ---@param module table Lua table with component
 function M.register(name, module)
@@ -101,6 +102,7 @@ end
 
 
 ---Call this function when the game language changes.
+---It will notify all Druid instances to update the lang text components.
 function M.on_language_change()
 	local instances = get_druid_instances()
 

druid/event.lua

@@ -1,3 +1,4 @@
+---Event system for Druid
 ---@class druid.event
 local M = {}
 
@@ -31,7 +32,7 @@ end
 --- Check is event subscribed.
 ---@param callback fun() Callback itself
 ---@param callback_context any|nil Additional context as first param to callback call
--- @treturn boolean, number|nil @Is event subscribed, return index of callback in event as second param
+---@return boolean, number|nil Is event subscribed, return index of callback in event as second param
 function M:is_subscribed(callback, callback_context)
 	if #self == 0 then
 		return false, nil

druid/extended/data_list.lua

@@ -25,13 +25,13 @@
 -- @tfield number last_index
 
 --- Event triggered when scroll progress is changed; event(self, progress_value)
--- @tfield DruidEvent on_scroll_progress_change DruidEvent
+-- @tfield druid.event on_scroll_progress_change druid.event
 
 ---On DataList visual element created Event callback(self, index, node, instance)
--- @tfield DruidEvent on_element_add DruidEvent
+-- @tfield druid.event on_element_add druid.event
 
 ---On DataList visual element created Event callback(self, index)
--- @tfield DruidEvent on_element_remove DruidEvent
+-- @tfield druid.event on_element_remove druid.event
 
 ---
 
@@ -223,7 +223,7 @@ end
 --- Add element at passed index using cache or create new
 -- @tparam DataList self DataList
 -- @tparam number index
--- @local
+---@private
 function M:_add_at(index)
 	if self._data_visual[index] then
 		self:_remove_at(index)
@@ -257,7 +257,7 @@ end
 --- Remove element from passed index and add it to cache if applicable
 -- @tparam DataList self DataList
 -- @tparam number index
--- @local
+---@private
 function M:_remove_at(index)
 	self.grid:remove(index, const.SHIFT.NO_SHIFT)
 
@@ -287,7 +287,7 @@ end
 
 --- Refresh all elements in DataList
 -- @tparam DataList self DataList
--- @local
+---@private
 function M:_refresh()
 	self.scroll:set_size(self.grid:get_size_for(#self._data))
 

druid/extended/hotkey.lua

@@ -8,10 +8,10 @@
 -- @alias druid.hotkey
 
 --- On hotkey released callback(self, argument)
--- @tfield DruidEvent on_hotkey_pressed DruidEvent
+-- @tfield druid.event on_hotkey_pressed druid.event
 
 --- On hotkey released callback(self, argument)
--- @tfield DruidEvent on_hotkey_released DruidEvent
+-- @tfield druid.event on_hotkey_released druid.event
 
 --- Visual node
 -- @tfield node node

druid/extended/input.lua

@@ -10,25 +10,25 @@
 -- @alias druid.input
 
 --- On input field select callback(self, input_instance)
--- @tfield DruidEvent on_input_select DruidEvent
+-- @tfield druid.event on_input_select druid.event
 
 --- On input field unselect callback(self, input_text, input_instance)
--- @tfield DruidEvent on_input_unselect DruidEvent
+-- @tfield druid.event on_input_unselect druid.event
 
 --- On input field text change callback(self, input_text)
--- @tfield DruidEvent on_input_text DruidEvent
+-- @tfield druid.event on_input_text druid.event
 
 --- On input field text change to empty string callback(self, input_text)
--- @tfield DruidEvent on_input_empty DruidEvent
+-- @tfield druid.event on_input_empty druid.event
 
 --- On input field text change to max length string callback(self, input_text)
--- @tfield DruidEvent on_input_full DruidEvent
+-- @tfield druid.event on_input_full druid.event
 
 --- On trying user input with not allowed character callback(self, params, input_text)
--- @tfield DruidEvent on_input_wrong DruidEvent
+-- @tfield druid.event on_input_wrong druid.event
 
 --- On cursor position change callback(self, cursor_index, start_index, end_index)
--- @tfield DruidEvent on_select_cursor_change DruidEvent
+-- @tfield druid.event on_select_cursor_change druid.event
 
 --- The cursor index. The index of letter cursor after. Leftmost cursor - 0
 -- @tfield number cursor_index

druid/extended/lang_text.lua

@@ -18,7 +18,7 @@
 -- @alias druid.lang_text
 
 --- On change text callback
--- @tfield DruidEvent on_change DruidEvent
+-- @tfield druid.event on_change druid.event
 
 --- The text component
 -- @tfield Text text Text

druid/extended/progress.lua

@@ -20,7 +20,7 @@
 -- @alias druid.progress
 
 --- On progress bar change callback(self, new_value)
--- @tfield DruidEvent on_change DruidEvent
+-- @tfield druid.event on_change druid.event
 
 --- Progress bar fill node
 -- @tfield node node

druid/extended/slider.lua

@@ -8,7 +8,7 @@
 -- @alias druid.slider
 
 --- On change value callback(self, value)
--- @tfield DruidEvent on_change_value DruidEvent
+-- @tfield druid.event on_change_value druid.event
 
 --- Slider pin node
 -- @tfield node node

druid/extended/swipe.lua

@@ -16,7 +16,7 @@
 -- @tparam node|nil click_zone
 
 --- Trigger on swipe event(self, swipe_side, dist, delta_time)
--- @tfield DruidEvent on_swipe) DruidEvent
+-- @tfield druid.event on_swipe) druid.event
 
 ---
 

druid/helper.lua

@@ -13,7 +13,6 @@ local POSITION_X = hash("position.x")
 local SCALE_X = hash("scale.x")
 local SIZE_X = hash("size.x")
 
-
 local function get_text_width(text_node)
 	if text_node then
 		local text_metrics = M.get_text_metrics_from_node(text_node)
@@ -138,10 +137,15 @@ end
 ---@return number stretch_y
 function M.get_screen_aspect_koef()
 	local window_x, window_y = window.get_size()
+
 	local stretch_x = window_x / gui.get_width()
 	local stretch_y = window_y / gui.get_height()
-	return stretch_x / math.min(stretch_x, stretch_y),
+	local stretch_koef = math.min(stretch_x, stretch_y)
-			stretch_y / math.min(stretch_x, stretch_y)
+
+	local koef_x = window_x / (stretch_koef * sys.get_config_int("display.width"))
+	local koef_y = window_y / (stretch_koef * sys.get_config_int("display.height"))
+
+	return koef_x, koef_y
 end
 
 
@@ -534,7 +538,7 @@ end
 
 ---Show message to require component
 ---@param component_name string
----@param component_type string
+---@param component_type string|nil
 function M.require_component_message(component_name, component_type)
 	component_type = component_type or "extended"
 

druid/system/druid_instance.lua

@@ -3,7 +3,7 @@
 --
 -- Helper - A useful set of functions for working with GUI nodes, such as centering nodes, get GUI scale ratio, etc
 --
--- DruidEvent - The core event system in Druid. Learn how to subscribe to any event in every Druid component.
+-- druid.event - The core event system in Druid. Learn how to subscribe to any event in every Druid component.
 --
 -- BaseComponent - The parent class of all Druid components. You can find all default component methods there.
 --
@@ -49,7 +49,7 @@ local back_handler = require("druid.base.back_handler")
 ---@field private _late_remove druid.base_component[]
 ---@field private _input_blacklist druid.base_component[]|nil
 ---@field private _input_whitelist druid.base_component[]|nil
----@field private _input_inited boolean
+---@field private input_inited boolean
 ---@field private _late_init_timer_id number
 ---@field private _input_components druid.base_component[]
 local M = {}
@@ -69,7 +69,7 @@ end
 
 
 -- The a and b - two Druid components
--- @local
+---@private
 local function sort_input_comparator(a, b)
 	local a_priority = a:get_input_priority()
 	local b_priority = b:get_input_priority()
@@ -231,9 +231,9 @@ end
 
 
 --- Druid class constructor
----@param table context Druid context. Usually it is self of gui script
+---@param context table Druid context. Usually it is self of gui script
----@param table style Druid style table
+---@param style table Druid style table
--- @local
+---@private
 function M:initialize(context, style)
 	self._context = context
 	self._style = style or settings.default_style
@@ -291,7 +291,8 @@ end
 --- Remove created component from Druid instance.
 --
 -- Component `on_remove` function will be invoked, if exist.
----@param BaseComponent component Component instance
+---@generic T: druid.base_component
+---@param component T Component instance
 ---@return boolean True if component was removed
 function M:remove(component)
 	if self._is_late_remove_enabled then
@@ -342,7 +343,7 @@ end
 --- Druid late update function called after initialization and before the regular update step
 -- This function is used to check the GUI state and perform actions after all components and nodes have been created.
 -- An example use case is performing an auto stencil check in the GUI hierarchy for input components.
--- @local
+---@private
 function M:late_init()
 	local late_init_components = self.components_interest[base_component.ON_LATE_INIT]
 	while late_init_components[1] do
@@ -435,7 +436,7 @@ end
 
 --- Calls the on_focus_lost function in all related components
 -- This one called by on_window_callback by global window listener
--- @local
+---@private
 function M:on_focus_lost()
 	local components = self.components_interest[base_component.ON_FOCUS_LOST]
 	for i = 1, #components do
@@ -446,7 +447,7 @@ end
 
 --- Calls the on_focus_gained function in all related components
 -- This one called by on_window_callback by global window listener
--- @local
+---@private
 function M:on_focus_gained()
 	local components = self.components_interest[base_component.ON_FOCUS_GAINED]
 	for i = 1, #components do
@@ -458,7 +459,7 @@ end
 --- Calls the on_language_change function in all related components
 -- This one called by global druid.on_language_change, but can be
 -- call manualy to update all translations
--- @local
+---@private
 function M:on_language_change()
 	local components = self.components_interest[base_component.ON_LANGUAGE_CHANGE]
 	for i = 1, #components do
@@ -508,7 +509,7 @@ end
 
 
 --- Remove all components on late remove step DruidInstance
--- @local
+---@private
 function M:_clear_late_remove()
 	if #self._late_remove == 0 then
 		return
@@ -543,7 +544,7 @@ function M:new_widget(widget, template, nodes, ...)
 end
 
 
---- Create Button component
+---Create Button component
 ---@param node string|node The node_id or gui.get_node(node_id)
 ---@param callback function|nil Button callback
 ---@param params any|nil Button callback params
@@ -554,7 +555,7 @@ function M:new_button(node, callback, params, anim_node)
 end
 
 
---- Create Blocker component
+---Create Blocker component
 ---@param node string|node The node_id or gui.get_node(node_id)
 ---@return druid.blocker Blocker component
 function M:new_blocker(node)
@@ -562,7 +563,7 @@ function M:new_blocker(node)
 end
 
 
---- Create BackHandler component
+---Create BackHandler component
 ---@param callback function|nil The callback(self, custom_args) to call on back event
 ---@param params any|nil Callback argument
 ---@return druid.back_handler BackHandler component
@@ -571,7 +572,7 @@ function M:new_back_handler(callback, params)
 end
 
 
---- Create Hover component
+---Create Hover component
 ---@param node string|node The node_id or gui.get_node(node_id)
 ---@param on_hover_callback function|nil Hover callback
 ---@param on_mouse_hover_callback function|nil Mouse hover callback
@@ -581,7 +582,7 @@ function M:new_hover(node, on_hover_callback, on_mouse_hover_callback)
 end
 
 
---- Create Text component
+---Create Text component
 ---@param node string|node The node_id or gui.get_node(node_id)
 ---@param value string|nil Initial text. Default value is node text from GUI scene.
 ---@param no_adjust boolean|nil If true, text will be not auto-adjust size
@@ -591,7 +592,7 @@ function M:new_text(node, value, no_adjust)
 end
 
 
---- Create StaticGrid component
+---Create StaticGrid component
 ---@param parent_node string|node The node_id or gui.get_node(node_id). Parent of all Grid items.
 ---@param item node Element prefab. Required to get grid's item size. Can be adjusted separately.
 ---@param in_row number|nil How many nodes in row can be placed
@@ -601,7 +602,7 @@ function M:new_grid(parent_node, item, in_row)
 end
 
 
---- Create StaticGrid component
+---Create StaticGrid component
 ---@param parent_node string|node The node_id or gui.get_node(node_id). Parent of all Grid items.
 ---@param item string|node Item prefab. Required to get grid's item size. Can be adjusted separately.
 ---@param in_row number|nil How many nodes in row can be placed
@@ -611,7 +612,7 @@ function M:new_static_grid(parent_node, item, in_row)
 end
 
 
---- Create Scroll component
+---Create Scroll component
 ---@param view_node string|node The node_id or gui.get_node(node_id). Will used as user input node.
 ---@param content_node string|node The node_id or gui.get_node(node_id). Will used as scrollable node inside view_node.
 ---@return druid.scroll Scroll component
@@ -620,7 +621,7 @@ function M:new_scroll(view_node, content_node)
 end
 
 
---- Create Drag component
+---Create Drag component
 ---@param node string|node The node_id or gui.get_node(node_id). Will used as user input node.
 ---@param on_drag_callback function|nil Callback for on_drag_event(self, dx, dy)
 ---@return druid.drag Drag component
@@ -629,7 +630,7 @@ function M:new_drag(node, on_drag_callback)
 end
 
 
---- Create Swipe component
+---Create Swipe component
 ---@param node string|node The node_id or gui.get_node(node_id). Will used as user input node.
 ---@param on_swipe_callback function|nil Swipe callback for on_swipe_end event
 ---@return druid.swipe Swipe component
@@ -638,7 +639,7 @@ function M:new_swipe(node, on_swipe_callback)
 end
 
 
---- Create LangText component
+---Create LangText component
 ---@param node string|node The_node id or gui.get_node(node_id)
 ---@param locale_id string|nil Default locale id or text from node as default
 ---@param adjust_type string|nil Adjust type for text node. Default: const.TEXT_ADJUST.DOWNSCALE
@@ -647,7 +648,8 @@ function M:new_lang_text(node, locale_id, adjust_type)
 	return helper.require_component_message("lang_text") --[[@as druid.lang_text]]
 end
 
---- Create Slider component
+
+---Create Slider component
 ---@param pin_node string|node The_node id or gui.get_node(node_id).
 ---@param end_pos vector3 The end position of slider
 ---@param callback function|nil On slider change callback
@@ -656,7 +658,7 @@ function M:new_slider(pin_node, end_pos, callback)
 	return helper.require_component_message("slider") --[[@as druid.slider]]
 end
 
---- Create Input component
+---Create Input component
 ---@param click_node string|node Button node to enabled input component
 ---@param text_node string|node|druid.text Text node what will be changed on user input
 ---@param keyboard_type number|nil Gui keyboard type for input field
@@ -665,7 +667,8 @@ function M:new_input(click_node, text_node, keyboard_type)
 	return helper.require_component_message("input") --[[@as druid.input]]
 end
 
---- Create DataList component
+
+---Create DataList component
 ---@param druid_scroll druid.scroll The Scroll instance for Data List component
 ---@param druid_grid druid.grid The StaticGrid} or @{DynamicGrid instance for Data List component
 ---@param create_function function The create function callback(self, data, index, data_list). Function should return (node, [component])
@@ -674,7 +677,8 @@ function M:new_data_list(druid_scroll, druid_grid, create_function)
 	return helper.require_component_message("data_list") --[[@as druid.data_list]]
 end
 
---- Create Timer component
+
+---Create Timer component
 ---@param node string|node Gui text node
 ---@param seconds_from number Start timer value in seconds
 ---@param seconds_to number|nil End timer value in seconds
@@ -684,7 +688,9 @@ function M:new_timer(node, seconds_from, seconds_to, callback)
 	return helper.require_component_message("timer") --[[@as druid.timer]]
 end
 
---- Create Progress component
+
+
+---Create Progress component
 ---@param node string|node Progress bar fill node or node name
 ---@param key string Progress bar direction: const.SIDE.X or const.SIDE.Y
 ---@param init_value number|nil Initial value of progress bar. Default: 1
@@ -693,7 +699,8 @@ function M:new_progress(node, key, init_value)
 	return helper.require_component_message("progress") --[[@as druid.progress]]
 end
 
---- Create Layout component
+
+---Create Layout component
 ---@param node string|node The_node id or gui.get_node(node_id).
 ---@param mode string The layout mode
 ---@return druid.layout Layout component
@@ -701,7 +708,8 @@ function M:new_layout(node, mode)
 	return helper.require_component_message("layout") --[[@as druid.layout]]
 end
 
---- Create Hotkey component
+
+---Create Hotkey component
 ---@param keys_array string|string[] Keys for trigger action. Should contains one action key and any amount of modificator keys
 ---@param callback function The callback function
 ---@param callback_argument any|nil The argument to pass into the callback function
@@ -710,7 +718,8 @@ function M:new_hotkey(keys_array, callback, callback_argument)
 	return helper.require_component_message("hotkey") --[[@as druid.hotkey]]
 end
 
---- Create RichText component.
+
+---Create RichText component.
 ---@param text_node string|node The text node to make Rich Text
 ---@param value string|nil The initial text value. Default will be gui.get_text(text_node)
 ---@return druid.rich_text RichText component
@@ -718,7 +727,8 @@ function M:new_rich_text(text_node, value)
 	return helper.require_component_message("rich_text", "custom") --[[@as druid.rich_text]]
 end
 
---- Create RichInput component.
+
+---Create RichInput component.
 -- As a template please check rich_input.gui layout.
 ---@param template string The template string name
 ---@param nodes table Nodes table from gui.clone_tree
@@ -727,4 +737,5 @@ function M:new_rich_input(template, nodes)
 	return helper.require_component_message("rich_input", "custom") --[[@as druid.rich_input]]
 end
 
+
 return M

example/examples/basic/drag/drag_to_node.lua

@@ -15,7 +15,7 @@ function M:init(template, nodes)
 	gui.set_text(self.text_counter, self.counter)
 
 	-- Init drag and move the drag node on drag callback
-	self.drag = self.druid:new_drag("drag/root", self.on_drag_start)
+	self.drag = self.druid:new_drag("drag/root", self.on_drag)
 	self.drag.on_drag_end:subscribe(self.on_drag_end)
 
 	-- Save start position for animation
@@ -23,7 +23,7 @@ function M:init(template, nodes)
 end
 
 
-function M:on_drag_start(dx, dy, x, y, touch)
+function M:on_drag(dx, dy, x, y, touch)
 	local position_x = gui.get(self.drag.node, "position.x")
 	local position_y = gui.get(self.drag.node, "position.y")
 	gui.set(self.drag.node, "position.x", position_x + dx)