Added gameplayer specs
@@ -1,3 +1,45 @@
|
|||||||
# ModuleClientApi - GameLib GamePlayer
|
# ModuleClientApi - GameLib GamePlayer
|
||||||
|
|
||||||
Class representing a Player of a GameLib Game inside the ModuleServerAPI.
|
Class representing a Player of a GameLib Game inside the ModuleServerAPI.
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### send
|
||||||
|
|
||||||
|
Send a message to the player.
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
Player.send(header, ...args);
|
||||||
|
```
|
||||||
|
|
||||||
|
| Argument | Type | Description |
|
||||||
|
|
||||||
|
| -------- | ------ | -------------------------- |
|
||||||
|
| header | string | The header of the message. |
|
||||||
|
| args | any[] | Data of any type |
|
||||||
|
|
||||||
|
## Constants
|
||||||
|
|
||||||
|
### **READONLY** clientId
|
||||||
|
|
||||||
|
The client id of the player.
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
Player.clientId;
|
||||||
|
```
|
||||||
|
|
||||||
|
### **READONLY** name
|
||||||
|
|
||||||
|
The nickname of the player.
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
Player.name;
|
||||||
|
```
|
||||||
|
|
||||||
|
### **READONLY** organization
|
||||||
|
|
||||||
|
The organization of the player.
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
Player.organization;
|
||||||
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user