From da27d6edd8e9fa914ddd1be5d03ba48fd3e210a5 Mon Sep 17 00:00:00 2001 From: Insality Date: Thu, 5 Dec 2019 22:05:17 +0300 Subject: [PATCH] Generate ldoc --- docs/index.html | 103 +++++++- docs/modules/back_handler.html | 155 +++++++++++ docs/modules/base.back_handler.html | 156 +++++++++++ docs/modules/base.blocker.html | 82 ++++++ docs/modules/base.button.html | 195 ++++++++++++++ docs/modules/base.checkbox.html | 82 ++++++ docs/modules/base.checkbox_group.html | 82 ++++++ docs/modules/base.grid.html | 82 ++++++ docs/modules/base.html | 155 +++++++++++ docs/modules/base.progress.html | 301 +++++++++++++++++++++ docs/modules/base.scroll.html | 278 +++++++++++++++++++ docs/modules/base.slider.html | 82 ++++++ docs/modules/base.text.html | 238 +++++++++++++++++ docs/modules/base.timer.html | 184 +++++++++++++ docs/modules/components.back_handler.html | 155 +++++++++++ docs/modules/constants.html | 111 ++++++++ docs/modules/druid.html | 309 ++++++++++++++++++++++ docs/modules/helper.animate.html | 82 ++++++ docs/modules/helper.formats.html | 191 +++++++++++++ docs/modules/helper.html | 153 +++++++++++ docs/modules/rich.progress_rich.html | 181 +++++++++++++ docs/modules/settings.html | 82 ++++++ 22 files changed, 3438 insertions(+), 1 deletion(-) create mode 100644 docs/modules/back_handler.html create mode 100644 docs/modules/base.back_handler.html create mode 100644 docs/modules/base.blocker.html create mode 100644 docs/modules/base.button.html create mode 100644 docs/modules/base.checkbox.html create mode 100644 docs/modules/base.checkbox_group.html create mode 100644 docs/modules/base.grid.html create mode 100644 docs/modules/base.html create mode 100644 docs/modules/base.progress.html create mode 100644 docs/modules/base.scroll.html create mode 100644 docs/modules/base.slider.html create mode 100644 docs/modules/base.text.html create mode 100644 docs/modules/base.timer.html create mode 100644 docs/modules/components.back_handler.html create mode 100644 docs/modules/constants.html create mode 100644 docs/modules/druid.html create mode 100644 docs/modules/helper.animate.html create mode 100644 docs/modules/helper.formats.html create mode 100644 docs/modules/helper.html create mode 100644 docs/modules/rich.progress_rich.html create mode 100644 docs/modules/settings.html diff --git a/docs/index.html b/docs/index.html index a695fc9..59a5bb7 100644 --- a/docs/index.html +++ b/docs/index.html @@ -29,6 +29,28 @@ +

Modules

+ @@ -37,12 +59,91 @@

Documentation for Druid Library

+

Modules

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
base.back_handlerComponent to handle back key (android, backspace)
base.blockerComponent to block input on specify zone (node)
base.buttonComponent to handle basic GUI button
base.checkboxDruid checkbox component
base.checkbox_groupCheckboux group module
base.gridComponent to handle placing components by row and columns.
base.progressBasic progress bar component
base.checkbox_groupRadio group module
base.scrollComponent to handle scroll content
base.sliderDruid slider component
base.textComponent to handle all GUI texts Good working with localization system
base.timerComponent to handle GUI timers
constantsDruid constants
druidDruid UI Library.
helperDruid helper module
helper.animateDruid helper module for animating GUI nodes
helper.formatsDruid module with utils on string formats
rich.progress_richComponent for rich progress component
settingsDruid settings file
generated by LDoc 1.4.6 -Last updated 2019-09-25 19:57:43 +Last updated 2019-12-05 22:04:11
diff --git a/docs/modules/back_handler.html b/docs/modules/back_handler.html new file mode 100644 index 0000000..0a7f657 --- /dev/null +++ b/docs/modules/back_handler.html @@ -0,0 +1,155 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module back_handler

