library-mirrors/cron.lua
1
0
Fork 0
mirror of https://github.com/kikito/cron.lua.git synced 2024-12-19 18:34:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Enrique García Cota 2011-04-24 17:08:22 +02:00
parent 63152e9d1b
commit f6f8648c4e
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.textile
View File

@ -4,9 +4,9 @@ h1. cron.lua
h1. Examples of use h1. Examples of use
* @cron.after(time, callback)@ will execute callback after the given amount of time units. * @cron.after(time, callback)@ will execute callback after the given amount of time units. Returns an identifier (@id@)
* @cron.every(time, callback)@ will repeat the same action periodically. * @cron.every(time, callback)@ will repeat the same action periodically. Returns an identifier (@id@)
* @cron.cancel(id)@ will stop a timed event from happening. @id@ is returned by @cron.after@ and @cron.every@ respectively. It will stop a timed event from happening, or stop a periodic action. * @cron.cancel(id)@ will stop a timed event from happening. It will stop a timed event from happening, or stop a periodic action.
* @cron.reset()@ removes all timed and periodic actions, and resets the time passed back to 0. * @cron.reset()@ removes all timed and periodic actions, and resets the time passed back to 0.
* @cron.update(dt)@ is needed to be executed on the main program loop. @dt@ is the amount of time that has passed since the last iteration. When @cron.update@ is executed, cron will check the list of pending actions and execute them if needed. * @cron.update(dt)@ is needed to be executed on the main program loop. @dt@ is the amount of time that has passed since the last iteration. When @cron.update@ is executed, cron will check the list of pending actions and execute them if needed.