RoomOptions

Where a game joins a room, and the name its character wears there.

Properties

Property	Type	Default value	Description
avatar?	string	undefined	The registered avatar her character is drawn in, on every page in the room: the scene CharacterSpawn’s when left out.
connectionText?	Partial<Record<ConnectionNotice, string>>	undefined	The game’s own sentence for any of the page’s notices about her connection, such as { reconnecting: "The fire dims…" }, which useRoom’s notice reads, as does the loading screen’s line for a game over. A notice left out keeps the engine’s connectionNoticeText.
playerName	string	undefined	-
reconnectGiveUpSeconds?	number	60	Seconds with no socket open before the page stops trying for the same character and takes a new seat, and before a try on a new seat gives up.
seat?	string	undefined	The seat ticket the app handed the page, which a room the backend runs asks for: none outside the app.
url	string	undefined	The room’s WebSocket address.
wire?	WireFormat	undefined	How the room spells what it sends: binary when left out, JSON text for an agent or a person reading the socket.