diff --git a/docs/modules/.druidback_handler.html b/docs/modules/.druidback_handler.html new file mode 100644 index 0000000..db4227b --- /dev/null +++ b/docs/modules/.druidback_handler.html @@ -0,0 +1,158 @@ + + + + + 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 new file mode 100644 index 0000000..24bcd5f --- /dev/null +++ b/docs/modules/.druidblocker.html @@ -0,0 +1,84 @@ + + + + + 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 new file mode 100644 index 0000000..810d334 --- /dev/null +++ b/docs/modules/.druidbutton.html @@ -0,0 +1,198 @@ + + + + + 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 new file mode 100644 index 0000000..fad3da3 --- /dev/null +++ b/docs/modules/.druidcheckbox.html @@ -0,0 +1,84 @@ + + + + + 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 new file mode 100644 index 0000000..71aa616 --- /dev/null +++ b/docs/modules/.druidcheckbox_group.html @@ -0,0 +1,84 @@ + + + + + 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 new file mode 100644 index 0000000..10824a8 --- /dev/null +++ b/docs/modules/.druidgrid.html @@ -0,0 +1,85 @@ + + + + + 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 new file mode 100644 index 0000000..e4f351d --- /dev/null +++ b/docs/modules/.druidprogress.html @@ -0,0 +1,303 @@ + + + + + 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 new file mode 100644 index 0000000..42b29ff --- /dev/null +++ b/docs/modules/.druidscroll.html @@ -0,0 +1,283 @@ + + + + + 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 new file mode 100644 index 0000000..58b522b --- /dev/null +++ b/docs/modules/.druidslider.html @@ -0,0 +1,84 @@ + + + + + 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 new file mode 100644 index 0000000..8700c2e --- /dev/null +++ b/docs/modules/.druidtext.html @@ -0,0 +1,242 @@ + + + + + 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 new file mode 100644 index 0000000..073d58d --- /dev/null +++ b/docs/modules/.druidtimer.html @@ -0,0 +1,186 @@ + + + + + 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/component.html b/docs/modules/component.html new file mode 100644 index 0000000..19309cb --- /dev/null +++ b/docs/modules/component.html @@ -0,0 +1,405 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module component

+

Basic class for all Druid components.

+

+ To create you component, use `component.create`

+ + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
setup_component(table, table)Setup component context and his style table
get_style()Get current component style table
set_style(style)Set current component style table
get_template()Get current component template name
set_template(template)Set current component template name
get_nodes()Get current component nodes
set_nodes(nodes)Set current component nodes
get_context()Get current component context
set_context(context)Set current component context
get_interests()Get current component interests
get_druid()Return druid with context of calling component.
Component.create(name, interest)Create new component.
+ +
+
+ + +

Functions

+ +
+
+ + setup_component(table, table) +
+
+ Setup component context and his style table + + +

Parameters:

+
    +
  • table + style + Druid style module +
    • +
  • table + style + Druid style module +
    • +
+ +

Returns:

+
    + + Component + Component itself +
+ + + + +
+
+ + get_style() +
+
+ Get current component style table + + + +

Returns:

+
    + + table + Component style table +
+ + + + +
+
+ + set_style(style) +
+
+ Set current component style table + + +

Parameters:

+
    +
  • style + table + Druid style module +
    • +
+ + + + + +
+
+ + get_template() +
+
+ Get current component template name + + + +

Returns:

+
    + + string + Component template name +
+ + + + +
+
+ + set_template(template) +
+
+ Set current component template name + + +

Parameters:

+
    +
  • template + string + Component template name +
    • +
+ + + + + +
+
+ + get_nodes() +
+
+ Get current component nodes + + + +

Returns:

+
    + + table + Component nodes table +
+ + + + +
+
+ + set_nodes(nodes) +
+
+ Set current component nodes + + +

Parameters:

+
    +
  • nodes + table + Component nodes table +
    • +
+ + + + + +
+
+ + get_context() +
+
+ Get current component context + + + +

Returns:

+
    + + table + Component context +
+ + + + +
+
+ + set_context(context) +
+
+ Set current component context + + +

