diff --git a/annotations.lua b/annotations.lua index 9f7fe9d..22152a9 100644 --- a/annotations.lua +++ b/annotations.lua @@ -11,7 +11,8 @@ local druid = {} function druid.new(context, style) end --- Druid on language change. -function druid.on_language_change() end +---@param self druid_instance +function druid.on_language_change(self) end --- Callback on global language change event. function druid.on_language_change() end @@ -28,6 +29,11 @@ function druid.on_window_callback(event) end ---@param module table lua table with component function druid.register(name, module) end +--- Set blacklist components for input processing. +---@param self druid_instance +---@param blacklist_components table|Component The array of component to blacklist +function druid.set_blacklist(self, blacklist_components) end + --- Set new default style. ---@param style table Druid style module function druid.set_default_style(style) end @@ -40,6 +46,11 @@ function druid.set_sound_function(callback) end ---@param callback function Get localized text function function druid.set_text_function(callback) end +--- Set whitelist components for input processing. +---@param self druid_instance +---@param whitelist_components table|Component The array of component to whitelist +function druid.set_whitelist(self, whitelist_components) end + ---@class druid.back_handler : druid.base_component ---@field on_back druid_event On back handler callback(self, params) @@ -63,6 +74,11 @@ function druid__back_handler.on_input(self, action_id, action) end ---@field ALL field Component Interests local druid__base_component = {} +--- Return all children components, recursive +---@param self druid.base_component +---@return table Array of childrens if the Druid component instance +function druid__base_component.get_childrens(self) end + --- Get current component context ---@param self druid.base_component ---@return table BaseComponent context @@ -163,6 +179,7 @@ function druid__blocker.set_enabled(self, state) end ---@class druid.button : druid.base_component ---@field anim_node node Animation node ---@field click_zone node Restriction zone +---@field hash node_id The hash of trigger node ---@field hover druid.hover Druid hover logic component ---@field node node Trigger node ---@field on_click druid_event On release button callback(self, params, button_instance) @@ -196,6 +213,12 @@ function druid__button.init(self, node, callback, params, anim_node) end ---@return bool True, if button is enabled function druid__button.is_enabled(self) end +--- Set function for additional check for button click availability +---@param check_function function Should return true or false. If true - button can be pressed. +---@param failure_callback function Function what will be called on button click, if check function return false +---@return druid.button Current button instance +function druid__button.set_check_function(check_function, failure_callback) end + --- Strict button click area. ---@param self druid.button ---@param zone node Gui node @@ -393,7 +416,8 @@ function druid__dynamic_grid._get_side_vector(self, side, is_forward) end ---@param node node Gui node ---@param index number The node position. By default add as last node ---@param shift_policy number How shift nodes, if required. See const.SHIFT -function druid__dynamic_grid.add(self, node, index, shift_policy) end +---@param is_instance boolean If true, update node positions instantly +function druid__dynamic_grid.add(self, node, index, shift_policy, is_instance) end --- Clear grid nodes array. ---@param self druid.dynamic_grid @@ -444,8 +468,9 @@ function druid__dynamic_grid.init(self, parent) end ---@param self druid.dynamic_grid ---@param index number The grid node index to remove ---@param shift_policy number How shift nodes, if required. See const.SHIFT +---@param is_instance boolean If true, update node positions instantly ---@return Node The deleted gui node from grid -function druid__dynamic_grid.remove(self, index, shift_policy) end +function druid__dynamic_grid.remove(self, index, shift_policy, is_instance) end --- Change set position function for grid nodes. ---@param self druid.dynamic_grid @@ -780,6 +805,7 @@ function druid__scroll.set_vertical_scroll(self, state) end ---@field INERT_THRESHOLD field Scroll speed to stop inertion ---@field POINTS_DEADZONE field Speed to check points of interests in no_inertion mode ---@field SMALL_CONTENT_SCROLL field If true, content node with size less than view node size can be scrolled +---@field WHEEL_SCROLL_BY_INERTION field If true, wheel will add inertion to scroll. Direct set position otherwise. ---@field WHEEL_SCROLL_INVERTED field If true, invert direction for touchpad and mouse wheel scroll ---@field WHEEL_SCROLL_SPEED field The scroll speed via mouse wheel scroll or touchpad. Set to 0 to disable wheel scrolling local druid__scroll__style = {} @@ -829,6 +855,7 @@ function druid__slider.set_steps(self, steps) end ---@field on_remove_item druid_event On item remove callback(self, index) ---@field on_update_positions druid_event On update item positions callback(self) ---@field parent node Parent gui node +---@field style druid.static_grid.style Component style params. local druid__static_grid = {} --- Add new item to the grid @@ -836,7 +863,8 @@ local druid__static_grid = {} ---@param item node Gui node ---@param index number The item position. By default add as last item ---@param shift_policy number How shift nodes, if required. See const.SHIFT -function druid__static_grid.add(self, item, index, shift_policy) end +---@param is_instance boolean If true, update node positions instantly +function druid__static_grid.add(self, item, index, shift_policy, is_instance) end --- Clear grid nodes array. ---@param self druid.static_grid @@ -892,8 +920,9 @@ function druid__static_grid.init(self, parent, element, in_row) end ---@param self druid.static_grid ---@param index number The grid node index to remove ---@param shift_policy number How shift nodes, if required. See const.SHIFT +---@param is_instance boolean If true, update node positions instantly ---@return Node The deleted gui node from grid -function druid__static_grid.remove(self, index, shift_policy) end +function druid__static_grid.remove(self, index, shift_policy, is_instance) end --- Set grid anchor. ---@param self druid.static_grid @@ -907,6 +936,11 @@ function druid__static_grid.set_anchor(self, anchor) end function druid__static_grid.set_position_function(self, callback) end +---@class druid.static_grid.style +---@field IS_DYNAMIC_NODE_POSES field If true, always center grid content as grid pivot sets +local druid__static_grid__style = {} + + ---@class druid.swipe : druid.base_component ---@field click_zone node Restriction zone ---@field node node Swipe node @@ -934,9 +968,10 @@ local druid__swipe__style = {} ---@class druid.text : druid.base_component +---@field adjust_type number Current text size adjust settings ---@field color vector3 Current text color ----@field is_no_adjust bool Current text size adjust settings ---@field node node Text node +---@field node_id hash The node id of text node ---@field on_set_pivot druid_event On change pivot callback(self, pivot) ---@field on_set_text druid_event On set text callback(self, text) ---@field on_update_text_scale druid_event On adjust text size callback(self, new_scale) @@ -944,9 +979,16 @@ local druid__swipe__style = {} ---@field scale vector3 Current text node scale ---@field start_scale vector3 Initial text node scale ---@field start_size vector3 Initial text node size +---@field style druid.text.style Component style params. ---@field text_area vector3 Current text node available are local druid__text = {} +--- Return current text adjust type +---@param self unknown +---@param adjust_type unknown +---@return number The current text adjust type +function druid__text.get_text_adjust(self, adjust_type) end + --- Calculate text width with font with respect to trailing space ---@param self druid.text ---@param text string @@ -956,8 +998,8 @@ function druid__text.get_text_width(self, text) end ---@param self druid.text ---@param node node Gui text node ---@param value string Initial text. Default value is node text from GUI scene. ----@param no_adjust bool If true, text will be not auto-adjust size -function druid__text.init(self, node, value, no_adjust) end +---@param adjust_type int Adjust type for text. By default is DOWNSCALE. Look const.TEXT_ADJUST for reference +function druid__text.init(self, node, value, adjust_type) end --- Return true, if text with line break ---@param self druid.text @@ -967,29 +1009,53 @@ function druid__text.is_multiline(self) end --- Set alpha ---@param self druid.text ---@param alpha number Alpha for node +---@return druid.text Current text instance function druid__text.set_alpha(self, alpha) end --- Set color ---@param self druid.text ---@param color vector4 Color for node +---@return druid.text Current text instance function druid__text.set_color(self, color) end +--- Set minimal scale for DOWNSCALE_LIMITED or SCALE_THEN_SCROLL adjust types +---@param self druid.text +---@param minimal_scale number If pass nil - not use minimal scale +---@return druid.text Current text instance +function druid__text.set_minimal_scale(self, minimal_scale) end + --- Set text pivot. ---@param self druid.text ---@param pivot gui.pivot Gui pivot constant +---@return druid.text Current text instance function druid__text.set_pivot(self, pivot) end --- Set scale ---@param self druid.text ---@param scale vector3 Scale for node +---@return druid.text Current text instance function druid__text.set_scale(self, scale) end +--- Set text adjust, refresh the current text visuals, if needed +---@param self druid.text +---@param adjust_type number See const.TEXT_ADJUST. If pass nil - use current adjust type +---@param minimal_scale number If pass nil - not use minimal scale +---@return druid.text Current text instance +function druid__text.set_text_adjust(self, adjust_type, minimal_scale) end + --- Set text to text field ---@param self druid.text ---@param set_to string Text for node +---@return druid.text Current text instance function druid__text.set_to(self, set_to) end +---@class druid.text.style +---@field DEFAULT_ADJUST field The default adjust type for any text component +---@field TRIM_POSTFIX field The postfix for TRIM adjust type +local druid__text__style = {} + + ---@class druid.timer : druid.base_component ---@field from number Initial timer value ---@field node node Trigger node @@ -1248,6 +1314,7 @@ function druid_instance.on_focus_lost(self) end ---@param self druid_instance ---@param action_id hash Action_id from on_input ---@param action table Action from on_input +---@return bool The boolean value is input was consumed function druid_instance.on_input(self, action_id, action) end --- Druid on layout change function. @@ -1323,6 +1390,11 @@ function helper.deprecated(message) end ---@return vector4 Vector with distance to node border: (left, top, right, down) function helper.get_border(node, offset) end +--- Return closest non inverted clipping parent node for node +---@param node node Gui node +---@return node|nil The clipping node +function helper.get_closest_stencil_node(node) end + --- Get node offset for given gui pivot ---@param pivot gui.pivot The node pivot ---@return vector3 Vector offset with [-1..1] values diff --git a/docs/index.html b/docs/index.html index 88f60a7..57e247c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -169,7 +169,7 @@
generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
diff --git a/docs/modules/BackHandler.html b/docs/modules/BackHandler.html index f7cee5f..e799be3 100644 --- a/docs/modules/BackHandler.html +++ b/docs/modules/BackHandler.html @@ -214,7 +214,7 @@
generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
diff --git a/docs/modules/BaseComponent.html b/docs/modules/BaseComponent.html index b84c60e..cf11016 100644 --- a/docs/modules/BaseComponent.html +++ b/docs/modules/BaseComponent.html @@ -133,6 +133,10 @@ setup_component(self, druid_instance, context, style) Setup component context and his style table + + get_childrens(self) + Return all children components, recursive +

