Annotations update [3]

druid/base/button.lua

@@ -478,7 +478,7 @@ end
 --
 -- This functions calls automatically if you don't disable it in game.project: druid.no_stencil_check
 -- @tparam Button self @{Button}
--- @tparam node zone Gui node
+-- @tparam node|nil zone Gui node
 -- @treturn Button Current button instance
 -- @usage
 -- button:set_click_zone("stencil_node")

druid/base/scroll.lua

@@ -359,7 +359,7 @@ end
 --- Set extra size for scroll stretching.
 -- Set 0 to disable stretching effect
 -- @tparam Scroll self @{Scroll}
--- @tparam[opt=0] number stretch_size Size in pixels of additional scroll area
+-- @tparam number|nil stretch_size Size in pixels of additional scroll area
 -- @treturn druid.scroll Current scroll instance
 function Scroll.set_extra_stretch_size(self, stretch_size)
 	self.style.EXTRA_STRETCH_SIZE = stretch_size or 0

druid/base/static_grid.lua

@@ -213,10 +213,10 @@ end
 
 --- Add new item to the grid
 -- @tparam StaticGrid self @{StaticGrid}
--- @tparam node item Gui node
+-- @tparam node item GUI node
 -- @tparam number|nil index The item position. By default add as last item
--- @tparam[opt=SHIFT.RIGHT] number shift_policy How shift nodes, if required. See const.SHIFT
--- @tparam[opt=false] boolean is_instant If true, update node positions instantly
+-- @tparam number|nil shift_policy How shift nodes, if required. Default: const.SHIFT.RIGHT
+-- @tparam boolean|nil is_instant If true, update node positions instantly
 function StaticGrid.add(self, item, index, shift_policy, is_instant)
 	index = index or ((self.last_index or 0) + 1)
 
@@ -239,8 +239,8 @@ end
 --- Remove the item from the grid. Note that gui node will be not deleted
 -- @tparam StaticGrid self @{StaticGrid}
 -- @tparam number index The grid node index to remove
--- @tparam[opt=SHIFT.RIGHT] number shift_policy How shift nodes, if required. See const.SHIFT
--- @tparam[opt=false] boolean is_instant If true, update node positions instantly
+-- @tparam number|nil shift_policy How shift nodes, if required. Default: const.SHIFT.RIGHT
+-- @tparam boolean|nil is_instant If true, update node positions instantly
 -- @treturn node The deleted gui node from grid
 function StaticGrid.remove(self, index, shift_policy, is_instant)
 	assert(self.nodes[index], "No grid item at given index " .. index)

druid/component.lua

@@ -347,7 +347,7 @@ end
 -- by `BaseComponent.create`
 -- @tparam BaseComponent self @{BaseComponent}
 -- @tparam string name BaseComponent name
