Skip to main content
Version: 2.0.0

RuvyriasEvents

ruvyrias


ruvyrias / RuvyriasEvents

Interface: RuvyriasEvents

Defined in: types/Ruvyrias.ts:212

Represents the events emitted by Ruvyrias.

Properties

debug()

debug: (...args) => void

Defined in: types/Ruvyrias.ts:216

Emitted when data useful for debugging is produced.

Parameters

args

...any[]

Returns

void


nodeConnect()

nodeConnect: (node) => void

Defined in: types/Ruvyrias.ts:226

Emitted when a Lavalink node is connected to Ruvyrias.

Parameters

node

Node

Returns

void


nodeCreate()

nodeCreate: (node) => void

Defined in: types/Ruvyrias.ts:236

Emitted when a Lavalink node is created in Ruvyrias.

Parameters

node

Node

Returns

void


nodeDestroy()

nodeDestroy: (node) => void

Defined in: types/Ruvyrias.ts:241

Emitted when a Lavalink node is destroyed from Ruvyrias.

Parameters

node

Node

Returns

void


nodeDisconnect()

nodeDisconnect: (node, event?) => void

Defined in: types/Ruvyrias.ts:231

Emitted when a Lavalink node is disconnected from Ruvyrias.

Parameters

node

Node

event?

unknown

Returns

void


nodeError()

nodeError: (node, event) => void

Defined in: types/Ruvyrias.ts:251

Emitted when a Lavalink node encounters an error.

Parameters

node

Node

event

any

Returns

void


nodeReconnect()

nodeReconnect: (node) => void

Defined in: types/Ruvyrias.ts:246

Emitted when Ruvyrias attempts to reconnect with a disconnected Lavalink node.

Parameters

node

Node

Returns

void


playerCreate()

playerCreate: (player) => void

Defined in: types/Ruvyrias.ts:296

Emitted when a player is created.

Parameters

player

Player

Returns

void


playerDestroy()

playerDestroy: (player) => void

Defined in: types/Ruvyrias.ts:301

Emitted when a player is destroyed.

Parameters

player

Player

Returns

void


playerUpdate()

playerUpdate: (player) => void

Defined in: types/Ruvyrias.ts:291

Emitted when a player is updated.

Parameters

player

LavalinkPlayer

Returns

void


queueAdd()

queueAdd: (player, track) => void

Defined in: types/Ruvyrias.ts:276

Emitted when a track is added to a player's queue.

Parameters

player

Player

track

Track

Returns

void


queueEnd()

queueEnd: (player) => void

Defined in: types/Ruvyrias.ts:286

Emitted when a player's queue is completed and going to disconnect.

Parameters

player

Player

Returns

void


queueRemove()

queueRemove: (player, track) => void

Defined in: types/Ruvyrias.ts:281

Emitted when a track is removed from a player's queue.

Parameters

player

Player

track

Track

Returns

void


raw()

raw: (topic, ...args) => void

Defined in: types/Ruvyrias.ts:221

Emitted when a response is received.

Parameters

topic

string

args

...unknown[]

Returns

void


socketClose()

socketClose: (player, track, data) => void

Defined in: types/Ruvyrias.ts:256

Emitted when the websocket connection to Discord voice servers is closed.

Parameters

player

Player

track

Track

data

WebSocketClosedEvent

Returns

void


trackEnd()

trackEnd: (player, track) => void

Defined in: types/Ruvyrias.ts:266

Emitted whenever a track ends.

Parameters

player

Player

track

Track

Returns

void


trackError()

trackError: (player, data) => void

Defined in: types/Ruvyrias.ts:271

Emitted when a track gets stuck while playing.

Parameters

player

Player

data

TrackStuckEvent

Returns

void


trackStart()

trackStart: (player, track) => void

Defined in: types/Ruvyrias.ts:261

Emitted whenever a player starts playing a new track.

Parameters

player

Player

track

Track

Returns

void