Class Room

Represents the client's view of a game room. Manages players, state, and dispatches room events.

Index

Constructors

Accessors

gameState hostId isHost isInRoom playerCount players roomId

Methods

destroy leave onAction onPlayerJoined onPlayerLeft onPlayerUpdated onStateChanged ready sendAction sendState

Constructors

constructor

new Room(network: NetworkManager): Room
Parameters
- network: NetworkManager
Returns Room
- Defined in packages/clik-engine/src/network/Room.ts:27

Accessors

gameState

get gameState(): Record<string, unknown>
Get the current game state

Returns Record<string, unknown>
- Defined in packages/clik-engine/src/network/Room.ts:126

hostId

get hostId(): string | null
Get the host player ID

Returns string | null
- Defined in packages/clik-engine/src/network/Room.ts:113

isHost

get isHost(): boolean
Check if the local player is the host

Returns boolean
- Defined in packages/clik-engine/src/network/Room.ts:116

isInRoom

get isInRoom(): boolean
Check if in a room

Returns boolean
- Defined in packages/clik-engine/src/network/Room.ts:136

playerCount

get playerCount(): number
Get player count

Returns number
- Defined in packages/clik-engine/src/network/Room.ts:131

players

get players(): PlayerInfo[]
Get all players in the room

Returns PlayerInfo[]
- Defined in packages/clik-engine/src/network/Room.ts:121

roomId

get roomId(): string | null
Get the room ID

Returns string | null
- Defined in packages/clik-engine/src/network/Room.ts:110

Methods

destroy

destroy(): void
Returns void
- Defined in packages/clik-engine/src/network/Room.ts:167

leave

leave(): void
Leave the current room

Returns void
- Defined in packages/clik-engine/src/network/Room.ts:86

onAction

onAction(handler: ActionHandler): this
Parameters
- handler: ActionHandler
Returns this
- Defined in packages/clik-engine/src/network/Room.ts:157

onPlayerJoined

onPlayerJoined(handler: PlayerHandler): this
Parameters
- handler: PlayerHandler
Returns this
- Defined in packages/clik-engine/src/network/Room.ts:142

onPlayerLeft

onPlayerLeft(handler: (id: string) => void): this
Parameters
- handler: (id: string) => void
Returns this
- Defined in packages/clik-engine/src/network/Room.ts:147

onPlayerUpdated

onPlayerUpdated(handler: PlayerHandler): this
Parameters
- handler: PlayerHandler
Returns this
- Defined in packages/clik-engine/src/network/Room.ts:152

onStateChanged

onStateChanged(handler: StateHandler): this
Parameters
- handler: StateHandler
Returns this
- Defined in packages/clik-engine/src/network/Room.ts:162

ready

ready(isReady?: boolean): void
Set ready status
Parameters
- isReady: boolean = true
Returns void
- Defined in packages/clik-engine/src/network/Room.ts:95

sendAction

sendAction(type: string, data?: Record<string, unknown>): void
Send a game action to all players in the room
Parameters
- type: string
- Optionaldata: Record<string, unknown>
Returns void
- Defined in packages/clik-engine/src/network/Room.ts:100

sendState

sendState(state: Record<string, unknown>): void
Send game state update (host typically does this)
Parameters
- state: Record<string, unknown>
Returns void
- Defined in packages/clik-engine/src/network/Room.ts:105