Class Player
Accessors
alias
-
get alias(): string
Returns the current nickname for this player or the slot name if not set.
Returns string
game
-
get game(): string
Returns the game this slot is playing.
Returns string
groups
-
Returns all the groups this player is a member of.
Returns Player[]
members
-
Returns all group members of this player, if player is a group. Otherwise, returns an empty array.
Returns Player[]
name
-
get name(): string
Returns the slot name for this player slot.
Returns string
slot
-
get slot(): number
Returns this slot's id.
Returns number
team
-
get team(): number
Returns the team id this player is a member of.
Returns number
type
-
get type(): 0 | 1 | 2
Returns the type of slot this player is. See slotTypes for more information.
Returns 0 | 1 | 2
Methods
fetchHints
-
Fetch this player's current hints.
Returns Promise<Hint[]>
fetchSlotData
-
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>
- SlotData extends JSONRecord
fetchStatus
-
Returns this slot's current status. See clientStatuses for more information.
Returns Promise<ClientStatus>
toString
-
Returns the alias for this player.
Returns string
A collection of metadata and helper methods for interacting with a particular player.