mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-12-15 12:40:30 +00:00
Code Issues Releases Wiki Activity
4d064d1552
CC-Tweaked/doc/events/timer.md
Jonathan Coates 8a203e7454
Re-license several more files under MPL-2.0 
- Several files where @MCJack123 is the exclusive contributor. He has
   signed over all contributions to "any OSI-approved license". Thank
   you!

 - Various the file handle classes: Looking at these again, I don't
   think they contain any of the original code.
2023-03-28 10:28:59 +01:00

575 B
Raw Blame History

module: [kind=event] timer see: os.startTimer To start a timer.

The @{timer} event is fired when a timer started with @{os.startTimer} completes.

Return Values

  1. @{string}: The event name.
  2. @{number}: The ID of the timer that finished.

Example

Start and wait for a timer to finish.

local timer_id = os.startTimer(2)
local event, id
repeat
    event, id = os.pullEvent("timer")
until id == timer_id
print("Timer with ID " .. id .. " was fired")