1.2.0 #1
@@ -9,24 +9,29 @@ but that misses the biggest benefit, which is the timer library itself managing
|
|||||||
timers, including discarding expired timers:
|
timers, including discarding expired timers:
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
timer.after(time, function, ...) -- runs once after time
|
timer.after(deadline, function, ...) -- runs once after time
|
||||||
timer.every(time, function, ...) -- runs repeatedly, every time
|
timer.every(interval, function, ...) -- runs repeatedly, every time
|
||||||
|
|
||||||
timer.update(delta) -- increment, run functions, discard expired..
|
timer.update(delta) -- increment, run functions, discard expired..
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Functions are completely optional, so you can use the mechanism to track time
|
||||||
|
rather than execute functions. `timer:get_run_time()` returns the amount of time
|
||||||
|
since the last interval. (Note: This is only useful for repeating timers.
|
||||||
|
One-run timers will only count to their `deadline` once, unless manually run.)
|
||||||
|
|
||||||
A timer can be excluded from `timer.update`, in which case it must be manually
|
A timer can be excluded from `timer.update`, in which case it must be manually
|
||||||
updated:
|
updated:
|
||||||
```lua
|
```lua
|
||||||
local my_timer = timer.every(time, function, ...)
|
local my_timer = timer.every(interval, function, ...)
|
||||||
my_timer.manual = true
|
my_timer:set_manual(true)
|
||||||
|
|
||||||
my_timer:update(delta)
|
my_timer:update(delta)
|
||||||
```
|
```
|
||||||
|
|
||||||
`timer.update` returns a table of expired timers. Example:
|
`timer.update` returns a table of expired timers. Example:
|
||||||
```lua
|
```lua
|
||||||
local my_timer = timer.after(time, function, ...)
|
local my_timer = timer.after(deadline, function, ...)
|
||||||
|
|
||||||
local expired = timer.update(delta)
|
local expired = timer.update(delta)
|
||||||
if expired[my_timer] then
|
if expired[my_timer] then
|
||||||
@@ -34,14 +39,18 @@ if expired[my_timer] then
|
|||||||
end
|
end
|
||||||
```
|
```
|
||||||
|
|
||||||
Timers can have their time set to a new value with `my_timer:reset(time)`. If
|
Timers can have their run time set to a new value with `my_timer:reset(time)`.
|
||||||
nothing is passed, they will be set to `0`.
|
If nothing is passed, they will be set to `0`.
|
||||||
|
|
||||||
|
- One-run timers can have their `deadline` changed with
|
||||||
|
`my_timer:set_deadline(time)`.
|
||||||
|
- Repeating timers can have their `interval` changed with
|
||||||
|
`my_timer:set_interval(time)`.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
Incompatibilities / Changes from kikito's cron.lua:
|
Incompatibilities / Changes from kikito's cron.lua:
|
||||||
- Number values are not checked or restricted.
|
- There are no checks or restrictions on what can be set.
|
||||||
- Different error message for callback not being callable.
|
|
||||||
- If a one-time timer is run by `timer.update`, it will *no longer be updated*
|
- If a one-time timer is run by `timer.update`, it will *no longer be updated*
|
||||||
by `timer.update`, even if reset.
|
by `timer.update`, even if reset.
|
||||||
|
|
||||||
@@ -51,5 +60,5 @@ GitHub unpublishes my releases frequently, check tags to find them!
|
|||||||
## Ideas / Tasks
|
## Ideas / Tasks
|
||||||
- [ ] Make an import/export format and add save/load functions - resumable timers.
|
- [ ] Make an import/export format and add save/load functions - resumable timers.
|
||||||
- [ ] Make it possible to save/load with a unix timestamp. (Dangerous.)
|
- [ ] Make it possible to save/load with a unix timestamp. (Dangerous.)
|
||||||
- [ ] Make an access function `get_run_time`
|
- [x] Make an access function `get_run_time`
|
||||||
- [ ] Make functions optional
|
- [x] Make functions optional
|
||||||
|
|||||||
Reference in New Issue
Block a user