Class PlayersManager

Manages tracking and updating all players in the room session.

Hierarchy

EventBasedManager<PlayerEvents>
- PlayersManager (View Summary)

Index

Accessors

self slots teams

Methods

findPlayer off on wait

Accessors

self

get self(): Player
Returns the Player for this client's player.

Returns Player

Throws
Error if attempting to lookup Player object before connecting to the server.
- Defined in src/classes/managers/PlayersManager.ts:62

slots

get slots(): Readonly<Record<number, NetworkSlot>>
Returns a record of basic information for each slot.

Returns Readonly<Record<number, NetworkSlot>>

Remarks
Slot information is shared across each team. For accessing player data, see PlayersManager.
- Defined in src/classes/managers/PlayersManager.ts:74

teams

get teams(): Player[][]
Returns a 2D array of player metadata ranked by team number, then slot number.

Returns Player[][]
Remarks
Take care when accessing data for 0th slot on a team (such as when iterating over all team members), as slot 0 does not technically exist in the server's multi-data, and is only relevant in-case a server sends cheated items.
Example: Print All Player Aliases to Console
```
for (const team of client.players.teams) {
    for (const player of team) {
        console.log(player.alias);
    }
}
```
- Defined in src/classes/managers/PlayersManager.ts:90

Methods

findPlayer

findPlayer(slot: string | number, team?: number): Player | undefined
Attempt to find a player by their team or slot name.
Parameters
- slot: string | number
  The slot id associated with the searched player.
- Optionalteam: number
  The team id associated with the searched player. If omitted, defaults to the team of the client player.
Returns Player | undefined
The player's metadata or undefined if not found.
- Defined in src/classes/managers/PlayersManager.ts:103

off

off<Event extends "aliasUpdated">(
event: Event,
listener: (...args: PlayerEvents[Event]) => void,
): this
Removes an existing event listener.
Type Parameters
- Event extends "aliasUpdated"
Parameters
- event: Event
  The event name associated with this listener to remove.
- listener: (...args: PlayerEvents[Event]) => void
  The callback function to remove.
Returns this
This object.
Inherited from EventBasedManager.off
- Defined in src/classes/managers/EventBasedManager.ts:27

on

on<Event extends "aliasUpdated">(
event: Event,
listener: (...args: PlayerEvents[Event]) => void,
): this
Add an event listener for a specific event.
Type Parameters
- Event extends "aliasUpdated"
Parameters
- event: Event
  The event name to listen for.
- listener: (...args: PlayerEvents[Event]) => void
  The callback function to fire when this event is received.
Returns this
This object.
Inherited from EventBasedManager.on
- Defined in src/classes/managers/EventBasedManager.ts:16

wait

wait<Event extends "aliasUpdated">(
event: Event,
clearPredicate?: (...args: PlayerEvents[Event]) => boolean,
): Promise<PlayerEvents[Event]>
Returns a promise that waits for a single specified event to be received. Resolves with the list of arguments dispatched with the event.
Type Parameters
- Event extends "aliasUpdated"
Parameters
- event: Event
  The event name to listen for.
- clearPredicate: (...args: PlayerEvents[Event]) => boolean = ...
  An optional predicate to check on incoming events to validate if the correct event has been received. If omitted, will return immediately on next event type received.
Returns Promise<PlayerEvents[Event]>
Inherited from EventBasedManager.wait
- Defined in src/classes/managers/EventBasedManager.ts:39