drag_api.md

druid.drag API

at /druid/base/drag.lua

A component that allows you to subscribe to drag events over a node

Functions

• init
• set_drag_cursors
• set_click_zone
• set_enabled
• is_enabled

Fields

• node
• on_touch_start
• on_touch_end
• on_drag_start
• on_drag
• on_drag_end
• style
• click_zone
• is_touch
• is_drag
• can_x
• can_y
• dx
• dy
• touch_id
• x
• y
• screen_x
• screen_y
• touch_start_pos
• druid
• hover

init

---

drag:init(node_or_node_id, [on_drag_callback])

The constructor for Drag component

• Parameters:
  • node_or_node_id (string|node): The node to subscribe to drag events over
  • [on_drag_callback] (fun(self: any, touch: any)): The callback to call when a drag occurs

set_drag_cursors

---

drag:set_drag_cursors(is_enabled)

Set Drag component enabled state.

• Parameters:
  • is_enabled (boolean): True if Drag component is enabled

set_click_zone

---

drag:set_click_zone([node])

Set Drag click zone

• Parameters:

  • [node] (string|node|nil): Node or node id

• Returns:

  • self (druid.drag): Current instance

set_enabled

---

drag:set_enabled(is_enabled)

Set Drag component enabled state.

• Parameters:

  • is_enabled (boolean):

• Returns:

  • self (druid.drag): Current instance

is_enabled

---

drag:is_enabled()

Check if Drag component is capture input

• Returns:
  • is_enabled (boolean): True if Drag component is enabled

Fields

• node (node): The node to subscribe to drag events over

• on_touch_start (event): fun(self, touch) The event triggered when a touch starts

• on_touch_end (event): fun(self, touch) The event triggered when a touch ends

• on_drag_start (event): fun(self, touch) The event triggered when a drag starts

• on_drag (event): fun(self, touch) The event triggered when a drag occurs

• on_drag_end (event): fun(self, touch) The event triggered when a drag ends

• style (druid.drag.style): The style of Drag component

• click_zone (node): The click zone of Drag component

• is_touch (boolean): True if a touch is active

• is_drag (boolean): True if a drag is active

• can_x (boolean): True if Drag can move horizontally

• can_y (boolean): True if Drag can move vertically

• dx (number): The horizontal drag distance

• dy (number): The vertical drag distance

• touch_id (number): The touch id

• x (number): The current x position

• y (number): The current y position

• screen_x (number): The current screen x position

• screen_y (number): The current screen y position

• touch_start_pos (vector3): The touch start position

• druid (druid.instance): The Druid Factory used to create components

• hover (druid.hover): The component for handling hover events on a node