along(z: number) → number

How far along the lane a z is, 0 at the start and 1 at the roost.

screen( ) → Screen

The live screen size and whether it is taller than it is wide.

unit(fraction: number) → number

A length that is `fraction` of the screen's SHORT side, in canvas units — the unit type sizes, paddings and gaps are stated in, so a card reads the same on a phone held either way and on a wide monitor.

on(name: string, fn: Handler) → void

Subscribe to a named event. Returns a function that unsubscribes.

emit(name: string, payload: any?) → void

Fire a named event. A handler that raises is logged and the others still run.

phase( ) → Phase

setPhase(next: Phase) → void

Move to a new phase and tell everyone. Entering "playing" from anywhere but "paused" resets the run clock.

resume( ) → void

Resume from "paused" to whatever phase was interrupted.

tick(dt: number) → void

Advance the run clock. Only the rules slice calls this, once per frame, while the phase is "playing".

runTime( ) → number

Seconds since the run began.

progress( ) → number

0 at the start of the run, 1 when first light has filled the floor.

light( ) → number

The light on the floor, 0..1, eased so the dark holds and then goes fast.

provide(name: string, surface: any) → void

Publish a surface under a name. The shapes are documented in the spec.

get(name: string) → any

Fetch a surface, or nil when its slice has not published yet.

whenProvided(name: string, fn: (any) → void

Fetch a surface now if it exists, else the moment it is provided.

lerp(a: number, b: number, t: number) → number

Small maths every slice ends up rewriting.

smooth(t: number) → number

approach(current: number, target: number, rate: number, dt: number) → number

Exponential approach: moves `current` toward `target` at `rate` per second.

hash(a: number, b: number?) → number

A deterministic hash in [0, 1) for scattering props the same way on every peer.