gameplate - v2.3.0
    Preparing search index...

    Interface Timers

    A pool of game-time timers. Drive it with Timers.advance.

    interface Timers {
        after: (seconds: number, callback: () => void) => TimerHandle;
        every: (seconds: number, callback: () => void) => TimerHandle;
        advance: (dt: number) => void;
        cancelAll: () => void;
        count: () => number;
    }
    Index

    Properties

    after every advance cancelAll count

    Properties

    after: (seconds: number, callback: () => void) => TimerHandle

    Fire callback once, seconds of game time from now. A non-positive seconds fires on the next advance.

    every: (seconds: number, callback: () => void) => TimerHandle

    Fire callback every seconds of game time, repeatedly. seconds must be > 0. If a single advance spans multiple intervals, the callback fires once per elapsed interval (catch-up), preserving the remainder.

    advance: (dt: number) => void

    Advance every active timer by dt seconds, firing those that come due (in scheduule order). Timers created during an advance wait for the next one.

    cancelAll: () => void

    Cancel every timer.

    count: () => number

    Number of currently-active timers.

    Settings

    Member Visibility

    On This Page

    Properties