Skip to content

Class: Ticker ​

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

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:15

Accessors ​

tickers ​

Get Signature ​

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

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

Returns ​

Map<number, TickerFunction>


tpsFiveSeconds ​

Get Signature ​

ts
get static tpsFiveSeconds(): number;

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

Returns ​

number


tpsOneSecond ​

Get Signature ​

ts
get static tpsOneSecond(): number;

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

Returns ​

number

Methods ​

add() ​

ts
static add(tick): number;

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

Parameters ​

ParameterType
tickTickerFunction

Returns ​

number


dispose() ​

ts
static dispose(): void;

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

Returns ​

void


remove() ​

ts
static remove(c?): void;

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

Parameters ​

ParameterType
c?number

Returns ​

void


start() ​

ts
static start(): void;

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

Returns ​

void


stop() ​

ts
static stop(): void;

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

Returns ​

void