mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-11-16 23:04:53 +00:00
Code Issues Releases Wiki Activity
234f69e8e5
CC-Tweaked/doc/events/timer.md
Jonathan Coates 52b78f92cd
Use standard Markdown link syntax for references 
References are now written using normal links: You now use [`print`] or
[print a string][`print`]) instead of @{print} or @{print|print a
string}.
2023-08-24 11:23:33 +01:00

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