Events

discord.Events.ClientReady → "ready"

Trigger

After Identify succeeds and the initial guild set is cached. Also emitted as clientReady.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("ready", function(client)
end)

discord.Events.Error → "error"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to error runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("error", function()
end)

discord.Events.Warn → "warn"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to warn runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("warn", function()
end)

discord.Events.Debug → "debug"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to debug runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("debug", function()
end)

discord.Events.MessageCreate → "messageCreate"

Trigger

A MESSAGE_CREATE Gateway dispatch was wrapped into a Message and stored on the channel cache when possible.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("messageCreate", function(message)
end)

discord.Events.MessageUpdate → "messageUpdate"

Trigger

A MESSAGE_UPDATE dispatch was wrapped. Partial messages follow Client partials.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("messageUpdate", function(message)
end)

discord.Events.MessageDelete → "messageDelete"

Trigger

A MESSAGE_DELETE dispatch. The handler may receive a partial object if the message was not cached.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("messageDelete", function(message)
end)

discord.Events.MessageBulkDelete → "messageDeleteBulk"

Trigger

A MESSAGE_DELETE_BULK dispatch. Arguments are the deleted messages collection and the channel.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("messageDeleteBulk", function(messages, channel)
end)

discord.Events.MessagePollVoteAdd → "messagePollVoteAdd"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to messagePollVoteAdd runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("messagePollVoteAdd", function()
end)

discord.Events.MessagePollVoteRemove → "messagePollVoteRemove"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to messagePollVoteRemove runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("messagePollVoteRemove", function()
end)

discord.Events.MessageReactionAdd → "messageReactionAdd"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to messageReactionAdd runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("messageReactionAdd", function(reaction, user)
end)

discord.Events.MessageReactionRemove → "messageReactionRemove"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to messageReactionRemove runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("messageReactionRemove", function(reaction, user)
end)

discord.Events.MessageReactionRemoveAll → "messageReactionRemoveAll"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to messageReactionRemoveAll runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("messageReactionRemoveAll", function(message, reactions)
end)

discord.Events.MessageReactionRemoveEmoji → "messageReactionRemoveEmoji"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to messageReactionRemoveEmoji runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("messageReactionRemoveEmoji", function(reaction)
end)

discord.Events.InteractionCreate → "interactionCreate"

Trigger

An INTERACTION_CREATE dispatch was wrapped into an Interaction subclass.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("interactionCreate", function(interaction)
end)

discord.Events.GuildCreate → "guildCreate"

Trigger

A GUILD_CREATE dispatch added or updated a Guild on client.guilds.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildCreate", function(guild)
end)

discord.Events.GuildUpdate → "guildUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to guildUpdate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildUpdate", function(guild)
end)

discord.Events.GuildDelete → "guildDelete"

Trigger

The client was removed from a guild, or the guild became unavailable.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildDelete", function(wrapped)
end)

discord.Events.GuildAvailable → "guildAvailable"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to guildAvailable runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildAvailable", function(guild)
end)

discord.Events.GuildUnavailable → "guildUnavailable"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to guildUnavailable runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildUnavailable", function(wrapped)
end)

discord.Events.GuildMemberAdd → "guildMemberAdd"

Trigger

A member joined a guild and was added to that guild's member cache.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildMemberAdd", function(member)
end)

discord.Events.GuildMemberRemove → "guildMemberRemove"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to guildMemberRemove runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildMemberRemove", function(wrapped, enums)
end)

discord.Events.GuildMemberUpdate → "guildMemberUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to guildMemberUpdate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildMemberUpdate", function(member)
end)

discord.Events.GuildMemberAvailable → "guildMemberAvailable"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to guildMemberAvailable runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildMemberAvailable", function(member)
end)

discord.Events.GuildMembersChunk → "guildMembersChunk"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to guildMembersChunk runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildMembersChunk", function(members, guild, arg3, count, notFound, nonce, arg7)
end)

discord.Events.GuildBanAdd → "guildBanAdd"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to guildBanAdd runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildBanAdd", function()
end)

discord.Events.GuildBanRemove → "guildBanRemove"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to guildBanRemove runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildBanRemove", function()
end)

discord.Events.GuildRoleCreate → "roleCreate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to roleCreate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("roleCreate", function(role)
end)

discord.Events.GuildRoleUpdate → "roleUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to roleUpdate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("roleUpdate", function(role)
end)

discord.Events.GuildRoleDelete → "roleDelete"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to roleDelete runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("roleDelete", function(role)
end)

