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
41c83988a1
CC-Tweaked/doc/events/timer.md
Jonathan Coates 2014e9527e
Some event typo fixes
2023-01-16 22:53:58 +00:00

475 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")