mirror of
https://github.com/Insality/druid.git
synced 2025-09-27 18:12:19 +02:00
Update docs
This commit is contained in:
@@ -2,14 +2,24 @@
|
||||
|
||||
> at /druid/base/blocker.lua
|
||||
|
||||
Druid component for block input. Use it to block input in special zone.
|
||||
|
||||
### Setup
|
||||
Create blocker component with druid: `druid:new_blocker(node_name)`
|
||||
|
||||
### Notes
|
||||
- Blocker can be used to create safe zones, where you have big buttons
|
||||
- Blocker will capture all input events that hit the node, preventing them from reaching other components
|
||||
- Blocker works placed as usual component in stack, so any other component can be placed on top of it and will work as usual
|
||||
|
||||
## Functions
|
||||
|
||||
- [init](#init)
|
||||
- [set_enabled](#set_enabled)
|
||||
- [is_enabled](#is_enabled)
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
- [node](#node)
|
||||
|
||||
|
||||
@@ -21,6 +31,8 @@
|
||||
blocker:init(node)
|
||||
```
|
||||
|
||||
The Blocker constructor
|
||||
|
||||
- **Parameters:**
|
||||
- `node` *(string|node)*: The node to use as a blocker
|
||||
|
||||
@@ -54,5 +66,5 @@ Get blocker enabled state
|
||||
|
||||
## Fields
|
||||
<a name="node"></a>
|
||||
- **node** (_node_)
|
||||
- **node** (_node_): The node that will block input
|
||||
|
||||
|
Reference in New Issue
Block a user