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

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).

isAuto

isAuto: boolean = true

Accessors

isRaf

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

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

tickInterval

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

Methods

wait

wait<K extends "error" | "tick">(
event: K,
timeout?: number,
): Promise<{ tick: [number]; error: [unknown] }[K]>
Await the next emission of a specific event. Resolves with the arguments passed to that event.
Type Parameters
- K extends "error" | "tick"
Parameters
- event: K
- timeout: number = ...
Returns Promise<{ tick: [number]; error: [unknown] }[K]>
Inherited from LeaEventEmitter.wait
- Defined in src/lea.ts:38

waitAny

waitAny<K extends "error" | "tick">(
events: K[],
): Promise<{ event: K; args: { tick: [number]; error: [unknown] }[K] }>
Await the next emission of any one of the listed events. Resolves with { event: name, args: the arguments it received }
Type Parameters
- K extends "error" | "tick"
Parameters
- events: K[]
Returns Promise<{ event: K; args: { tick: [number]; error: [unknown] }[K] }>
Inherited from LeaEventEmitter.waitAny
- Defined in src/lea.ts:58

waitAll

waitAll<const K extends readonly ("error" | "tick")[]>(
    ...events: K,
): Promise<
    {
        [I in string
        | number
        | symbol]: { tick: [number]; error: [unknown] }[K[I<I>]]
    },
>
Type Parameters
- const K extends readonly ("error" | "tick")[]
Parameters
- ...events: K
Returns Promise<
    {
        [I in string
        | number
        | symbol]: { tick: [number]; error: [unknown] }[K[I<I>]]
    },
>
Inherited from LeaEventEmitter.waitAll
- Defined in src/lea.ts:74

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

onWithCleanup

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

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

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

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

`Protected`emitIgnored

emitIgnored<K extends "error" | "tick">(event: K, ...args: any): 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: any
  Arguments to pass to listeners
Returns boolean
true if any listeners were invoked, false otherwise
Inherited from LeaEventEmitter.emitIgnored
- Defined in src/lea.ts:209

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

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

setNow

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

waitMs

waitMs(ms: number, ticker?: LeaTickerII): Promise<void>
Returns a promise that resolves after the given milliseconds. Uses the nearest available ticker if you pass one (recommended), otherwise falls back to setTimeout.
Parameters
- ms: number
- Optionalticker: LeaTickerII
Returns Promise<void>
- Defined in src/lea.ts:590

waitUntil

waitUntil(condition: () => boolean, timeoutMs?: number): Promise<void>
Resolves when the condition function returns true (checked every tick)
Parameters
- condition: () => boolean
- OptionaltimeoutMs: number
Returns Promise<void>
- Defined in src/lea.ts:604

now

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

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

`Private`__tick

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

forcedTick

forcedTick(delta: number): void
Parameters
- delta: number
Returns void
- Defined in src/lea.ts:680

createTimeout

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

createTween

createTween(
config: TweenConfig,
callback?: (change: number) => void,
): DeltaTweenII
Parameters
- config: TweenConfig
- callback: (change: number) => void = ...
Returns DeltaTweenII
- Defined in src/lea.ts:696

createTweenV2

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

start

start(): void
Starts the ticker loop.

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

stop

stop(): void
Stops the ticker loop.

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

getSineMod

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

getLoopMod

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

Class LeaTickerII

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LeaTickerII

Properties

listenerMap

Private__intervalId

Private__lastTime

speedHackDT

isAuto

Accessors

isRaf

Returns boolean

tickInterval

Returns number

Parameters

Returns void

Methods

wait

Type Parameters

Parameters

Returns Promise<{ tick: [number]; error: [unknown] }[K]>

waitAny

Type Parameters

Parameters

Returns Promise<{ event: K; args: { tick: [number]; error: [unknown] }[K] }>

waitAll

Type Parameters

Parameters

Returns Promise< { [I in string | number | symbol]: { tick: [number]; error: [unknown] }[K[I<I>]] },>

on

Type Parameters

Parameters

Returns this

onWithCleanup

Type Parameters

Parameters

Returns () => void

once

Type Parameters

Parameters

Returns this

off

Type Parameters

Parameters

Returns this

emit

Type Parameters

Parameters

Returns boolean

ProtectedemitIgnored

Type Parameters

Parameters

Returns boolean

removeAllListeners

Type Parameters

Parameters

Returns LeaTickerII

listenerCount

Type Parameters

Parameters

Returns number

setNow

Parameters

Returns void

waitMs

Parameters

Returns Promise<void>

waitUntil

Parameters

Returns Promise<void>

now

`Private`__intervalId

`Private`__lastTime

Returns Promise<
{
[I in string
| number
| symbol]: { tick: [number]; error: [unknown] }[K[I<I>]]
},
>

`Protected`emitIgnored

`Private`__tick