diff --git a/docs/index.html b/docs/index.html index 193baec..45b2665 100644 --- a/docs/index.html +++ b/docs/index.html @@ -4,7 +4,7 @@ Defold Druid UI Library - + @@ -37,7 +37,8 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • -
  • druid.locale
    • +
  • druid.input
    • +
  • druid.lang_text
  • druid.progress
  • druid.radio_group
  • druid.scroll
    • @@ -46,8 +47,8 @@
  • druid.timer
  • component
  • druid
    • -
  • helper
    • -
  • druid.progress_rich
    • +
  • druid_event
    • +
  • druid.helper
  • druid_instance
    • @@ -85,7 +86,11 @@ Component to handle placing components by row and columns. - druid.locale + druid.input + Component to handle hover node interaction + + + druid.lang_text Component to handle all GUI texts Good working with localization system @@ -123,12 +128,12 @@ Druid UI Library. - helper - Text node or icon node can be nil + druid_event + Lua event small library - druid.progress_rich - Component for rich progress component + druid.helper + Text node or icon node can be nil druid_instance @@ -140,7 +145,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-07 01:09:38 +Last updated 2020-02-23 13:01:03
    diff --git a/docs/ldoc_pale.css b/docs/ldoc_fixed.css similarity index 95% rename from docs/ldoc_pale.css rename to docs/ldoc_fixed.css index 4202bd3..9b0fc00 100644 --- a/docs/ldoc_pale.css +++ b/docs/ldoc_fixed.css @@ -147,16 +147,22 @@ table.index td { text-align: left; vertical-align: top; } #main { background-color:#FFFFFF; // #f0f0f0; - //border-left: 2px solid #cccccc; + border-left: 1px solid #cccccc; } #navigation { + position: fixed; + top: 0; + left: 0; float: left; width: 14em; vertical-align: top; background-color:#FFFFFF; // #f0f0f0; border-right: 2px solid #cccccc; overflow: visible; + overflow-y: scroll; + height: 100%; + padding-left: 1em; } #navigation h2 { @@ -165,7 +171,6 @@ table.index td { text-align: left; vertical-align: top; } color:#000000; text-align: left; padding:0.2em; - //border-top:1px solid #dddddd; border-bottom:1px solid #dddddd; } @@ -189,6 +194,7 @@ table.index td { text-align: left; vertical-align: top; } #content { margin-left: 14em; padding: 1em; + padding-left: 2em; width: 700px; border-left: 2px solid #cccccc; // border-right: 2px solid #cccccc; @@ -197,8 +203,10 @@ table.index td { text-align: left; vertical-align: top; } #about { clear: both; - padding: 5px; + padding-left: 1em; + margin-left: 14em; // avoid the damn sidebar! border-top: 2px solid #cccccc; + border-left: 2px solid #cccccc; background-color: #ffffff; } diff --git a/docs/modules/component.html b/docs/modules/component.html index 5923cd0..d0b3851 100644 --- a/docs/modules/component.html +++ b/docs/modules/component.html @@ -4,7 +4,7 @@ Defold Druid UI Library - + @@ -38,23 +38,24 @@

    Modules

    @@ -64,59 +65,58 @@

    Module component

    Basic class for all Druid components.

    -

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

    +

    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 nodesComponent.create(name, interest)Create new component.
    get_context() Get current component context
    set_context(context)Set current component contextget_druid()Return druid with context of calling component.
    get_interests() Get current component interests
    get_druid()Return druid with context of calling component.get_nodes()Get current component nodes
    Component.create(name, interest)Create new component.get_style()Get current component style table
    get_template()Get current component template name
    set_context(context)Set current component context
    set_nodes(nodes)Set current component nodes
    set_style(style)Set current component style table
    set_template(template)Set current component template name
    setup_component(table, table)Setup component context and his style table
    @@ -127,6 +127,237 @@

    Functions

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

    Parameters:

    + + + + + + +
    +
    + + get_context() +
    +
    + Get current component context + + + +

    Returns:

    +
      + + table + Component context +
    + + + + +
    +
    + + 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 +
    + + + + +
    +
    + + get_interests() +
    +
    + Get current component interests + + + +

    Returns:

    +
      + + table + List of component interests +
    + + + + +
    +
    + + get_nodes() +
    +
    + Get current component nodes + + + +

    Returns:

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

    Returns:

    +
      + + table + Component style table +
    + + + + +
    +
    + + get_template() +
    +
    + Get current component template name + + + +

    Returns:

    +
      + + string + Component template name +
    + + + + +
    +
    + + set_context(context) +
    +
    + Set current component context + + +

    Parameters:

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

    Parameters:

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

    Parameters:

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

    Parameters:

    + + + + + + +
    setup_component(table, table) @@ -157,237 +388,6 @@ - -
    - - get_style() -
    -
    - Get current component style table - - - -

    Returns:

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

    Parameters:

    - - - - - - -
    -
    - - get_template() -
    -
    - Get current component template name - - - -

    Returns:

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

    Parameters:

    - - - - - - -
    -
    - - get_nodes() -
    -
    - Get current component nodes - - - -

    Returns:

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

    Parameters:

    - - - - - - -
    -
    - - get_context() -
    -
    - Get current component context - - - -

    Returns:

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

    Parameters:

    - - - - - - -
    -
    - - 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:

    - - - - - -
    @@ -396,7 +396,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-07 01:09:38 +Last updated 2020-02-23 13:01:03
    diff --git a/docs/modules/druid.back_handler.html b/docs/modules/druid.back_handler.html index c0b420f..66881c1 100644 --- a/docs/modules/druid.back_handler.html +++ b/docs/modules/druid.back_handler.html @@ -4,7 +4,7 @@ Defold Druid UI Library - + @@ -38,23 +38,24 @@

    Modules

    @@ -64,7 +65,9 @@

    Module druid.back_handler

    Component to handle back key (android, backspace)

    -

    +

    + +

    Functions

    @@ -148,7 +151,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-07 01:09:38 +Last updated 2020-02-23 13:01:03
    diff --git a/docs/modules/druid.blocker.html b/docs/modules/druid.blocker.html index e1924ab..cd46818 100644 --- a/docs/modules/druid.blocker.html +++ b/docs/modules/druid.blocker.html @@ -4,7 +4,7 @@ Defold Druid UI Library - + @@ -34,23 +34,24 @@

    Modules

    @@ -60,7 +61,9 @@

    Module druid.blocker

    Component to block input on specify zone (node)

    -

    +

    + +

    @@ -74,7 +77,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-07 01:09:38 +Last updated 2020-02-23 13:01:03
    diff --git a/docs/modules/druid.button.html b/docs/modules/druid.button.html index 7e0edbc..4108eb2 100644 --- a/docs/modules/druid.button.html +++ b/docs/modules/druid.button.html @@ -4,7 +4,7 @@ Defold Druid UI Library - + @@ -33,28 +33,30 @@

    Contents

    Modules

    @@ -64,23 +66,56 @@

    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
    get_key_trigger(self)Get key-code to trigger this button
    init(self, node, callback[, params[, anim_node[, event]]])Component init function
    set_callback(self, callback)Set usual button callback
    set_click_zone(self, zone) Strict button click area.
    set_double_tap_callback(self, callback)Get doubletap callback on this button
    set_hold_callback(self, callback)Repeat callback always, while holding button
    set_long_tap_callback(self, callback)Single callbacka after long_tap.
    +

    Tables

    + + + + + + + + +
    eventsComponent events
    fieldsComponent fields

    @@ -90,6 +125,49 @@

    Functions

    +
    + + disable_animation(self) +
    +
    + Disable all button animations + + +

    Parameters:

    + + + + + + +
    +
    + + get_key_trigger(self) +
    +
    + Get key-code to trigger this button + + +

    Parameters:

    + + + + + + +
    init(self, node, callback[, params[, anim_node[, event]]]) @@ -135,18 +213,24 @@
    - - disable_animation(self) + + set_callback(self, callback)
    - Disable all button animations + Set usual button callback

    Parameters:

    @@ -180,6 +264,153 @@ +
    +
    + + set_double_tap_callback(self, callback) +
    +
    + Get doubletap callback on this button + + +

    Parameters:

    + + + + + + +
    +
    + + set_hold_callback(self, callback) +
    +
    + Repeat callback always, while holding button + + +

    Parameters:

    + + + + + + +
    +
    + + set_long_tap_callback(self, callback) +
    +
    + Single callbacka after long_tap. No usual callback invoked + + +

    Parameters:

    + + + + + + +
    +
    +

    Tables

    + +
    +
    + + events +
    +
    + Component events + + +

    Fields:

    + + + + + + +
    +
    + + fields +
    +
    + Component fields + + +

    Fields:

    + + + + + +
    @@ -188,7 +419,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-07 01:09:38 +Last updated 2020-02-23 13:01:03
    diff --git a/docs/modules/druid.checkbox.html b/docs/modules/druid.checkbox.html index 51a2f75..e3b8461 100644 --- a/docs/modules/druid.checkbox.html +++ b/docs/modules/druid.checkbox.html @@ -4,7 +4,7 @@ Defold Druid UI Library - + @@ -34,23 +34,24 @@

    Modules

    @@ -60,7 +61,9 @@

    Module druid.checkbox

    Druid checkbox component

    -

    +

    + +

    @@ -74,7 +77,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-07 01:09:38 +Last updated 2020-02-23 13:01:03
    diff --git a/docs/modules/druid.checkbox_group.html b/docs/modules/druid.checkbox_group.html index 0071b08..6a20fe6 100644 --- a/docs/modules/druid.checkbox_group.html +++ b/docs/modules/druid.checkbox_group.html @@ -4,7 +4,7 @@ Defold Druid UI Library - + @@ -34,23 +34,24 @@

    Modules

    @@ -60,7 +61,9 @@

    Module druid.checkbox_group

    Checkboux group module

    -

    +

    + +

    @@ -74,7 +77,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-07 01:09:38 +Last updated 2020-02-23 13:01:03
    diff --git a/docs/modules/druid.grid.html b/docs/modules/druid.grid.html index 9321a7f..ad0f258 100644 --- a/docs/modules/druid.grid.html +++ b/docs/modules/druid.grid.html @@ -4,7 +4,7 @@ Defold Druid UI Library - + @@ -34,23 +34,24 @@

    Modules

    @@ -60,8 +61,7 @@

    Module druid.grid

    Component to handle placing components by row and columns.

    -

    - Grid can anchor your elements, get content size and other

    +

    Grid can anchor your elements, get content size and other

    @@ -75,7 +75,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-07 01:09:38 +Last updated 2020-02-23 13:01:03
    diff --git a/docs/modules/helper.html b/docs/modules/druid.helper.html similarity index 70% rename from docs/modules/helper.html rename to docs/modules/druid.helper.html index 0577525..820aaec 100644 --- a/docs/modules/helper.html +++ b/docs/modules/druid.helper.html @@ -4,7 +4,7 @@ Defold Druid UI Library - + @@ -38,23 +38,24 @@

    Modules

    @@ -62,20 +63,30 @@
    -

    Module helper

    +

    Module druid.helper

    Text node or icon node can be nil

    -

    +

    + +

    Functions

    + + + + - - + + + + + +
    centrate_icon_with_text([icon_node[, text_node[, margin=0]]])Center two nodes.
    centrate_text_with_icon([text_node][, icon_node], margin) Center two nodes.
    centrate_icon_with_text([icon_node[, text_node[, margin=0]]])Center two nodes.get_pivot_offset(pivot)Get node offset for given gui pivot
    is_enabled(node)Check if node is enabled in gui hierarchy.
    @@ -86,39 +97,6 @@

    Functions

    -
    - - centrate_text_with_icon([text_node][, icon_node], margin) -
    -
    - Center two nodes. - Nodes will be center around 0 x position - text_node will be first (at left side) - - -

    Parameters:

    -
      -
    • text_node - text - Gui text node - (optional) -
      • -
    • icon_node - box - Gui box node - (optional) -
      • -
    • margin - number - Offset between nodes -
      • -
    - - - - - -
    centrate_icon_with_text([icon_node[, text_node[, margin=0]]]) @@ -152,6 +130,94 @@ + +
    + + centrate_text_with_icon([text_node][, icon_node], margin) +
    +
    + Center two nodes. + Nodes will be center around 0 x position + text_node will be first (at left side) + + +

    Parameters:

    +
      +
    • text_node + text + Gui text node + (optional) +
      • +
    • icon_node + box + Gui box node + (optional) +
      • +
    • margin + number + Offset between nodes +
      • +
    + + + + + +
    +
    + + get_pivot_offset(pivot) +
    +
    + Get node offset for given gui pivot + + +

    Parameters:

    +
      +
    • pivot + gui.pivot + The node pivot +
      • +
    + +

    Returns:

    +
      + + vector3 + Vector offset with [-1..1] values +
    + + + + +
    +
    + + is_enabled(node) +
    +
    + Check if node is enabled in gui hierarchy. + Return false, if node or any his parent is disabled + + +

    Parameters:

    +
      +
    • node + node + Gui node +
      • +
    + +

    Returns:

    +
      + + bool + Is enabled in hierarchy +
    + + + +
    @@ -160,7 +226,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-07 01:09:38 +Last updated 2020-02-23 13:01:03
    diff --git a/docs/modules/druid.html b/docs/modules/druid.html index 18bfff8..eef8815 100644 --- a/docs/modules/druid.html +++ b/docs/modules/druid.html @@ -4,7 +4,7 @@ Defold Druid UI Library - + @@ -38,23 +38,24 @@

    Modules

    @@ -65,25 +66,36 @@

    Module druid

    Druid UI Library.

    - Powerful Defold component based UI library. Use standart + +

    Powerful Defold component based UI library. Use standart components or make your own game-specific to make amazing - GUI in your games. + GUI in your games.

    +

    Contains the several basic components and examples to how to do your custom complex components to - separate UI game logic to small files + separate UI game logic to small files

    + + +
    +require("druid.druid")
+function init(self)
+    self.druid = druid.new(self)
+end
+
    +

    Functions

    - - - - + + + +
    register(name, module)Register external druid component.
    new(context[, style]) Create Druid instance.
    register(name, module)Register external druid component.

    @@ -93,33 +105,6 @@

    Functions

    -
    - - register(name, module) -
    -
    - Register external druid component. - After register you can create the component with - druid_instance:new_{name}. For example `druid:new_button(...)` - - -

    Parameters:

    - - - - - - -
    new(context[, style]) @@ -151,6 +136,33 @@ + +
    + + register(name, module) +
    +
    + Register external druid component. + After register you can create the component with + druidinstance:new{name}. For example druid:new_button(...) + + +

    Parameters:

    + + + + + +
    @@ -159,7 +171,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-07 01:09:38 +Last updated 2020-02-23 13:01:03
    diff --git a/docs/modules/druid.progress_rich.html b/docs/modules/druid.input.html similarity index 61% rename from docs/modules/druid.progress_rich.html rename to docs/modules/druid.input.html index 335a6b3..234ed47 100644 --- a/docs/modules/druid.progress_rich.html +++ b/docs/modules/druid.input.html @@ -4,7 +4,7 @@ Defold Druid UI Library - + @@ -38,23 +38,24 @@

    Modules

    @@ -62,24 +63,22 @@
    -

    Module druid.progress_rich

    -

    Component for rich progress component

    -

    +

    Module druid.input

    +

    Component to handle hover node interaction

    +

    + +

    Functions

    - - + + - - - - - - + +
    set_to(self, value)Instant fill progress bar to valuebutton:set_click_zone(self, zone)Strict button click area.
    empty(self)Empty a progress bar
    to(self, to[, callback])Start animation of a progress barhover:init(self, node, on_hover_callback)Component init function
    @@ -91,11 +90,12 @@
    - - set_to(self, value) + + button:set_click_zone(self, zone)
    - Instant fill progress bar to value + Strict button click area. Useful for + no click events outside stencil node

    Parameters:

    @@ -104,9 +104,9 @@ table Component instance -
  • value - number - Progress bar value, from 0 to 1 +
  • zone + node + Gui node
    • @@ -116,11 +116,11 @@
    - - empty(self) + + hover:init(self, node, on_hover_callback)
    - Empty a progress bar + Component init function

    Parameters:

    @@ -129,35 +129,13 @@ table Component instance - - - - - - -
    -
    - - to(self, to[, callback]) -
    -
    - Start animation of a progress bar - - -

    Parameters:

    -
      -
    • self - table - Component instance +
    • node + node + Gui node
      • -
    • to - number - value between 0..1 -
      • -
    • callback +
    • on_hover_callback function - Callback on animation ends - (optional) + Hover callback
    @@ -173,7 +151,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-07 01:09:38 +Last updated 2020-02-23 13:01:03
    diff --git a/docs/modules/druid.locale.html b/docs/modules/druid.lang_text.html similarity index 87% rename from docs/modules/druid.locale.html rename to docs/modules/druid.lang_text.html index cd07ef0..7eefddd 100644 --- a/docs/modules/druid.locale.html +++ b/docs/modules/druid.lang_text.html @@ -4,7 +4,7 @@ Defold Druid UI Library - + @@ -38,23 +38,24 @@

    Modules

    @@ -62,10 +63,12 @@
    -

    Module druid.locale

    +

    Module druid.lang_text

    Component to handle all GUI texts Good working with localization system

    -

    +

    + +

    Functions

    @@ -115,7 +118,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-07 01:09:38 +Last updated 2020-02-23 13:01:03
    diff --git a/docs/modules/druid.progress.html b/docs/modules/druid.progress.html index c133fb8..a505c5a 100644 --- a/docs/modules/druid.progress.html +++ b/docs/modules/druid.progress.html @@ -4,7 +4,7 @@ Defold Druid UI Library - + @@ -38,23 +38,24 @@

    Modules

    @@ -64,36 +65,38 @@

    Module druid.progress

    Basic progress bar component

    -

    +

    + +

    Functions

    - - + + - - - - - - - - + + + + + + + + @@ -106,6 +109,69 @@

    Functions

    +
    + + empty(self) +
    +
    + Empty a progress bar + + +

    Parameters:

    + + + + + + +
    +
    + + empty(self) +
    +
    + Fill a progress bar and stop progress animation + + +

    Parameters:

    + + + + + + +
    +
    + + get(self) +
    +
    + Return current progress bar value + + +

    Parameters:

    + + + + + + +
    init(self, node, key, init_value) @@ -140,11 +206,11 @@
    - - empty(self) + + set_steps(self, steps, callback)
    - Fill a progress bar and stop progress animation + Set points on progress bar to fire the callback

    Parameters:

    @@ -153,26 +219,13 @@ table Component instance - - - - - - -
    -
    - - empty(self) -
    -
    - Empty a progress bar - - -

    Parameters:

    - @@ -205,56 +258,6 @@ -
    -
    - - get(self) -
    -
    - Return current progress bar value - - -

    Parameters:

    - - - - - - -
    -
    - - set_steps(self, steps, callback) -
    -
    - Set points on progress bar to fire the callback - - -

    Parameters:

    - - - - - -
    @@ -293,7 +296,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-07 01:09:38 +Last updated 2020-02-23 13:01:03
    diff --git a/docs/modules/druid.radio_group.html b/docs/modules/druid.radio_group.html index e4db277..95f1c32 100644 --- a/docs/modules/druid.radio_group.html +++ b/docs/modules/druid.radio_group.html @@ -4,7 +4,7 @@ Defold Druid UI Library - + @@ -34,23 +34,24 @@

    Modules

    @@ -60,7 +61,9 @@

    Module druid.radio_group

    Radio group module

    -

    +

    + +

    @@ -74,7 +77,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-07 01:09:38 +Last updated 2020-02-23 13:01:03
    diff --git a/docs/modules/druid.scroll.html b/docs/modules/druid.scroll.html index c91a211..c12e1aa 100644 --- a/docs/modules/druid.scroll.html +++ b/docs/modules/druid.scroll.html @@ -4,7 +4,7 @@ Defold Druid UI Library - + @@ -38,23 +38,24 @@

    Modules

    @@ -64,35 +65,37 @@

    Module druid.scroll

    Component to handle scroll content

    -

    +

    + +

    Functions

    init(self, node, key, init_value)Component init functionempty(self)Empty a progress bar
    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
    init(self, node, key, init_value)Component init function
    set_steps(self, steps, callback) Set points on progress bar to fire the callback
    set_to(self, to)Instant fill progress bar to value
    to(self, to[, callback]) Start animation of a progress bar
    - - - - - - - - - - - - + + + + + + + + + + + +
    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)
    scroll_to(vector3[, is_instant])Start scroll to target point
    set_border(self, border) Set the scroll possibly area
    set_inert(self, state)Enable or disable scroll inert.
    set_points(self, points)Set points of interest.

    @@ -102,6 +105,61 @@

    Functions

    +
    + + init(self, index[, skip_cb]) +
    +
    + Scroll to item in scroll by point index + + +

    Parameters:

    + + + + + + +
    +
    + + on_point_move(self, callback) +
    +
    + Set the callback on scrolling to point (if exist) + + +

    Parameters:

    + + + + + + +
    scroll_to(vector3[, is_instant]) @@ -134,11 +192,11 @@
    - - init(self, index[, skip_cb]) + + set_border(self, border)
    - Scroll to item in scroll by point index + Set the scroll possibly area

    Parameters:

    @@ -147,40 +205,9 @@ 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:

    - @@ -217,11 +244,12 @@
    - - on_point_move(self, callback) + + set_points(self, points)
    - Set the callback on scrolling to point (if exist) + Set points of interest. + Scroll will always centered on closer points

    Parameters:

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

    Parameters:

    - @@ -273,7 +276,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-07 01:09:38 +Last updated 2020-02-23 13:01:03
    diff --git a/docs/modules/druid.slider.html b/docs/modules/druid.slider.html index 4a71669..fb5dc21 100644 --- a/docs/modules/druid.slider.html +++ b/docs/modules/druid.slider.html @@ -4,7 +4,7 @@ Defold Druid UI Library - + @@ -34,23 +34,24 @@

    Modules

    @@ -60,7 +61,9 @@

    Module druid.slider

    Druid slider component

    -

    +

    + +

    @@ -74,7 +77,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-07 01:09:38 +Last updated 2020-02-23 13:01:03
    diff --git a/docs/modules/druid.text.html b/docs/modules/druid.text.html index c35de59..a1ec437 100644 --- a/docs/modules/druid.text.html +++ b/docs/modules/druid.text.html @@ -4,7 +4,7 @@ Defold Druid UI Library - + @@ -38,23 +38,24 @@

    Modules

    @@ -65,30 +66,32 @@

    Module druid.text

    Component to handle all GUI texts Good working with localization system

    -

    +

    + +

    Functions

    - - + + - - + + - - + +
    set_to(self, set_to)Set text to text fieldset_alpha(self, alpha)Set alpha
    set_color(self, color) Set color
    set_alpha(self, alpha)Set alphaset_pivot(self, pivot)Set text pivot.
    set_scale(self, scale) Set scale
    set_pivot(self, pivot)Set text pivot.set_to(self, set_to)Set text to text field
    @@ -100,11 +103,11 @@
    - - set_to(self, set_to) + + set_alpha(self, alpha)
    - Set text to text field + Set alpha

    Parameters:

    @@ -113,9 +116,9 @@ table Component instance -
  • set_to - string - Text for node +
  • alpha + number + Alpha for node
    • @@ -150,11 +153,12 @@
    - - set_alpha(self, alpha) + + set_pivot(self, pivot)
    - Set alpha + Set text pivot. Text will re-anchor inside + his text area

    Parameters:

    @@ -163,9 +167,9 @@ table Component instance -
  • alpha - number - Alpha for node +
  • pivot + gui.pivot + Gui pivot constant
    • @@ -200,12 +204,11 @@
    - - set_pivot(self, pivot) + + set_to(self, set_to)
    - Set text pivot. Text will re-anchor inside - his text area + Set text to text field

    Parameters:

    @@ -214,9 +217,9 @@ table Component instance -
  • pivot - gui.pivot - Gui pivot constant +
  • set_to + string + Text for node
    • @@ -232,7 +235,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-07 01:09:38 +Last updated 2020-02-23 13:01:03
    diff --git a/docs/modules/druid.timer.html b/docs/modules/druid.timer.html index afc6f94..afa6a7a 100644 --- a/docs/modules/druid.timer.html +++ b/docs/modules/druid.timer.html @@ -4,7 +4,7 @@ Defold Druid UI Library - + @@ -38,23 +38,24 @@

    Modules

    @@ -64,22 +65,24 @@

    Module druid.timer

    Component to handle GUI timers

    -

    +

    + +

    Functions

    - - + + - - + +
    set_to(self, set_to)Set text to text fieldset_interval(self, from, to)Set time interval
    set_state(self, is_on) Called when update
    set_interval(self, from, to)Set time intervalset_to(self, set_to)Set text to text field
    @@ -91,11 +94,11 @@
    - - set_to(self, set_to) + + set_interval(self, from, to)
    - Set text to text field + Set time interval

    Parameters:

    @@ -104,9 +107,13 @@ table Component instance -
  • set_to +
  • from number - Value in seconds + Start time in seconds +
    • +
  • to + number + Target time in seconds
    • @@ -141,11 +148,11 @@
    - - set_interval(self, from, to) + + set_to(self, set_to)
    - Set time interval + Set text to text field

    Parameters:

    @@ -154,13 +161,9 @@ table Component instance -
  • from +
  • set_to number - Start time in seconds -
    • -
  • to - number - Target time in seconds + Value in seconds
    • @@ -176,7 +179,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-07 01:09:38 +Last updated 2020-02-23 13:01:03
    diff --git a/docs/modules/const.html b/docs/modules/druid_event.html similarity index 56% rename from docs/modules/const.html rename to docs/modules/druid_event.html index 0b50a56..f6bda44 100644 --- a/docs/modules/const.html +++ b/docs/modules/druid_event.html @@ -4,7 +4,7 @@ Defold Druid UI Library - + @@ -30,34 +30,28 @@
  • Index
    • -

    Contents

    -

    Modules

    @@ -65,79 +59,25 @@
    -

    Module const

    -

    Druid constants

    -

    +

    Module druid_event

    +

    Lua event small library

    +

    + +

    -

    Tables

    - - - - - -
    pivots
    -

    Fields

    - - - - - -
    ON_MESSAGEInterests


    -

    Tables

    - -
    -
    - - pivots -
    -
    - - - -

    Fields:

    -
      -
    • test - test -
      • -
    - - - - - -
    -
    -

    Fields

    - -
    -
    - - ON_MESSAGE -
    -
    - Interests - - - - - - - -
    -
    generated by LDoc 1.4.6 -Last updated 2020-02-07 01:01:14 +Last updated 2020-02-23 13:01:03
    diff --git a/docs/modules/druid_instance.html b/docs/modules/druid_instance.html index fc11032..719a0ca 100644 --- a/docs/modules/druid_instance.html +++ b/docs/modules/druid_instance.html @@ -4,7 +4,7 @@ Defold Druid UI Library - + @@ -38,23 +38,24 @@

    Modules

    @@ -71,8 +72,9 @@
  • druid.button
  • druid.blocker
  • druid.back_handler
    • +
  • druid.input
  • druid.text
    • -
  • druid.locale
    • +
  • druid.lang_text
  • druid.timer
  • druid.progress
  • druid.grid
    • @@ -86,69 +88,25 @@

    Functions

    - - - - - - - - - - - - - - - - - - - - - - - - - - + + - - + + - - - - - - - - - - - - - - - - - - - - - - + + @@ -159,12 +117,60 @@ + + + + + + + + + + + + + + + + + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    druid:initialize(table, table)Druid class constructor
    druid:create(component, ...) 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 componentdruid:initialize(table, table)Druid class constructor
    druid:new_back_handler(...) Create back_handler basic component
    druid:new_text(...)Create text basic componentdruid:new_blocker(...)Create blocker 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 componentdruid:new_button(...)Create button basic component
    druid:new_checkbox(...)Create checkbox_group basic component
    druid:new_grid(...)Create grid basic component
    druid:new_hover(...)Create hover basic component
    druid:new_input(...)Create input basic component
    druid:new_lang_text(...)Create lang_text basic component
    druid:new_progress(...)Create progress basic component
    druid:new_radio_group(...) Create radio_group basic component
    druid:new_progress_rich(...)Create progress_rich basic componentdruid:new_scroll(...)Create scroll basic component
    druid:new_slider(...)Create slider basic component
    druid:new_text(...)Create text basic component
    druid:new_timer(...)Create timer basic component
    druid:on_input(action_id, action)Druid on_input function
    druid:on_message(message_id, message, sender)Druid on_message function
    druid:remove(component)Remove component from druid instance.
    druid:update(dt)Druid update function
    @@ -175,31 +181,6 @@

    Functions

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

    Parameters:

    -
      -
    • table - style - Druid style module -
      • -
    • table - style - Druid style module -
      • -
    - - - - - -
    druid:create(component, ...) @@ -226,19 +207,22 @@
    - - druid:remove(component) + + druid:initialize(table, table)
    - Remove component from druid instance. - Component `on_remove` function will be invoked, if exist. + Druid class constructor

    Parameters:

      -
    • component - Component - Component instance +
    • table + style + Druid style module +
      • +
    • table + style + Druid style module
    @@ -248,93 +232,18 @@
    - - druid:update(dt) + + druid:new_back_handler(...)
    - 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 + Create back_handler basic component

    Parameters:

    • ... args - button init args + back_handler init args
    @@ -342,7 +251,7 @@
      Component - button component + back_handler component
    @@ -377,18 +286,18 @@
    - - druid:new_back_handler(...) + + druid:new_button(...)
    - Create back_handler basic component + Create button basic component

    Parameters:

    • ... args - back_handler init args + button init args
    @@ -396,196 +305,7 @@
      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 + button component
    @@ -645,6 +365,141 @@ +
    +
    + + druid:new_grid(...) +
    +
    + Create grid basic component + + +

    Parameters:

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

    Returns:

    +
      + + Component + grid component +
    + + + + +
    +
    + + druid:new_hover(...) +
    +
    + Create hover basic component + + +

    Parameters:

    +
      +
    • ... + args + hover init args +
      • +
    + +

    Returns:

    +
      + + Component + hover component +
    + + + + +
    +
    + + druid:new_input(...) +
    +
    + Create input basic component + + +

    Parameters:

    +
      +
    • ... + args + input init args +
      • +
    + +

    Returns:

    +
      + + Component + input component +
    + + + + +
    +
    + + druid:new_lang_text(...) +
    +
    + Create lang_text basic component + + +

    Parameters:

    +
      +
    • ... + args + lang_text init args +
      • +
    + +

    Returns:

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

    Parameters:

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

    Returns:

    +
      + + Component + progress component +
    + + + +
    @@ -674,18 +529,18 @@
    - - druid:new_progress_rich(...) + + druid:new_scroll(...)
    - Create progress_rich basic component + Create scroll basic component

    Parameters:

    • ... args - progress_rich init args + scroll init args
    @@ -693,12 +548,190 @@
      Component - progress_rich component + scroll component
    +
    +
    + + druid:new_slider(...) +
    +
    + Create slider basic component + + +

    Parameters:

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

    Returns:

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

    Parameters:

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

    Returns:

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

    Parameters:

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

    Returns:

    +
      + + Component + timer component +
    + + + + +
    +
    + + druid:on_input(action_id, action) +
    +
    + Druid on_input function + + +

    Parameters:

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

    Parameters:

    +
      +
    • message_id + hash + Messageid from onmessage +
      • +
    • message + table + Message from on_message +
      • +
    • sender + hash + Sender from on_message +
      • +
    + + + + + +
    +
    + + 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 +
      • +
    + + + + +
    @@ -707,7 +740,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-07 01:09:38 +Last updated 2020-02-23 13:01:03
    diff --git a/docs/modules/helper.formats.html b/docs/modules/helper.formats.html deleted file mode 100644 index 59952c4..0000000 --- a/docs/modules/helper.formats.html +++ /dev/null @@ -1,191 +0,0 @@ - - - - - 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 2020-02-07 01:01:59 -
    -
    - -