Druid-Extension/api/components/base/hover_api.md

druid.hover API

at /druid/base/hover.lua

Functions

• init
• on_late_init
• on_style_change
• on_input
• on_input_interrupt
• set_hover
• is_hovered
• set_mouse_hover
• is_mouse_hovered
• set_click_zone
• set_enabled
• is_enabled

Fields

• node
• on_hover
• on_mouse_hover
• style
• click_zone

init

---

hover:init(node, on_hover_callback, on_mouse_hover)

• Parameters:
  • node (node): Gui node
  • on_hover_callback (function): Hover callback
  • on_mouse_hover (function): On mouse hover callback

on_late_init

---

hover:on_late_init()

on_style_change

---

hover:on_style_change(style)

• Parameters:
  • style (druid.hover.style):

on_input

---

hover:on_input(action_id, action)

• Parameters:

  • action_id (hash):
  • action (table):

• Returns:

  • `` (boolean):

on_input_interrupt

---

hover:on_input_interrupt()

set_hover

---

hover:set_hover([state])

Set hover state

• Parameters:
  • [state] (boolean|nil): The hover state

is_hovered

---

hover:is_hovered()

Return current hover state. True if touch action was on the node at current time

• Returns:
  • is_hovered (boolean): The current hovered state

set_mouse_hover

---

hover:set_mouse_hover([state])

Set mouse hover state

• Parameters:
  • [state] (boolean|nil): The mouse hover state

is_mouse_hovered

---

hover:is_mouse_hovered()

Return current hover state. True if nil action_id (usually desktop mouse) was on the node at current time

• Returns:
  • The (boolean): current hovered state

set_click_zone

---

hover:set_click_zone([zone])

Strict hover click area. Useful for no click events outside stencil node

• Parameters:
  • [zone] (string|node|nil): Gui node

set_enabled

---

hover:set_enabled([state])

Set enable state of hover component. If hover is not enabled, it will not generate any hover events

• Parameters:
  • [state] (boolean|nil): The hover enabled state

is_enabled

---

hover:is_enabled()

Return current hover enabled state

• Returns:
  • The (boolean): hover enabled state

Fields

• node (node)

• on_hover (event)

• on_mouse_hover (event)

• style (druid.hover.style)

• click_zone (node)