Module Hover
Component to handle hover node interaction
| on_hover |
On hover callback(self, state, hover_instance) |
| on_mouse_hover |
On mouse hover callback(self, state, hover_instance) |
-
init(self, node, on_hover_callback)
-
Component init function
Parameters:
- self
Hover
Hover
- node
node
Gui node
- on_hover_callback
function
Hover callback
-
is_enabled(self)
-
Return current hover enabled state
Parameters:
Returns:
bool
The hover enabled state
-
is_hovered(self)
-
Return current hover state. True if touch action was on the node at current time
Parameters:
Returns:
bool
The current hovered state
-
is_mouse_hovered(self)
-
Return current hover state. True if nil action_id (usually desktop mouse) was on the node at current time
Parameters:
Returns:
bool
The current hovered state
-
set_click_zone(self, zone)
-
Strict hover click area. Useful for
no click events outside stencil node
Parameters:
- self
Hover
Hover
- zone
node
Gui node
-
set_enabled(self, state)
-
Set enable state of hover component.
If hover is not enabled, it will not generate
any hover events
Parameters:
- self
Hover
Hover
- state
bool
The hover enabled state
-
set_hover(self, state)
-
Set hover state
Parameters:
- self
Hover
Hover
- state
bool
The hover state
-
set_mouse_hover(self, state)
-
Set mouse hover state
Parameters:
- self
Hover
Hover
- state
bool
The mouse hover state
-
on_hover
-
On hover callback(self, state, hover_instance)
-
on_mouse_hover
-
On mouse hover callback(self, state, hover_instance)