diff --git a/config.ld b/config.ld index 00b4508..6da4f05 100644 --- a/config.ld +++ b/config.ld @@ -1,7 +1,12 @@ project='Druid' title='Defold Druid UI Library' description='Documentation for Druid Library' -file={"./druid"} +file={"./druid", + exclude = { + "./druid/styles/", + "./druid/system/middleclass.lua" + } +} package='druid' sort=false dir='./docs' diff --git a/docs/index.html b/docs/index.html index aa797fc..c7d2383 100644 --- a/docs/index.html +++ b/docs/index.html @@ -37,6 +37,7 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • +
  • druid.hover
  • druid.input
  • druid.lang_text
  • druid.progress
    • @@ -67,7 +68,7 @@ druid.blocker - Component to block input on specify zone (node) + Component to block input on specify zone by node druid.button @@ -79,16 +80,20 @@ druid.checkbox_group - Checkboux group module + Checkbox group module druid.grid Component to handle placing components by row and columns. - druid.input + druid.hover Component to handle hover node interaction + + druid.input + Druid input text component. + druid.lang_text Component to handle all GUI texts @@ -96,7 +101,7 @@ druid.progress - Basic progress bar component + Basic progress bar component. druid.radio_group @@ -104,7 +109,7 @@ druid.scroll - Component to handle scroll content + Component to handle scroll content. druid.slider @@ -112,12 +117,11 @@ druid.text - Component to handle all GUI texts - Good working with localization system + Component to handle all GUI texts. druid.timer - Component to handle GUI timers + Component to handle GUI timers. component @@ -145,7 +149,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-03-21 20:02:23 +Last updated 2020-03-21 21:42:52
    diff --git a/docs/modules/component.html b/docs/modules/component.html index 03ef47b..a145600 100644 --- a/docs/modules/component.html +++ b/docs/modules/component.html @@ -44,6 +44,7 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • +
  • druid.hover
  • druid.input
  • druid.lang_text
  • druid.progress
    • @@ -396,7 +397,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-24 00:03:02 +Last updated 2020-03-21 21:42:52
    diff --git a/docs/modules/druid.back_handler.html b/docs/modules/druid.back_handler.html index 2943f1f..19bd134 100644 --- a/docs/modules/druid.back_handler.html +++ b/docs/modules/druid.back_handler.html @@ -33,6 +33,7 @@

    Contents

    @@ -44,6 +45,7 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • +
  • druid.hover
  • druid.input
  • druid.lang_text
  • druid.progress
    • @@ -73,7 +75,7 @@

    Functions

    - + @@ -81,6 +83,17 @@
    init(self, callback[, Callback])init(callback[, Callback]) Component init function
    Input handler for component
    +

    Tables

    + + + + + + + + + +
    EventsComponent events
    FieldsComponent fields


    @@ -91,7 +104,7 @@
    - init(self, callback[, Callback]) + init(callback[, Callback])
    Component init function @@ -99,10 +112,6 @@

    Parameters:

    +
    +

    Tables

    + +
    +
    + + Events +
    +
    + Component events + + +

    Fields:

    + + + + + + +
    +
    + + Fields +
    +
    + Component fields + + +

    Fields:

    + + + + + +
    @@ -151,7 +206,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-24 00:03:02 +Last updated 2020-03-21 21:42:52
    diff --git a/docs/modules/druid.blocker.html b/docs/modules/druid.blocker.html index ad72a4e..1c9d698 100644 --- a/docs/modules/druid.blocker.html +++ b/docs/modules/druid.blocker.html @@ -30,6 +30,11 @@
  • Index
    • +

    Contents

    +

    Modules

    @@ -40,6 +45,7 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • +
  • druid.hover
  • druid.input
  • druid.lang_text
  • druid.progress
    • @@ -60,24 +66,166 @@

    Module druid.blocker

    -

    Component to block input on specify zone (node)

    +

    Component to block input on specify zone by node

    +

    Functions

    + + + + + + + + + + + + + +
    init(node)Component init function
    set_enabled(state)Set enabled blocker component state
    is_enabled()Return blocked enabled state
    +

    Tables

    + + + + + + + + + +
    EventsComponent events
    FieldsComponent fields


    +

    Functions

    + +
    +
    + + init(node) +
    +
    + Component init function + + +

    Parameters:

    +
      +
    • node + node + Gui node +
      • +
    + + + + + +
    +
    + + set_enabled(state) +
    +
    + Set enabled blocker component state + + +

    Parameters:

    +
      +
    • state + bool + Enabled state +
      • +
    + + + + + +
    +
    + + is_enabled() +
    +
    + Return blocked enabled state + + + +

    Returns:

    +
      + + bool + True, if blocker is enabled +
    + + + + +
    +
    +

    Tables

    + +
    +
    + + Events +
    +
    + Component events + + +

    Fields:

    +
      +
    • on_click + druid_event + On release button callback +
      • +
    • on_enable_change + druid_event + On enable/disable callback +
      • +
    + + + + + +
    +
    + + Fields +
    +
    + Component fields + + +

    Fields:

    +
      +
    • node + node + Trigger node +
      • +
    + + + + + +
    +
    generated by LDoc 1.4.6 -Last updated 2020-02-24 00:03:02 +Last updated 2020-03-21 21:42:52
    diff --git a/docs/modules/druid.button.html b/docs/modules/druid.button.html index 886be31..a7097f9 100644 --- a/docs/modules/druid.button.html +++ b/docs/modules/druid.button.html @@ -45,6 +45,7 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • +
  • druid.hover
  • druid.input
  • druid.lang_text
  • druid.progress
    • @@ -74,19 +75,27 @@

    Functions

    - + - - + + - + + + + + - + + + + +
    init(self, node, callback[, params[, anim_node[, event]]])init(node, callback[, params[, anim_node[, event]]]) Component init function
    disable_animation(self)Disable all button animationsset_enabled(state)Set enabled button component state
    set_click_zone(self, zone)is_enabled()Return button enabled state
    set_click_zone(zone) Strict button click area.
    get_key_trigger(self)set_key_trigger(key)Set key-code to trigger this button
    get_key_trigger() Get key-code to trigger this button
    @@ -115,7 +124,7 @@
    - init(self, node, callback[, params[, anim_node[, event]]]) + init(node, callback[, params[, anim_node[, event]]])
    Component init function @@ -123,10 +132,6 @@

    Parameters:

    - - disable_animation(self) + + set_enabled(state)
    - Disable all button animations + Set enabled button component state

    Parameters:

    @@ -177,10 +182,30 @@ +
    +
    + + is_enabled() +
    +
    + Return button enabled state + + + +

    Returns:

    +
      + + bool + True, if button is enabled +
    + + + +
    - set_click_zone(self, zone) + set_click_zone(zone)
    Strict button click area. Useful for @@ -189,10 +214,6 @@

    Parameters:

    +
    + + set_key_trigger(key) +
    +
    + Set key-code to trigger this button + + +

    Parameters:

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

    Parameters:

    - - + hash + The action_id of the key + @@ -294,10 +334,6 @@ any Params to click callbacks -
  • hover_anim - boolean - Is hover anim enabled -
  • hover druid.hover Druid hover logic component @@ -360,7 +396,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-24 00:03:02 +Last updated 2020-03-21 21:42:52
    diff --git a/docs/modules/druid.checkbox.html b/docs/modules/druid.checkbox.html index 66054fe..cb9ad9f 100644 --- a/docs/modules/druid.checkbox.html +++ b/docs/modules/druid.checkbox.html @@ -30,6 +30,11 @@
  • Index
    • +

    Contents

    +

    Modules

    @@ -40,6 +45,7 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • +
  • druid.hover
  • druid.input
  • druid.lang_text
  • druid.progress
    • @@ -66,18 +72,203 @@

    +

    Functions

    + + + + + + + + + + + + + +
    init(node, callback[, click=node])Component init function
    set_state(state, is_silent)Set checkbox state
    get_state()Return checkbox state
    +

    Tables

    + + + + + + + + + + + + + +
    EventsComponent events
    FieldsComponent fields
    StyleComponent style params


    +

    Functions

    + +
    +
    + + init(node, callback[, click=node]) +
    +
    + Component init function + + +

    Parameters:

    +
      +
    • node + node + Gui node +
      • +
    • callback + function + Checkbox callback +
      • +
    • click + node + node Trigger node, by default equals to node + (default node) +
      • +
    + + + + + +
    +
    + + set_state(state, is_silent) +
    +
    + Set checkbox state + + +

    Parameters:

    +
      +
    • state + bool + Checkbox state +
      • +
    • is_silent + bool + Don't trigger onchangestate if true +
      • +
    + + + + + +
    +
    + + get_state() +
    +
    + Return checkbox state + + + +

    Returns:

    +
      + + bool + Checkbox state +
    + + + + +
    +
    +

    Tables

    + +
    +
    + + Events +
    +
    + Component events + + +

    Fields:

    +
      +
    • on_change_state + druid_event + On change state callback +
      • +
    + + + + + +
    +
    + + Fields +
    +
    + Component fields + + +

    Fields:

    +
      +
    • node + node + Visual node +
      • +
    • click_node + node + Button trigger node + (default node) +
      • +
    • button + druid.button + Button component from click_node +
      • +
    + + + + + +
    +
    + + Style +
    +
    + Component style params + + +

    Fields:

    +
      +
    • on_change_state + function + (self, node, state) +
      • +
    + + + + + +
    +
    generated by LDoc 1.4.6 -Last updated 2020-02-24 00:03:02 +Last updated 2020-03-21 21:42:52
    diff --git a/docs/modules/druid.checkbox_group.html b/docs/modules/druid.checkbox_group.html index 1c40d26..920762e 100644 --- a/docs/modules/druid.checkbox_group.html +++ b/docs/modules/druid.checkbox_group.html @@ -30,6 +30,11 @@
  • Index
    • +

    Contents

    +

    Modules

    @@ -40,6 +45,7 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • +
  • druid.hover
  • druid.input
  • druid.lang_text
  • druid.progress
    • @@ -60,24 +66,171 @@

    Module druid.checkbox_group

    -

    Checkboux group module

    +

    Checkbox group module

    +

    Functions

    + + + + + + + + + + + + + +
    init(node, callback[, click=node])Component init function
    set_state(state)Set checkbox group state
    get_state()Return checkbox group state
    +

    Tables

    + + + + + + + + + +
    EventsComponent events
    FieldsComponent fields


    +

    Functions

    + +
    +
    + + init(node, callback[, click=node]) +
    +
    + Component init function + + +

    Parameters:

    +
      +
    • node + node[] + Array of gui node +
      • +
    • callback + function + Checkbox callback +
      • +
    • click + node[] + node Array of trigger nodes, by default equals to nodes + (default node) +
      • +
    + + + + + +
    +
    + + set_state(state) +
    +
    + Set checkbox group state + + +

    Parameters:

    +
      +
    • state + bool[] + Array of checkbox state +
      • +
    + + + + + +
    +
    + + get_state() +
    +
    + Return checkbox group state + + + +

    Returns:

    +
      + + bool[] + Array if checkboxes state +
    + + + + +
    +
    +

    Tables

    + +
    +
    + + Events +
    +
    + Component events + + +

    Fields:

    +
      +
    • on_checkbox_click + druid_event + On any checkbox click +
      • +
    + + + + + +
    +
    + + Fields +
    +
    + Component fields + + +

    Fields:

    +
      +
    • checkboxes + table + Array of checkbox components +
      • +
    + + + + + +
    +
    generated by LDoc 1.4.6 -Last updated 2020-02-24 00:03:02 +Last updated 2020-03-21 21:42:52
    diff --git a/docs/modules/druid.grid.html b/docs/modules/druid.grid.html index 69dee2b..3df4a00 100644 --- a/docs/modules/druid.grid.html +++ b/docs/modules/druid.grid.html @@ -30,6 +30,11 @@
  • Index
    • +

    Contents

    +

    Modules

    @@ -40,6 +45,7 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • +
  • druid.hover
  • druid.input
  • druid.lang_text
  • druid.progress
    • @@ -64,18 +70,298 @@

    Grid can anchor your elements, get content size and other

    +

    Functions

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    init(parent, element[, in_row=1])Component init function
    set_offset(offset)Set grid items offset, the distance between items
    set_anchor(acnhor)Set grid anchor
    add(item[, index])Add new item to the grid
    get_size()Return grid content size
    get_all_pos()Return array of all node positions
    clear()Clear all items from the grid
    +

    Tables

    + + + + + + + + + +
    EventsComponent events
    FieldsComponent fields


    +

    Functions

    + +
    +
    + + init(parent, element[, in_row=1]) +
    +
    + Component init function + + +

    Parameters:

    +
      +
    • parent + node + The gui node parent, where items will be placed +
      • +
    • element + node + Element prefab. Need to get it size +
      • +
    • in_row + number + How many nodes in row can be placed + (default 1) +
      • +
    + + + + + +
    +
    + + set_offset(offset) +
    +
    + Set grid items offset, the distance between items + + +

    Parameters:

    +
      +
    • offset + vector3 + Offset +
      • +
    + + + + + +
    +
    + + set_anchor(acnhor) +
    +
    + Set grid anchor + + +

    Parameters:

    +
      +
    • acnhor + vector3 + Anchor +
      • +
    + + + + + +
    +
    + + add(item[, index]) +
    +
    + Add new item to the grid + + +

    Parameters:

    +
      +
    • item + node + Gui node +
      • +
    • index + number + The item position. By default add as last item + (optional) +
      • +
    + + + + + +
    +
    + + get_size() +
    +
    + Return grid content size + + + +

    Returns:

    +
      + + vector3 + The grid content size +
    + + + + +
    +
    + + get_all_pos() +
    +
    + Return array of all node positions + + + +

    Returns:

    +
      + + vector3[] + All grid node positions +
    + + + + +
    +
    + + clear() +
    +
    + Clear all items from the grid + + + + + + + +
    +
    +

    Tables

    + +
    +
    + + Events +
    +
    + Component events + + +

    Fields:

    +
      +
    • on_add_item + druid_event + On item add callback +
      • +
    • on_remove_item + druid_event + On item remove callback +
      • +
    • on_clear + druid_event + On grid clear callback +
      • +
    • on_update_positions + druid_event + On update item positions callback +
      • +
    + + + + + +
    +
    + + Fields +
    +
    + Component fields + + +

    Fields:

    +
      +
    • parent + node + Parent gui node +
      • +
    • nodes + node[] + List of all grid nodes +
      • +
    • offset + vector3 + Item distance between each other items +
      • +
    • anchor + vector3 + Item anchor +
      • +
    • node_size + vector3 + Item size +
      • +
    • border + vector4 + The size of item content +
      • +
    • border_offer + vector3 + The border offset for correct anchor calculations +
      • +
    + + + + + +
    +
    generated by LDoc 1.4.6 -Last updated 2020-02-24 00:03:02 +Last updated 2020-03-21 21:42:52
    diff --git a/docs/modules/druid.helper.html b/docs/modules/druid.helper.html index c81e977..5091943 100644 --- a/docs/modules/druid.helper.html +++ b/docs/modules/druid.helper.html @@ -44,6 +44,7 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • +
  • druid.hover
  • druid.input
  • druid.lang_text
  • druid.progress
    • @@ -226,7 +227,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-24 00:03:02 +Last updated 2020-03-21 21:42:52
    diff --git a/docs/modules/druid.hover.html b/docs/modules/druid.hover.html new file mode 100644 index 0000000..da05a4d --- /dev/null +++ b/docs/modules/druid.hover.html @@ -0,0 +1,209 @@ + + + + + Defold Druid UI Library + + + + +
    + +
    + +
    +
    +
    + + +
    + + + + + + +
    + +

    Module druid.hover

    +

    Component to handle hover node interaction

    +

    + +

    + + +

    Functions

    + + + + + + + + + + + + + +
    init(node, on_hover_callback)Component init function
    set_hover(state)Set hover state
    set_click_zone(zone)Strict button click area.
    +

    Tables

    + + + + + +
    EventsComponent events
    + +
    +
    + + +

    Functions

    + +
    +
    + + init(node, on_hover_callback) +
    +
    + Component init function + + +

    Parameters:

    +
      +
    • node + node + Gui node +
      • +
    • on_hover_callback + function + Hover callback +
      • +
    + + + + + +
    +
    + + set_hover(state) +
    +
    + Set hover state + + +

    Parameters:

    +
      +
    • state + bool + The hover state +
      • +
    + + + + + +
    +
    + + set_click_zone(zone) +
    +
    + Strict button click area. Useful for + no click events outside stencil node + + +

    Parameters:

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

    Tables

    + +
    +
    + + Events +
    +
    + Component events + + +

    Fields:

    +
      +
    • on_hover + druid_event + On hover callback +
      • +
    + + + + + +
    +
    + + +
    +
    +
    +generated by LDoc 1.4.6 +Last updated 2020-03-21 21:42:52 +
    +
    + + diff --git a/docs/modules/druid.html b/docs/modules/druid.html index 46038ef..7e40457 100644 --- a/docs/modules/druid.html +++ b/docs/modules/druid.html @@ -44,6 +44,7 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • +
  • druid.hover
  • druid.input
  • druid.lang_text
  • druid.progress
    • @@ -68,8 +69,8 @@

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

    + components or make your own game-specific components to + make amazing GUI in your games.

    Contains the several basic components and examples to how to do your custom complex components to @@ -171,7 +172,7 @@

    generated by LDoc 1.4.6 -Last updated 2020-02-24 00:03:02 +Last updated 2020-03-21 21:42:52
    diff --git a/docs/modules/druid.input.html b/docs/modules/druid.input.html index da6d315..b453a81 100644 --- a/docs/modules/druid.input.html +++ b/docs/modules/druid.input.html @@ -30,10 +30,6 @@
  • Index
    • -

    Contents

    -

    Modules

    @@ -44,6 +40,7 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • +
  • druid.hover
  • druid.input
  • druid.lang_text
  • druid.progress
    • @@ -64,94 +61,23 @@

    Module druid.input

    -

    Component to handle hover node interaction

    -

    - -

    +

    Druid input text component.

    +

    Carry on user text input + UNIMPLEMENTED

    -

    Functions

    - - - - - - - - - -
    hover:init(self, node, on_hover_callback)Component init function
    button:set_click_zone(self, zone)Strict button click area.


    -

    Functions

    - -
    -
    - - hover:init(self, node, on_hover_callback) -
    -
    - Component init function - - -

    Parameters:

    -
      -
    • self - table - Component instance -
      • -
    • node - node - Gui node -
      • -
    • on_hover_callback - function - Hover callback -
      • -
    - - - - - -
    -
    - - 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-24 00:03:02 +Last updated 2020-03-21 21:42:52
    diff --git a/docs/modules/druid.lang_text.html b/docs/modules/druid.lang_text.html index 9f52f6b..9c5f2f6 100644 --- a/docs/modules/druid.lang_text.html +++ b/docs/modules/druid.lang_text.html @@ -33,6 +33,7 @@

    Contents

    @@ -44,6 +45,7 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • +
  • druid.hover
  • druid.input
  • druid.lang_text
  • druid.progress
    • @@ -74,10 +76,29 @@

    Functions

    - + + + + + + + + +
    text:translate(self, locale_id)init(node, locale_id, no_adjust)Component init function
    set_to(text)Setup raw text to lang_text component
    translate(locale_id) Translate the text by locale_id
    +

    Tables

    + + + + + + + + + +
    EventsComponent events
    FieldsComponent fields


    @@ -87,8 +108,58 @@
    - - text:translate(self, locale_id) + + init(node, locale_id, no_adjust) +
    +
    + Component init function + + +

    Parameters:

    +
      +
    • node + node + The text node +
      • +
    • locale_id + string + Default locale id +
      • +
    • no_adjust + bool + If true, will not correct text size +
      • +
    + + + + + +
    +
    + + set_to(text) +
    +
    + Setup raw text to lang_text component + + +

    Parameters:

    +
      +
    • text + string + Text for text node +
      • +
    + + + + + +
    +
    + + translate(locale_id)
    Translate the text by locale_id @@ -96,10 +167,6 @@

    Parameters:

      -
    • self - table - Component instance -
    • locale_id string Locale id @@ -110,6 +177,52 @@ +
    +
    +

    Tables

    + +
    +
    + + Events +
    +
    + Component events + + +

    Fields:

    +
      +
    • on_change + druid_event + On change text callback +
      • +
    + + + + + +
    +
    + + Fields +
    +
    + Component fields + + +

    Fields:

    +
      +
    • text + druid.text + The text component +
      • +
    + + + + +
    @@ -118,7 +231,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-24 00:03:02 +Last updated 2020-03-21 21:42:52
    diff --git a/docs/modules/druid.progress.html b/docs/modules/druid.progress.html index e8e1115..14ca013 100644 --- a/docs/modules/druid.progress.html +++ b/docs/modules/druid.progress.html @@ -33,6 +33,7 @@

    Contents

    @@ -44,6 +45,7 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • +
  • druid.hover
  • druid.input
  • druid.lang_text
  • druid.progress
    • @@ -64,43 +66,56 @@

    Module druid.progress

    -

    Basic progress bar component

    -

    - -

    +

    Basic progress bar component.

    +

    For correct progress bar init it should be in max size from gui

    Functions

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

    Tables

    + + + + + + + + + + + + + +
    EventsComponent events
    FieldsComponent fields
    StyleComponent style params


    @@ -111,7 +126,7 @@
    - init(self, node, key, init_value) + init(node, key, init_value)
    Component init function @@ -119,17 +134,13 @@

    Parameters:

      -
    • self - table - Component instance -
    • node string or node Progress bar fill node or node name
    • key string - Progress bar direction (x or y) + Progress bar direction: const.SIDE.X or const.SIDE.Y
    • init_value number @@ -143,20 +154,13 @@
    - - empty(self) + + fill()
    Fill a progress bar and stop progress animation -

    Parameters:

    -
      -
    • self - table - Component instance -
      • -
    @@ -165,19 +169,12 @@
    - empty(self) + empty()
    Empty a progress bar -

    Parameters:

    -
      -
    • self - table - Component instance -
      • -
    @@ -186,7 +183,7 @@
    - set_to(self, to) + set_to(to)
    Instant fill progress bar to value @@ -194,10 +191,6 @@

    Parameters:

      -
    • self - table - Component instance -
    • to number Progress bar value, from 0 to 1 @@ -211,19 +204,12 @@
    - get(self) + get()
    Return current progress bar value -

    Parameters:

    -
      -
    • self - table - Component instance -
      • -
    @@ -232,7 +218,7 @@
    - set_steps(self, steps, callback) + set_steps(steps, callback)
    Set points on progress bar to fire the callback @@ -240,12 +226,8 @@

    Parameters:

      -
    • self - table - Component instance -
    • steps - table + number[] Array of progress bar values
    • callback @@ -257,11 +239,15 @@ +

      Usage:

      +
        + 
        progress:set_steps({0, 0.3, 0.6, 1}, function(self, step) end)
        +
    - to(self, to[, callback]) + to(to[, callback])
    Start animation of a progress bar @@ -269,10 +255,6 @@

    Parameters:

      -
    • self - table - Component instance -
    • to number value between 0..1 @@ -288,6 +270,97 @@ +
    +
    +

    Tables

    + +
    +
    + + Events +
    +
    + Component events + + +

    Fields:

    +
      +
    • on_change + druid_event + On progress bar change callback +
      • +
    + + + + + +
    +
    + + Fields +
    +
    + Component fields + + +

    Fields:

    +
      +
    • node + node + Progress bar fill node +
      • +
    • key + string + The progress bar direction +
      • +
    • scale + vector3 + Current progress bar scale +
      • +
    • size + vector3 + Current progress bar size +
      • +
    • max_size + number + Maximum size of progress bar +
      • +
    • slice + vector4 + Progress bar slice9 settings +
      • +
    + + + + + +
    +
    + + Style +
    +
    + Component style params + + +

    Fields:

    +
      +
    • SPEED + number + Progress bas fill rate. More -> faster +
      • +
    • MIN_DELTA + number + Minimum step to fill progress bar +
      • +
    + + + + +
    @@ -296,7 +369,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-24 00:03:02 +Last updated 2020-03-21 21:42:52
    diff --git a/docs/modules/druid.radio_group.html b/docs/modules/druid.radio_group.html index 5d71a85..e14bc76 100644 --- a/docs/modules/druid.radio_group.html +++ b/docs/modules/druid.radio_group.html @@ -30,6 +30,11 @@
  • Index
    • +

    Contents

    +

    Modules

    @@ -40,6 +45,7 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • +
  • druid.hover
  • druid.input
  • druid.lang_text
  • druid.progress
    • @@ -66,18 +72,165 @@

    +

    Functions

    + + + + + + + + + + + + + +
    init(node, callback[, click=node])Component init function
    set_state(state)Set radio group state
    get_state()Return radio group state
    +

    Tables

    + + + + + + + + + +
    EventsComponent events
    FieldsComponent fields


    +

    Functions

    + +
    +
    + + init(node, callback[, click=node]) +
    +
    + Component init function + + +

    Parameters:

    +
      +
    • node + node[] + Array of gui node +
      • +
    • callback + function + Radio callback +
      • +
    • click + node[] + node Array of trigger nodes, by default equals to nodes + (default node) +
      • +
    + + + + + +
    +
    + + set_state(state) +
    +
    + Set radio group state + + +

    Parameters:

    +
      +
    • state + bool[] + Array of checkbox state +
      • +
    + + + + + +
    +
    + + get_state() +
    +
    + Return radio group state + + + +

    Returns:

    +
      + + bool[] + Array if checkboxes state +
    + + + + +
    +
    +

    Tables

    + +
    +
    + + Events +
    +
    + Component events + + +

    Fields:

    +
      +
    • on_radio_click + druid_event + On any checkbox click +
      • +
    + + + + + +
    +
    + + Fields +
    +
    + Component fields + + +

    Fields:

    +
      +
    • checkboxes + table + Array of checkbox components +
      • +
    + + + + + +
    +
    generated by LDoc 1.4.6 -Last updated 2020-02-24 00:03:02 +Last updated 2020-03-21 21:42:52
    diff --git a/docs/modules/druid.scroll.html b/docs/modules/druid.scroll.html index 551ceb5..38a41bb 100644 --- a/docs/modules/druid.scroll.html +++ b/docs/modules/druid.scroll.html @@ -33,6 +33,7 @@

    Contents

    @@ -44,6 +45,7 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • +
  • druid.hover
  • druid.input
  • druid.lang_text
  • druid.progress
    • @@ -64,38 +66,68 @@

    Module druid.scroll

    -

    Component to handle scroll content

    -

    - -

    +

    Component to handle scroll content.

    +

    Scroll consist from two nodes: scroll parent and scroll input + Scroll input the user input zone, it's static + Scroll parent the scroll moving part, it will change position. + Setup initial scroll size by changing scroll parent size. If scroll parent + size will be less than scroll_input size, no scroll is available. For scroll + parent size should be more than input size

    Functions

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

    Tables

    + + + + + + + + + + + + +
    EventsComponent events
    FieldsComponent fields
    StyleComponent style params

    @@ -105,6 +137,31 @@

    Functions

    +
    + + init(scroll_parent, input_zone) +
    +
    + Component init function + + +

    Parameters:

    +
      +
    • scroll_parent + node + Gui node where placed scroll content. This node will change position +
      • +
    • input_zone + node + Gui node where input is catched +
      • +
    + + + + + +
    scroll_to(vector3[, is_instant]) @@ -135,10 +192,40 @@ 
  • scroll:scroll_to(vmath.vector3(0), true)
    • +
    +
    + + scroll_to_percent(vector3[, is_instant]) +
    +
    + Start scroll to target scroll percent + + +

    Parameters:

    + + + + + +

    Usage:

    + +
    - init(self, index[, skip_cb]) + init(index[, skip_cb])
    Scroll to item in scroll by point index @@ -146,16 +233,12 @@

    Parameters:

    - set_points(self, points) + set_points(points)
    Set points of interest. @@ -177,10 +260,6 @@

    Parameters:

    - set_inert(self, state) + set_inert(state)
    Enable or disable scroll inert. @@ -204,12 +283,8 @@

    Parameters:

    @@ -221,7 +296,7 @@
    - on_point_move(self, callback) + on_point_move(callback)
    Set the callback on scrolling to point (if exist) @@ -229,10 +304,6 @@

    Parameters:

    - set_border(self, border) + set_border(border)
    Set the scroll possibly area @@ -254,12 +325,8 @@

    Parameters:

    @@ -268,6 +335,161 @@ +
    +
    + + get_scroll_percent() +
    +
    + Return current scroll progress + + + +

    Returns:

    +
      + + vector3 + Scroll progress +
    + + + + +
    +
    +

    Tables

    + +
    +
    + + Events +
    +
    + Component events + + +

    Fields:

    + + + + + + +
    +
    + + Fields +
    +
    + Component fields + + +

    Fields:

    + + + + + + +
    +
    + + Style +
    +
    + Component style params + + +

    Fields:

    + + + + + +
    @@ -276,7 +498,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-24 00:03:02 +Last updated 2020-03-21 21:42:52
    diff --git a/docs/modules/druid.slider.html b/docs/modules/druid.slider.html index a4abba6..2f2e11e 100644 --- a/docs/modules/druid.slider.html +++ b/docs/modules/druid.slider.html @@ -30,6 +30,11 @@
  • Index
    • +

    Contents

    +

    Modules

    @@ -40,6 +45,7 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • +
  • druid.hover
  • druid.input
  • druid.lang_text
  • druid.progress
    • @@ -66,18 +72,174 @@

    +

    Functions

    + + + + + + + + + +
    init(node, end_pos[, callback])Component init function
    set(value[, is_silent])Set value for slider
    +

    Tables

    + + + + + + + + + +
    EventsComponent events
    FieldsComponent fields


    +

    Functions

    + +
    +
    + + init(node, end_pos[, callback]) +
    +
    + Component init function + + +

    Parameters:

    + + + + + + +
    +
    + + set(value[, is_silent]) +
    +
    + Set value for slider + + +

    Parameters:

    + + + + + + +
    +
    +

    Tables

    + +
    +
    + + Events +
    +
    + Component events + + +

    Fields:

    + + + + + + +
    +
    + + Fields +
    +
    + Component fields + + +

    Fields:

    + + + + + + +
    +
    generated by LDoc 1.4.6 -Last updated 2020-02-24 00:03:02 +Last updated 2020-03-21 21:42:52
    diff --git a/docs/modules/druid.text.html b/docs/modules/druid.text.html index 6df4131..7796639 100644 --- a/docs/modules/druid.text.html +++ b/docs/modules/druid.text.html @@ -33,6 +33,7 @@

    Contents

    @@ -44,6 +45,7 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • +
  • druid.hover
  • druid.input
  • druid.lang_text
  • druid.progress
    • @@ -64,36 +66,49 @@

    Module druid.text

    -

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

    -

    - -

    +

    Component to handle all GUI texts.

    +

    Druid text can adjust itself for text node size + Text will never will be outside of his text size (even multiline)

    Functions

    - + + + + + - + - + - + - +
    set_to(self, set_to)init(node[, value[, no_adjust]])Component init function
    set_to(set_to) Set text to text field
    set_color(self, color)set_color(color) Set color
    set_alpha(self, alpha)set_alpha(alpha) Set alpha
    set_scale(self, scale)set_scale(scale) Set scale
    set_pivot(self, pivot)set_pivot(pivot) Set text pivot.
    +

    Tables

    + + + + + + + + + +
    EventsComponent events
    FieldsComponent fields


    @@ -102,9 +117,40 @@

    Functions

    +
    + + init(node[, value[, no_adjust]]) +
    +
    + Component init function + + +

    Parameters:

    +
      +
    • node + node + Gui text node +
      • +
    • value + string + Initial text + (optional) +
      • +
    • no_adjust + bool + If true, text will be not auto-adjust size + (optional) +
      • +
    + + + + + +
    - set_to(self, set_to) + set_to(set_to)
    Set text to text field @@ -112,10 +158,6 @@

    Parameters:

      -
    • self - table - Component instance -
    • set_to string Text for node @@ -129,7 +171,7 @@
    - set_color(self, color) + set_color(color)
    Set color @@ -137,12 +179,8 @@

    Parameters:

      -
    • self - table - Component instance -
    • color - vmath.vector4 + vector4 Color for node
    @@ -154,7 +192,7 @@
    - set_alpha(self, alpha) + set_alpha(alpha)
    Set alpha @@ -162,10 +200,6 @@

    Parameters:

      -
    • self - table - Component instance -
    • alpha number Alpha for node @@ -179,7 +213,7 @@
    - set_scale(self, scale) + set_scale(scale)
    Set scale @@ -187,12 +221,8 @@

    Parameters:

      -
    • self - table - Component instance -
    • scale - vmath.vector3 + vector3 Scale for node
    @@ -204,7 +234,7 @@
    - set_pivot(self, pivot) + set_pivot(pivot)
    Set text pivot. Text will re-anchor inside @@ -213,10 +243,6 @@

    Parameters:

      -
    • self - table - Component instance -
    • pivot gui.pivot Gui pivot constant @@ -227,6 +253,88 @@ +
    +
    +

    Tables

    + +
    +
    + + Events +
    +
    + Component events + + +

    Fields:

    +
      +
    • on_set_text + druid_event + On set text callback +
      • +
    • on_update_text_scale + druid_event + On adjust text size callback +
      • +
    • on_set_pivot + druid_event + On change pivot callback +
      • +
    + + + + + +
    +
    + + Fields +
    +
    + Component fields + + +

    Fields:

    +
      +
    • node + node + Text node +
      • +
    • pos + vector3 + Current text position +
      • +
    • start_scale + vector3 + Initial text node scale +
      • +
    • scale + vector3 + Current text node scale +
      • +
    • start_size + vector3 + Initial text node size +
      • +
    • text_area + vector3 + Current text node available are +
      • +
    • is_no_adjust + bool + Current text size adjust settings +
      • +
    • color + vector3 + Current text color +
      • +
    + + + + +
    @@ -235,7 +343,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-24 00:03:02 +Last updated 2020-03-21 21:42:52
    diff --git a/docs/modules/druid.timer.html b/docs/modules/druid.timer.html index 8fef622..a45db3f 100644 --- a/docs/modules/druid.timer.html +++ b/docs/modules/druid.timer.html @@ -33,6 +33,7 @@

    Contents

    @@ -44,6 +45,7 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • +
  • druid.hover
  • druid.input
  • druid.lang_text
  • druid.progress
    • @@ -64,27 +66,41 @@

    Module druid.timer

    -

    Component to handle GUI timers

    -

    - -

    +

    Component to handle GUI timers.

    +

    Timer updating by game delta time. If game is not focused - + timer will be not updated.

    Functions

    - + + + + + - + - +
    set_to(self, set_to)init(node, seconds_from[, seconds_to=0[, callback]])Component init function
    set_to(set_to) Set text to text field
    set_state(self, is_on)set_state(is_on) Called when update
    set_interval(self, from, to)set_interval(from, to) Set time interval
    +

    Tables

    + + + + + + + + + +
    EventsComponent events
    FieldsComponent fields


    @@ -93,9 +109,44 @@

    Functions

    +
    + + init(node, seconds_from[, seconds_to=0[, callback]]) +
    +
    + Component init function + + +

    Parameters:

    +
      +
    • node + node + Gui text node +
      • +
    • seconds_from + number + Start timer value in seconds +
      • +
    • seconds_to + number + End timer value in seconds + (default 0) +
      • +
    • callback + function + Function on timer end + (optional) +
      • +
    + + + + + +
    - set_to(self, set_to) + set_to(set_to)
    Set text to text field @@ -103,10 +154,6 @@

    Parameters:

      -
    • self - table - Component instance -
    • set_to number Value in seconds @@ -120,7 +167,7 @@
    - set_state(self, is_on) + set_state(is_on)
    Called when update @@ -128,12 +175,8 @@

    Parameters:

      -
    • self - table - Component instance -
    • is_on - boolean + bool Timer enable state
    @@ -145,7 +188,7 @@
    - set_interval(self, from, to) + set_interval(from, to)
    Set time interval @@ -153,10 +196,6 @@

    Parameters:

      -
    • self - table - Component instance -
    • from number Start time in seconds @@ -171,6 +210,86 @@ +
    +
    +

    Tables

    + +
    +
    + + Events +
    +
    + Component events + + +

    Fields:

    +
      +
    • on_tick + druid_event + On timer tick callback. Fire every second +
      • +
    • on_set_enabled + druid_event + On timer change enabled state callback +
      • +
    • on_timer_end + druid_event + On timer end callback +
      • +
    + + + + + +
    +
    + + Fields +
    +
    + Component fields + + +

    Fields:

    +
      +
    • node + node + Trigger node +
      • +
    • anim_node + node + Animation node + (default node) +
      • +
    • scale_from + vector3 + Initial scale of anim_node +
      • +
    • pos + vector3 + Initial pos of anim_node +
      • +
    • params + any + Params to click callbacks +
      • +
    • hover + druid.hover + Druid hover logic component +
      • +
    • click_zone + node + Restriction zone + (optional) +
      • +
    + + + + +
    @@ -179,7 +298,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-24 00:03:02 +Last updated 2020-03-21 21:42:52
    diff --git a/docs/modules/druid_event.html b/docs/modules/druid_event.html index dc54081..b665666 100644 --- a/docs/modules/druid_event.html +++ b/docs/modules/druid_event.html @@ -44,6 +44,7 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • +
  • druid.hover
  • druid.input
  • druid.lang_text
  • druid.progress
    • @@ -72,6 +73,10 @@

    Functions

    + + + + @@ -81,6 +86,14 @@ + + + + + + + + @@ -93,6 +106,27 @@

    Functions

    +
    + + Event(initial_callback) +
    +
    + Event constructur + + +

    Parameters:

    + + + + + + +
    event:subscribe(callback) @@ -134,6 +168,40 @@ + +
    + + event:is_exist() +
    +
    + Return true, if event have at lease one handler + + + +

    Returns:

    +
      + + bool + True if event have handlers +
    + + + + +
    +
    + + event:clear() +
    +
    + Clear the all event handlers + + + + + + +
    @@ -162,7 +230,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-24 00:03:02 +Last updated 2020-03-21 21:42:52
    diff --git a/docs/modules/druid_instance.html b/docs/modules/druid_instance.html index 732fba4..d4f8c21 100644 --- a/docs/modules/druid_instance.html +++ b/docs/modules/druid_instance.html @@ -44,6 +44,7 @@
  • druid.checkbox
  • druid.checkbox_group
  • druid.grid
    • +
  • druid.hover
  • druid.input
  • druid.lang_text
  • druid.progress
    • @@ -740,7 +741,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-02-24 00:03:02 +Last updated 2020-03-21 21:42:52
    diff --git a/druid/base/blocker.lua b/druid/base/blocker.lua index e32239e..0b336bd 100644 --- a/druid/base/blocker.lua +++ b/druid/base/blocker.lua @@ -17,6 +17,9 @@ local component = require("druid.component") local M = component.create("blocker", { const.ON_INPUT_HIGH }) +--- Component init function +-- @function blocker:init +-- @tparam node node Gui node function M.init(self, node) self.node = self:get_node(node) diff --git a/druid/base/hover.lua b/druid/base/hover.lua index a38cda0..0fb916a 100644 --- a/druid/base/hover.lua +++ b/druid/base/hover.lua @@ -72,7 +72,7 @@ end --- Strict button click area. Useful for -- no click events outside stencil node --- @function button:set_click_zone +-- @function hover:set_click_zone -- @tparam node zone Gui node function M.set_click_zone(self, zone) self.click_zone = self:get_node(zone) diff --git a/druid/base/input.lua b/druid/base/input.lua index 21079a2..603eb71 100644 --- a/druid/base/input.lua +++ b/druid/base/input.lua @@ -1,6 +1,6 @@ --- Druid input text component. -- Carry on user text input --- @local unimplemented +-- UNIMPLEMENTED -- @module druid.input local component = require("druid.component") diff --git a/druid/druid.lua b/druid/druid.lua index 5993e26..3a05c83 100644 --- a/druid/druid.lua +++ b/druid/druid.lua @@ -1,7 +1,7 @@ --- Druid UI Library. -- Powerful Defold component based UI library. Use standart --- components or make your own game-specific to make amazing --- GUI in your games. +-- components or make your own game-specific components to +-- make amazing GUI in your games. -- -- Contains the several basic components and examples -- to how to do your custom complex components to
    Event(initial_callback)Event constructur
    event:subscribe(callback) Subscribe callback on eventUnsubscribe callback on event
    event:is_exist()Return true, if event have at lease one handler
    event:clear()Clear the all event handlers
    event:trigger(...) Trigger the event and call all subscribed callbacks