Skip to main content

Class: Friend

Represents a friend from the friend list

Hierarchy​

Properties​

chatName​

• chatName: string

The raw player's name, as directly reported by the community platform.

Inherited from​

TribullePlayer.chatName

client​

• client: Client

Inherited from​

TribullePlayer.client

game​

• game: Game

The game that the player is playing

gender​

• gender: Gender

The player's gender

hasAddedBack​

• hasAddedBack: boolean

If the player has added the client back

hasAvatar​

• hasAvatar: boolean

If the player has an avatar

id​

• id: number

The player's id

isConnected​

• isConnected: boolean

If the player is connected

isSoulmate​

• isSoulmate: boolean

If the player is the soulmate of the client

lastConnection​

• lastConnection: number

The player's last connection time

name​

• name: string

The player's name.

Inherited from​

TribullePlayer.name

roomName​

• roomName: string

The room name of the player (if they are online)

Accessors​

avatar​

• get avatar(): string

The player's avatar url

Returns​

string

Methods​

friend​

▸ friend(): void

Add player to the friend list

Returns​

void

Inherited from​

TribullePlayer.friend

unfriend​

▸ unfriend(): void

Remove player from the friend list

Returns​

void

Inherited from​

TribullePlayer.unfriend

whisper​

▸ whisper(message): void

Send a whisper to the player

Parameters​

NameType
messagestring

Returns​

void

Inherited from​

TribullePlayer.whisper