Skip to main content

Player

A player connected to a room.

TYPE
object

Properties

NAMETYPEDESCRIPTION
idstringThe user ID for this player. This will be shared if the same player joins a room multiple times
connectionIdstringThe ID for this players connection. This will be unique if the same player joins the room multiple times
role"GM" | "PLAYER"The current role for the player
selectionstring[]An optional array of item IDs referencing what this player has selected
colorstringThe chosen color for this player
syncViewbooleanWhether this player has sync view enabled
metadataMetadataThe custom metadata for this player