mirror of
https://github.com/Insality/druid
synced 2025-09-27 18:12:21 +02:00
Reimport docs
This commit is contained in:
@@ -2,11 +2,11 @@
|
||||
|
||||
> at /druid/extended/timer.lua
|
||||
|
||||
The component that handles a text to display a seconds timer
|
||||
|
||||
|
||||
## Functions
|
||||
- [init](#init)
|
||||
- [update](#update)
|
||||
- [on_layout_change](#on_layout_change)
|
||||
- [set_to](#set_to)
|
||||
- [set_state](#set_state)
|
||||
- [set_interval](#set_interval)
|
||||
@@ -42,23 +42,6 @@ timer:init(node, [seconds_from], [seconds_to], [callback])
|
||||
- **Returns:**
|
||||
- `` *(druid.timer)*:
|
||||
|
||||
### update
|
||||
|
||||
---
|
||||
```lua
|
||||
timer:update([dt])
|
||||
```
|
||||
|
||||
- **Parameters:**
|
||||
- `[dt]` *(any)*:
|
||||
|
||||
### on_layout_change
|
||||
|
||||
---
|
||||
```lua
|
||||
timer:on_layout_change()
|
||||
```
|
||||
|
||||
### set_to
|
||||
|
||||
---
|
||||
@@ -66,11 +49,13 @@ timer:on_layout_change()
|
||||
timer:set_to(set_to)
|
||||
```
|
||||
|
||||
Set the timer to a specific value
|
||||
|
||||
- **Parameters:**
|
||||
- `set_to` *(number)*: Value in seconds
|
||||
|
||||
- **Returns:**
|
||||
- `self` *(druid.timer)*:
|
||||
- `self` *(druid.timer)*: Current timer instance
|
||||
|
||||
### set_state
|
||||
|
||||
@@ -79,11 +64,13 @@ timer:set_to(set_to)
|
||||
timer:set_state([is_on])
|
||||
```
|
||||
|
||||
Set the timer to a specific value
|
||||
|
||||
- **Parameters:**
|
||||
- `[is_on]` *(boolean|nil)*: Timer enable state
|
||||
|
||||
- **Returns:**
|
||||
- `self` *(druid.timer)*:
|
||||
- `self` *(druid.timer)*: Current timer instance
|
||||
|
||||
### set_interval
|
||||
|
||||
@@ -92,38 +79,40 @@ timer:set_state([is_on])
|
||||
timer:set_interval(from, to)
|
||||
```
|
||||
|
||||
Set the timer interval
|
||||
|
||||
- **Parameters:**
|
||||
- `from` *(number)*: Start time in seconds
|
||||
- `to` *(number)*: Target time in seconds
|
||||
|
||||
- **Returns:**
|
||||
- `self` *(druid.timer)*:
|
||||
- `self` *(druid.timer)*: Current timer instance
|
||||
|
||||
|
||||
## Fields
|
||||
<a name="on_tick"></a>
|
||||
- **on_tick** (_event_)
|
||||
- **on_tick** (_event_): fun(context, value) The event triggered when the timer ticks
|
||||
|
||||
<a name="on_set_enabled"></a>
|
||||
- **on_set_enabled** (_event_)
|
||||
- **on_set_enabled** (_event_): fun(context, is_on) The event triggered when the timer is enabled
|
||||
|
||||
<a name="on_timer_end"></a>
|
||||
- **on_timer_end** (_event_)
|
||||
- **on_timer_end** (_event_): fun(context) The event triggered when the timer ends
|
||||
|
||||
<a name="node"></a>
|
||||
- **node** (_node_)
|
||||
- **node** (_node_): The node to display the timer
|
||||
|
||||
<a name="from"></a>
|
||||
- **from** (_number_)
|
||||
- **from** (_number_): The start time of the timer
|
||||
|
||||
<a name="target"></a>
|
||||
- **target** (_number_)
|
||||
- **target** (_number_): The target time of the timer
|
||||
|
||||
<a name="value"></a>
|
||||
- **value** (_number_)
|
||||
- **value** (_number_): The current value of the timer
|
||||
|
||||
<a name="is_on"></a>
|
||||
- **is_on** (_boolean_)
|
||||
- **is_on** (_boolean_): True if the timer is on
|
||||
|
||||
<a name="temp"></a>
|
||||
- **temp** (_unknown_)
|
||||
|
Reference in New Issue
Block a user