From aeaeaf1ec43456f8afa86042300d2661d5e79547 Mon Sep 17 00:00:00 2001 From: Mees van der Wijk Date: Sun, 10 Aug 2025 17:20:26 +0200 Subject: [PATCH] Finished MCA --- ModuleClientAPI.md | 14 +++++++++++++- ModuleClientAPINeighbor.md | 2 +- ModuleClientAPINeighborResults.md | 3 +++ _Sidebar.md | 1 + 4 files changed, 18 insertions(+), 2 deletions(-) create mode 100644 ModuleClientAPINeighborResults.md diff --git a/ModuleClientAPI.md b/ModuleClientAPI.md index 5c22fb7..3f718ce 100644 --- a/ModuleClientAPI.md +++ b/ModuleClientAPI.md @@ -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 diff --git a/ModuleClientAPINeighbor.md b/ModuleClientAPINeighbor.md index 616d527..86d91d4 100644 --- a/ModuleClientAPINeighbor.md +++ b/ModuleClientAPINeighbor.md @@ -1,3 +1,3 @@ -# ModuleClientApi - User +# ModuleClientApi - Neighbor Class representing a Neighbor of the ModuleClientAPI User. diff --git a/ModuleClientAPINeighborResults.md b/ModuleClientAPINeighborResults.md new file mode 100644 index 0000000..fd923aa --- /dev/null +++ b/ModuleClientAPINeighborResults.md @@ -0,0 +1,3 @@ +# ModuleClientApi - Neighbor Results + +Class representing a group of Neighbors of the ModuleClientAPI User. diff --git a/_Sidebar.md b/_Sidebar.md index 8efe4d7..ba275bc 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -16,6 +16,7 @@ - [Important Principals](./ModuleClientAPIPrincipals) - [User](./ModuleClientAPIUser) - [Neighbor](./ModuleClientAPINeighbor) + - [Neighbor Results](./ModuleClientAPINeighborResults) - [GameLib](./ModuleClientAPIGameLib) - [Controller](./ModuleClientAPIGameLibController) - [ModuleServerAPI](./ModuleServerAPI)