Class Player
Index
Accessors
Methods
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
members
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
fetchSlotData
- fetch
Slot <SlotData>(): Promise<SlotData>Data 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
- fetch
Status (): Promise<ClientStatus> Returns this slot's current status. See clientStatuses for more information.
Returns Promise<ClientStatus>
A collection of metadata and helper methods for interacting with a particular player.