ModuleClientApi - GameLib Room

Class representing the GameLib Room inside the ModuleServerAPI.

Methods

Create a new game.

Room.newGame(gameDetails);

Argument	Type	Description
gameDetails	GameDetails	The details of the game.

Return Game Game instance.

Clear the queue.

Room.clearQueue();

Get the amount of players in the waiting queue.

Room.getQueueLength();

Return number Players in the queue.

Triggers when a player join the queue.

Room.on('playerJoinQueue', (player) => {});

Argument	Type	Description
player	GamePlayer	The player that joined the queue.

Triggers when a player leaves the queue.

Room.on('playerLeaveQueue', (player) => {});

Argument	Type	Description
player	GamePlayer	The player that left the queue.

Triggers when the queue updates.

Room.on('queueUpdate', (players) => {});

Argument	Type	Description
players	GamePlayer[]	The players in the queue.

Triggers when the active game changes.

Room.on('activeGameChanged', (gameDetails) => {});

Argument	Type	Description
gameDetails	GameDetails	The details of the new active game.

Triggers when the main scoreboard of the active game updates.

Room.on('mainScoreboardUpdate', (state) => {});

Argument	Type	Description
state	ScoreboardState	The current state of the scoreboard.

Triggers when any scoreboard of the active game updates.

Room.on('anyScoreboardUpdates', (state) => {});

Argument	Type	Description
state	ScoreboardState	The current state of the scoreboard.