+

Component to handle back key

+

+ + +

Functions

+ + + + + + + + + +
init(self, callback[, Callback])Component init function
on_input(action_id, action)Input handler for component
+ +
+
+ + +

Functions

+ +
+
+ + init(self, callback[, Callback]) +
+
+ Component init function + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • callback + callback + On back button +
    • +
  • Callback + params + argument + (optional) +
    • +
+ + + + + +
+
+ + on_input(action_id, action) +
+
+ Input handler for component + + +

Parameters:

+
    +
  • action_id + string + on_input action id +
    • +
  • action + table + on_input action +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 21:37:51 +
+
+ + diff --git a/docs/modules/base.back_handler.html b/docs/modules/base.back_handler.html new file mode 100644 index 0000000..5d11f6e --- /dev/null +++ b/docs/modules/base.back_handler.html @@ -0,0 +1,156 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module base.back_handler

+

Component to handle back key (android, backspace)

+

+ + +

Functions

+ + + + + + + + + +
init(self, callback[, Callback])Component init function
on_input(action_id, action)Input handler for component
+ +
+
+ + +

Functions

+ +
+
+ + init(self, callback[, Callback]) +
+
+ Component init function + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • callback + callback + On back button +
    • +
  • Callback + params + argument + (optional) +
    • +
+ + + + + +
+
+ + on_input(action_id, action) +
+
+ Input handler for component + + +

Parameters:

+
    +
  • action_id + string + on_input action id +
    • +
  • action + table + on_input action +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 22:04:11 +
+
+ + diff --git a/docs/modules/base.blocker.html b/docs/modules/base.blocker.html new file mode 100644 index 0000000..9d0f4a5 --- /dev/null +++ b/docs/modules/base.blocker.html @@ -0,0 +1,82 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module base.blocker

+

Component to block input on specify zone (node)

+

+ + + +
+
+ + + + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 22:04:11 +
+
+ + diff --git a/docs/modules/base.button.html b/docs/modules/base.button.html new file mode 100644 index 0000000..f99cfcd --- /dev/null +++ b/docs/modules/base.button.html @@ -0,0 +1,195 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module base.button

+

Component to handle basic GUI button

+

+ + +

Functions

+ + + + + + + + + + + + + +
init(self, node, callback[, params[, anim_node[, event]]])Component init function
disable_animation(self)Disable all button animations
set_click_zone(self, zone)Strict button click area.
+ +
+
+ + +

Functions

+ +
+
+ + init(self, node, callback[, params[, anim_node[, event]]]) +
+
+ Component init function + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • node + node + Gui node +
    • +
  • callback + function + Button callback +
    • +
  • params + table + Button callback params + (optional) +
    • +
  • anim_node + node + Button anim node (node, if not provided) + (optional) +
    • +
  • event + string + Button react event, const.ACTION_TOUCH by default + (optional) +
    • +
+ + + + + +
+
+ + disable_animation(self) +
+
+ Disable all button animations + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
+ + + + + +
+
+ + set_click_zone(self, zone) +
+
+ Strict button click area. Useful for no click events outside stencil node + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • zone + node + Gui node +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 22:04:11 +
+
+ + diff --git a/docs/modules/base.checkbox.html b/docs/modules/base.checkbox.html new file mode 100644 index 0000000..cc3dce8 --- /dev/null +++ b/docs/modules/base.checkbox.html @@ -0,0 +1,82 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module base.checkbox

+

Druid checkbox component

+

+ + + +
+
+ + + + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 22:04:11 +
+
+ + diff --git a/docs/modules/base.checkbox_group.html b/docs/modules/base.checkbox_group.html new file mode 100644 index 0000000..2c8f1d9 --- /dev/null +++ b/docs/modules/base.checkbox_group.html @@ -0,0 +1,82 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module base.checkbox_group

+

Radio group module

+