Fields

@@ -551,6 +555,33 @@ + +
+ + get_childrens(self) +
+
+ Return all children components, recursive + + +

Parameters:

+ + +

Returns:

+
    + + table + Array of childrens if the Druid component instance +
+ + + +

Fields

@@ -577,7 +608,7 @@
generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
diff --git a/docs/modules/Blocker.html b/docs/modules/Blocker.html index 49faf68..b74f280 100644 --- a/docs/modules/Blocker.html +++ b/docs/modules/Blocker.html @@ -212,7 +212,7 @@
generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
diff --git a/docs/modules/Button.html b/docs/modules/Button.html index 0df5f06..e213d88 100644 --- a/docs/modules/Button.html +++ b/docs/modules/Button.html @@ -101,6 +101,10 @@ + + + +
get_key_trigger(self) Get key-code to trigger this button
set_check_function([check_function[, failure_callback]])Set function for additional check for button click availability

Tables

@@ -140,6 +144,10 @@ + + + + @@ -320,7 +328,7 @@
  • key - hash + hash The action_id of the key
    • @@ -355,13 +363,46 @@

    Returns:

      - hash + hash The action_id of the key
    + +
    + + set_check_function([check_function[, failure_callback]]) +
    +
    + Set function for additional check for button click availability + + +

    Parameters:

    + + +

    Returns:

    +
      + + Button + Current button instance +
    + + + +

    Tables

    @@ -564,6 +605,26 @@ + +
    + + hash +
    +
    + The hash of trigger node + + + + + + + +
    @@ -714,7 +775,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    diff --git a/docs/modules/Checkbox.html b/docs/modules/Checkbox.html index d8386ca..c9c8c4d 100644 --- a/docs/modules/Checkbox.html +++ b/docs/modules/Checkbox.html @@ -333,7 +333,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    diff --git a/docs/modules/CheckboxGroup.html b/docs/modules/CheckboxGroup.html index 0710b19..667da3d 100644 --- a/docs/modules/CheckboxGroup.html +++ b/docs/modules/CheckboxGroup.html @@ -245,7 +245,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    diff --git a/docs/modules/DataList.html b/docs/modules/DataList.html index e3f3c01..e7a91a5 100644 --- a/docs/modules/DataList.html +++ b/docs/modules/DataList.html @@ -499,7 +499,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    diff --git a/docs/modules/Drag.html b/docs/modules/Drag.html index 3534548..2c6a224 100644 --- a/docs/modules/Drag.html +++ b/docs/modules/Drag.html @@ -489,7 +489,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    diff --git a/docs/modules/DruidEvent.html b/docs/modules/DruidEvent.html index f6437e9..6a5a812 100644 --- a/docs/modules/DruidEvent.html +++ b/docs/modules/DruidEvent.html @@ -271,7 +271,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    diff --git a/docs/modules/DruidInstance.html b/docs/modules/DruidInstance.html index dd7bf7b..b79406c 100644 --- a/docs/modules/DruidInstance.html +++ b/docs/modules/DruidInstance.html @@ -144,10 +144,18 @@
    - + + + + + + + + + @@ -392,6 +400,12 @@ +

    Returns:

    +
      + + bool + The boolean value is input was consumed +
    @@ -498,7 +512,7 @@
    - druid.on_language_change() + druid.on_language_change(self)
    Druid on language change. @@ -506,6 +520,69 @@ call manualy to update all translations +

    Parameters:

    + + + + + + +
    +
    + + druid.set_whitelist(self[, whitelist_components=nil]) +
    +
    + Set whitelist components for input processing. + If whitelist is not empty and component not contains in this list, + component will be not processed on input step + + +

    Parameters:

    + + + + + + +
    +
    + + druid.set_blacklist(self[, blacklist_components=nil]) +
    +
    + Set blacklist components for input processing. + If blacklist is not empty and component contains in this list, + component will be not processed on input step + + +

    Parameters:

    + @@ -1283,7 +1360,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    diff --git a/docs/modules/DynamicGrid.html b/docs/modules/DynamicGrid.html index 92e438d..8bfb609 100644 --- a/docs/modules/DynamicGrid.html +++ b/docs/modules/DynamicGrid.html @@ -85,11 +85,11 @@
    - + - + @@ -247,7 +247,7 @@
    - add(self, node[, index[, shift_policy=SHIFT.RIGHT]]) + add(self, node[, index[, shift_policy=SHIFT.RIGHT[, is_instance=false]]])
    Add new node to the grid @@ -273,6 +273,11 @@ How shift nodes, if required. See const.SHIFT (default SHIFT.RIGHT) +
  • is_instance + boolean + If true, update node positions instantly + (default false) +
    • @@ -282,7 +287,7 @@
    - remove(self, index[, shift_policy=SHIFT.RIGHT]) + remove(self, index[, shift_policy=SHIFT.RIGHT[, is_instance=false]])
    Remove the item from the grid. Note that gui node will be not deleted @@ -303,6 +308,11 @@ How shift nodes, if required. See const.SHIFT (default SHIFT.RIGHT) +
  • is_instance + boolean + If true, update node positions instantly + (default false) +

    • Returns:

    @@ -776,7 +786,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    diff --git a/docs/modules/Hover.html b/docs/modules/Hover.html index 7eaea0d..0405a2f 100644 --- a/docs/modules/Hover.html +++ b/docs/modules/Hover.html @@ -330,7 +330,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    diff --git a/docs/modules/Input.html b/docs/modules/Input.html index dc58671..def67e8 100644 --- a/docs/modules/Input.html +++ b/docs/modules/Input.html @@ -688,7 +688,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    diff --git a/docs/modules/LangText.html b/docs/modules/LangText.html index d9eaef6..13e843d 100644 --- a/docs/modules/LangText.html +++ b/docs/modules/LangText.html @@ -243,7 +243,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    diff --git a/docs/modules/Progress.html b/docs/modules/Progress.html index b370019..729b3b7 100644 --- a/docs/modules/Progress.html +++ b/docs/modules/Progress.html @@ -522,7 +522,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    diff --git a/docs/modules/RadioGroup.html b/docs/modules/RadioGroup.html index d293600..87668da 100644 --- a/docs/modules/RadioGroup.html +++ b/docs/modules/RadioGroup.html @@ -245,7 +245,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    diff --git a/docs/modules/Scroll.html b/docs/modules/Scroll.html index 050eacf..6159d01 100644 --- a/docs/modules/Scroll.html +++ b/docs/modules/Scroll.html @@ -814,6 +814,11 @@ If true, invert direction for touchpad and mouse wheel scroll (default false) +
  • WHEEL_SCROLL_BY_INERTION + bool + If true, wheel will add inertion to scroll. Direct set position otherwise. + (default false) +
    • @@ -1113,7 +1118,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    diff --git a/docs/modules/Slider.html b/docs/modules/Slider.html index b7057fd..10bc621 100644 --- a/docs/modules/Slider.html +++ b/docs/modules/Slider.html @@ -421,7 +421,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    diff --git a/docs/modules/StaticGrid.html b/docs/modules/StaticGrid.html index c1f9b3a..24e3604 100644 --- a/docs/modules/StaticGrid.html +++ b/docs/modules/StaticGrid.html @@ -33,6 +33,7 @@

    Contents

    @@ -98,11 +99,11 @@
    - + - + @@ -130,6 +131,13 @@
    Trigger node
    hashThe hash of trigger node
    anim_node Animation node
    Druid on layout change function.
    druid.on_language_change()druid.on_language_change(self) Druid on language change.
    druid.set_whitelist(self[, whitelist_components=nil])Set whitelist components for input processing.
    druid.set_blacklist(self[, blacklist_components=nil])Set blacklist components for input processing.
    new_button(self, node, callback[, params[, anim_node]]) Create button basic component
    Return pos for grid node index
    add(self, node[, index[, shift_policy=SHIFT.RIGHT]])add(self, node[, index[, shift_policy=SHIFT.RIGHT[, is_instance=false]]]) Add new node to the grid
    remove(self, index[, shift_policy=SHIFT.RIGHT])remove(self, index[, shift_policy=SHIFT.RIGHT[, is_instance=false]]) Remove the item from the grid.
    Set grid anchor.
    add(self, item[, index[, shift_policy=SHIFT.RIGHT]])add(self, item[, index[, shift_policy=SHIFT.RIGHT[, is_instance=false]]]) Add new item to the grid
    remove(self, index[, shift_policy=SHIFT.RIGHT])remove(self, index[, shift_policy=SHIFT.RIGHT[, is_instance=false]]) Remove the item from the grid.
    Return StaticGrid offset, where StaticGrid content starts.
    +

    Tables

    + + + + + +
    styleComponent style params.

    Fields

    @@ -343,7 +351,7 @@
    - add(self, item[, index[, shift_policy=SHIFT.RIGHT]]) + add(self, item[, index[, shift_policy=SHIFT.RIGHT[, is_instance=false]]])
    Add new item to the grid @@ -369,6 +377,11 @@ How shift nodes, if required. See const.SHIFT (default SHIFT.RIGHT) +
  • is_instance + boolean + If true, update node positions instantly + (default false) +
    • @@ -378,7 +391,7 @@
    - remove(self, index[, shift_policy=SHIFT.RIGHT]) + remove(self, index[, shift_policy=SHIFT.RIGHT[, is_instance=false]])
    Remove the item from the grid. Note that gui node will be not deleted @@ -399,6 +412,11 @@ How shift nodes, if required. See const.SHIFT (default SHIFT.RIGHT) +
  • is_instance + boolean + If true, update node positions instantly + (default false) +

    • Returns:

    @@ -579,6 +597,34 @@ +
    + +

    Tables

    + +
    +
    + + style +
    +
    + Component style params. + You can override this component styles params in druid styles table + or create your own style + + +

    Fields:

    + + + + + +

    Fields

    @@ -831,7 +877,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    diff --git a/docs/modules/Swipe.html b/docs/modules/Swipe.html index 775bd1a..8aad3ce 100644 --- a/docs/modules/Swipe.html +++ b/docs/modules/Swipe.html @@ -283,7 +283,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    diff --git a/docs/modules/Text.html b/docs/modules/Text.html index 67968f2..e5cd4ec 100644 --- a/docs/modules/Text.html +++ b/docs/modules/Text.html @@ -33,6 +33,7 @@

    Contents

    @@ -79,7 +80,7 @@

    Functions

    - + @@ -110,6 +111,25 @@ + + + + + + + + + + + + +
    init(self, node[, value[, no_adjust]])init(self, node[, value[, adjust_type=0]]) Component init function
    is_multiline(self) Return true, if text with line break
    set_text_adjust(self[, adjust_type[, minimal_scale]])Set text adjust, refresh the current text visuals, if needed
    set_minimal_scale(self, minimal_scale)Set minimal scale for DOWNSCALE_LIMITED or SCALE_THEN_SCROLL adjust types
    get_text_adjust(self, adjust_type)Return current text adjust type
    +

    Tables

    + + + + +
    styleComponent style params.

    Fields

    @@ -130,6 +150,10 @@ + + + + @@ -150,7 +174,7 @@ - + @@ -168,7 +192,7 @@
    - init(self, node[, value[, no_adjust]]) + init(self, node[, value[, adjust_type=0]])
    Component init function @@ -189,10 +213,10 @@ Initial text. Default value is node text from GUI scene. (optional) -
  • no_adjust - bool - If true, text will be not auto-adjust size - (optional) +
  • adjust_type + int + Adjust type for text. By default is DOWNSCALE. Look const.TEXT_ADJUST for reference + (default 0)
    • @@ -247,6 +271,12 @@ +

    Returns:

    +
      + + Text + Current text instance +
    @@ -272,6 +302,12 @@ +

    Returns:

    +
      + + Text + Current text instance +
    @@ -297,6 +333,12 @@ +

    Returns:

    +
      + + Text + Current text instance +
    @@ -322,6 +364,12 @@ +

    Returns:

    +
      + + Text + Current text instance +
    @@ -332,8 +380,7 @@ set_pivot(self, pivot)
    - Set text pivot. Text will re-anchor inside - his text area + Set text pivot. Text will re-anchor inside text area

    Parameters:

    @@ -348,6 +395,12 @@ +

    Returns:

    +
      + + Text + Current text instance +
    @@ -379,6 +432,136 @@ +
    +
    + + set_text_adjust(self[, adjust_type[, minimal_scale]]) +
    +
    + Set text adjust, refresh the current text visuals, if needed + + +

    Parameters:

    + + +

    Returns:

    +
      + + Text + Current text instance +
    + + + + +
    +
    + + set_minimal_scale(self, minimal_scale) +
    +
    + Set minimal scale for DOWNSCALE_LIMITED or SCALE_THEN_SCROLL adjust types + + +

    Parameters:

    + + +

    Returns:

    +
      + + Text + Current text instance +
    + + + + +
    +
    + + get_text_adjust(self, adjust_type) +
    +
    + Return current text adjust type + + +

    Parameters:

    + + +

    Returns:

    +
      + + number + The current text adjust type +
    + + + + +
    +
    +

    Tables

    + +
    +
    + + style +
    +
    + Component style params. + You can override this component styles params in druid styles table + or create your own style + + +

    Fields:

    + + + + + +

    Fields

    @@ -463,6 +646,26 @@ + +
    + + node_id +
    +
    + The node id of text node + + + + + + + +
    @@ -565,16 +768,16 @@
    - - is_no_adjust + + adjust_type
    Current text size adjust settings @@ -611,7 +814,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    diff --git a/docs/modules/Timer.html b/docs/modules/Timer.html index 54d6fbc..fdf01b9 100644 --- a/docs/modules/Timer.html +++ b/docs/modules/Timer.html @@ -403,7 +403,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    diff --git a/docs/modules/druid.helper.html b/docs/modules/druid.helper.html index 3df5ea1..e086870 100644 --- a/docs/modules/druid.helper.html +++ b/docs/modules/druid.helper.html @@ -92,6 +92,10 @@
    + + + + @@ -242,6 +246,33 @@ + +
    + + get_closest_stencil_node(node) +
    +
    + Return closest non inverted clipping parent node for node + + +

    Parameters:

    + + +

    Returns:

    +
      + + node or nil + The clipping node +
    + + + +
    @@ -356,7 +387,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    diff --git a/docs/modules/druid.html b/docs/modules/druid.html index 5237d4e..c44e434 100644 --- a/docs/modules/druid.html +++ b/docs/modules/druid.html @@ -314,7 +314,7 @@
    generated by LDoc 1.4.6 -Last updated 2021-04-06 00:03:14 +Last updated 2021-10-23 17:32:40
    Text node
    node_idThe node id of text node
    pos Current text position
    Current text node available are
    is_no_adjustadjust_type Current text size adjust settings
    Check if node is enabled in gui hierarchy.
    get_closest_stencil_node(node)Return closest non inverted clipping parent node for node
    get_pivot_offset(pivot) Get node offset for given gui pivot