Finished MCA
@@ -251,7 +251,19 @@ api.getPlayState();
|
|||||||
|
|
||||||
## Neighbors
|
## Neighbors
|
||||||
|
|
||||||
### getNeighbors **(TODO)**
|
### getNeighbors
|
||||||
|
|
||||||
|
Get one ore more module neighbors.
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
api.getNeighbors(filter);
|
||||||
|
```
|
||||||
|
|
||||||
|
| Argument | Type | Description |
|
||||||
|
| -------- | --------------------------------------------------------------- | --------------------------------------------- |
|
||||||
|
| filter | { moduleId?:string, moduleType?:string, moduleTypes?:string[] } | The filter other modules have to comply with. |
|
||||||
|
|
||||||
|
**Returns** [NeighborResults](./ModuleClientAPINeighborResults.md) _NeighborResults instance._
|
||||||
|
|
||||||
### onNeighborMessage
|
### onNeighborMessage
|
||||||
|
|
||||||
|
|||||||
@@ -1,3 +1,3 @@
|
|||||||
# ModuleClientApi - User
|
# ModuleClientApi - Neighbor
|
||||||
|
|
||||||
Class representing a Neighbor of the ModuleClientAPI User.
|
Class representing a Neighbor of the ModuleClientAPI User.
|
||||||
|
|||||||
3
ModuleClientAPINeighborResults.md
Normal file
3
ModuleClientAPINeighborResults.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# ModuleClientApi - Neighbor Results
|
||||||
|
|
||||||
|
Class representing a group of Neighbors of the ModuleClientAPI User.
|
||||||
@@ -16,6 +16,7 @@
|
|||||||
- [Important Principals](./ModuleClientAPIPrincipals)
|
- [Important Principals](./ModuleClientAPIPrincipals)
|
||||||
- [User](./ModuleClientAPIUser)
|
- [User](./ModuleClientAPIUser)
|
||||||
- [Neighbor](./ModuleClientAPINeighbor)
|
- [Neighbor](./ModuleClientAPINeighbor)
|
||||||
|
- [Neighbor Results](./ModuleClientAPINeighborResults)
|
||||||
- [GameLib](./ModuleClientAPIGameLib)
|
- [GameLib](./ModuleClientAPIGameLib)
|
||||||
- [Controller](./ModuleClientAPIGameLibController)
|
- [Controller](./ModuleClientAPIGameLibController)
|
||||||
- [ModuleServerAPI](./ModuleServerAPI)
|
- [ModuleServerAPI](./ModuleServerAPI)
|
||||||
|
|||||||
Reference in New Issue
Block a user