VoiceChannelEffect
ClassOn this page
VoiceChannelEffect is a DiscordLua class representing a Discord resource. Obtain it from a manager, an event payload, or the constructor when one is documented below.
Properties
- Name
animationId- Type
any- Access
- readonly
- Description
- Instance field
VoiceChannelEffect.animationId. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this VoiceChannelEffect.
- Name
animationType- Type
any- Access
- readonly
- Description
- Instance field
VoiceChannelEffect.animationType. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this VoiceChannelEffect.
- Name
channelId- Type
any- Access
- readonly
- Description
- Instance field
VoiceChannelEffect.channelId. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this VoiceChannelEffect.
- Name
client- Type
any- Access
- readonly
- Description
- Owning Client instance used for REST, cache, and event dispatch.
- Availability
- Populated from the Gateway/REST payload or constructor for this VoiceChannelEffect.
- Name
emoji- Type
any- Access
- readonly
- Description
- Instance field
VoiceChannelEffect.emoji. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this VoiceChannelEffect.
- Name
guildId- Type
any- Access
- readonly
- Description
- Instance field
VoiceChannelEffect.guildId. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this VoiceChannelEffect.
- Name
raw- Type
any- Access
- readonly
- Description
- Instance field
VoiceChannelEffect.raw. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this VoiceChannelEffect.
- Name
soundId- Type
any- Access
- readonly
- Description
- Instance field
VoiceChannelEffect.soundId. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this VoiceChannelEffect.
- Name
soundVolume- Type
any- Access
- readonly
- Description
- Instance field
VoiceChannelEffect.soundVolume. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this VoiceChannelEffect.
- Name
userId- Type
any- Access
- readonly
- Description
- Instance field
VoiceChannelEffect.userId. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this VoiceChannelEffect.
Methods
VoiceChannelEffect:channel()
#Performs channel on this VoiceChannelEffect. Call it from bot code when you need that operation on the current object.
Signature
VoiceChannelEffect:channel() Parameters
No parameters.
Returns
VoiceChannelEffect — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a VoiceChannelEffect
object:channel()VoiceChannelEffect:guild()
#Performs guild on this VoiceChannelEffect. Call it from bot code when you need that operation on the current object.
Signature
VoiceChannelEffect:guild() Parameters
No parameters.
Returns
VoiceChannelEffect — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a VoiceChannelEffect
object:guild()VoiceChannelEffect:soundboardSound()
#Performs soundboard sound on this VoiceChannelEffect. Call it from bot code when you need that operation on the current object.
Signature
VoiceChannelEffect:soundboardSound() Parameters
No parameters.
Returns
any.
Example
local discord = require("discord")
-- object is a VoiceChannelEffect
object:soundboardSound()Examples
Obtain this object from a manager, wrap helper, or event payload — it is not constructed directly in typical bot code.
Related APIs
ActionRow · Activity · ActivityInstance · ActivityLocation · AnonymousGuild · ApplicationCommand · ApplicationRoleConnectionMetadata · Attachment
Version: discord 1.2.4 · runtime 1.0.0