1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2025-10-17 15:07:38 +00:00
Files
CC-Tweaked/doc/events/timer.md
Jonathan Coates 70a24d371d Update build.gradle to more closely match CC:T's
- Adds cct-javadoc fun and renables checkstyle (yay?)
 - Fixes a few javadoc and formatting issues
 - Cherry pick the docs so illuaminate doesn't complain
2021-11-27 09:32:25 +00:00

474 B

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