Module Button
Component to handle basic GUI button
| style |
Component style params. |
| anim_node |
Animation node |
| click_zone |
Restriction zone |
| hash |
The hash of trigger node |
| hover |
Druid hover logic component |
| node |
Trigger node |
| on_click |
On release button callback(self, params, button_instance) |
| on_click_outside |
On click outside of button(self, params, button_instance) |
| on_double_click |
On double tap button callback(self, params, button_instance, click_amount) |
| on_hold_callback |
On button hold before long_click callback(self, params, button_instance, time) |
| on_long_click |
On long tap button callback(self, params, button_instance, time) |
| on_repeated_click |
On repeated action button callback(self, params, button_instance, click_amount) |
| params |
Params to click callbacks |
| pos |
Initial pos of anim_node |
| start_pos |
Initial pos of anim_node |
| start_scale |
Initial scale of anim_node |
-
get_key_trigger(self)
-
Get key-code to trigger this button
Parameters:
Returns:
hash
The action_id of the key
-
init(self, node, callback[, params[, anim_node]])
-
Component init function
Parameters:
- self
Button
Button
- node
node
Gui node
- callback
function
Button callback
- params
table
Button callback params
(optional)
- anim_node
node
Button anim node (node, if not provided)
(optional)
-
is_enabled(self)
-
Return button enabled state
Parameters:
Returns:
bool
True, if button is enabled
-
set_check_function(self[, check_function[, failure_callback]])
-
Set function for additional check for button click availability
Parameters:
- self
Button
- check_function
function
Should return true or false. If true - button can be pressed.
(optional)
- failure_callback
function
Function what will be called on button click, if check function return false
(optional)
Returns:
Button
Current button instance
-
set_click_zone(self, zone)
-
Strict button click area. Useful for
no click events outside stencil node
Parameters:
Returns:
Button
Current button instance
-
set_enabled(self, state)
-
Set enabled button component state
Parameters:
- self
Button
Button
- state
bool
Enabled state
Returns:
Button
Current button instance
-
set_key_trigger(self, key)
-
Set key-code to trigger this button
Parameters:
- self
Button
Button
- key
hash
The action_id of the key
Returns:
Button
Current button instance
-
style
-
Component style params.
You can override this component styles params in druid styles table
or create your own style
Fields:
- LONGTAP_TIME
number
Minimum time to trigger on_hold_callback
(default 0.4)
- AUTOHOLD_TRIGGER
number
Maximum hold time to trigger button release while holding
(default 0.8)
- DOUBLETAP_TIME
number
Time between double taps
(default 0.4)
- on_click
function
(self, node)
- on_click_disabled
function
(self, node)
- on_hover
function
(self, node, hover_state)
- on_mouse_hover
function
(self, node, hover_state)
- on_set_enabled
function
(self, node, enabled_state)
-
anim_node
-
Animation node
- anim_node
node
(default node)
-
click_zone
-
Restriction zone
- click_zone
node
(optional)
-
hash
-
The hash of trigger node
-
hover
-
Druid hover logic component
-
node
-
Trigger node
-
on_click
-
On release button callback(self, params, button_instance)
-
on_click_outside
-
On click outside of button(self, params, button_instance)
-
on_double_click
-
On double tap button callback(self, params, button_instance, click_amount)
-
on_hold_callback
-
On button hold before long_click callback(self, params, button_instance, time)
-
on_long_click
-
On long tap button callback(self, params, button_instance, time)
-
on_repeated_click
-
On repeated action button callback(self, params, button_instance, click_amount)
-
params
-
Params to click callbacks
-
pos
-
Initial pos of anim_node
-
start_pos
-
Initial pos of anim_node
-
start_scale
-
Initial scale of anim_node