+ + + +
+
+ + + + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 22:04:11 +
+
+ + diff --git a/docs/modules/base.grid.html b/docs/modules/base.grid.html new file mode 100644 index 0000000..c8e0f78 --- /dev/null +++ b/docs/modules/base.grid.html @@ -0,0 +1,82 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module base.grid

+

Component to handle placing components by row and columns.

+

Grid can anchor your elements, get content size and other

+ + + +
+
+ + + + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 22:04:11 +
+
+ + diff --git a/docs/modules/base.html b/docs/modules/base.html new file mode 100644 index 0000000..6e44f09 --- /dev/null +++ b/docs/modules/base.html @@ -0,0 +1,155 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module base

+

Component to handle back key

+

+ + +

Functions

+ + + + + + + + + +
back_handler:init(self, callback[, Callback])Component init function
back_handler:on_input(action_id, action)Input handler for component
+ +
+
+ + +

Functions

+ +
+
+ + back_handler:init(self, callback[, Callback]) +
+
+ Component init function + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • callback + callback + On back button +
    • +
  • Callback + params + argument + (optional) +
    • +
+ + + + + +
+
+ + back_handler:on_input(action_id, action) +
+
+ Input handler for component + + +

Parameters:

+
    +
  • action_id + string + on_input action id +
    • +
  • action + table + on_input action +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 21:36:59 +
+
+ + diff --git a/docs/modules/base.progress.html b/docs/modules/base.progress.html new file mode 100644 index 0000000..ba8e905 --- /dev/null +++ b/docs/modules/base.progress.html @@ -0,0 +1,301 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module base.progress

+

Basic progress bar component

+

+ + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
init(self, node, key, init_value)Component init function
empty(self)Fill a progress bar and stop progress animation
empty(self)Empty a progress bar
set_to(self, to)Instant fill progress bar to value
get(self)Return current progress bar value
set_steps(self, steps, callback)Set points on progress bar to fire the callback
to(self, to[, callback])Start animation of a progress bar
+ +
+
+ + +

Functions

+ +
+
+ + init(self, node, key, init_value) +
+
+ Component init function + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • node + string or node + Progress bar fill node or node name +
    • +
  • key + string + Progress bar direction (x or y) +
    • +
  • init_value + number + Initial value of progress bar +
    • +
+ + + + + +
+
+ + empty(self) +
+
+ Fill a progress bar and stop progress animation + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
+ + + + + +
+
+ + empty(self) +
+
+ Empty a progress bar + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
+ + + + + +
+
+ + set_to(self, to) +
+
+ Instant fill progress bar to value + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • to + number + Progress bar value, from 0 to 1 +
    • +
+ + + + + +
+
+ + get(self) +
+
+ Return current progress bar value + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
+ + + + + +
+
+ + set_steps(self, steps, callback) +
+
+ Set points on progress bar to fire the callback + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • steps + table + Array of progress bar values +
    • +
  • callback + function + Callback on intersect step value +
    • +
+ + + + + +
+
+ + to(self, to[, callback]) +
+
+ Start animation of a progress bar + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • to + number + value between 0..1 +
    • +
  • callback + function + Callback on animation ends + (optional) +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 22:04:11 +
+
+ + diff --git a/docs/modules/base.scroll.html b/docs/modules/base.scroll.html new file mode 100644 index 0000000..dabe409 --- /dev/null +++ b/docs/modules/base.scroll.html @@ -0,0 +1,278 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module base.scroll

+

Component to handle scroll content

+

+ + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + +
scroll_to(vector3[, is_instant])Start scroll to target point
init(self, index[, skip_cb])Scroll to item in scroll by point index
set_points(self, points)Set points of interest.
set_inert(self, state)Enable or disable scroll inert.
on_point_move(self, callback)Set the callback on scrolling to point (if exist)
set_border(self, border)Set the scroll possibly area
+ +
+
+ + +

Functions

+ +
+
+ + scroll_to(vector3[, is_instant]) +
+
+ Start scroll to target point + + +

Parameters:

+
    +
  • vector3 + point + target point +
    • +
  • is_instant + bool + instant scroll flag + (optional) +
    • +