Parameters:

+
    +
  • context + table + Druid context. Usually it is self of script +
    • +
+ + + + + +
+
+ + get_interests() +
+
+ Get current component interests + + + +

Returns:

+
    + + table + List of component interests +
+ + + + +
+
+ + get_druid() +
+
+ Return druid with context of calling component. + Use it to create component inside of other components. + + + +

Returns:

+
    + + Druid + Druid instance with component context +
+ + + + +
+
+ + Component.create(name, interest) +
+
+ Create new component. It will inheritance from basic + druid component. + + +

Parameters:

+
    +
  • name + string + Component name +
    • +
  • interest + table + List of component's interest +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2020-02-05 02:41:04 +
+
+ + diff --git a/docs/modules/const.html b/docs/modules/const.html new file mode 100644 index 0000000..019e1a4 --- /dev/null +++ b/docs/modules/const.html @@ -0,0 +1,112 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module const

+

Druid constants

+

+ + +

Fields

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

Fields

+ +
+
+ + ON_MESSAGE +
+
+ Interests + + + + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2020-02-05 02:41:04 +
+
+ + diff --git a/docs/modules/druid.back_handler.html b/docs/modules/druid.back_handler.html new file mode 100644 index 0000000..7d5829e --- /dev/null +++ b/docs/modules/druid.back_handler.html @@ -0,0 +1,157 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module druid.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-05 02:41:04 +
+
+ + diff --git a/docs/modules/druid.blocker.html b/docs/modules/druid.blocker.html new file mode 100644 index 0000000..20e343f --- /dev/null +++ b/docs/modules/druid.blocker.html @@ -0,0 +1,83 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module druid.blocker

+

Component to block input on specify zone (node)

+

+ + + +
+
+ + + + +
+
+
+generated by LDoc 1.4.6 +Last updated 2020-02-05 02:41:04 +
+
+ + diff --git a/docs/modules/druid.button.html b/docs/modules/druid.button.html new file mode 100644 index 0000000..8452e64 --- /dev/null +++ b/docs/modules/druid.button.html @@ -0,0 +1,197 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module druid.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-05 02:41:04 +
+
+ + diff --git a/docs/modules/druid.checkbox.html b/docs/modules/druid.checkbox.html new file mode 100644 index 0000000..2eb557a --- /dev/null +++ b/docs/modules/druid.checkbox.html @@ -0,0 +1,83 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module druid.checkbox

+

Druid checkbox component

+

+ + + +
+
+ + + + +
+
+
+generated by LDoc 1.4.6 +Last updated 2020-02-05 02:41:04 +
+
+ + diff --git a/docs/modules/druid.checkbox_group.html b/docs/modules/druid.checkbox_group.html new file mode 100644 index 0000000..b7c40b2 --- /dev/null +++ b/docs/modules/druid.checkbox_group.html @@ -0,0 +1,83 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module druid.checkbox_group

+

Checkboux group module

+

+ + + +
+
+ + + + +
+
+
+generated by LDoc 1.4.6 +Last updated 2020-02-05 02:41:04 +
+
+ + diff --git a/docs/modules/druid.grid.html b/docs/modules/druid.grid.html new file mode 100644 index 0000000..d749e24 --- /dev/null +++ b/docs/modules/druid.grid.html @@ -0,0 +1,84 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module druid.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-05 02:41:04 +
+
+ + diff --git a/docs/modules/druid.locale.html b/docs/modules/druid.locale.html new file mode 100644 index 0000000..ee8be26 --- /dev/null +++ b/docs/modules/druid.locale.html @@ -0,0 +1,124 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module druid.locale

+

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

+

+ + +

Functions

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

Functions

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

Parameters:

+
    +
  • self + table + Component instance +
    • +
  • locale_id + string + Locale id +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2020-02-05 02:41:04 +
