From 8403670a9884b298c9ef8f6ce8d45d3ad59d1265 Mon Sep 17 00:00:00 2001 From: Mees van der Wijk Date: Sun, 10 Aug 2025 16:14:28 +0200 Subject: [PATCH] Updated GameLib --- ModuleClientAPIGameLibController.md | 6 ++-- ModuleServerAPIGameLibGame.md | 53 ++++++++++++++++++++++++++++- 2 files changed, 55 insertions(+), 4 deletions(-) diff --git a/ModuleClientAPIGameLibController.md b/ModuleClientAPIGameLibController.md index a4f59f3..99208a5 100644 --- a/ModuleClientAPIGameLibController.md +++ b/ModuleClientAPIGameLibController.md @@ -74,9 +74,9 @@ Triggers when the endscreen should be shown. Controller.on('endScreen', (endScreen) => {}); ``` -| Argument | Type | Description | -| --------- | ------------------------------------------- | ------------------- | -| endScreen | [EndScreen](./ModuleAPIGameLibEndScreen.md) | The endscreen data. | +| Argument | Type | Description | +| --------- | ---------------------------------------- | ------------------- | +| endScreen | [EndScreen](./ModuleAPIGameLibEndScreen) | The endscreen data. | ### on: queuePositionUpdate diff --git a/ModuleServerAPIGameLibGame.md b/ModuleServerAPIGameLibGame.md index 778e832..aa84b69 100644 --- a/ModuleServerAPIGameLibGame.md +++ b/ModuleServerAPIGameLibGame.md @@ -52,12 +52,63 @@ Game.setMainScoreboard(scoreboard); ### requestFromQueue +Request a player from the queue. When the queue is empty it will return null. + +```javascript +Game.requestFromQueue(); +``` + +**Return** [GamePlayer](./ModuleServerAPIGameLibGamePlayer) _GamePlayer instance._ + ### removePlayer +Remove a player from the game and show them their endscreen. + +```javascript +Game.removePlayer(clientId, endScreen); +``` + +| Argument | Type | Description | +| --------- | ---------------------------------------- | ---------------------------- | +| clientId | string | The client id of the player. | +| endScreen | [EndScreen](./ModuleAPIGameLibEndScreen) | The endscreen data. | + ### getPlayer -### getPlayers +Get a player in the game. + +```javascript +Game.getPlayer(clientId); +``` + +| Argument | Type | Description | +| -------- | ------ | ---------------------------- | +| clientId | string | The client id of the player. | + +**Return** [GamePlayer](./ModuleServerAPIGameLibGamePlayer) _GamePlayer instance._ ### hasPlayer +Check if a player is in the game. + +```javascript +Game.hasPlayer(clientId); +``` + +| Argument | Type | Description | +| -------- | ------ | ---------------------------- | +| clientId | string | The client id of the player. | + +**Return** boolean _Player is in the game._ + +### getPlayers + +Get the players in the game. + +```javascript +Game.getPlayers(); +``` + +**Return** [GamePlayer](./ModuleServerAPIGameLibGamePlayer)[] _GamePlayer instances._ + ## Events