Skip to content

Class: Ticker ​

Defined in: packages/minerender/src/Ticker.ts:18

Shared 20-per-second tick loop, used for things like animated texture frames.

The timers are started lazily by Ticker.add and unref'd where the platform supports it - importing MineRender must never on its own keep a Node process alive.

Constructors ​

Constructor ​

ts
new Ticker(): Ticker;

Returns ​

Ticker

Properties ​

PropertyModifierTypeDefault valueDefined in
TPSreadonly2020packages/minerender/src/Ticker.ts:20

Accessors ​

tickers ​

Get Signature ​

ts
get static tickers(): Map<number, TickerFunction>;

Defined in: packages/minerender/src/Ticker.ts:97

Returns ​

Map<number, TickerFunction>


tpsFiveSeconds ​

Get Signature ​

ts
get static tpsFiveSeconds(): number;

Defined in: packages/minerender/src/Ticker.ts:105

Returns ​

number


tpsOneSecond ​

Get Signature ​

ts
get static tpsOneSecond(): number;

Defined in: packages/minerender/src/Ticker.ts:101

Returns ​

number

Methods ​

add() ​

ts
static add(tick): number;

Defined in: packages/minerender/src/Ticker.ts:83

Registers a callback, starts the loop if needed, and returns an ID for remove.

Parameters ​

ParameterType
tickTickerFunction

Returns ​

number


dispose() ​

ts
static dispose(): void;

Defined in: packages/minerender/src/Ticker.ts:110

Stops the loop and removes all registered callbacks.

Returns ​

void


remove() ​

ts
static remove(c?): void;

Defined in: packages/minerender/src/Ticker.ts:91

Removes a callback by ID and stops the timers when no callbacks remain.

Parameters ​

ParameterType
c?number

Returns ​

void


start() ​

ts
static start(): void;

Defined in: packages/minerender/src/Ticker.ts:46

Starts or resumes the shared tick loop. Repeated calls have no effect.

Returns ​

void


stop() ​

ts
static stop(): void;

Defined in: packages/minerender/src/Ticker.ts:73

Pauses the loop while retaining callbacks for a later start.

Returns ​

void