+
+ + diff --git a/docs/modules/druid.progress.html b/docs/modules/druid.progress.html new file mode 100644 index 0000000..7e0b1fa --- /dev/null +++ b/docs/modules/druid.progress.html @@ -0,0 +1,302 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module druid.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-05 02:41:04 +
+
+ + diff --git a/docs/modules/druid.progress_rich.html b/docs/modules/druid.progress_rich.html new file mode 100644 index 0000000..98909b2 --- /dev/null +++ b/docs/modules/druid.progress_rich.html @@ -0,0 +1,182 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module druid.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 2020-02-05 02:41:04 +
+
+ + diff --git a/docs/modules/druid.radio_group.html b/docs/modules/druid.radio_group.html new file mode 100644 index 0000000..a76e405 --- /dev/null +++ b/docs/modules/druid.radio_group.html @@ -0,0 +1,83 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module druid.radio_group

+

Radio group module

+

+ + + +
+
+ + + + +
+
+
+generated by LDoc 1.4.6 +Last updated 2020-02-05 02:41:04 +
+
+ + diff --git a/docs/modules/druid.scroll.html b/docs/modules/druid.scroll.html new file mode 100644 index 0000000..266dc5f --- /dev/null +++ b/docs/modules/druid.scroll.html @@ -0,0 +1,282 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module druid.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-05 02:41:04 +
+
+ + diff --git a/docs/modules/druid.slider.html b/docs/modules/druid.slider.html new file mode 100644 index 0000000..57fc713 --- /dev/null +++ b/docs/modules/druid.slider.html @@ -0,0 +1,83 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module druid.slider

+

Druid slider component

+

+ + + +
+
+ + + + +
+
+
+generated by LDoc 1.4.6 +Last updated 2020-02-05 02:41:04 +
+
+ + diff --git a/docs/modules/druid.text.html b/docs/modules/druid.text.html new file mode 100644 index 0000000..47483a0 --- /dev/null +++ b/docs/modules/druid.text.html @@ -0,0 +1,241 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module druid.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-05 02:41:04 +
+
+ + diff --git a/docs/modules/druid.timer.html b/docs/modules/druid.timer.html new file mode 100644 index 0000000..4af92c2 --- /dev/null +++ b/docs/modules/druid.timer.html @@ -0,0 +1,185 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module druid.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-05 02:41:04 +
+
+ + diff --git a/docs/modules/druid_instance.html b/docs/modules/druid_instance.html new file mode 100644 index 0000000..5165ae6 --- /dev/null +++ b/docs/modules/druid_instance.html @@ -0,0 +1,716 @@ + + + + + Defold Druid UI Library + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module druid_instance

+

Druid main class.

+

Create instance of this + to start creating components

+

See also:

+ + + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
druid:initialize(table, table)Druid class constructor
druid:create(component_module, ...)Create new druid component
druid:remove(component)Remove component from druid instance.
druid:update(dt)Druid update function
druid:on_input(action_id, action)Druid on_input function
druid:on_message(message_id, message, sender)Druid on_message function
druid:new_button(...)Create button basic component
druid:new_blocker(...)Create blocker basic component
druid:new_back_handler(...)Create back_handler basic component
druid:new_text(...)Create text basic component
druid:new_locale(...)Create locale basic component
druid:new_timer(...)Create timer basic component
druid:new_progress(...)Create progress basic component
druid:new_grid(...)Create grid basic component
druid:new_scroll(...)Create scroll basic component
druid:new_slider(...)Create slider basic component
druid:new_checkbox(...)Create checkbox basic component
druid:new_checkbox_group(...)Create checkbox_group basic component
druid:new_radio_group(...)Create radio_group basic component
druid:new_progress_rich(...)Create progress_rich basic component
+ +
+
+ + +

Functions

+ +
+
+ + druid:initialize(table, table) +
+
+ Druid class constructor + + +

Parameters:

+
    +
  • table + style + Druid style module +
    • +
  • table + style + Druid style module +
    • +
+ + + + + +
+
+ + druid:create(component_module, ...) +
+
+ Create new druid component + + +

Parameters:

+
    +
  • component_module + Component + Component module +
    • +
  • ... + args + Other component params to pass it to component:init function +
    • +
+ + + + + +
+
+ + druid:remove(component) +
+
+ Remove component from druid instance. + Component `on_remove` function will be invoked, if exist. + + +

Parameters:

