Interface NodeEvents

Hierarchy

NodeEvents

Index

Methods

Methods

connect

connect(): void

- Defined in src/structures/CoffeeNode.ts:17
Emitted when node connects

Returns void

destroy

destroy(): void

- Defined in src/structures/CoffeeNode.ts:15
Emitted when node is destroyed

Returns void

disconnect

disconnect(reason: { code: number; reason: string }): void

- Defined in src/structures/CoffeeNode.ts:23
Emitted when node disconnects

Parameters
- reason: { code: number; reason: string }
  - code: number
  - reason: string
Returns void

error

error(error: Error): void

- Defined in src/structures/CoffeeNode.ts:25
Emitted when node has an error

Parameters
- error: Error
Returns void

event

event(payload: EventPayloads): void

- Defined in src/structures/CoffeeNode.ts:29
Emitted whenever any Lavalink event is received

Parameters
- payload: EventPayloads
Returns void

missingPlugins

missingPlugins(missing: string[]): any

- Defined in src/structures/CoffeeNode.ts:19
Emitted when node lack required plugins after connected

Parameters
- missing: string[]
Returns any

playerUpdate

playerUpdate(guildID: string, state: { connected: boolean; position: number; time: number }): void

- Defined in src/structures/CoffeeNode.ts:31
Emitted whenever playerUpdate is received

Parameters
- guildID: string
- state: { connected: boolean; position: number; time: number }
  - connected: boolean
  - position: number
  - time: number
Returns void

raw

raw(payload: IncomingPayloads): void

- Defined in src/structures/CoffeeNode.ts:27
Emitted whenever any Lavalink incoming message is received

Parameters
- payload: IncomingPayloads
Returns void

reconnect

reconnect(): void

- Defined in src/structures/CoffeeNode.ts:21
Emitted when node reconnects

Returns void

Generated using TypeDoc