Skip to content
Discord Luau

VoiceRegion

Implementation of the Discord VoiceRegion class in Luau

https://discord.com/developers/docs/resources/voice#voice-region-object

Summary

Properties

VoiceRegion.id :: stringVoiceRegion.name :: stringVoiceRegion.optimal :: booleanVoiceRegion.deprecated :: booleanVoiceRegion.custom :: boolean

Methods

VoiceRegion:sync(voiceRegionData: apiTypes.VoiceRegionObject)

Functions

VoiceRegion.new(voiceRegionData: apiTypes.VoiceRegionObject) → VoiceRegion

Properties

Section titled “Properties”

id

Section titled “id”
VoiceRegion.id  :: string

Unique ID for the voice region

name

Section titled “name”
VoiceRegion.name  :: string

Name of the voice region

optimal

Section titled “optimal”
VoiceRegion.optimal  :: boolean

True if this is an optimal voice region for the current user

deprecated

Section titled “deprecated”
VoiceRegion.deprecated  :: boolean

Whether this is a deprecated voice region

custom

Section titled “custom”
VoiceRegion.custom  :: boolean

Whether this is a custom voice region (used for events/etc)

Methods

Section titled “Methods”

sync

Section titled “sync”
VoiceRegion : sync ( voiceRegionData )  -> ()

Responsible for syncing data to this voice region object. This is typically called by the API when this object is created or updated.

Parameters

voiceRegionData: VoiceRegionObject

Functions

Section titled “Functions”

new

Section titled “new”
VoiceRegion . new ( voiceRegionData )  -> VoiceRegion

Responsible for constructing this class.

Parameters

voiceRegionData: VoiceRegionObject

Returns

VoiceRegion