Getiyo-Public/Getiyo-Developer-Documentation
1
0
Fork 0
Code Issues 6 Releases Wiki Activity

Updated more specs

Mees van der Wijk
2025-08-09 17:39:07 +02:00
parent 53931d40ea
commit f27067b585
4 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
ModuleClientAPIGameLibControllerEndScreen.md → ModuleAPIGameLibEndScreen.md

14
ModuleApiGameLibGameDetails.md

@@ -21,13 +21,13 @@ The game details decribe basic information about the game and specifies how the
``` ```
| Attribute | Type | Description | | Attribute | Type | Description |
| --------------- | ---------------------------------------------- | ----------------------------------------- | | --------------- | ---------------------------------------------- | ------------------------------------------ |
| name | string | The name of the game. | | name | string | The name of the game. |
| description | string | The description of the game. | | description | string | The description of the game. |
| hints | string[] | List of hints for the game. | | hints | string[] | List of hints for the game. |
| (Optional) icon | string | Path to the icon of the module. | | (Optional) icon | string | Path to the icon of the module. |
| controls | [Control](ModuleApiGameLibGameDetails#control) | Statistics rows to show on the endscreen. | | controls | [Control](ModuleApiGameLibGameDetails#control) | The actions the controller should respect. |
## Control ## Control

6
ModuleClientAPIGameLibController.md

@@ -74,9 +74,9 @@ Triggers when the endscreen should be shown.
Controller.on('endScreen', (endScreen) => {}); Controller.on('endScreen', (endScreen) => {});
``` ```
| Argument | Type | Description | | Argument | Type | Description |
| --------- | -------------------------------------------------------- | ------------------- | | --------- | ------------------------------------------- | ------------------- |
| endScreen | [EndScreen](./ModuleClientAPIGameLibControllerEndScreen) | The endscreen data. | | endScreen | [EndScreen](./ModuleAPIGameLibEndScreen.md) | The endscreen data. |
### on: queuePositionUpdate ### on: queuePositionUpdate

2
_Sidebar.md

@@ -15,6 +15,7 @@
- [Important Principals](./ModuleClientAPIPrincipals) - [Important Principals](./ModuleClientAPIPrincipals)
- [User](./ModuleClientAPIUser) - [User](./ModuleClientAPIUser)
- [GameLib](./ModuleClientAPIGameLib) - [GameLib](./ModuleClientAPIGameLib)
- [Controller](./ModuleClientAPIGameLibController.md)
- [ModuleServerAPI](./ModuleServerAPI) - [ModuleServerAPI](./ModuleServerAPI)
- [Important Principals](./ModuleServerAPIPrincipals) - [Important Principals](./ModuleServerAPIPrincipals)
- [Client](./ModuleServerAPIClient) - [Client](./ModuleServerAPIClient)
@@ -24,6 +25,7 @@
- [Axios](https://axios-http.com/docs/instance) - [Axios](https://axios-http.com/docs/instance)
- ModuleApi Shared - ModuleApi Shared
- [GameLib GameDetails](./ModuleApiGameLibGameDetails) - [GameLib GameDetails](./ModuleApiGameLibGameDetails)
- [GameLib EndScreen](./ModuleAPIGameLibEndScreen)
- [Module Debugging](./ModuleDebugging) - [Module Debugging](./ModuleDebugging)
- [ModuleStore](./ModuleStore) - [ModuleStore](./ModuleStore)
- [Bug/Feature Reporting](./Reporting) - [Bug/Feature Reporting](./Reporting)