+ + + + +

Usage:

+
    + 
  • scroll:scroll_to(vmath.vector3(0, 50, 0))
    • + 
  • scroll:scroll_to(vmath.vector3(0), true)
    • +
+ +
+
+ + init(self, index[, skip_cb]) +
+
+ Scroll to item in scroll by point index + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • index + number + Point index +
    • +
  • skip_cb + boolean + If true, skip the point callback + (optional) +
    • +
+ + + + + +
+
+ + set_points(self, points) +
+
+ Set points of interest. Scroll will always centered on closer points + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • points + table + Array of vector3 points +
    • +
+ + + + + +
+
+ + set_inert(self, state) +
+
+ Enable or disable scroll inert. If disabled, scroll through points (if exist) If no points, just simple drag without inertion + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • state + boolean + Inert scroll state +
    • +
+ + + + + +
+
+ + on_point_move(self, callback) +
+
+ Set the callback on scrolling to point (if exist) + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • callback + function + Callback on scroll to point of interest +
    • +
+ + + + + +
+
+ + set_border(self, border) +
+
+ Set the scroll possibly area + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • border + vmath.vector3 + Size of scrolling area +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 22:04:11 +
+
+ + diff --git a/docs/modules/base.slider.html b/docs/modules/base.slider.html new file mode 100644 index 0000000..14f8f6e --- /dev/null +++ b/docs/modules/base.slider.html @@ -0,0 +1,82 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module base.slider

+

Druid slider component

+

+ + + +
+
+ + + + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 22:04:11 +
+
+ + diff --git a/docs/modules/base.text.html b/docs/modules/base.text.html new file mode 100644 index 0000000..26e0f16 --- /dev/null +++ b/docs/modules/base.text.html @@ -0,0 +1,238 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module base.text

+

Component to handle all GUI texts Good working with localization system

+

+ + +

Functions

+ + + + + + + + + + + + + + + + + + + + + +
translate(self, locale_id)Translate the text by locale_id
set_to(self, set_to)Set text to text field
set_color(self, color)Set color
set_alpha(self, alpha)Set alpha
set_scale(self, scale)Set scale
+ +
+
+ + +

Functions

+ +
+
+ + translate(self, locale_id) +
+
+ Translate the text by locale_id + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • locale_id + string + Locale id +
    • +
+ + + + + +
+
+ + set_to(self, set_to) +
+
+ Set text to text field + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • set_to + string + Text for node +
    • +
+ + + + + +
+
+ + set_color(self, color) +
+
+ Set color + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • color + vmath.vector4 + Color for node +
    • +
+ + + + + +
+
+ + set_alpha(self, alpha) +
+
+ Set alpha + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • alpha + number + Alpha for node +
    • +
+ + + + + +
+
+ + set_scale(self, scale) +
+
+ Set scale + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • scale + vmath.vector3 + Scale for node +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 22:04:11 +
+
+ + diff --git a/docs/modules/base.timer.html b/docs/modules/base.timer.html new file mode 100644 index 0000000..dc66bfb --- /dev/null +++ b/docs/modules/base.timer.html @@ -0,0 +1,184 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module base.timer

+

Component to handle GUI timers

+

+ + +

Functions

+ + + + + + + + + + + + + +
set_to(self, set_to)Set text to text field
set_state(self, is_on)Called when update
set_interval(self, from, to)Set time interval
+ +
+
+ + +

Functions

+ +
+
+ + set_to(self, set_to) +
+
+ Set text to text field + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • set_to + number + Value in seconds +
    • +
+ + + + + +
+
+ + set_state(self, is_on) +
+
+ Called when update + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • is_on + boolean + Timer enable state +
    • +
+ + + + + +
+
+ + set_interval(self, from, to) +
+
+ Set time interval + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • from + number + Start time in seconds +
    • +
  • to + number + Target time in seconds +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 22:04:11 +
+
+ + diff --git a/docs/modules/components.back_handler.html b/docs/modules/components.back_handler.html new file mode 100644 index 0000000..6e25bbe --- /dev/null +++ b/docs/modules/components.back_handler.html @@ -0,0 +1,155 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module components.back_handler

