Class Player

A collection of metadata and helper methods for interacting with a particular player.

Index

Accessors

alias game groups members name slot team type

Methods

fetchHints fetchSlotData fetchStatus toString

Accessors

alias

get alias(): string
Returns the current nickname for this player or the slot name if not set.

Returns string
- Defined in src/classes/Player.ts:36

game

get game(): string
Returns the game this slot is playing.

Returns string
- Defined in src/classes/Player.ts:41

groups

get groups(): Player[]
Returns all the groups this player is a member of.

Returns Player[]
- Defined in src/classes/Player.ts:80

members

get members(): Player[]
Returns all group members of this player, if player is a group. Otherwise, returns an empty array.

Returns Player[]
- Defined in src/classes/Player.ts:69

name

get name(): string
Returns the slot name for this player slot.

Returns string
- Defined in src/classes/Player.ts:31

slot

get slot(): number
Returns this slot's id.

Returns number
- Defined in src/classes/Player.ts:64

team

get team(): number
Returns the team id this player is a member of.

Returns number
- Defined in src/classes/Player.ts:59

type

get type(): 0 | 1 | 2
Returns the type of slot this player is. See slotTypes for more information.

Returns 0 | 1 | 2
- Defined in src/classes/Player.ts:50

Methods

fetchHints

fetchHints(): Promise<Hint[]>
Fetch this player's current hints.

Returns Promise<Hint[]>
- Defined in src/classes/Player.ts:111

fetchSlotData

fetchSlotData<SlotData>(): Promise<SlotData>
Fetch this player's slot data over the network.
Type Parameters
- SlotData extends JSONRecord
  The type of the slot data that is returned, for better typing information.
Returns Promise<SlotData>
Remarks
This data is not tracked after running, so slot data should be cached to reduce additional network calls, if necessary.
- Defined in src/classes/Player.ts:106

fetchStatus

fetchStatus(): Promise<ClientStatus>
Returns this slot's current status. See clientStatuses for more information.

Returns Promise<ClientStatus>
- Defined in src/classes/Player.ts:91

toString

toString(): string
Returns the alias for this player.

Returns string
- Defined in src/classes/Player.ts:26