Class VoiceRegion

constructor

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

  Parameters

  • player: Player
  • regionId: string

  Returns VoiceRegion

Readonlyid

Readonlyplayer

inSync

• inSync(): boolean

  Whether this region has an entry for all nodes that are ready

  Returns boolean

forgetNode

• forgetNode(name: string): boolean

  Delete a node's entry

  Parameters

  • name: string

    Name of the node

  Returns boolean

forgetAllNodes

• forgetAllNodes(): void

  Delete all node entries

  Returns void

getAveragePing

• getAveragePing(node: string): number | null

  Get the average ping of a node

  Parameters

  • node: string

    Name of the node

  Returns number | null

getRelevantNode

• getRelevantNode(): Node | undefined

  Get a node relevant for this region.

  When in sync, this will return the node with the lowest average ping.

  When not in sync, this will continue to yield nodes it doesn't have an entry for.

  Returns Node | undefined

[OnPingUpdateSymbol]

• "[OnPingUpdateSymbol]"(node: string, state: PlayerState): void

  Parameters

  • node: string
  • state: PlayerState

  Returns void