+

Component to handle back key

+

+ + +

Functions

+ + + + + + + + + +
init(self, callback[, Callback])Component init function
on_input(action_id, action)Input handler for component
+ +
+
+ + +

Functions

+ +
+
+ + init(self, callback[, Callback]) +
+
+ Component init function + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • callback + callback + On back button +
    • +
  • Callback + params + argument + (optional) +
    • +
+ + + + + +
+
+ + on_input(action_id, action) +
+
+ Input handler for component + + +

Parameters:

+
    +
  • action_id + string + on_input action id +
    • +
  • action + table + on_input action +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 21:38:00 +
+
+ + diff --git a/docs/modules/constants.html b/docs/modules/constants.html new file mode 100644 index 0000000..5cd9b0b --- /dev/null +++ b/docs/modules/constants.html @@ -0,0 +1,111 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module constants

+

Druid constants

+

+ + +

Fields

+ + + + + +
ON_MESSAGEInterests
+ +
+
+ + +

Fields

+ +
+
+ + ON_MESSAGE +
+
+ Interests + + + + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 22:04:11 +
+
+ + diff --git a/docs/modules/druid.html b/docs/modules/druid.html new file mode 100644 index 0000000..f7b1a7a --- /dev/null +++ b/docs/modules/druid.html @@ -0,0 +1,309 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module druid

+

Druid UI Library.

+

Component based UI library to make your life easier. Contains a lot of base components and give API to create your own rich components.

+ + +

Functions

+ + + + + + + + + + + + + + + + + + + + + +
register(name, module)Register external module
new(component_script)Create UI instance for ui elements
_fct_metatable.on_message(self, message_id, message, sender)Called on_message
_fct_metatable.on_input(self, action_id, action)Called ON_INPUT
_fct_metatable.update(self, dt)Called on_update
+

Tables

+ + + + + +
compsBasic components
+ +
+
+ + +

Functions

+ +
+
+ + register(name, module) +
+
+ Register external module + + +

Parameters:

+
    +
  • name + string + module name +
    • +
  • module + table + lua table with module +
    • +
+ + + + + +
+
+ + new(component_script) +
+
+ Create UI instance for ui elements + + +

Parameters:

+
    +
  • component_script + +
    • +
+ +

Returns:

+
    + + instance with all ui components +
+ + + + +
+
+ + _fct_metatable.on_message(self, message_id, message, sender) +
+
+ Called on_message + + +

Parameters:

+
    +
  • self + +
    • +
  • message_id + +
    • +
  • message + +
    • +
  • sender + +
    • +
+ + + + + +
+
+ + _fct_metatable.on_input(self, action_id, action) +
+
+ Called ON_INPUT + + +

Parameters:

+
    +
  • self + +
    • +
  • action_id + +
    • +
  • action + +
    • +
+ + + + + +
+
+ + _fct_metatable.update(self, dt) +
+
+ Called on_update + + +

Parameters:

+
    +
  • self + +
    • +
  • dt + +
    • +
+ + + + + +
+
+

Tables

+ +
+
+ + comps +
+
+ Basic components + + +

Fields:

+
    +
  • button + +
    • +
  • blocker + +
    • +
  • back_handler + +
    • +
  • text + +
    • +
  • timer + +
    • +
  • progress + +
    • +
  • grid + +
    • +
  • scroll + +
    • +
  • slider + +
    • +
  • checkbox + +
    • +
  • checkbox_group + +
    • +
  • radio_group + +
    • +
  • progress_rich + +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 22:04:11 +
+
+ + diff --git a/docs/modules/helper.animate.html b/docs/modules/helper.animate.html new file mode 100644 index 0000000..63f59ee --- /dev/null +++ b/docs/modules/helper.animate.html @@ -0,0 +1,82 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module helper.animate

+

Druid helper module for animating GUI nodes

+

