Finished MCA

2025-08-10 17:20:26 +02:00
parent c4fc61e651
commit aeaeaf1ec4
4 changed files with 18 additions and 2 deletions

@@ -251,7 +251,19 @@ api.getPlayState();
## 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

@@ -1,3 +1,3 @@
# ModuleClientApi - User
# ModuleClientApi - Neighbor
Class representing a Neighbor of the ModuleClientAPI User.

@@ -0,0 +1,3 @@
# ModuleClientApi - Neighbor Results
Class representing a group of Neighbors of the ModuleClientAPI User.

@@ -16,6 +16,7 @@
- [Important Principals](./ModuleClientAPIPrincipals)
- [User](./ModuleClientAPIUser)
- [Neighbor](./ModuleClientAPINeighbor)
- [Neighbor Results](./ModuleClientAPINeighborResults)
- [GameLib](./ModuleClientAPIGameLib)
- [Controller](./ModuleClientAPIGameLibController)
- [ModuleServerAPI](./ModuleServerAPI)