Class VoiceRegion

constructor

• new VoiceRegion(player: Player, regionId: string): VoiceRegion

  Parameters

  • player: Player
  • regionId: string

  Returns VoiceRegion

Readonlyid

nodes

• get nodes(): string[]

  Names of nodes that have participated in this region

  Returns string[]

forgetNode

• forgetNode(name: string): void

  Deletes and stops tracking a node's ping

  Parameters

  • name: string

    Name of the node

  Returns void

onPingUpdate

• onPingUpdate(name: string, ping: number, time: number): void

  A player state update listener. Not for general use

  Parameters

  • name: string

    Name of the node

  • ping: number

    Ping from lavalink

  • time: number

    Time from lavalink

  Returns void

getAveragePing

• getAveragePing(name: string): number

  Returns the average ping of a node in this region

  Parameters

  • name: string

    Name of the node

  Returns number

getRelevantNode

• getRelevantNode(...exclusions: string[]): Node | undefined

  Parameters

  • ...exclusions: string[]

    List of names of nodes to exclude

  Returns Node | undefined

  Node with the least average ping, undefined if none available