discord.Events.GuildIntegrationsUpdate → "guildIntegrationsUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to guildIntegrationsUpdate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildIntegrationsUpdate", function(data)
end)

discord.Events.GuildAuditLogEntryCreate → "guildAuditLogEntryCreate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to guildAuditLogEntryCreate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildAuditLogEntryCreate", function(entry, guild)
end)

discord.Events.GuildScheduledEventCreate → "guildScheduledEventCreate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to guildScheduledEventCreate runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildScheduledEventCreate", function()
end)

discord.Events.GuildScheduledEventUpdate → "guildScheduledEventUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to guildScheduledEventUpdate runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildScheduledEventUpdate", function()
end)

discord.Events.GuildScheduledEventDelete → "guildScheduledEventDelete"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to guildScheduledEventDelete runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildScheduledEventDelete", function(guildScheduledEvent)
end)

discord.Events.GuildScheduledEventUserAdd → "guildScheduledEventUserAdd"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to guildScheduledEventUserAdd runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildScheduledEventUserAdd", function()
end)

discord.Events.GuildScheduledEventUserRemove → "guildScheduledEventUserRemove"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to guildScheduledEventUserRemove runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildScheduledEventUserRemove", function()
end)

discord.Events.ChannelCreate → "channelCreate"

Trigger

A channel was created and cached.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("channelCreate", function(channel)
end)

discord.Events.ChannelUpdate → "channelUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to channelUpdate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("channelUpdate", function(channel)
end)

discord.Events.ChannelDelete → "channelDelete"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to channelDelete runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("channelDelete", function(channel)
end)

discord.Events.ChannelPinsUpdate → "channelPinsUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to channelPinsUpdate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("channelPinsUpdate", function(channel, data)
end)

discord.Events.ThreadCreate → "threadCreate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to threadCreate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("threadCreate", function(channel)
end)

discord.Events.ThreadUpdate → "threadUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to threadUpdate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("threadUpdate", function(channel)
end)

discord.Events.ThreadDelete → "threadDelete"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to threadDelete runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("threadDelete", function(channel)
end)

discord.Events.ThreadListSync → "threadListSync"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to threadListSync runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("threadListSync", function(threads, data)
end)

discord.Events.ThreadMemberUpdate → "threadMemberUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to threadMemberUpdate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("threadMemberUpdate", function(member, thread)
end)

discord.Events.ThreadMembersUpdate → "threadMembersUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to threadMembersUpdate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("threadMembersUpdate", function(added, removed, thread)
end)

discord.Events.PresenceUpdate → "presenceUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to presenceUpdate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("presenceUpdate", function(presence)
end)

discord.Events.VoiceStateUpdate → "voiceStateUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to voiceStateUpdate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("voiceStateUpdate", function(state)
end)

discord.Events.VoiceServerUpdate → "voiceServerUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to voiceServerUpdate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("voiceServerUpdate", function(data)
end)

discord.Events.VoiceChannelEffectSend → "voiceChannelEffectSend"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to voiceChannelEffectSend runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("voiceChannelEffectSend", function(data)
end)

discord.Events.Resumed → "resumed"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to resumed runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("resumed", function(data)
end)

discord.Events.IntegrationCreate → "integrationCreate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to integrationCreate runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("integrationCreate", function()
end)

discord.Events.IntegrationUpdate → "integrationUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to integrationUpdate runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("integrationUpdate", function()
end)

discord.Events.IntegrationDelete → "integrationDelete"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to integrationDelete runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("integrationDelete", function(data)
end)

discord.Events.TypingStart → "typingStart"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to typingStart runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("typingStart", function(typing)
end)

discord.Events.WebhooksUpdate → "webhooksUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to webhooksUpdate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("webhooksUpdate", function(channel)
end)

discord.Events.InviteCreate → "inviteCreate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to inviteCreate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("inviteCreate", function(invite)
end)

discord.Events.InviteDelete → "inviteDelete"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to inviteDelete runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("inviteDelete", function(invite)
end)

discord.Events.UserUpdate → "userUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to userUpdate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("userUpdate", function(user)
end)

discord.Events.EmojiCreate → "emojiCreate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to emojiCreate runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("emojiCreate", function()
end)

discord.Events.EmojiUpdate → "emojiUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to emojiUpdate runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("emojiUpdate", function()
end)

discord.Events.EmojiDelete → "emojiDelete"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to emojiDelete runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("emojiDelete", function(emoji)
end)

discord.Events.StickerCreate → "stickerCreate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to stickerCreate runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("stickerCreate", function()
end)

discord.Events.StickerUpdate → "stickerUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to stickerUpdate runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("stickerUpdate", function()
end)

