From f27067b58582cd21b9bbdacc7b3c19e0e5b154c3 Mon Sep 17 00:00:00 2001 From: Mees van der Wijk Date: Sat, 9 Aug 2025 17:39:07 +0200 Subject: [PATCH] Updated more specs --- ...lerEndScreen.md => ModuleAPIGameLibEndScreen.md | 0 ModuleApiGameLibGameDetails.md | 14 +++++++------- ModuleClientAPIGameLibController.md | 6 +++--- _Sidebar.md | 2 ++ 4 files changed, 12 insertions(+), 10 deletions(-) rename ModuleClientAPIGameLibControllerEndScreen.md => ModuleAPIGameLibEndScreen.md (100%) diff --git a/ModuleClientAPIGameLibControllerEndScreen.md b/ModuleAPIGameLibEndScreen.md similarity index 100% rename from ModuleClientAPIGameLibControllerEndScreen.md rename to ModuleAPIGameLibEndScreen.md diff --git a/ModuleApiGameLibGameDetails.md b/ModuleApiGameLibGameDetails.md index 41564ae..e8325ca 100644 --- a/ModuleApiGameLibGameDetails.md +++ b/ModuleApiGameLibGameDetails.md @@ -21,13 +21,13 @@ The game details decribe basic information about the game and specifies how the ``` -| Attribute | Type | Description | -| --------------- | ---------------------------------------------- | ----------------------------------------- | -| name | string | The name of the game. | -| description | string | The description of the game. | -| hints | string[] | List of hints for the game. | -| (Optional) icon | string | Path to the icon of the module. | -| controls | [Control](ModuleApiGameLibGameDetails#control) | Statistics rows to show on the endscreen. | +| Attribute | Type | Description | +| --------------- | ---------------------------------------------- | ------------------------------------------ | +| name | string | The name of the game. | +| description | string | The description of the game. | +| hints | string[] | List of hints for the game. | +| (Optional) icon | string | Path to the icon of the module. | +| controls | [Control](ModuleApiGameLibGameDetails#control) | The actions the controller should respect. | ## Control diff --git a/ModuleClientAPIGameLibController.md b/ModuleClientAPIGameLibController.md index c697fb8..a4f59f3 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](./ModuleClientAPIGameLibControllerEndScreen) | The endscreen data. | +| Argument | Type | Description | +| --------- | ------------------------------------------- | ------------------- | +| endScreen | [EndScreen](./ModuleAPIGameLibEndScreen.md) | The endscreen data. | ### on: queuePositionUpdate diff --git a/_Sidebar.md b/_Sidebar.md index 6b96db9..9c5477c 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -15,6 +15,7 @@ - [Important Principals](./ModuleClientAPIPrincipals) - [User](./ModuleClientAPIUser) - [GameLib](./ModuleClientAPIGameLib) + - [Controller](./ModuleClientAPIGameLibController.md) - [ModuleServerAPI](./ModuleServerAPI) - [Important Principals](./ModuleServerAPIPrincipals) - [Client](./ModuleServerAPIClient) @@ -24,6 +25,7 @@ - [Axios](https://axios-http.com/docs/instance) - ModuleApi Shared - [GameLib GameDetails](./ModuleApiGameLibGameDetails) + - [GameLib EndScreen](./ModuleAPIGameLibEndScreen) - [Module Debugging](./ModuleDebugging) - [ModuleStore](./ModuleStore) - [Bug/Feature Reporting](./Reporting)