mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-11-19 08:14:52 +00:00
Code Issues Releases Wiki Activity
0d6528aaf0
CC-Tweaked/doc/events/timer.md
JackMacWindows a934e42219
Finish the rest of the event documentation (#683)
2021-01-19 09:20:52 +00:00

474 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

Starts a timer and then prints its ID:

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