--- @tparam[opt=DEFAULT] number input_priority The input priority. The bigger number processed first
+-- @tparam number|nil input_priority The input priority. The bigger number processed first
 -- @local
 function BaseComponent.initialize(self, name, input_priority)
 	self._component = {
@@ -483,7 +483,7 @@ end
 --- Create new component. It will inheritance from basic Druid component.
 -- @function BaseComponent.create
 -- @tparam string name BaseComponent name
--- @tparam[opt=DEFAULT] number input_priority The input priority. The bigger number processed first
+-- @tparam number|nil input_priority The input priority. The bigger number processed first
 -- @local
 function BaseComponent.create(name, input_priority)
 	-- Yea, inheritance here

druid/const.lua

@@ -7,18 +7,18 @@
 
 local M = {}
 
-M.ACTION_TEXT = hash(sys.get_config("druid.input_text", "text"))
-M.ACTION_TOUCH = hash(sys.get_config("druid.input_touch", "touch"))
-M.ACTION_MARKED_TEXT = hash(sys.get_config("druid.input_marked_text", "marked_text"))
-M.ACTION_ESC = hash(sys.get_config("druid.input_key_esc", "key_esc"))
-M.ACTION_BACK = hash(sys.get_config("druid.input_key_back", "key_back"))
-M.ACTION_ENTER = hash(sys.get_config("druid.input_key_enter", "key_enter"))
-M.ACTION_MULTITOUCH = hash(sys.get_config("druid.input_multitouch", "touch_multi"))
-M.ACTION_BACKSPACE = hash(sys.get_config("druid.input_key_backspace", "key_backspace"))
-M.ACTION_SCROLL_UP = hash(sys.get_config("druid.input_scroll_up", "mouse_wheel_up"))
-M.ACTION_SCROLL_DOWN = hash(sys.get_config("druid.input_scroll_down", "mouse_wheel_down"))
+M.ACTION_TEXT = hash(sys.get_config_string("druid.input_text", "text"))
+M.ACTION_TOUCH = hash(sys.get_config_string("druid.input_touch", "touch"))
+M.ACTION_MARKED_TEXT = hash(sys.get_config_string("druid.input_marked_text", "marked_text"))
+M.ACTION_ESC = hash(sys.get_config_string("druid.input_key_esc", "key_esc"))
+M.ACTION_BACK = hash(sys.get_config_string("druid.input_key_back", "key_back"))
+M.ACTION_ENTER = hash(sys.get_config_string("druid.input_key_enter", "key_enter"))
+M.ACTION_MULTITOUCH = hash(sys.get_config_string("druid.input_multitouch", "touch_multi"))
+M.ACTION_BACKSPACE = hash(sys.get_config_string("druid.input_key_backspace", "key_backspace"))
+M.ACTION_SCROLL_UP = hash(sys.get_config_string("druid.input_scroll_up", "mouse_wheel_up"))
+M.ACTION_SCROLL_DOWN = hash(sys.get_config_string("druid.input_scroll_down", "mouse_wheel_down"))
 
-M.IS_STENCIL_CHECK = not (sys.get_config("druid.no_stencil_check") == "1")
+M.IS_STENCIL_CHECK = not (sys.get_config_string("druid.no_stencil_check") == "1")
 
 
 M.ON_INPUT = "on_input"

druid/extended/lang_text.lua

@@ -23,6 +23,9 @@
 --- The text component
 -- @tfield Text text @{Text}
 
+--- Text node
+-- @tfield node node
+
 ---
 
 local Event = require("druid.event")

druid/extended/timer.lua

@@ -48,7 +48,7 @@ end
 -- @tparam Timer self @{Timer}
 -- @tparam node node Gui text node
 -- @tparam number seconds_from Start timer value in seconds
--- @tparam[opt=0] number seconds_to End timer value in seconds
+-- @tparam number|nil seconds_to End timer value in seconds
 -- @tparam function|nil callback Function on timer end
 function Timer.init(self, node, seconds_from, seconds_to, callback)
 	self.node = self:get_node(node)

druid/helper.lua

@@ -63,7 +63,7 @@ end
 -- @function helper.centrate_icon_with_text
 -- @tparam box|nil icon_node Gui box node
 -- @tparam text|nil text_node Gui text node
--- @tparam[opt=0] number margin Offset between nodes
+-- @tparam number|nil margin Offset between nodes
 -- @local
 function M.centrate_icon_with_text(icon_node, text_node, margin)
 	return M.centrate_nodes(margin, icon_node, text_node)
@@ -75,7 +75,7 @@ end
 -- This functions calculate total width of nodes and set position for each node.
 -- The centrate will be around 0 x position.
 -- @function helper.centrate_nodes
--- @tparam[opt=0] number margin Offset between nodes
+-- @tparam number|nil margin Offset between nodes
 -- @param ... Gui nodes
 function M.centrate_nodes(margin, ...)
 	margin = margin or 0
@@ -200,7 +200,7 @@ end
 --- Round number to specified decimal places
 -- @function helper.round
 -- @tparam number num Number
--- @tparam[opt=0] number num_decimal_places Decimal places
+-- @tparam number|nil num_decimal_places Decimal places
 -- @treturn number Rounded number
 function M.round(num, num_decimal_places)
 	local mult = 10^(num_decimal_places or 0)

druid/system/druid_instance.lua

@@ -261,6 +261,7 @@ end
 -- @tparam DruidInstance self
 -- @tparam BaseComponent component Component module
 -- @tparam any ... Other component params to pass it to component:init function
+-- @treturn BaseComponent Component instance
 function DruidInstance.new(self, component, ...)
 	local instance = create(self, component)
 
@@ -559,7 +560,7 @@ end
 --- Create @{Button} component
 -- @tparam DruidInstance self
 -- @tparam string|node node The node_id or gui.get_node(node_id)
--- @tparam function callback Button callback
+-- @tparam function|nil callback Button callback
 -- @tparam table|nil params Button callback params
 -- @tparam node|nil anim_node Button anim node (node, if not provided)
 -- @treturn Button @{Button} component
@@ -579,7 +580,7 @@ end
 
 --- Create @{BackHandler} component
 -- @tparam DruidInstance self
--- @tparam function callback @The callback(self, custom_args) to call on back event
+-- @tparam function|nil callback @The callback(self, custom_args) to call on back event
 -- @tparam any|nil params Callback argument
 -- @treturn BackHandler @{BackHandler} component
 function DruidInstance.new_back_handler(self, callback, params)
@@ -590,7 +591,7 @@ end
 --- Create @{Hover} component
 -- @tparam DruidInstance self
 -- @tparam string|node node The node_id or gui.get_node(node_id)
--- @tparam function on_hover_callback Hover callback
+-- @tparam function|nil on_hover_callback Hover callback
 -- @treturn Hover @{Hover} component
 function DruidInstance.new_hover(self, node, on_hover_callback)
 	return DruidInstance.new(self, hover, node, on_hover_callback)
@@ -612,24 +613,24 @@ end
 -- Deprecated
 -- @tparam DruidInstance self
 -- @tparam string|node parent_node The node_id or gui.get_node(node_id). Parent of all Grid items.
--- @tparam node element Element prefab. Need to get it size
--- @tparam[opt=1] number in_row How many nodes in row can be placed
+-- @tparam node item Element prefab. Required to get grid's item size. Can be adjusted separately.
+-- @tparam number|nil in_row How many nodes in row can be placed
 -- @treturn StaticGrid @{StaticGrid} component
 -- @local
-function DruidInstance.new_grid(self, parent_node, element, in_row)
+function DruidInstance.new_grid(self, parent_node, item, in_row)
 	helper.deprecated("The druid:new_grid is deprecated. Please use druid:new_static_grid instead")
-	return DruidInstance.new(self, static_grid, parent_node, element, in_row)
+	return DruidInstance.new(self, static_grid, parent_node, item, in_row)
 end
 
 
 --- Create @{StaticGrid} component
 -- @tparam DruidInstance self
 -- @tparam string|node parent_node The node_id or gui.get_node(node_id). Parent of all Grid items.
--- @tparam node element Element prefab. Need to get it size
--- @tparam[opt=1] number in_row How many nodes in row can be placed
+-- @tparam string|node item Item prefab. Required to get grid's item size. Can be adjusted separately.
+-- @tparam number|nil in_row How many nodes in row can be placed
 -- @treturn StaticGrid @{StaticGrid} component
-function DruidInstance.new_static_grid(self, parent_node, element, in_row)
-	return DruidInstance.new(self, static_grid, parent_node, element, in_row)
+function DruidInstance.new_static_grid(self, parent_node, item, in_row)
+	return DruidInstance.new(self, static_grid, parent_node, item, in_row)
 end
 
 
@@ -646,7 +647,7 @@ end
 --- Create @{Drag} component
 -- @tparam DruidInstance self
 -- @tparam string|node node The node_id or gui.get_node(node_id). Will used as user input node.
--- @tparam function on_drag_callback Callback for on_drag_event(self, dx, dy)
+-- @tparam function|nil on_drag_callback Callback for on_drag_event(self, dx, dy)
 -- @treturn Drag @{Drag} component
 function DruidInstance.new_drag(self, node, on_drag_callback)
 	return DruidInstance.new(self, drag, node, on_drag_callback)
@@ -656,7 +657,7 @@ end
 --- Create @{Swipe} component
 -- @tparam DruidInstance self
 -- @tparam string|node node The node_id or gui.get_node(node_id). Will used as user input node.
--- @tparam function on_swipe_callback Swipe callback for on_swipe_end event
+-- @tparam function|nil on_swipe_callback Swipe callback for on_swipe_end event
 -- @treturn Swipe @{Swipe} component
 function DruidInstance.new_swipe(self, node, on_swipe_callback)
 	return helper.require_component_message("swipe")
@@ -697,9 +698,9 @@ end
 --- Create @{Checkbox} component
 -- @tparam DruidInstance self
 -- @tparam string|node node The_node id or gui.get_node(node_id).
--- @tparam function callback Checkbox callback
--- @tparam[opt=node] node click_node Trigger node, by default equals to node
--- @tparam[opt=false] boolean initial_state The initial state of checkbox, default - false
+-- @tparam function|nil callback Checkbox callback
+-- @tparam node|nil click_node Trigger node, Default: node
+-- @tparam boolean|nil initial_state The initial state of checkbox, Default: false
 -- @treturn Checkbox @{Checkbox} component
 function DruidInstance.new_checkbox(self, node, callback, click_node, initial_state)
 	return helper.require_component_message("checkbox")
@@ -754,7 +755,7 @@ end
 -- @tparam DruidInstance self
 -- @tparam string|node node Gui text node
 -- @tparam number seconds_from Start timer value in seconds
--- @tparam[opt=0] number seconds_to End timer value in seconds
+-- @tparam number|nil seconds_to End timer value in seconds
 -- @tparam function|nil callback Function on timer end
 -- @treturn Timer @{Timer} component
 function DruidInstance.new_timer(self, node, seconds_from, seconds_to, callback)
@@ -766,7 +767,7 @@ end
 -- @tparam DruidInstance self
 -- @tparam string|node node Progress bar fill node or node name
 -- @tparam string key Progress bar direction: const.SIDE.X or const.SIDE.Y
--- @tparam[opt=1] number init_value Initial value of progress bar
+-- @tparam number|nil init_value Initial value of progress bar. Default: 1
 -- @treturn Progress @{Progress} component
 function DruidInstance.new_progress(self, node, key, init_value)
 	return helper.require_component_message("progress")