From af6f636d1c4ef9f447dd9b4f0e35ea35b7177018 Mon Sep 17 00:00:00 2001 From: Mees van der Wijk Date: Sun, 10 Aug 2025 15:36:48 +0200 Subject: [PATCH] Added more specs --- ModuleServerAPIGameLib.md | 30 +++++++++++++++++++++ ModuleServerAPIGameLibGame.md | 3 +++ ModuleServerAPIGameLibGamePlayer.md | 3 +++ ModuleServerAPIGameLibRoom.md | 41 +++++++++++++++++++++++++++++ ModuleServerAPIGameLibScoreboard.md | 3 +++ _Sidebar.md | 9 +++++++ 6 files changed, 89 insertions(+) create mode 100644 ModuleServerAPIGameLibGame.md create mode 100644 ModuleServerAPIGameLibGamePlayer.md create mode 100644 ModuleServerAPIGameLibRoom.md create mode 100644 ModuleServerAPIGameLibScoreboard.md diff --git a/ModuleServerAPIGameLib.md b/ModuleServerAPIGameLib.md index 92aea17..9a4fc67 100644 --- a/ModuleServerAPIGameLib.md +++ b/ModuleServerAPIGameLib.md @@ -2,6 +2,36 @@ Class representing the GameLib inside the ModuleServerAPI. +## Rooms + +### getRoom + +Get a game room. + +```javascript +api.GameLib.getRoom(roomId); +``` + +| Argument | Type | Description | +| -------- | ------ | ------------------- | +| roomId | string | The id of the room. | + +**Return** [GameRoom](./ModuleServerAPIGameLibRoom) _GameRoom instance._ + +### hasRoom + +Check if a game room exists. + +```javascript +api.GameLib.hetRoom(roomId); +``` + +| Argument | Type | Description | +| -------- | ------ | ------------------- | +| roomId | string | The id of the room. | + +**Return** boolean _Room exists._ + ## Collision ### toSpace diff --git a/ModuleServerAPIGameLibGame.md b/ModuleServerAPIGameLibGame.md new file mode 100644 index 0000000..9ba72ab --- /dev/null +++ b/ModuleServerAPIGameLibGame.md @@ -0,0 +1,3 @@ +# ModuleClientApi - GameLib Game + +Class representing the GameLib Game inside the ModuleServerAPI. diff --git a/ModuleServerAPIGameLibGamePlayer.md b/ModuleServerAPIGameLibGamePlayer.md new file mode 100644 index 0000000..4eaae25 --- /dev/null +++ b/ModuleServerAPIGameLibGamePlayer.md @@ -0,0 +1,3 @@ +# ModuleClientApi - GameLib GamePlayer + +Class representing a Player of a GameLib Game inside the ModuleServerAPI. diff --git a/ModuleServerAPIGameLibRoom.md b/ModuleServerAPIGameLibRoom.md new file mode 100644 index 0000000..9bc723a --- /dev/null +++ b/ModuleServerAPIGameLibRoom.md @@ -0,0 +1,41 @@ +# ModuleClientApi - GameLib Room + +Class representing the GameLib Room inside the ModuleServerAPI. + +## Methods + +### newGame + +Create a new game. + +```javascript +room.newGame(gameDetails); +``` + +| Argument | Type | Description | +| ----------- | -------------------------------------------- | ------------------------ | +| gameDetails | [GameDetails](./ModuleApiGameLibGameDetails) | The details of the game. | + +**Return** [Game](./ModuleServerAPIGameLibGame) _Game instance._ + +### clearQueue + +Clear the queue. + +```javascript +room.clearQueue(); +``` + +## Events + +### on: endScreen + +Triggers when the endscreen should be shown. + +```javascript +Controller.on('endScreen', (endScreen) => {}); +``` + +| Argument | Type | Description | +| --------- | ------------------------------------------- | ------------------- | +| endScreen | [EndScreen](./ModuleAPIGameLibEndScreen.md) | The endscreen data. | diff --git a/ModuleServerAPIGameLibScoreboard.md b/ModuleServerAPIGameLibScoreboard.md new file mode 100644 index 0000000..5ede0f2 --- /dev/null +++ b/ModuleServerAPIGameLibScoreboard.md @@ -0,0 +1,3 @@ +# ModuleClientApi - GameLib Scoreboard + +Class representing a Scoreboard of a GameLib Game inside the ModuleServerAPI. diff --git a/_Sidebar.md b/_Sidebar.md index e849be4..df1cc1d 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -3,6 +3,7 @@ - [Setting up server](./ServerSetup) - [Config](./Config) - Module Development + - [Module Structure](./ModuleStructure) - [Module.json](./ModuleJSON) - [Property](./ModuleJSONProperty) @@ -17,13 +18,20 @@ - [GameLib](./ModuleClientAPIGameLib) - [Controller](./ModuleClientAPIGameLibController) - [ModuleServerAPI](./ModuleServerAPI) + - [Important Principals](./ModuleServerAPIPrincipals) - [Client](./ModuleServerAPIClient) - [Property](./ModuleServerAPIProperty) - [GameLib](./ModuleServerAPIGameLib) + - [Room](./ModuleServerAPIGameLibRoom) + - [Game](./ModuleServerAPIGameLibGame) + - [GamePlayer](./ModuleServerAPIGameLibGamePlayer) + - [Scoreboard](./ModuleServerAPIGameLibScoreboard) + - [GameLib CollisionSpace](./ModuleServerAPIGameLibCollisionSpace) - [Libs](./ModuleServerAPILibs) - [LibWebSocket](./ModuleServerAPILibsWebSocketLib) - [Axios](https://axios-http.com/docs/instance) + - ModuleApi Shared - [GameLib GameDetails](./ModuleApiGameLibGameDetails) - [GameLib EndScreen](./ModuleAPIGameLibEndScreen) @@ -32,5 +40,6 @@ - [GameLib Ratio](./ModuleAPIGameLibRatio) - [Module Debugging](./ModuleDebugging) - [ModuleStore](./ModuleStore) + - [Bug/Feature Reporting](./Reporting) - [Contact Details](./ContactDetails)