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

Edited README.textile via GitHub

Browse Source
This commit is contained in:
Enrique García 2011-04-25 11:47:58 -07:00
parent a6fed7662d
commit 2e4c3913bf
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.textile
View File

@ -6,7 +6,7 @@ h1. Examples of use
* @cron.after(time, callback)@ will execute callback after the given amount of time units. Returns an identifier (@id@) * @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. Returns an identifier (@id@) * @cron.every(time, callback)@ will repeat the same action periodically. Returns an identifier (@id@)
* @cron.cancel(id)@ will stop a timed event from happening. It will stop a timed event from happening, or stop a periodic action. * @cron.cancel(id)@ will stop a timed action from happening, and will interrupt the periodical execution of 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.