--- Component to handle basic GUI button -- @module druid.button --- Button gui component --@class druid --- Component events -- @table Events -- @tfield druid_event on_click On release button callback -- @tfield druid_event on_repeated_click On repeated action button callback -- @tfield druid_event on_long_click On long tap button callback -- @tfield druid_event on_double_click On double tap button callback --- Component fields -- @table Fields -- @tfield node node Trigger node -- @tfield[opt=node] node anim_node Animation node -- @tfield vector3 scale_from Initial scale of anim_node -- @tfield vector3 pos Initial pos of anim_node -- @tfield any params Params to click callbacks -- @tfield boolean hover_anim Is hover anim enabled -- @tfield druid.hover hover Druid hover logic component -- @tfield[opt] node click_zone Restriction zone --- Component style params -- @table Style -- @tfield function on_click (self, node) -- @tfield function on_click_disabled (self, node) -- @tfield function on_hover (self, node, hover_state) -- @tfield function on_set_enabled (self, node, enabled_state) -- @tfield bool IS_HOVER local Event = require("druid.event") local const = require("druid.const") local helper = require("druid.helper") local component = require("druid.component") local M = component.create("button", { const.ON_INPUT }) local function on_button_hover(self, hover_state) if not self.style.on_hover then return end self.style.on_hover(self, self.anim_node, hover_state) end local function on_button_release(self) if not self.disabled then if not self.stub and self.can_action then self.can_action = false if self.style.on_click then self.style.on_click(self, self.anim_node) end self.on_click:trigger(self:get_context(), self.params, self) end return true else if self.style.on_click_disabled then self.style.on_click_disabled(self, self.anim_node) end return false end end --- Component init function -- @function button:init -- @tparam table self Component instance -- @tparam node node Gui node -- @tparam function callback Button callback -- @tparam[opt] table params Button callback params -- @tparam[opt] node anim_node Button anim node (node, if not provided) -- @tparam[opt] string event Button react event, const.ACTION_TOUCH by default function M.init(self, node, callback, params, anim_node, event) self.druid = self:get_druid() self.style = self:get_style() self.node = self:get_node(node) self.anim_node = anim_node and helper:get_node(anim_node) or self.node -- TODO: rename to start_scale self.scale_from = gui.get_scale(self.anim_node) self.params = params self.hover_anim = self.style.IS_HOVER self.hover = self.druid:new_hover(node, self, on_button_hover) self.click_zone = nil -- Event stubs self.on_click = Event(callback) self.on_repeated_click = Event() self.on_long_click = Event() self.on_double_click = Event() end function M.on_input(self, action_id, action) if action_id ~= const.ACTION_TOUCH then return false end if not helper.is_enabled(self.node) then return false end local is_pick = gui.pick_node(self.node, action.x, action.y) if self.click_zone then is_pick = is_pick and gui.pick_node(self.click_zone, action.x, action.y) end if not is_pick then -- Can't interact, if touch outside of button self.can_action = false return false end if action.pressed then -- Can interact if start touch on the button self.can_action = true self.repeated_counter = 0 return true end if action.released then return on_button_release(self) end return not self.disabled end function M.on_input_interrupt(self) self.can_action = false end function M.set_enabled(self, state) self.disabled = not state if self.style.on_set_enabled then self.style.on_set_enabled(self, self.node, state) end end function M.get_enabled(self) return not self.disabled end --- Disable all button animations -- @function button:disable_animation -- @tparam table self Component instance function M.disable_animation(self) self.hover_anim = false end --- Strict button click area. Useful for -- no click events outside stencil node -- @function button:set_click_zone -- @tparam table self Component instance -- @tparam node zone Gui node function M.set_click_zone(self, zone) self.click_zone = self:get_node(zone) end -- TODO: implement them all! --- Set key-code to trigger this button function M.set_key_trigger(self, key) end --- Get key-code to trigger this button function M.get_key_trigger(self) end return M