ModuleClientApi - Neighbor Results

Class representing a group of Neighbors of the ModuleClientAPI User.

Methods

Send a packet to all neighbors in the result result.

NeighborResults.sendToAll(header, ...args);

Argument	Type	Description
header	string	The header of the message.
args	any[]	Data of any type.

Loop trough all neighbors in this result.

NeighborResults.forEach(callback);

Argument	Type	Description
callback	( Neighbor ):void	Handler thats called for every neighbor in result.

Get all neighbors in this result.

NeighborResults.getAll();

Returns Neighbor[] Neighbors in result.

Get a neighbors in this result.

NeighborResults.get(index);

Argument	Type	Description
index	number	The index of the neighbor in this result.

Returns Neighbor Neighbor instance.

Get the first neighbors in this result.

NeighborResults.first();

Returns Neighbor Neighbor instance.

Get the last neighbors in this result.

NeighborResults.last();

Returns Neighbor Neighbor instance.

Amount of neighbors in the result.

NeighborResults.length;

Get a neighbor at a specific index

NeighborResults[index];

Argument	Type	Description
index	number	The index of the neighbor in this result.

Returns Neighbor Neighbor instance.