nextRand( ) → number

now( ) → number

Seconds the kit's clock has advanced (play time the host has ticked).

inPlay( ) → boolean

True in play mode (or while a test forces it).

_playScope(on: boolean?) → void

Tests only: force play mode on or off (nil = follow engine.mode).

random(lo: number, hi: number) → number

A uniform random number in [lo, hi).

randomInt(lo: number, hi: number) → number

A random whole number in [lo, hi].

_seed(n: number) → void

Tests only: reseed the random source so a run repeats.

onTick(name: string, fn: (number) → void

Register a per-frame step under a name (re-registering the name replaces it).

tick(dt: number) → void

Advance the kit by dt seconds: the clock, then every registered step in order.

hostComponent( ) → string

ensureHost( ) → void

Make sure the local host entity that ticks the kit exists (play mode only). Every public call that needs time to pass calls this, so a game never places it by hand.

_attach(id: string) → void

_detach(id: string) → void

host( ) → string

The host entity id, or nil when none is running.

realVoice(name: string, fields: { [string]: any }, at: vector?) → any

comp( ) → any

setVolume(x: number) → void

setClip(clip: any) → void

play( ) → void

stop( ) → void

destroy( ) → void

oneShot(clip: any, o: any?) → void

moveTo(p: vector) → void

isReady( ) → boolean

the mixer is playing this voice's clip: a streamed clip spends its first frames loading, and a fade that rises over those frames is a fade nobody hears

voiceReady(v: any) → boolean

Whether a voice is really sounding yet (a voice that cannot tell counts as ready).

voice(name: string, fields: { [string]: any }, at: vector?) → any

Spawn a kit-owned voice: `fields` are Audio component fields, `at` an optional position.

_useVoiceFactory(fn: any) → void

Tests only: build voices with `fn(name, fields, at)` instead of spawning entities (nil = real).

worldStore( ) → any

The world-wide shared store (runtime_data.world, or a test stand-in).

playerStore(id: string) → any

A player's store (runtime_data.player(id), or a test stand-in).

localId( ) → string

This client's player id, or nil when it has none.

_useStores(world: any, player: any) → void

Tests only: use stand-in stores (nil restores runtime_data).

players( ) → any

The players registry of the active root scene, or nil.

playerCount( ) → number

How many players are connected (1 when the registry cannot say).

othersPresent( ) → boolean

True when another player is in this play session: the players registry lists one, or the relay's play room holds another peer (the room knows before a joiner's registry does).

_usePlayers(reg: any, others: boolean?) → void

Tests only: stand in for the players registry and for whether others are present (nil = the real ones).

relaySend(channel: string, msg: any) → void

Send a transient message to every other player in the session (multiplayer.send). Nothing is stored: a player who is not here when it is sent never hears it.

relayOn(channel: string, fn: (any, any) → void

Hear other players' messages on `channel`: `fn(fromPeer, msg)` (multiplayer.on).

_useRelay(r: any) → void

Tests only: use a stand-in relay `{ send(channel, msg), on(channel, fn) }` (nil = multiplayer).

listenerPosition( ) → vector

Where this client hears from: the local avatar when there is one, else the camera.

toVector(v: any) → vector

Read a vector-ish value (vector, {x,y,z} or an entity) as a vector, or nil.

_reset( ) → void

Tests only: forget the host and clock.