mirror of
https://github.com/Insality/druid.git
synced 2025-09-27 18:12:19 +02:00
Update component docs
This commit is contained in:
@@ -1,9 +1,17 @@
|
||||
--- Component to block input on specify zone (node)
|
||||
--- Component to block input on specify zone by node
|
||||
-- @module druid.blocker
|
||||
|
||||
--- Component events
|
||||
-- @table Events
|
||||
-- @tfield druid_event on_click On release button callback
|
||||
-- @tfield druid_event on_enable_change On enable/disable callback
|
||||
|
||||
--- Component fields
|
||||
-- @table Fields
|
||||
-- @tfield node node Trigger node
|
||||
|
||||
local Event = require("druid.event")
|
||||
local const = require("druid.const")
|
||||
local helper = require("druid.helper")
|
||||
local component = require("druid.component")
|
||||
|
||||
local M = component.create("blocker", { const.ON_INPUT_HIGH })
|
||||
@@ -22,7 +30,7 @@ function M.on_input(self, action_id, action)
|
||||
return false
|
||||
end
|
||||
|
||||
if not helper.is_enabled(self.node) then
|
||||
if not self:is_enabled(self.node) then
|
||||
return false
|
||||
end
|
||||
|
||||
@@ -34,13 +42,19 @@ function M.on_input(self, action_id, action)
|
||||
end
|
||||
|
||||
|
||||
--- Set enabled blocker component state
|
||||
-- @function blocker:set_enabled
|
||||
-- @tparam bool state Enabled state
|
||||
function M.set_enabled(self, state)
|
||||
|
||||
gui.set_enabled(self.node, state)
|
||||
end
|
||||
|
||||
|
||||
--- Return blocked enabled state
|
||||
-- @function blocker:is_enabled
|
||||
-- @treturn bool True, if blocker is enabled
|
||||
function M.is_enabled(self, state)
|
||||
|
||||
return gui.is_enabled(self.node)
|
||||
end
|
||||
|
||||
|
||||
|
Reference in New Issue
Block a user