Druid

• Index

Topics

• 01-components
• Creating custom components
• Styles
• Druid assets
• Examples
• Druid 0.3.0:
• faq
• README

Modules

• druid.back_handler
• druid.blocker
• druid.button
• druid.drag
• druid.hover
• druid.scroll
• druid.static_grid
• druid.swipe
• druid.text
• component
• druid
• druid_event
• druid.checkbox
• druid.checkbox_group
• druid.dynamic_grid
• druid.input
• druid.lang_text
• druid.progress
• druid.radio_group
• druid.slider
• druid.timer
• druid.helper
• druid_instance

Druid 0.3.0:

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

• Add swipe basic component

  - Swipe component handle simple swipe gestures on node. It has single callback with direction on swipe. You can adjust a several parameters of swipe in druid style.
  - Swipe can be triggered on action.released or while user is make swiping (in process)
  - Add swipe example at main Druid example. Try swipe left/right to switch example pages.
  

• Add input basic component

  - Input component handle user text input. Input contains from button and text components. Button needed for selecting/unselecting input field
  - Long click on input field for clear and select input field (clearing can be disable via styles)
  - Click outside of button to unselect input field
  - On focus lost (game minimized) input field will be unselected
  - You can setup max length of the text
  - You can setup allowed characters. On add not allowed characters on_input_wrong will be called. By default it cause simple shake animation
  - The keyboard for input will not show on mobile HTML5. So input field in mobile HTML5 is not working now
  - To make work different keyboard type, make sure value in game.project Android:InputMethod set to HiddenInputField (https://defold.com/manuals/project-settings/#input-method)
  

• Add two functions to basic component: increase_input_priority and reset_input_priority. It used to process component input first in current input stack (there is two input stacks now: INPUT and INPUT_HIGH). Example: on selecting input field, it increase input self priority until it be unselected

• Add two new component interests: on_focus_gain and on_focus_lost

• Add global druid events:

  - on_window_callback: call druid.on_window_callback(event) for on_focus_gain/lost correct work
  - on_language_change: call druid.on_language_change() (#38) for update all druid instances lang components
  - on_layout_change: call druid.on_layout_change() (#37) for update all gui layouts (unimplemented now)
  

• Add button on_click_outside event. You can subscribe on this event in button. Was needed for Input component (click outside to deselect input field)

• Add startpos_ field to button component

• Changed input binding settings. Add esc, enter, text and marked_text. Backspace now is different from android back button event. Check the README setup section

• Renamed onchangelanguage -> onlanguagechange component interest

• Add several examples to druid-assets respository (see live example here): https://insality.github.io/druid-assets/)

• Known issues:

  - Adjusting text size by height works wrong. Adjusting single line texting works fine
  - Space is not working in HTML5
  

  Druid 0.4.0:

• Add Drag basic component

  - Drag component allow you detect dragging on GUI node
  - Drag will be processed even the cursor is outside of node, if drag is already started
  - Drag provides correct handle of several touches. Drag can switch between them (no more scroll gliches with position)
  - Drag have next events:
      - on_touch_start (self)
      - on_touch_end (self)
      - on_drag_start (self)
      - on_drag (self, dx, dy)
      - on_drag_end (self)
  - 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_)
  

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

  - Update scroll documentation
  - Change constructor order params
  - Change _scroll:set_border_ to _scroll:set_size_
  - Scroll now contains from view and content node
      - _View node_ - static node, which size determine the "camera" zone
      - _Content node_ - dynamic node, moving by _Scroll_ component
  - Scroll will be disabled only if content size equals to view size (by width or height separatly)
  - You can adjust start scroll size via _.gui_ scene. Just setup correct node size
  - 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
  

• Druid Grid Update

  - Anchor by default equals to node pivot (so, more component settings in _.gui_ settings) (#51)
  - Function grid:clear now don't delete any GUI nodes. Druid will not care about gui.delete_node logic anymore (#56)
  

• Druid Hover component now have two hover events (#49):

  - _on_hover_ is usual hover event. Trigger only if touch or mouse action_id pressed on node
  - _on_mouse_hover_ action on node without action_id (desktop mouse over). Works only on desktop platform
  

• Styles update:

  - Styles table now can be empty, every component have their default style values
  - 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](https://insality.github.io/druid/index.html)
  

• Druid update:

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

Besides a lot of fixes (thanks for feedback!) two components was add: StaticGrid and DynamicGrid instead of usual Grid component (it is deprecated now). Add component:setinputenabled for basic component class. So you can enable/disable user input for any component. Finaly implemented onlayoutchanged support. Druid components now will try keep their data between layout changing! You also can use this callback in your custom components. Also check component.template.lua what you can use for your own custom components!

• #77 Grid update:

  - The _grid_ component now is __deprecated__. Use _static_grid_ instead. Druid will show you deprecated message, if you still using _grid_ component
  - __[BREAKING]__ Remove the _grid:set_offset_ grid functions. To adjust the distance between nodes inside grid - setup correct node sizes
  - Add _static_grid_ component
      - The behaviour like previous _grid_ component
      - Have constant element size, so have ability to precalculate positions, indexes and size of content
      - By default, not shifting elements on removing element. Add _is_shift_ flag to _static_grid:remove_ function
      - This grid can spawn elements with several rows and columns
  - Add _dynamic_grid_ component
      - Can have different element size. So have no ability to precalculate stuff like _static_grid_
      - This grid can't have gaps between elements. You will get the error, if spawn element far away from other elements
      - The grid can spawn elements only in row or in column
      - The grid node should have __West__, __East__, __South__ or __North__ pivot (vertical or horizontal element placement)
      - Able to shift nodes left or right on _grid:add_ / _grid:remove_ functions
  

• Scroll update:

  - Add _scroll:set_vertical_scroll_ and _scroll:set_horizontal_scroll_ for disable scroll sides
  - Add _scroll:bind_grid_ function. Now is possible to bind Druid Grid component (Static or Dynamic) to the scroll for auto refresh the scroll size on grid nodes changing
  

• #37 Add onlayoutchange support. Druid will keep and restore GUI component data between changing game layout. Override function onlayoutchange in your custom components to do stuff you need.
• #85 Move several components from base folder to extended. In future to use them, you have to register them manually. This is done for decrease build size by excluding unused components
• 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: [BREAKING] Fix typo: strech -> stretch. Scroll function set_extra_stretch_size renamed
• Fix #76: Add params for lang text localization component
• Fix #79: Fix druid:remove inside on_input callback
• Fix #80: Fix hover:setenable_ typo function call
• Fix #88: Add component:setinputenabled function to enable/disable input for druid component. Now you can disable input of any druid component, even complex (with other components inside)
• Add component.template.lua as template for Druid custom component
• Update the example app