From ec2acceebe5a7647533ce299219174a2ec5e344e Mon Sep 17 00:00:00 2001 From: Insality Date: Wed, 5 Feb 2020 02:43:02 +0300 Subject: [PATCH] Update docs --- docs/index.html | 2 +- docs/modules/.druidback_handler.html | 158 ----------- docs/modules/.druidblocker.html | 84 ------ docs/modules/.druidbutton.html | 198 -------------- docs/modules/.druidcheckbox.html | 84 ------ docs/modules/.druidcheckbox_group.html | 84 ------ docs/modules/.druidgrid.html | 85 ------ docs/modules/.druidprogress.html | 303 ---------------------- docs/modules/.druidscroll.html | 283 -------------------- docs/modules/.druidslider.html | 84 ------ docs/modules/.druidtext.html | 242 ----------------- docs/modules/.druidtimer.html | 186 ------------- docs/modules/back_handler.html | 155 ----------- docs/modules/base.back_handler.html | 158 ----------- docs/modules/base.blocker.html | 84 ------ docs/modules/base.button.html | 198 -------------- docs/modules/base.checkbox.html | 84 ------ docs/modules/base.checkbox_group.html | 84 ------ docs/modules/base.grid.html | 85 ------ docs/modules/base.html | 155 ----------- docs/modules/base.progress.html | 303 ---------------------- docs/modules/base.scroll.html | 283 -------------------- docs/modules/base.slider.html | 84 ------ docs/modules/base.text.html | 242 ----------------- docs/modules/base.timer.html | 186 ------------- docs/modules/component.html | 2 +- docs/modules/components.back_handler.html | 155 ----------- docs/modules/const.html | 2 +- docs/modules/constants.html | 111 -------- docs/modules/druid.back_handler.html | 2 +- docs/modules/druid.blocker.html | 2 +- docs/modules/druid.button.html | 2 +- docs/modules/druid.checkbox.html | 2 +- docs/modules/druid.checkbox_group.html | 2 +- docs/modules/druid.grid.html | 2 +- docs/modules/druid.html | 2 +- docs/modules/druid.locale.html | 2 +- docs/modules/druid.progress.html | 2 +- docs/modules/druid.progress_rich.html | 2 +- docs/modules/druid.radio_group.html | 2 +- docs/modules/druid.scroll.html | 2 +- docs/modules/druid.slider.html | 2 +- docs/modules/druid.text.html | 2 +- docs/modules/druid.timer.html | 2 +- docs/modules/druid_instance.html | 8 +- docs/modules/helper.animate.html | 84 ------ docs/modules/helper.formats.html | 2 +- docs/modules/helper.html | 2 +- docs/modules/rich.progress_rich.html | 183 ------------- docs/modules/settings.html | 84 ------ 50 files changed, 24 insertions(+), 4533 deletions(-) delete mode 100644 docs/modules/.druidback_handler.html delete mode 100644 docs/modules/.druidblocker.html delete mode 100644 docs/modules/.druidbutton.html delete mode 100644 docs/modules/.druidcheckbox.html delete mode 100644 docs/modules/.druidcheckbox_group.html delete mode 100644 docs/modules/.druidgrid.html delete mode 100644 docs/modules/.druidprogress.html delete mode 100644 docs/modules/.druidscroll.html delete mode 100644 docs/modules/.druidslider.html delete mode 100644 docs/modules/.druidtext.html delete mode 100644 docs/modules/.druidtimer.html delete mode 100644 docs/modules/back_handler.html delete mode 100644 docs/modules/base.back_handler.html delete mode 100644 docs/modules/base.blocker.html delete mode 100644 docs/modules/base.button.html delete mode 100644 docs/modules/base.checkbox.html delete mode 100644 docs/modules/base.checkbox_group.html delete mode 100644 docs/modules/base.grid.html delete mode 100644 docs/modules/base.html delete mode 100644 docs/modules/base.progress.html delete mode 100644 docs/modules/base.scroll.html delete mode 100644 docs/modules/base.slider.html delete mode 100644 docs/modules/base.text.html delete mode 100644 docs/modules/base.timer.html delete mode 100644 docs/modules/components.back_handler.html delete mode 100644 docs/modules/constants.html delete mode 100644 docs/modules/helper.animate.html delete mode 100644 docs/modules/rich.progress_rich.html delete mode 100644 docs/modules/settings.html diff --git a/docs/index.html b/docs/index.html index e8b905e..f04bfad 100644 --- a/docs/index.html +++ b/docs/index.html @@ -150,7 +150,7 @@
generated by LDoc 1.4.6 -Last updated 2020-02-05 02:41:04 +Last updated 2020-02-05 02:43:10
diff --git a/docs/modules/.druidback_handler.html b/docs/modules/.druidback_handler.html deleted file mode 100644 index db4227b..0000000 --- a/docs/modules/.druidback_handler.html +++ /dev/null @@ -1,158 +0,0 @@ - - - - - Defold Druid UI Library - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module .druidback_handler

