Class LeaTickerII

Fixed or variable timestep ticker that emits a "tick" event with delta time (seconds).

Supports RAF mode (tickInterval = Infinity) or fixed interval.

Example

const ticker = new LeaTickerII(1000 / 60); // 60 Hz
ticker.on("tick", (delta) => {
  // update game state
});
ticker.start();

Hierarchy (View Summary)

LeaEventEmitter<{ tick: [number]; error: [unknown] }>
- LeaTickerII

Index

Constructors

constructor

new LeaTickerII(tickInterval?: number): LeaTickerII
Parameters
- tickInterval: number = 16
  Interval in ms
Returns LeaTickerII
Overrides LeaEventEmitter.constructor
- Defined in src/lea.ts:456

Properties

listenerMap

listenerMap: Map<"error" | "tick", Listener<any[]>[]> = ...

`Private`__intervalId

__intervalId: () => void = null

`Private`__lastTime

__lastTime: number = 0

speedHackDT

speedHackDT: number

Speed multiplier for delta time (for slow-motion / fast-forward).

Accessors

isRaf

get isRaf(): boolean
Whether the ticker is using requestAnimationFrame (RAF) mode.

Returns boolean
- Defined in src/lea.ts:470

tickInterval

get tickInterval(): number
Tick interval in milliseconds.
- Finite number = fixed timestep
- Infinity = RAF / variable timestep
Returns number
- Defined in src/lea.ts:481
set tickInterval(s: number): void
Parameters
- s: number
Returns void
- Defined in src/lea.ts:485

Methods

on

on<K extends "error" | "tick">(
event: K,
listener: (...args: { tick: [number]; error: [unknown] }[K]) => void,
): this
Registers a listener for the specified event.
Type Parameters
- K extends "error" | "tick"
  Event name
Parameters
- event: K
  The name of the event
- listener: (...args: { tick: [number]; error: [unknown] }[K]) => void
  The callback to invoke when the event is emitted
Returns this
This emitter for chaining
Inherited from LeaEventEmitter.on
- Defined in src/lea.ts:38

once

once<K extends "error" | "tick">(
event: K,
listener: (...args: { tick: [number]; error: [unknown] }[K]) => void,
): this
Registers a one-time listener for the specified event.

The listener is automatically removed after the first invocation.
Type Parameters
- K extends "error" | "tick"
  Event name
Parameters
- event: K
  The name of the event
- listener: (...args: { tick: [number]; error: [unknown] }[K]) => void
  The callback to invoke once
Returns this
This emitter for chaining
Inherited from LeaEventEmitter.once
- Defined in src/lea.ts:58

off

off<K extends "error" | "tick">(
event: K,
listener: (...args: { tick: [number]; error: [unknown] }[K]) => void,
): this
Removes a listener for the specified event.
Type Parameters
- K extends "error" | "tick"
  Event name
Parameters
- event: K
  The name of the event
- listener: (...args: { tick: [number]; error: [unknown] }[K]) => void
  The callback to remove
Returns this
This emitter for chaining
Inherited from LeaEventEmitter.off
- Defined in src/lea.ts:78

emit

emit<K extends "error" | "tick">(
event: K,
...args: { tick: [number]; error: [unknown] }[K],
): boolean
Emits an event, invoking all registered listeners with the provided arguments.

If the event is "error" and no listeners are registered, the first argument (the error) will be thrown.
Type Parameters
- K extends "error" | "tick"
  Event name
Parameters
- event: K
  The name of the event to emit
- ...args: { tick: [number]; error: [unknown] }[K]
  Arguments to pass to listeners
Returns boolean
true if any listeners were invoked, false otherwise
Inherited from LeaEventEmitter.emit
- Defined in src/lea.ts:100

removeAllListeners

removeAllListeners<K extends "error" | "tick">(event?: K): LeaTickerII
Removes all listeners for the specified event, or all listeners if no event is provided.
Type Parameters
- K extends "error" | "tick"
  Event name
Parameters
- Optionalevent: K
  Optional event name to clear listeners for
Returns LeaTickerII
This emitter for chaining
Inherited from LeaEventEmitter.removeAllListeners
- Defined in src/lea.ts:122

listenerCount

listenerCount<K extends "error" | "tick">(event: K): number
Returns the number of listeners registered for the specified event.
Type Parameters
- K extends "error" | "tick"
  Event name
Parameters
- event: K
  The event to count listeners for
Returns number
The number of registered listeners
Inherited from LeaEventEmitter.listenerCount
- Defined in src/lea.ts:138

setNow

setNow(now: number): void
Parameters
- now: number
Returns void
- Defined in src/lea.ts:446

now

now(): number
Current time in milliseconds (monotonic).

Returns number
- Defined in src/lea.ts:496

`Private`__tick

__tick(): void
Returns void
- Defined in src/lea.ts:500

createTimeout

createTimeout(ms: number): LeaTimeout
Parameters
- ms: number
Returns LeaTimeout
- Defined in src/lea.ts:513

createTween

createTween(
config: { delta: number; ms: number; easing?: (t: number) => number },
callback?: (change: number) => void,
): DeltaTweenII
Parameters
- config: { delta: number; ms: number; easing?: (t: number) => number }
- callback: (change: number) => void = ...
Returns DeltaTweenII
- Defined in src/lea.ts:517

createTweenV2

createTweenV2(
config: { delta: number; ms: number; easing?: (t: number) => number },
callback?: (change: number) => void,
): { inst: DeltaTweenII; stop(): void }
Parameters
- config: { delta: number; ms: number; easing?: (t: number) => number }
- callback: (change: number) => void = ...
Returns { inst: DeltaTweenII; stop(): void }
- Defined in src/lea.ts:538

start

start(): void
Starts the ticker loop.

Returns void
- Defined in src/lea.ts:569

stop

stop(): void
Stops the ticker loop.

Returns void
- Defined in src/lea.ts:581

getSineMod

getSineMod(ms: number, offset?: number): number
Parameters
- ms: number
- offset: number = 0
Returns number
- Defined in src/lea.ts:596

getLoopMod

getLoopMod(ms: number, offset?: number): number
Parameters
- ms: number
- offset: number = 0
Returns number
- Defined in src/lea.ts:602

Class LeaTickerII

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LeaTickerII

Properties

listenerMap

Private__intervalId

Private__lastTime

speedHackDT

Accessors

isRaf

Returns boolean

tickInterval

Returns number

Parameters

Returns void

Methods

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

off

Type Parameters

Parameters

Returns this

emit

Type Parameters

Parameters

Returns boolean

removeAllListeners

Type Parameters

Parameters

Returns LeaTickerII

listenerCount

Type Parameters

Parameters

Returns number

setNow

Parameters

Returns void

now

Returns number

Private__tick

Returns void

createTimeout

Parameters

Returns LeaTimeout

createTween

Parameters

Returns DeltaTweenII

createTweenV2

Parameters

Returns { inst: DeltaTweenII; stop(): void }

start

Returns void

stop

Returns void

getSineMod

Parameters

Returns number

getLoopMod

Parameters

Returns number

Settings

On This Page

`Private`__intervalId

`Private`__lastTime

`Private`__tick