Skip to content
PEERLESSDocs

Events

Event types delivered through Peerless.on(type, listener).

Subscribing

const unsubscribe = Peerless.on("overlay", ({ visible }) => setPaused(visible));
// Later:
unsubscribe();

Event types

TypeValueWhen
overlay{ visible }A player panel opened or closed. Held keys and pointer lock are already released.
audio{ muted, volume }The player changed volume or mute.
leave-game{}The player chose Leave game.
eventYour event plus senderA relay room event.
presenceRoom rosterA relay room roster changed.
disconnect{ room }A relay connection closed.
errorstringA relay connection or message error.
session{ intent }A platform session update while a lobby is bound.
session-errorErrorA session request failed; the binding keeps retrying.
social-errorErrorA social refresh failed; the last snapshot is kept.
host-changeHostChangeA listen or hybrid host election.

Typed overloads in peerless-sdk.d.ts give each listener the right value type.