-

Component to handle back key (android, backspace)

-

- - -

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 2020-02-04 23:48:07 -
-
- - diff --git a/docs/modules/.druidblocker.html b/docs/modules/.druidblocker.html deleted file mode 100644 index 24bcd5f..0000000 --- a/docs/modules/.druidblocker.html +++ /dev/null @@ -1,84 +0,0 @@ - - - - - Defold Druid UI Library - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module .druidblocker

-

Component to block input on specify zone (node)

-

- - - -
-
- - - - -
-
-
-generated by LDoc 1.4.6 -Last updated 2020-02-04 23:48:07 -
-
- - diff --git a/docs/modules/.druidbutton.html b/docs/modules/.druidbutton.html deleted file mode 100644 index 810d334..0000000 --- a/docs/modules/.druidbutton.html +++ /dev/null @@ -1,198 +0,0 @@ - - - - - Defold Druid UI Library - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module .druidbutton

-

Component to handle basic GUI button

-

- - -

Functions

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

Functions

- -
-
- - button: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) -
    • -
- - - - - -
-
- - button:disable_animation(self) -
-
- Disable all button animations - - -

Parameters:

-
    -
  • self - table - Component instance -
    • -
- - - - - -
-
- - button: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 2020-02-04 23:48:07 -
-
- - diff --git a/docs/modules/.druidcheckbox.html b/docs/modules/.druidcheckbox.html deleted file mode 100644 index fad3da3..0000000 --- a/docs/modules/.druidcheckbox.html +++ /dev/null @@ -1,84 +0,0 @@ - - - - - Defold Druid UI Library - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module .druidcheckbox

-

Druid checkbox component

-

- - - -
-
- - - - -
-
-
-generated by LDoc 1.4.6 -Last updated 2020-02-04 23:48:07 -
-
- - diff --git a/docs/modules/.druidcheckbox_group.html b/docs/modules/.druidcheckbox_group.html deleted file mode 100644 index 71aa616..0000000 --- a/docs/modules/.druidcheckbox_group.html +++ /dev/null @@ -1,84 +0,0 @@ - - - - - Defold Druid UI Library - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module .druidcheckbox_group

-

Radio group module

-

- - - -
-
- - - - -
-
-
-generated by LDoc 1.4.6 -Last updated 2020-02-04 23:48:07 -
-
- - diff --git a/docs/modules/.druidgrid.html b/docs/modules/.druidgrid.html deleted file mode 100644 index 10824a8..0000000 --- a/docs/modules/.druidgrid.html +++ /dev/null @@ -1,85 +0,0 @@ - - - - - Defold Druid UI Library - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module .druidgrid

-

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 2020-02-04 23:48:07 -
-
- - diff --git a/docs/modules/.druidprogress.html b/docs/modules/.druidprogress.html deleted file mode 100644 index e4f351d..0000000 --- a/docs/modules/.druidprogress.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - Defold Druid UI Library - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module .druidprogress

-

Basic progress bar component

-

- - -

Functions

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

Functions

