Interface TimerHandle

Handle to a scheduled timer. Returned by Timers.after / Timers.every.

interface TimerHandle {
    cancel: () => void;
    active: () => boolean;
    remaining: () => number;
}

Index

Properties

cancel active remaining

Properties

`Readonly`cancel

cancel: () => void

Cancel the timer. Idempotent; safe to call from inside its own callback.

`Readonly`active

active: () => boolean

true until the timer has fired (one-shot) or been cancelled.

`Readonly`remaining

remaining: () => number

Seconds of game time until the next fire. 0 once elapsed.