+ + + +
+
+ + + + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 22:04:11 +
+
+ + diff --git a/docs/modules/helper.formats.html b/docs/modules/helper.formats.html new file mode 100644 index 0000000..6cf1ce1 --- /dev/null +++ b/docs/modules/helper.formats.html @@ -0,0 +1,191 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module helper.formats

+

Druid module with utils on string formats

+

+ + +

Functions

+ + + + + + + + + + + + + +
add_prefix_zeros(num, count)Return number with zero number prefix
second_string_min(sec)Convert seconds to string minutes:seconds
second_string_min(s, tab)Interpolate string with named Parameters in Table
+ +
+
+ + +

Functions

+ +
+
+ + add_prefix_zeros(num, count) +
+
+ Return number with zero number prefix + + +

Parameters:

+
    +
  • num + number + Number for conversion +
    • +
  • count + number + Count of numerals +
    • +
+ +

Returns:

+
    + + string with need count of zero (1,3) -> 001 +
+ + + + +
+
+ + second_string_min(sec) +
+
+ Convert seconds to string minutes:seconds + + +

Parameters:

+
    +
  • sec + number + Seconds +
    • +
+ +

Returns:

+
    + + string minutes:seconds +
+ + + + +
+
+ + second_string_min(s, tab) +
+
+ Interpolate string with named Parameters in Table + + +

Parameters:

+
    +
  • s + string + Target string +
    • +
  • tab + table + Table with parameters +
    • +
+ +

Returns:

+
    + + string with replaced parameters +
+ + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 22:04:11 +
+
+ + diff --git a/docs/modules/helper.html b/docs/modules/helper.html new file mode 100644 index 0000000..e7ecf16 --- /dev/null +++ b/docs/modules/helper.html @@ -0,0 +1,153 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module helper

+

Druid helper module

+

+ + +

Functions

+ + + + + + + + + +
centrate_text_with_icon(text_node, icon_node, margin)Text node or icon node can be nil
centrate_icon_with_text(icon_node, text_node, margin)Icon node or text node can be nil
+ +
+
+ + +

Functions

+ +
+
+ + centrate_text_with_icon(text_node, icon_node, margin) +
+
+ Text node or icon node can be nil + + +

Parameters:

+
    +
  • text_node + +
    • +
  • icon_node + +
    • +
  • margin + +
    • +
+ + + + + +
+
+ + centrate_icon_with_text(icon_node, text_node, margin) +
+
+ Icon node or text node can be nil + + +

Parameters:

+
    +
  • icon_node + +
    • +
  • text_node + +
    • +
  • margin + +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 22:04:11 +
+
+ + diff --git a/docs/modules/rich.progress_rich.html b/docs/modules/rich.progress_rich.html new file mode 100644 index 0000000..0ce5b2e --- /dev/null +++ b/docs/modules/rich.progress_rich.html @@ -0,0 +1,181 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module rich.progress_rich

+

Component for rich progress component

+

+ + +

Functions

+ + + + + + + + + + + + + +
set_to(self, value)Instant fill progress bar to value
empty(self)Empty a progress bar
to(self, to[, callback])Start animation of a progress bar
+ +
+
+ + +

Functions

+ +
+
+ + set_to(self, value) +
+
+ Instant fill progress bar to value + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • value + number + Progress bar value, from 0 to 1 +
    • +
+ + + + + +
+
+ + empty(self) +
+
+ Empty a progress bar + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
+ + + + + +
+
+ + to(self, to[, callback]) +
+
+ Start animation of a progress bar + + +

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • to + number + value between 0..1 +
    • +
  • callback + function + Callback on animation ends + (optional) +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 22:04:11 +
+
+ + diff --git a/docs/modules/settings.html b/docs/modules/settings.html new file mode 100644 index 0000000..205e608 --- /dev/null +++ b/docs/modules/settings.html @@ -0,0 +1,82 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module settings

+

Druid settings file

+

+ + + +
+
+ + + + +
+
+
+generated by LDoc 1.4.6 +Last updated 2019-12-05 22:04:11 +
+
+ +