- -
-
- - progress: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 -
    • -
- - - - - -
-
- - progress:empty(self) -
-
- Fill a progress bar and stop progress animation - - -

Parameters:

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

Parameters:

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

Parameters:

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

Parameters:

-
    -
  • self - table - Component instance -
    • -
- - - - - -
-
- - progress: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 -
    • -
- - - - - -
-
- - progress: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 2020-02-04 23:48:07 -
-
- - diff --git a/docs/modules/.druidscroll.html b/docs/modules/.druidscroll.html deleted file mode 100644 index 42b29ff..0000000 --- a/docs/modules/.druidscroll.html +++ /dev/null @@ -1,283 +0,0 @@ - - - - - Defold Druid UI Library - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module .druidscroll

-

Component to handle scroll content

-

- - -

Functions

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

Functions

- -
-
- - scroll: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)
    • -
- -
-
- - scroll: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) -
    • -
- - - - - -
-
- - scroll: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 -
    • -
- - - - - -
-
- - scroll: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 -
    • -
- - - - - -
-
- - scroll: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 -
    • -
- - - - - -
-
- - scroll: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 2020-02-04 23:48:07 -
-
- - diff --git a/docs/modules/.druidslider.html b/docs/modules/.druidslider.html deleted file mode 100644 index 58b522b..0000000 --- a/docs/modules/.druidslider.html +++ /dev/null @@ -1,84 +0,0 @@ - - - - - Defold Druid UI Library - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module .druidslider

-

Druid slider component

-

- - - -
-
- - - - -
-
-
-generated by LDoc 1.4.6 -Last updated 2020-02-04 23:48:07 -
-
- - diff --git a/docs/modules/.druidtext.html b/docs/modules/.druidtext.html deleted file mode 100644 index 8700c2e..0000000 --- a/docs/modules/.druidtext.html +++ /dev/null @@ -1,242 +0,0 @@ - - - - - Defold Druid UI Library - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module .druidtext

-

Component to handle all GUI texts - Good working with localization system

-

- - -

Functions

- - - - - - - - - - - - - - - - - - - - - -
text:set_to(self, set_to)Set text to text field
text:set_color(self, color)Set color
text:set_alpha(self, alpha)Set alpha
text:set_scale(self, scale)Set scale
text:set_pivot(self, pivot)Set text pivot.
- -
-
- - -

Functions

- -
-
- - text:set_to(self, set_to) -
-
- Set text to text field - - -

Parameters:

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

Parameters:

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

Parameters:

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

Parameters:

-
    -
  • self - table - Component instance -
    • -
  • scale - vmath.vector3 - Scale for node -
    • -
- - - - - -
-
- - text:set_pivot(self, pivot) -
-
- Set text pivot. Text will re-anchor inside - his text area - - -

Parameters:

-
    -
  • self - table - Component instance -
    • -
  • pivot - gui.pivot - Gui pivot constant -
    • -
- - - - - -
-
- - -
-
-
-generated by LDoc 1.4.6 -Last updated 2020-02-04 23:48:07 -
-
- - diff --git a/docs/modules/.druidtimer.html b/docs/modules/.druidtimer.html deleted file mode 100644 index 073d58d..0000000 --- a/docs/modules/.druidtimer.html +++ /dev/null @@ -1,186 +0,0 @@ - - - - - Defold Druid UI Library - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module .druidtimer

-

Component to handle GUI timers

-

- - -

Functions

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

Functions

- -
-
- - timer:set_to(self, set_to) -
-
- Set text to text field - - -

Parameters:

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

Parameters:

-
    -
  • self - table - Component instance -
    • -
  • is_on - boolean - Timer enable state -
    • -