discord.Events.StickerDelete → "stickerDelete"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to stickerDelete runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("stickerDelete", function(sticker)
end)

discord.Events.ApplicationCommandPermissionsUpdate → "applicationCommandPermissionsUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to applicationCommandPermissionsUpdate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("applicationCommandPermissionsUpdate", function(data)
end)

discord.Events.AutoModerationActionExecution → "autoModerationActionExecution"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to autoModerationActionExecution runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("autoModerationActionExecution", function(autoModerationActionExecution)
end)

discord.Events.AutoModerationRuleCreate → "autoModerationRuleCreate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to autoModerationRuleCreate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("autoModerationRuleCreate", function(autoModerationRule)
end)

discord.Events.AutoModerationRuleDelete → "autoModerationRuleDelete"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to autoModerationRuleDelete runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("autoModerationRuleDelete", function(autoModerationRule)
end)

discord.Events.AutoModerationRuleUpdate → "autoModerationRuleUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to autoModerationRuleUpdate runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("autoModerationRuleUpdate", function(autoModerationRule)
end)

discord.Events.EntitlementCreate → "entitlementCreate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to entitlementCreate runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("entitlementCreate", function()
end)

discord.Events.EntitlementUpdate → "entitlementUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to entitlementUpdate runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("entitlementUpdate", function()
end)

discord.Events.EntitlementDelete → "entitlementDelete"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to entitlementDelete runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("entitlementDelete", function(entitlement)
end)

discord.Events.StageInstanceCreate → "stageInstanceCreate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to stageInstanceCreate runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("stageInstanceCreate", function()
end)

discord.Events.StageInstanceUpdate → "stageInstanceUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to stageInstanceUpdate runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("stageInstanceUpdate", function()
end)

discord.Events.StageInstanceDelete → "stageInstanceDelete"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to stageInstanceDelete runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("stageInstanceDelete", function()
end)

discord.Events.SubscriptionCreate → "subscriptionCreate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to subscriptionCreate runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("subscriptionCreate", function()
end)

discord.Events.SubscriptionUpdate → "subscriptionUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to subscriptionUpdate runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("subscriptionUpdate", function()
end)

discord.Events.SubscriptionDelete → "subscriptionDelete"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to subscriptionDelete runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("subscriptionDelete", function(subscription)
end)

discord.Events.SoundboardSounds → "soundboardSounds"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to soundboardSounds runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("soundboardSounds", function()
end)

discord.Events.GuildSoundboardSoundCreate → "guildSoundboardSoundCreate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to guildSoundboardSoundCreate runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildSoundboardSoundCreate", function()
end)

discord.Events.GuildSoundboardSoundUpdate → "guildSoundboardSoundUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to guildSoundboardSoundUpdate runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildSoundboardSoundUpdate", function()
end)

discord.Events.GuildSoundboardSoundDelete → "guildSoundboardSoundDelete"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to guildSoundboardSoundDelete runs in Client.

Arguments

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildSoundboardSoundDelete", function(soundboardSound)
end)

discord.Events.GuildSoundboardSoundsUpdate → "guildSoundboardSoundsUpdate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to guildSoundboardSoundsUpdate runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("guildSoundboardSoundsUpdate", function()
end)

discord.Events.ShardDisconnect → "shardDisconnect"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to shardDisconnect runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("shardDisconnect", function()
end)

discord.Events.ShardError → "shardError"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to shardError runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("shardError", function()
end)

discord.Events.ShardReady → "shardReady"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to shardReady runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("shardReady", function()
end)

discord.Events.ShardReconnecting → "shardReconnecting"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to shardReconnecting runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("shardReconnecting", function()
end)

discord.Events.ShardResume → "shardResume"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to shardResume runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("shardResume", function()
end)

discord.Events.ShardCreate → "shardCreate"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to shardCreate runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("shardCreate", function()
end)

discord.Events.Invalidated → "invalidated"

Trigger

The session can no longer be used. Stop the process or create a new Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("invalidated", function()
end)

discord.Events.CacheSweep → "cacheSweep"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to cacheSweep runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("cacheSweep", function()
end)

discord.Events.WebSocketShardClose → "close"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to close runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("close", function()
end)

discord.Events.WebSocketShardAllReady → "allReady"

Trigger

Dispatched when the Gateway payload or local Client lifecycle mapped to allReady runs in Client.

Arguments

No additional payload arguments. The handler is function().

Lifecycle

Handlers registered with Client:on run synchronously in registration order. Client:once removes the listener after the first successful emit. Errors in a handler do not automatically disconnect the Gateway.

Example

client:on("allReady", function()
end)