Update component docs

This commit is contained in:
Insality
2020-03-21 21:37:32 +03:00
parent b33efd692f
commit ca78b10794
20 changed files with 603 additions and 334 deletions

View File

@@ -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