diff --git a/README.md b/README.md index cc2f071..2fad178 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![GitHub release (latest by date)](https://img.shields.io/github/v/release/insality/druid)](https://github.com/Insality/druid/releases) -**Druid** - powerful defold component UI library. Use basic **Druid** components or make your own game-specific components to make amazing GUI in your games. +**Druid** - powerful Defold component UI library. Use basic **Druid** components or make your own game-specific components to make amazing GUI in your games. ## Setup @@ -184,18 +184,19 @@ function on_message(self, message_id, message, sender) end ``` +- *final* required function for correct druid lifecycle - *on_input* used for almost all basic druid components - *update* used for progress bar, scroll and timer base components - *on_message* used for specific druid events, like language change or layout change -- *final* used for custom components, what have to do several action before destroy -Recommended is fully integrate al druid lifecycles functions +Recommended is fully integrate all druid lifecycles functions ## Features - Druid input goes as stack. Last created button will checked first. So create your GUI from back - Don't forget about `return` in `on_input`: `return self.druid:on_input()`. It need, if you have more than 1 acquire inputs (several druid, other input system, etc) +- Druid by default do _acquire_input_focus_. So you don't need do it manually. Buy only if you have components, which requires _on_input_ ## Examples diff --git a/docs/index.html b/docs/index.html index e4788f4..cd47334 100644 --- a/docs/index.html +++ b/docs/index.html @@ -200,7 +200,7 @@
generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
diff --git a/docs/modules/component.html b/docs/modules/component.html index 99b8ff4..7dcbe5c 100644 --- a/docs/modules/component.html +++ b/docs/modules/component.html @@ -510,7 +510,7 @@
generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
diff --git a/docs/modules/druid.back_handler.html b/docs/modules/druid.back_handler.html index 7f6e1b0..a97c4c4 100644 --- a/docs/modules/druid.back_handler.html +++ b/docs/modules/druid.back_handler.html @@ -218,7 +218,7 @@
generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
diff --git a/docs/modules/druid.blocker.html b/docs/modules/druid.blocker.html index 236317c..e08833b 100644 --- a/docs/modules/druid.blocker.html +++ b/docs/modules/druid.blocker.html @@ -237,7 +237,7 @@
generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
diff --git a/docs/modules/druid.button.html b/docs/modules/druid.button.html index 0c807bf..ed24186 100644 --- a/docs/modules/druid.button.html +++ b/docs/modules/druid.button.html @@ -99,11 +99,11 @@ Return button enabled state - set_click_zone(zone, Self) + set_click_zone(zone) Strict button click area. - set_key_trigger(key, Self) + set_key_trigger(key) Set key-code to trigger this button @@ -185,6 +185,12 @@ +

Returns:

+
    + + druid.button + Current button instance +
@@ -212,7 +218,7 @@
- set_click_zone(zone, Self) + set_click_zone(zone)
Strict button click area. Useful for @@ -225,12 +231,14 @@ node Gui node -
  • Self - druid.button - instance to make chain calls -
    • +

    Returns:

    +
      + + druid.button + Current button instance +
    @@ -238,7 +246,7 @@
    - set_key_trigger(key, Self) + set_key_trigger(key)
    Set key-code to trigger this button @@ -250,12 +258,14 @@ hash The action_id of the key -
  • Self - druid.button - instance to make chain calls -
    • +

    Returns:

    +
      + + druid.button + Current button instance +
    @@ -438,7 +448,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/modules/druid.checkbox.html b/docs/modules/druid.checkbox.html index 8d8c732..5391bf0 100644 --- a/docs/modules/druid.checkbox.html +++ b/docs/modules/druid.checkbox.html @@ -282,7 +282,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/modules/druid.checkbox_group.html b/docs/modules/druid.checkbox_group.html index bd03b40..eaf898f 100644 --- a/docs/modules/druid.checkbox_group.html +++ b/docs/modules/druid.checkbox_group.html @@ -242,7 +242,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/modules/druid.drag.html b/docs/modules/druid.drag.html index 5cc0261..3ffc533 100644 --- a/docs/modules/druid.drag.html +++ b/docs/modules/druid.drag.html @@ -282,7 +282,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/modules/druid.grid.html b/docs/modules/druid.grid.html index 730bc39..9982cc3 100644 --- a/docs/modules/druid.grid.html +++ b/docs/modules/druid.grid.html @@ -374,7 +374,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/modules/druid.helper.html b/docs/modules/druid.helper.html index 64a239d..fa7d7d7 100644 --- a/docs/modules/druid.helper.html +++ b/docs/modules/druid.helper.html @@ -298,7 +298,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/modules/druid.hover.html b/docs/modules/druid.hover.html index 25a72f9..bcf21b1 100644 --- a/docs/modules/druid.hover.html +++ b/docs/modules/druid.hover.html @@ -102,6 +102,14 @@ set_click_zone(zone) Strict hover click area. + + set_enabled(state) + Set enable state of hover component. + + + is_enabled() + Return current hover enabled state +

    Tables

    @@ -206,6 +214,49 @@ + +
    + + set_enabled(state) +
    +
    + Set enable state of hover component. + If hover is not enabled, it will not generate + any hover events + + +

    Parameters:

    + + + + + + +
    +
    + + is_enabled() +
    +
    + Return current hover enabled state + + + +

    Returns:

    +
      + + bool + The hover enabled state +
    + + + +

    Tables

    @@ -243,7 +294,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/modules/druid.html b/docs/modules/druid.html index ac40eb7..b3a108b 100644 --- a/docs/modules/druid.html +++ b/docs/modules/druid.html @@ -329,7 +329,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/modules/druid.input.html b/docs/modules/druid.input.html index d5a0952..37d842c 100644 --- a/docs/modules/druid.input.html +++ b/docs/modules/druid.input.html @@ -194,7 +194,7 @@
      druid.input - Self instance to make chain calls + Current input instance
    @@ -223,7 +223,7 @@
      druid.input - Self instance to make chain calls + Current input instance
    @@ -388,7 +388,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/modules/druid.lang_text.html b/docs/modules/druid.lang_text.html index 84c9334..2edcdb4 100644 --- a/docs/modules/druid.lang_text.html +++ b/docs/modules/druid.lang_text.html @@ -243,7 +243,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/modules/druid.progress.html b/docs/modules/druid.progress.html index ec3270b..2641e70 100644 --- a/docs/modules/druid.progress.html +++ b/docs/modules/druid.progress.html @@ -386,7 +386,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/modules/druid.radio_group.html b/docs/modules/druid.radio_group.html index f87e4ad..7f4fab6 100644 --- a/docs/modules/druid.radio_group.html +++ b/docs/modules/druid.radio_group.html @@ -242,7 +242,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/modules/druid.scroll.html b/docs/modules/druid.scroll.html index da5ff6e..f9e2799 100644 --- a/docs/modules/druid.scroll.html +++ b/docs/modules/druid.scroll.html @@ -122,7 +122,7 @@ - + @@ -311,7 +311,7 @@
      druid.scroll - Self instance + Current scroll instance
    @@ -340,7 +340,7 @@
      druid.scroll - Self instance + Current scroll instance
    @@ -368,8 +368,8 @@
    - - set_extra_strech_size([stretch_size=0]) + + set_extra_stretch_size([stretch_size=0])
    Set extra size for scroll stretching. @@ -389,7 +389,7 @@
      druid.scroll - Self instance + Current scroll instance
    @@ -437,7 +437,7 @@
      druid.scroll - Self instance + Current scroll instance
    @@ -586,7 +586,7 @@ Scroll gui.animation speed for scroll_to function (default 0.2) -
  • EXTRA_STRECH_SIZE +
  • EXTRA_STRETCH_SIZE number extra size in pixels outside of scroll (stretch effect) (default 0) @@ -610,7 +610,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/modules/druid.slider.html b/docs/modules/druid.slider.html index 1303128..c952191 100644 --- a/docs/modules/druid.slider.html +++ b/docs/modules/druid.slider.html @@ -281,7 +281,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/modules/druid.swipe.html b/docs/modules/druid.swipe.html index 60464fd..339ae62 100644 --- a/docs/modules/druid.swipe.html +++ b/docs/modules/druid.swipe.html @@ -256,7 +256,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/modules/druid.text.html b/docs/modules/druid.text.html index b75b29b..e3fbea8 100644 --- a/docs/modules/druid.text.html +++ b/docs/modules/druid.text.html @@ -407,7 +407,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/modules/druid.timer.html b/docs/modules/druid.timer.html index 517ff76..3c2675a 100644 --- a/docs/modules/druid.timer.html +++ b/docs/modules/druid.timer.html @@ -296,7 +296,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/modules/druid_event.html b/docs/modules/druid_event.html index 261e260..3e03611 100644 --- a/docs/modules/druid_event.html +++ b/docs/modules/druid_event.html @@ -242,7 +242,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/modules/druid_instance.html b/docs/modules/druid_instance.html index c0f164b..4a0ae8c 100644 --- a/docs/modules/druid_instance.html +++ b/docs/modules/druid_instance.html @@ -913,7 +913,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/topics/01-components.md.html b/docs/topics/01-components.md.html index 21478e4..29a51b8 100644 --- a/docs/topics/01-components.md.html +++ b/docs/topics/01-components.md.html @@ -129,7 +129,8 @@ Where node name is name of node from GUI scene. You can use node_namet trigger if callback is empty -

    - If button have double click event and it is triggered, usual callback will be not invoked +

    - Click event will not trigger, if between pressed and released state cursor was outside of node zone +- If button have double click event and it is triggered, usual callback will be not invoked - If you have stencil on buttons and you don't want trigger them outside of stencil node, you can use button:set_click_zone to restrict button click zone - Button can have key trigger to use then by key: button:set_key_trigger - Animation node can be used for example to animate small icon on big panel. Node name of trigger zone will be big panel and animation node will be small icon

    @@ -239,7 +240,7 @@ Where node name is name of node from GUI scene. You can use node_name- You can adjust scroll content size by scroll:set_size(node_size). It will setup new size to content node - You can enabled or disable inertion mode via scroll:set_intert(state) -- You can adjust extra stretch size via scroll:set_extra_stretch_size +- You can adjust extra stretch size via scroll:set_extra_stretch_size - Multitouch is required for scroll. Scroll is correctly handling touch_id swap while dragging scroll

    @@ -386,7 +387,8 @@ Key is value from druid const: const.SIDE.X (or just "x") or const.SIDE.Y (or ju

    Notes

    - By default, hover handles hover event with pressed touch action_id. So it's mean, what mouse or touch have to be pressed -- On desktop platforms there is onmousehover event. It's event on mouse hover without any action id

    +- On desktop platforms there is onmousehover event. It's event on mouse hover without any action id +- By default, assume what node is on not hovered state (both hover and mousehover_)

    @@ -463,7 +465,7 @@ Key is value from druid const: const.SIDE.X (or just "x") or const.SIDE.Y (or ju
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/topics/02-creating_custom_components.md.html b/docs/topics/02-creating_custom_components.md.html index 086bc4f..5938201 100644 --- a/docs/topics/02-creating_custom_components.md.html +++ b/docs/topics/02-creating_custom_components.md.html @@ -121,8 +121,8 @@ function M.on_message(self, message_id, message, sender) end --- Call only if component with ON_LANGUAGE_CHANGE interest -function M.on_language_change(self) +-- Call only if component with ON_ANGUAGECHANinterest +function M.on_anguagechanself) end -- Call only if component with ON_LAYOUT_CHANGE interest @@ -245,7 +245,7 @@ There is next interests in druid:
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/topics/03-styles.md.html b/docs/topics/03-styles.md.html index b51a6c6..a1da483 100644 --- a/docs/topics/03-styles.md.html +++ b/docs/topics/03-styles.md.html @@ -155,7 +155,7 @@ You can pass nil or emptytable_ to use default values for all
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/topics/04-druid_assets.md.html b/docs/topics/04-druid_assets.md.html index 8df0a70..1272c79 100644 --- a/docs/topics/04-druid_assets.md.html +++ b/docs/topics/04-druid_assets.md.html @@ -92,7 +92,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/topics/05-examples.md.html b/docs/topics/05-examples.md.html index c124314..b7b7f5e 100644 --- a/docs/topics/05-examples.md.html +++ b/docs/topics/05-examples.md.html @@ -90,7 +90,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/topics/README.md.html b/docs/topics/README.md.html index 07dcf24..b0e8677 100644 --- a/docs/topics/README.md.html +++ b/docs/topics/README.md.html @@ -90,7 +90,7 @@

    GitHub release (latest by date)

    -

    Druid - powerful defold component UI library. Use basic Druid components or make your own game-specific components to make amazing GUI in your games.

    +

    Druid - powerful Defold component UI library. Use basic Druid components or make your own game-specific components to make amazing GUI in your games.

    @@ -271,13 +271,13 @@
      +
    • final required function for correct druid lifecycle
    • *on_input* used for almost all basic druid components
    • update used for progress bar, scroll and timer base components
    • *on_message* used for specific druid events, like language change or layout change
      • -
    • final used for custom components, what have to do several action before destroy
    -

    Recommended is fully integrate al druid lifecycles functions

    +

    Recommended is fully integrate all druid lifecycles functions

    @@ -286,6 +286,7 @@
    • Druid input goes as stack. Last created button will checked first. So create your GUI from back
    • Don't forget about return in on_input: return self.druid:on_input(). It need, if you have more than 1 acquire inputs (several druid, other input system, etc)
      • +
    • Druid by default do acquireinputfocus. So you don't need do it manually. Buy only if you have components, which requires oninput_
    @@ -339,7 +340,7 @@ https://insality.github.io/druid/

    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs/topics/changelog.md.html b/docs/topics/changelog.md.html index 4fe82e0..762b41e 100644 --- a/docs/topics/changelog.md.html +++ b/docs/topics/changelog.md.html @@ -72,8 +72,7 @@
    - -

    Druid 0.3.0:

    + Druid 0.3.0:

    • Druid:final() now is important function for correct working

      • @@ -133,11 +132,11 @@ - on_drag_start (self) - on_drag (self, dx, dy) - on_drag_end (self) -- You can restriction side of draggin by changing _drag.can_x_ and _drag.can_y_ fields -- You can setup drag deadzone to detect, when dragging is started (by default 10 pixels) +- You can restriction side of dragging by changing _drag.can_x_ and _drag.can_y_ fields +- You can setup drag deadzone to detect, when dragging is started (_by default 10 pixels_) -

    • Druid Scroll component fully reworked. Input logic moved to Drag component

      +

    • [Breaking changes] Druid Scroll component fully reworked. Input logic moved to Drag component

       - Update scroll documentation
@@ -151,7 +150,7 @@
 - Different anchoring is supported (for easier layouting)
 - Function _scroll_to_ now accept position relative to _content node_. It's more easier for handling. _Example:_ if you have children node of _content_node_, you can pass this node position to scroll to this.
 - **Resolve #52**: _Content node size_ now can be less than _view node size_. In this case, content will be scrolled only inside _view size_ (can be disabled via style field: _SMALL_CONTENT_SCROLL_)
-- **Fix #50**: If style:SOFT_ZONE_SIZE equals to [0..1], scroll can be disappeared
+- **Fix #50**: If style.SOFT_ZONE_SIZE equals to [0..1], scroll can be disappeared

    • Druid Grid Update

      @@ -172,9 +171,9 @@ 
       - Styles table now can be empty, every component have their default style values
-- Remove component:get_style function. Now style can be only set
+- Remove component:get_style function. Now you can only set styles
 - To get style values in component, add component:on_style_change function. It's invoked on component:set_style function
-- You can look up default values inside component:on_style_change function or style component API on Druid API
+- You can look up default values inside component:on_style_change function or style component API on [Druid API](https://insality.github.io/druid/index.html)

    • Druid update:

      @@ -183,17 +182,24 @@ - Now function druid:remove remove instance and all instance children components. No more manual deleting child components (#41)
      • -

    • Fix: Blocker component bug (blocker had very high priority, so it's block even button components, created after bloker)

      • +

    • Fix: Blocker component bug (blocker had very high priority, so it's block even button components, created after blocker)

    • Fix #58: Bug, when druid instance should be always named druid (ex: self.druid = druid.new(self))

    • Fix #53: Bug with final Druid instance without any components

    +

    Druid 0.5.0: +- Fix #61: Button component: fix button animation node creation +- Fix #64: Hover component: wrong mouse_hover default state +- Fix #71: Blocker: blocker now correct block mouse hover event +- Fix #72: Fix return nil in some on_input functions +- Fix #74: Fix typo: strech -> stretch. Scroll function set_extra_stretch_size renamed +

    generated by LDoc 1.4.6 -Last updated 2020-05-09 16:07:15 +Last updated 2020-06-14 20:13:02
    diff --git a/docs_md/01-components.md b/docs_md/01-components.md index e24a182..39e1087 100644 --- a/docs_md/01-components.md +++ b/docs_md/01-components.md @@ -25,6 +25,7 @@ Where node name is name of node from GUI scene. You can use `node_name` as input - **on_long_click** - callback on long button tap, don't trigger if callback is empty - **on_hold_click** - hold callback, before long_click trigger, don't trigger if callback is empty - **on_double_click** - different callback, if tap button 2+ in row, don't trigger if callback is empty +- Click event will not trigger, if between pressed and released state cursor was outside of node zone - If button have double click event and it is triggered, usual callback will be not invoked - If you have stencil on buttons and you don't want trigger them outside of stencil node, you can use `button:set_click_zone` to restrict button click zone - Button can have key trigger to use then by key: `button:set_key_trigger` diff --git a/docs_md/02-creating_custom_components.md b/docs_md/02-creating_custom_components.md index b6ed5ed..43c1cf7 100644 --- a/docs_md/02-creating_custom_components.md +++ b/docs_md/02-creating_custom_components.md @@ -36,8 +36,8 @@ end function M.on_message(self, message_id, message, sender) end --- Call only if component with ON_LANGUAGE_CHANGE interest -function M.on_language_change(self) +-- Call only if component with ON_ANGUAGECHANinterest +function M.on_anguagechanself) end -- Call only if component with ON_LAYOUT_CHANGE interest diff --git a/docs_md/changelog.md b/docs_md/changelog.md index b78563d..1010700 100644 --- a/docs_md/changelog.md +++ b/docs_md/changelog.md @@ -96,3 +96,8 @@ Druid 0.4.0: Druid 0.5.0: - **Fix #61:** Button component: fix button animation node creation - **Fix #64:** Hover component: wrong mouse_hover default state +- **Fix #71:** Blocker: blocker now correct block mouse hover event +- **Fix #72:** Fix `return nil` in some `on_input` functions +- **Fix #74:** Fix typo: strech -> stretch. Scroll function `set_extra_stretch_size` renamed +- Add `component.tempalte.lua` as template for Druid custom component +
    • Return if scroll have inertion.
    set_extra_strech_size([stretch_size=0])set_extra_stretch_size([stretch_size=0]) Set extra size for scroll stretching.