+
    +
  • component + Component + Component instance +
    • +
+ + + + + +
+
+ + druid:update(dt) +
+
+ Druid update function + + +

Parameters:

+
    +
  • dt + number + Delta time +
    • +
+ + + + + +
+
+ + druid:on_input(action_id, action) +
+
+ Druid on_input function + + +

Parameters:

+
    +
  • action_id + hash + Action_id from on_input +
    • +
  • action + table + Action from on_input +
    • +
+ + + + + +
+
+ + druid:on_message(message_id, message, sender) +
+
+ Druid on_message function + + +

Parameters:

+
    +
  • message_id + hash + Message_id from on_message +
    • +
  • message + table + Message from on_message +
    • +
  • sender + hash + Sender from on_message +
    • +
+ + + + + +
+
+ + druid:new_button(...) +
+
+ Create button basic component + + +

Parameters:

+
    +
  • ... + args + button init args +
    • +
+ +

Returns:

+
    + + Component + button component +
+ + + + +
+
+ + druid:new_blocker(...) +
+
+ Create blocker basic component + + +

Parameters:

+
    +
  • ... + args + blocker init args +
    • +
+ +

Returns:

+
    + + Component + blocker component +
+ + + + +
+
+ + druid:new_back_handler(...) +
+
+ Create back_handler basic component + + +

Parameters:

+
    +
  • ... + args + back_handler init args +
    • +
+ +

Returns:

+
    + + Component + back_handler component +
+ + + + +
+
+ + druid:new_text(...) +
+
+ Create text basic component + + +

Parameters:

+
    +
  • ... + args + text init args +
    • +
+ +

Returns:

+
    + + Component + text component +
+ + + + +
+
+ + druid:new_locale(...) +
+
+ Create locale basic component + + +

Parameters:

+
    +
  • ... + args + locale init args +
    • +
+ +

Returns:

+
    + + Component + locale component +
+ + + + +
+
+ + druid:new_timer(...) +
+
+ Create timer basic component + + +

Parameters:

+
    +
  • ... + args + timer init args +
    • +
+ +

Returns:

+
    + + Component + timer component +
+ + + + +
+
+ + druid:new_progress(...) +
+
+ Create progress basic component + + +

Parameters:

+
    +
  • ... + args + progress init args +
    • +
+ +

Returns:

+
    + + Component + progress component +
+ + + + +
+
+ + druid:new_grid(...) +
+
+ Create grid basic component + + +

Parameters:

+
    +
  • ... + args + grid init args +
    • +
+ +

Returns:

+
    + + Component + grid component +
+ + + + +
+
+ + druid:new_scroll(...) +
+
+ Create scroll basic component + + +

Parameters:

+
    +
  • ... + args + scroll init args +
    • +
+ +

Returns:

+
    + + Component + scroll component +
+ + + + +
+
+ + druid:new_slider(...) +
+
+ Create slider basic component + + +

Parameters:

+
    +
  • ... + args + slider init args +
    • +
+ +

Returns:

+
    + + Component + slider component +
+ + + + +
+
+ + druid:new_checkbox(...) +
+
+ Create checkbox basic component + + +

Parameters:

+
    +
  • ... + args + checkbox init args +
    • +
+ +

Returns:

+
    + + Component + checkbox component +
+ + + + +
+
+ + druid:new_checkbox_group(...) +
+
+ Create checkbox_group basic component + + +

Parameters:

+
    +
  • ... + args + checkbox_group init args +
    • +
+ +

Returns:

+
    + + Component + checkbox_group component +
+ + + + +
+
+ + druid:new_radio_group(...) +
+
+ Create radio_group basic component + + +

Parameters:

+
    +
  • ... + args + radio_group init args +
    • +
+ +

Returns:

+
    + + Component + radio_group component +
+ + + + +
+
+ + druid:new_progress_rich(...) +
+
+ Create progress_rich basic component + + +

Parameters:

+
    +
  • ... + args + progress_rich init args +
    • +
+ +

Returns:

+
    + + Component + progress_rich component +
+ + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2020-02-05 02:41:04 +
+
+ +