- - - - - -
-
- - timer: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 2020-02-04 23:48:07 -
-
- - diff --git a/docs/modules/back_handler.html b/docs/modules/back_handler.html deleted file mode 100644 index 0a7f657..0000000 --- a/docs/modules/back_handler.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - 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 deleted file mode 100644 index 50d1f20..0000000 --- a/docs/modules/base.back_handler.html +++ /dev/null @@ -1,158 +0,0 @@ - - - - - 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 2020-02-04 23:46:10 -
-
- - diff --git a/docs/modules/base.blocker.html b/docs/modules/base.blocker.html deleted file mode 100644 index e43d201..0000000 --- a/docs/modules/base.blocker.html +++ /dev/null @@ -1,84 +0,0 @@ - - - - - Defold Druid UI Library - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module base.blocker

-

Component to block input on specify zone (node)

-

- - - -
-
- - - - -
-
-
-generated by LDoc 1.4.6 -Last updated 2020-02-04 23:46:10 -
-
- - diff --git a/docs/modules/base.button.html b/docs/modules/base.button.html deleted file mode 100644 index 57ef749..0000000 --- a/docs/modules/base.button.html +++ /dev/null @@ -1,198 +0,0 @@ - - - - - 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 2020-02-04 23:46:10 -
-
- - diff --git a/docs/modules/base.checkbox.html b/docs/modules/base.checkbox.html deleted file mode 100644 index 92d23d3..0000000 --- a/docs/modules/base.checkbox.html +++ /dev/null @@ -1,84 +0,0 @@ - - - - - Defold Druid UI Library - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module base.checkbox

-

Druid checkbox component

-

- - - -
-
- - - - -
-
-
-generated by LDoc 1.4.6 -Last updated 2020-02-04 23:46:10 -
-
- - diff --git a/docs/modules/base.checkbox_group.html b/docs/modules/base.checkbox_group.html deleted file mode 100644 index 34069ff..0000000 --- a/docs/modules/base.checkbox_group.html +++ /dev/null @@ -1,84 +0,0 @@ - - - - - Defold Druid UI Library - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module base.checkbox_group

-

Radio group module

-

- - - -
-
- - - - -
-
-
-generated by LDoc 1.4.6 -Last updated 2020-02-04 23:46:10 -
-
- - diff --git a/docs/modules/base.grid.html b/docs/modules/base.grid.html deleted file mode 100644 index af5cf25..0000000 --- a/docs/modules/base.grid.html +++ /dev/null @@ -1,85 +0,0 @@ - - - - - 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 2020-02-04 23:46:10 -
-
- - diff --git a/docs/modules/base.html b/docs/modules/base.html deleted file mode 100644 index 6e44f09..0000000 --- a/docs/modules/base.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - 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 deleted file mode 100644 index 5622257..0000000 --- a/docs/modules/base.progress.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - 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 2020-02-04 23:46:10 -
-
- - diff --git a/docs/modules/base.scroll.html b/docs/modules/base.scroll.html deleted file mode 100644 index 087322d..0000000 --- a/docs/modules/base.scroll.html +++ /dev/null @@ -1,283 +0,0 @@ - - - - - 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 2020-02-04 23:46:10 -
-
- - diff --git a/docs/modules/base.slider.html b/docs/modules/base.slider.html deleted file mode 100644 index 37e794d..0000000 --- a/docs/modules/base.slider.html +++ /dev/null @@ -1,84 +0,0 @@ - - - - - Defold Druid UI Library - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module base.slider

-

Druid slider component

-

- - - -
-
- - - - -
-
-
-generated by LDoc 1.4.6 -Last updated 2020-02-04 23:46:10 -
-
- - diff --git a/docs/modules/base.text.html b/docs/modules/base.text.html deleted file mode 100644 index 7b29689..0000000 --- a/docs/modules/base.text.html +++ /dev/null @@ -1,242 +0,0 @@ - - - - - Defold Druid UI Library - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module base.text

-

Component to handle all GUI texts - Good working with localization system

-

- - -

Functions

- - - - - - - - - - - - - - - - - - - - - -
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
set_pivot(self, pivot)Set text pivot.
- -
-
- - -

Functions

- -
-
- - 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 -
    • -
- - - - - -
-
- - set_pivot(self, pivot) -
-
- Set text pivot. Text will re-anchor inside - his text area - - -

Parameters:

