Skip to content

Latest commit

 

History

History
144 lines (97 loc) · 2.49 KB

hover_api.md

File metadata and controls

144 lines (97 loc) · 2.49 KB

druid.hover API

at /druid/base/hover.lua

The component for handling hover events on a node

Functions

Fields

init

hover:init(node, on_hover_callback, on_mouse_hover)

The constructor for the hover component

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

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): Gui node

  • on_hover (event): fun(self: druid.hover, is_hover: boolean) Hover event

  • on_mouse_hover (event): fun(self: druid.hover, is_hover: boolean) Mouse hover event

  • style (druid.hover.style): Style of the hover component

  • click_zone (node): Click zone of the hover component