Added more specs
@@ -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
|
||||
|
||||
3
ModuleServerAPIGameLibGame.md
Normal file
3
ModuleServerAPIGameLibGame.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# ModuleClientApi - GameLib Game
|
||||
|
||||
Class representing the GameLib Game inside the ModuleServerAPI.
|
||||
3
ModuleServerAPIGameLibGamePlayer.md
Normal file
3
ModuleServerAPIGameLibGamePlayer.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# ModuleClientApi - GameLib GamePlayer
|
||||
|
||||
Class representing a Player of a GameLib Game inside the ModuleServerAPI.
|
||||
41
ModuleServerAPIGameLibRoom.md
Normal file
41
ModuleServerAPIGameLibRoom.md
Normal file
@@ -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. |
|
||||
3
ModuleServerAPIGameLibScoreboard.md
Normal file
3
ModuleServerAPIGameLibScoreboard.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# ModuleClientApi - GameLib Scoreboard
|
||||
|
||||
Class representing a Scoreboard of a GameLib Game inside the ModuleServerAPI.
|
||||
@@ -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)
|
||||
|
||||
Reference in New Issue
Block a user