-
    -
  • self - table - Component instance -
    • -
  • pivot - gui.pivot - Gui pivot constant -
    • -
- - - - - -
-
- - -
-
-
-generated by LDoc 1.4.6 -Last updated 2020-02-04 23:46:10 -
-
- - diff --git a/docs/modules/base.timer.html b/docs/modules/base.timer.html deleted file mode 100644 index 7c5d6fb..0000000 --- a/docs/modules/base.timer.html +++ /dev/null @@ -1,186 +0,0 @@ - - - - - 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 2020-02-04 23:46:10 -
-
- - diff --git a/docs/modules/component.html b/docs/modules/component.html index 19309cb..efdbf93 100644 --- a/docs/modules/component.html +++ b/docs/modules/component.html @@ -398,7 +398,7 @@
generated by LDoc 1.4.6 -Last updated 2020-02-05 02:41:04 +Last updated 2020-02-05 02:43:10
diff --git a/docs/modules/components.back_handler.html b/docs/modules/components.back_handler.html deleted file mode 100644 index 6e25bbe..0000000 --- a/docs/modules/components.back_handler.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - 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/const.html b/docs/modules/const.html index 019e1a4..a660ac7 100644 --- a/docs/modules/const.html +++ b/docs/modules/const.html @@ -105,7 +105,7 @@
generated by LDoc 1.4.6 -Last updated 2020-02-05 02:41:04 +Last updated 2020-02-05 02:43:10
diff --git a/docs/modules/constants.html b/docs/modules/constants.html deleted file mode 100644 index 5cd9b0b..0000000 --- a/docs/modules/constants.html +++ /dev/null @@ -1,111 +0,0 @@ - - - - - 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.back_handler.html b/docs/modules/druid.back_handler.html index 7d5829e..056ed7a 100644 --- a/docs/modules/druid.back_handler.html +++ b/docs/modules/druid.back_handler.html @@ -150,7 +150,7 @@
generated by LDoc 1.4.6 -Last updated 2020-02-05 02:41:04 +Last updated 2020-02-05 02:43:10
diff --git a/docs/modules/druid.blocker.html b/docs/modules/druid.blocker.html index 20e343f..2bfeb01 100644 --- a/docs/modules/druid.blocker.html +++ b/docs/modules/druid.blocker.html @@ -76,7 +76,7 @@
generated by LDoc 1.4.6 -Last updated 2020-02-05 02:41:04 +Last updated 2020-02-05 02:43:10
diff --git a/docs/modules/druid.button.html b/docs/modules/druid.button.html index 8452e64..5550167 100644 --- a/docs/modules/druid.button.html +++ b/docs/modules/druid.button.html @@ -190,7 +190,7 @@
generated by LDoc 1.4.6 -Last updated 2020-02-05 02:41:04 +Last updated 2020-02-05 02:43:10
diff --git a/docs/modules/druid.checkbox.html b/docs/modules/druid.checkbox.html index 2eb557a..69bf10e 100644 --- a/docs/modules/druid.checkbox.html +++ b/docs/modules/druid.checkbox.html @@ -76,7 +76,7 @@
generated by LDoc 1.4.6 -Last updated 2020-02-05 02:41:04 +Last updated 2020-02-05 02:43:10
diff --git a/docs/modules/druid.checkbox_group.html b/docs/modules/druid.checkbox_group.html index b7c40b2..fd22518 100644 --- a/docs/modules/druid.checkbox_group.html +++ b/docs/modules/druid.checkbox_group.html @@ -76,7 +76,7 @@
generated by LDoc 1.4.6 -Last updated 2020-02-05 02:41:04 +Last updated 2020-02-05 02:43:10
diff --git a/docs/modules/druid.grid.html b/docs/modules/druid.grid.html index d749e24..2dc932e 100644 --- a/docs/modules/druid.grid.html +++ b/docs/modules/druid.grid.html @@ -77,7 +77,7 @@
generated by LDoc 1.4.6 -Last updated 2020-02-05 02:41:04 +Last updated 2020-02-05 02:43:10
diff --git a/docs/modules/druid.html b/docs/modules/druid.html index 41b769f..e2407f7 100644 --- a/docs/modules/druid.html +++ b/docs/modules/druid.html @@ -161,7 +161,7 @@
generated by LDoc 1.4.6 -Last updated 2020-02-05 02:41:04 +Last updated 2020-02-05 02:43:10
diff --git a/docs/modules/druid.locale.html b/docs/modules/druid.locale.html index ee8be26..a815917 100644 --- a/docs/modules/druid.locale.html +++ b/docs/modules/druid.locale.html @@ -117,7 +117,7 @@
generated by LDoc 1.4.6 -Last updated 2020-02-05 02:41:04 +Last updated 2020-02-05 02:43:10
diff --git a/docs/modules/druid.progress.html b/docs/modules/druid.progress.html index 7e0b1fa..a51299f 100644 --- a/docs/modules/druid.progress.html +++ b/docs/modules/druid.progress.html @@ -295,7 +295,7 @@
generated by LDoc 1.4.6 -Last updated 2020-02-05 02:41:04 +Last updated 2020-02-05 02:43:10
diff --git a/docs/modules/druid.progress_rich.html b/docs/modules/druid.progress_rich.html index 98909b2..f543b12 100644 --- a/docs/modules/druid.progress_rich.html +++ b/docs/modules/druid.progress_rich.html @@ -175,7 +175,7 @@
generated by LDoc 1.4.6 -Last updated 2020-02-05 02:41:04 +Last updated 2020-02-05 02:43:10
diff --git a/docs/modules/druid.radio_group.html b/docs/modules/druid.radio_group.html index a76e405..37f9b24 100644 --- a/docs/modules/druid.radio_group.html +++ b/docs/modules/druid.radio_group.html @@ -76,7 +76,7 @@
generated by LDoc 1.4.6 -Last updated 2020-02-05 02:41:04 +Last updated 2020-02-05 02:43:10
diff --git a/docs/modules/druid.scroll.html b/docs/modules/druid.scroll.html index 266dc5f..dc62222 100644 --- a/docs/modules/druid.scroll.html +++ b/docs/modules/druid.scroll.html @@ -275,7 +275,7 @@
generated by LDoc 1.4.6 -Last updated 2020-02-05 02:41:04 +Last updated 2020-02-05 02:43:10
diff --git a/docs/modules/druid.slider.html b/docs/modules/druid.slider.html index 57fc713..bb12425 100644 --- a/docs/modules/druid.slider.html +++ b/docs/modules/druid.slider.html @@ -76,7 +76,7 @@
generated by LDoc 1.4.6 -Last updated 2020-02-05 02:41:04 +Last updated 2020-02-05 02:43:10
diff --git a/docs/modules/druid.text.html b/docs/modules/druid.text.html index 47483a0..d118b49 100644 --- a/docs/modules/druid.text.html +++ b/docs/modules/druid.text.html @@ -234,7 +234,7 @@
generated by LDoc 1.4.6 -Last updated 2020-02-05 02:41:04 +Last updated 2020-02-05 02:43:10
diff --git a/docs/modules/druid.timer.html b/docs/modules/druid.timer.html index 4af92c2..23a625d 100644 --- a/docs/modules/druid.timer.html +++ b/docs/modules/druid.timer.html @@ -178,7 +178,7 @@
generated by LDoc 1.4.6 -Last updated 2020-02-05 02:41:04 +Last updated 2020-02-05 02:43:10
diff --git a/docs/modules/druid_instance.html b/docs/modules/druid_instance.html index 5165ae6..f0be67e 100644 --- a/docs/modules/druid_instance.html +++ b/docs/modules/druid_instance.html @@ -93,7 +93,7 @@ Druid class constructor - druid:create(component_module, ...) + druid:create(component, ...) Create new druid component @@ -204,7 +204,7 @@
- druid:create(component_module, ...) + druid:create(component, ...)
Create new druid component @@ -212,7 +212,7 @@

Parameters: