From f619b25ba8504c6eba7752b269435adedf32a884 Mon Sep 17 00:00:00 2001 From: Insality Date: Wed, 5 Feb 2020 02:42:36 +0300 Subject: [PATCH] Update docs --- config.ld | 1 - docs/index.html | 85 +++++----- docs/modules/base.back_handler.html | 16 +- docs/modules/base.blocker.html | 6 +- docs/modules/base.button.html | 27 +-- docs/modules/base.checkbox.html | 6 +- docs/modules/base.checkbox_group.html | 6 +- docs/modules/base.grid.html | 9 +- docs/modules/base.progress.html | 36 ++-- docs/modules/base.scroll.html | 39 +++-- docs/modules/base.slider.html | 6 +- docs/modules/base.text.html | 84 +++++----- docs/modules/base.timer.html | 20 ++- docs/modules/druid.html | 233 +++++--------------------- docs/modules/helper.animate.html | 34 ++-- docs/modules/helper.formats.html | 47 +++--- docs/modules/helper.html | 37 ++-- docs/modules/rich.progress_rich.html | 42 ++--- docs/modules/settings.html | 30 ++-- 19 files changed, 333 insertions(+), 431 deletions(-) diff --git a/config.ld b/config.ld index 92f8231..43d3a05 100644 --- a/config.ld +++ b/config.ld @@ -1,7 +1,6 @@ project='Druid' title='Defold Druid UI Library' description='Documentation for Druid Library' -format='lunamark' file={"./druid"} dir='./docs' style='!pale' diff --git a/docs/index.html b/docs/index.html index 59a5bb7..e8b905e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -31,25 +31,26 @@

Modules

@@ -62,55 +63,61 @@

Modules

- + - + - + - + - + - + - + + + + + - + - + - + - - + + - + - + @@ -119,23 +126,23 @@ - - - - - + - + - - + + + + + +
base.back_handlerdruid.back_handler Component to handle back key (android, backspace)
base.blockerdruid.blocker Component to block input on specify zone (node)
base.buttondruid.button Component to handle basic GUI button
base.checkboxdruid.checkbox Druid checkbox component
base.checkbox_groupdruid.checkbox_group Checkboux group module
base.griddruid.grid Component to handle placing components by row and columns.
base.progressdruid.localeComponent to handle all GUI texts + Good working with localization system
druid.progress Basic progress bar component
base.checkbox_groupdruid.radio_group Radio group module
base.scrolldruid.scroll Component to handle scroll content
base.sliderdruid.slider Druid slider component
base.textComponent to handle all GUI texts Good working with localization systemdruid.textComponent to handle all GUI texts + Good working with localization system
base.timerdruid.timer Component to handle GUI timers
constantsconst Druid constants
helperDruid helper module
helper.animateDruid helper module for animating GUI nodesText node or icon node can be nil
helper.formats Druid module with utils on string formats
rich.progress_richdruid.progress_rich Component for rich progress component
settingsDruid settings filecomponentBasic class for all Druid components.
druid_instanceDruid main class.
@@ -143,7 +150,7 @@
generated by LDoc 1.4.6 -Last updated 2019-12-05 22:04:11 +Last updated 2020-02-05 02:41:04
diff --git a/docs/modules/base.back_handler.html b/docs/modules/base.back_handler.html index 5d11f6e..50d1f20 100644 --- a/docs/modules/base.back_handler.html +++ b/docs/modules/base.back_handler.html @@ -44,18 +44,20 @@
  • base.checkbox
  • base.checkbox_group
  • base.grid
    • +
  • base.text
  • base.progress
  • base.checkbox_group
  • base.scroll
  • base.slider
  • base.text
  • base.timer
    • -
  • constants
    • +
  • const
  • druid
  • helper
  • helper.animate
  • helper.formats
  • rich.progress_rich
    • +
  • component
  • settings
    • @@ -99,15 +101,15 @@ @@ -129,11 +131,11 @@ @@ -149,7 +151,7 @@
    generated by LDoc 1.4.6 -Last updated 2019-12-05 22:04:11 +Last updated 2020-02-04 23:46:10
    diff --git a/docs/modules/base.blocker.html b/docs/modules/base.blocker.html index 9d0f4a5..e43d201 100644 --- a/docs/modules/base.blocker.html +++ b/docs/modules/base.blocker.html @@ -40,18 +40,20 @@
  • base.checkbox
  • base.checkbox_group
  • base.grid
    • +
  • base.text
  • base.progress
  • base.checkbox_group
  • base.scroll
  • base.slider
  • base.text
  • base.timer
    • -
  • constants
    • +
  • const
  • druid
  • helper
  • helper.animate
  • helper.formats
  • rich.progress_rich
    • +
  • component
  • settings
    • @@ -75,7 +77,7 @@
    generated by LDoc 1.4.6 -Last updated 2019-12-05 22:04:11 +Last updated 2020-02-04 23:46:10
    diff --git a/docs/modules/base.button.html b/docs/modules/base.button.html index f99cfcd..57ef749 100644 --- a/docs/modules/base.button.html +++ b/docs/modules/base.button.html @@ -44,18 +44,20 @@
  • base.checkbox
  • base.checkbox_group
  • base.grid
    • +
  • base.text
  • base.progress
  • base.checkbox_group
  • base.scroll
  • base.slider
  • base.text
  • base.timer
    • -
  • constants
    • +
  • const
  • druid
  • helper
  • helper.animate
  • helper.formats
  • rich.progress_rich
    • +
  • component
  • settings
    • @@ -103,29 +105,29 @@ @@ -147,7 +149,7 @@ @@ -161,18 +163,19 @@ set_click_zone(self, zone)
    - Strict button click area. Useful for no click events outside stencil node + Strict button click area. Useful for + no click events outside stencil node

    Parameters:

    @@ -188,7 +191,7 @@
    generated by LDoc 1.4.6 -Last updated 2019-12-05 22:04:11 +Last updated 2020-02-04 23:46:10
    diff --git a/docs/modules/base.checkbox.html b/docs/modules/base.checkbox.html index cc3dce8..92d23d3 100644 --- a/docs/modules/base.checkbox.html +++ b/docs/modules/base.checkbox.html @@ -40,18 +40,20 @@
  • base.checkbox
  • base.checkbox_group
  • base.grid
    • +
  • base.text
  • base.progress
  • base.checkbox_group
  • base.scroll
  • base.slider
  • base.text
  • base.timer
    • -
  • constants
    • +
  • const
  • druid
  • helper
  • helper.animate
  • helper.formats
  • rich.progress_rich
    • +
  • component
  • settings
    • @@ -75,7 +77,7 @@
    generated by LDoc 1.4.6 -Last updated 2019-12-05 22:04:11 +Last updated 2020-02-04 23:46:10
    diff --git a/docs/modules/base.checkbox_group.html b/docs/modules/base.checkbox_group.html index 2c8f1d9..34069ff 100644 --- a/docs/modules/base.checkbox_group.html +++ b/docs/modules/base.checkbox_group.html @@ -40,18 +40,20 @@
  • base.checkbox
  • base.checkbox_group
  • base.grid
    • +
  • base.text
  • base.progress
  • base.checkbox_group
  • base.scroll
  • base.slider
  • base.text
  • base.timer
    • -
  • constants
    • +
  • const
  • druid
  • helper
  • helper.animate
  • helper.formats
  • rich.progress_rich
    • +
  • component
  • settings
    • @@ -75,7 +77,7 @@
    generated by LDoc 1.4.6 -Last updated 2019-12-05 22:04:11 +Last updated 2020-02-04 23:46:10
    diff --git a/docs/modules/base.grid.html b/docs/modules/base.grid.html index c8e0f78..af5cf25 100644 --- a/docs/modules/base.grid.html +++ b/docs/modules/base.grid.html @@ -40,18 +40,20 @@
  • base.checkbox
  • base.checkbox_group
  • base.grid
    • +
  • base.text
  • base.progress
  • base.checkbox_group
  • base.scroll
  • base.slider
  • base.text
  • base.timer
    • -
  • constants
    • +
  • const
  • druid
  • helper
  • helper.animate
  • helper.formats
  • rich.progress_rich
    • +
  • component
  • settings
    • @@ -61,7 +63,8 @@

    Module base.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 +78,7 @@
    generated by LDoc 1.4.6 -Last updated 2019-12-05 22:04:11 +Last updated 2020-02-04 23:46:10
    diff --git a/docs/modules/base.progress.html b/docs/modules/base.progress.html index ba8e905..5622257 100644 --- a/docs/modules/base.progress.html +++ b/docs/modules/base.progress.html @@ -44,18 +44,20 @@
  • base.checkbox
  • base.checkbox_group
  • base.grid
    • +
  • base.text
  • base.progress
  • base.checkbox_group
  • base.scroll
  • base.slider
  • base.text
  • base.timer
    • -
  • constants
    • +
  • const
  • druid
  • helper
  • helper.animate
  • helper.formats
  • rich.progress_rich
    • +
  • component
  • settings
    • @@ -119,19 +121,19 @@ @@ -152,7 +154,7 @@ @@ -173,7 +175,7 @@ @@ -194,11 +196,11 @@ @@ -219,7 +221,7 @@ @@ -240,15 +242,15 @@ @@ -269,15 +271,15 @@ @@ -294,7 +296,7 @@
    generated by LDoc 1.4.6 -Last updated 2019-12-05 22:04:11 +Last updated 2020-02-04 23:46:10
    diff --git a/docs/modules/base.scroll.html b/docs/modules/base.scroll.html index dabe409..087322d 100644 --- a/docs/modules/base.scroll.html +++ b/docs/modules/base.scroll.html @@ -44,18 +44,20 @@
  • base.checkbox
  • base.checkbox_group
  • base.grid
    • +
  • base.text
  • base.progress
  • base.checkbox_group
  • base.scroll
  • base.slider
  • base.text
  • base.timer
    • -
  • constants
    • +
  • const
  • druid
  • helper
  • helper.animate
  • helper.formats
  • rich.progress_rich
    • +
  • component
  • settings
    • @@ -115,11 +117,11 @@ @@ -146,15 +148,15 @@ @@ -169,18 +171,19 @@ set_points(self, points)
    - Set points of interest. Scroll will always centered on closer points + Set points of interest. + Scroll will always centered on closer points

    Parameters:

    @@ -194,18 +197,20 @@ set_inert(self, state)
    - Enable or disable scroll inert. If disabled, scroll through points (if exist) If no points, just simple drag without inertion + Enable or disable scroll inert. + If disabled, scroll through points (if exist) + If no points, just simple drag without inertion

    Parameters:

    @@ -226,11 +231,11 @@ @@ -251,11 +256,11 @@ @@ -271,7 +276,7 @@
    generated by LDoc 1.4.6 -Last updated 2019-12-05 22:04:11 +Last updated 2020-02-04 23:46:10
    diff --git a/docs/modules/base.slider.html b/docs/modules/base.slider.html index 14f8f6e..37e794d 100644 --- a/docs/modules/base.slider.html +++ b/docs/modules/base.slider.html @@ -40,18 +40,20 @@
  • base.checkbox
  • base.checkbox_group
  • base.grid
    • +
  • base.text
  • base.progress
  • base.checkbox_group
  • base.scroll
  • base.slider
  • base.text
  • base.timer
    • -
  • constants
    • +
  • const
  • druid
  • helper
  • helper.animate
  • helper.formats
  • rich.progress_rich
    • +
  • component
  • settings
    • @@ -75,7 +77,7 @@
    generated by LDoc 1.4.6 -Last updated 2019-12-05 22:04:11 +Last updated 2020-02-04 23:46:10
    diff --git a/docs/modules/base.text.html b/docs/modules/base.text.html index 26e0f16..7b29689 100644 --- a/docs/modules/base.text.html +++ b/docs/modules/base.text.html @@ -44,18 +44,20 @@
  • base.checkbox
  • base.checkbox_group
  • base.grid
    • +
  • base.text
  • base.progress
  • base.checkbox_group
  • base.scroll
  • base.slider
  • base.text
  • base.timer
    • -
  • constants
    • +
  • const
  • druid
  • helper
  • helper.animate
  • helper.formats
  • rich.progress_rich
    • +
  • component
  • settings
    • @@ -64,16 +66,13 @@

    Module base.text

    -

    Component to handle all GUI texts Good working with localization system

    +

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

    Functions

    - - - - @@ -90,6 +89,10 @@ + + + +
    translate(self, locale_id)Translate the text by locale_id
    set_to(self, set_to) Set text to text fieldset_scale(self, scale) Set scale
    set_pivot(self, pivot)Set text pivot.

    @@ -99,31 +102,6 @@

    Functions

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

    Parameters:

    -
      -
    • self - table - Component instance -
      • -
    • locale_id - string - Locale id -
      • -
    - - - - - -
    set_to(self, set_to) @@ -136,11 +114,11 @@
    • self table - Component instance + Component instance
    • set_to string - Text for node + Text for node
    @@ -161,11 +139,11 @@
    • self table - Component instance + Component instance
    • color vmath.vector4 - Color for node + Color for node
    @@ -186,11 +164,11 @@
    • self table - Component instance + Component instance
    • alpha number - Alpha for node + Alpha for node
    @@ -211,11 +189,37 @@
    • self table - Component instance + Component instance
    • scale vmath.vector3 - Scale for node + Scale for node +
      • +
    + + + + + +
    +
    + + set_pivot(self, pivot) +
    +
    + Set text pivot. Text will re-anchor inside + his text area + + +

    Parameters:

    + @@ -231,7 +235,7 @@
    generated by LDoc 1.4.6 -Last updated 2019-12-05 22:04:11 +Last updated 2020-02-04 23:46:10
    diff --git a/docs/modules/base.timer.html b/docs/modules/base.timer.html index dc66bfb..7c5d6fb 100644 --- a/docs/modules/base.timer.html +++ b/docs/modules/base.timer.html @@ -44,18 +44,20 @@
  • base.checkbox
  • base.checkbox_group
  • base.grid
    • +
  • base.text
  • base.progress
  • base.checkbox_group
  • base.scroll
  • base.slider
  • base.text
  • base.timer
    • -
  • constants
    • +
  • const
  • druid
  • helper
  • helper.animate
  • helper.formats
  • rich.progress_rich
    • +
  • component
  • settings
    • @@ -103,11 +105,11 @@ @@ -128,11 +130,11 @@ @@ -153,15 +155,15 @@ @@ -177,7 +179,7 @@
    generated by LDoc 1.4.6 -Last updated 2019-12-05 22:04:11 +Last updated 2020-02-04 23:46:10
    diff --git a/docs/modules/druid.html b/docs/modules/druid.html index f7b1a7a..41b769f 100644 --- a/docs/modules/druid.html +++ b/docs/modules/druid.html @@ -33,31 +33,31 @@

    Contents

    Modules

    @@ -66,37 +66,25 @@

    Module druid

    Druid UI Library.

    -

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

    +

    + Powerful Defold component based UI library. Use standart + components or make your own game-specific to make amazing + 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 +

    Functions

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

    Tables

    - - - - + +
    compsBasic componentsnew(context[, style])Create Druid instance.
    @@ -112,18 +100,20 @@ register(name, module)
    - Register external module + Register external druid component. + After register you can create the component with + druid_instance:new_{name}. For example `druid:new_button(...)`

    Parameters:

    @@ -134,166 +124,35 @@
    - new(component_script) + new(context[, style])
    - Create UI instance for ui elements + Create Druid instance.

    Parameters:

    Returns:

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

    Parameters:

    - - - - - - -
    -
    - - _fct_metatable.on_input(self, action_id, action) -
    -
    - Called ON_INPUT - - -

    Parameters:

    - - - - - - -
    -
    - - _fct_metatable.update(self, dt) -
    -
    - Called on_update - - -

    Parameters:

    - - - - - - -
    - -

    Tables

    - -
    -
    - - comps -
    -
    - Basic components - - -

    Fields:

    -
      -
    • button - -
      • -
    • blocker - -
      • -
    • back_handler - -
      • -
    • text - -
      • -
    • timer - -
      • -
    • progress - -
      • -
    • grid - -
      • -
    • scroll - -
      • -
    • slider - -
      • -
    • checkbox - -
      • -
    • checkbox_group - -
      • -
    • radio_group - -
      • -
    • progress_rich - -
      • -
    - - - - -
    @@ -302,7 +161,7 @@
    generated by LDoc 1.4.6 -Last updated 2019-12-05 22:04:11 +Last updated 2020-02-05 02:41:04
    diff --git a/docs/modules/helper.animate.html b/docs/modules/helper.animate.html index 63f59ee..b07fb30 100644 --- a/docs/modules/helper.animate.html +++ b/docs/modules/helper.animate.html @@ -34,25 +34,27 @@

    Modules

    @@ -75,7 +77,7 @@
    generated by LDoc 1.4.6 -Last updated 2019-12-05 22:04:11 +Last updated 2020-02-05 00:14:12
    diff --git a/docs/modules/helper.formats.html b/docs/modules/helper.formats.html index 6cf1ce1..e89c3e9 100644 --- a/docs/modules/helper.formats.html +++ b/docs/modules/helper.formats.html @@ -38,25 +38,26 @@

    Modules

    @@ -103,18 +104,18 @@

    Returns:

      - string with need count of zero (1,3) -> 001 + string with need count of zero (1,3) -> 001
    @@ -133,7 +134,7 @@ @@ -159,11 +160,11 @@ @@ -184,7 +185,7 @@
    generated by LDoc 1.4.6 -Last updated 2019-12-05 22:04:11 +Last updated 2020-02-05 02:41:04
    diff --git a/docs/modules/helper.html b/docs/modules/helper.html index e7ecf16..6e1efff 100644 --- a/docs/modules/helper.html +++ b/docs/modules/helper.html @@ -38,25 +38,26 @@

    Modules

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

    Module helper

    -

    Druid helper module

    +

    Text node or icon node can be nil

    @@ -146,7 +147,7 @@
    generated by LDoc 1.4.6 -Last updated 2019-12-05 22:04:11 +Last updated 2020-02-05 02:41:04
    diff --git a/docs/modules/rich.progress_rich.html b/docs/modules/rich.progress_rich.html index 0ce5b2e..e69b51e 100644 --- a/docs/modules/rich.progress_rich.html +++ b/docs/modules/rich.progress_rich.html @@ -38,24 +38,26 @@

    Modules

    @@ -103,11 +105,11 @@ @@ -128,7 +130,7 @@ @@ -149,15 +151,15 @@ @@ -174,7 +176,7 @@
    generated by LDoc 1.4.6 -Last updated 2019-12-05 22:04:11 +Last updated 2020-02-05 00:02:17
    diff --git a/docs/modules/settings.html b/docs/modules/settings.html index 205e608..4dbda1f 100644 --- a/docs/modules/settings.html +++ b/docs/modules/settings.html @@ -34,24 +34,26 @@

    Modules

    @@ -75,7 +77,7 @@
    generated by LDoc 1.4.6 -Last updated 2019-12-05 22:04:11 +Last updated 2020-02-05 00:02:17