Events

How to use events

discorb uses event driven programming. You can register event handlers with Discorb::Client#on. Alternatively, you can use Discorb::Client#once to register a one-time event handler.

client.on :message do |event|
  puts event.message.content
end

This example will print the content of every message received.

Since v0.2.5, you can also register event handlers by adding a method to the client, with the prefix on_ and the event name as the method name.

client = Discorb::Client.new

class << client
  def on_standby
    puts "Ready!"
  end
end

If you want to seperate event handlers from the client, consider using Discorb::Extension. Learn more about extensions.

Since v0.6.1, you can set :override to true to register overridable event handlers.

client.on :message, override: true do |event|
  puts "This event handler is overrideable!"
end

client.on :message do |event|
  puts "Override!"
end

This example will print Override!, but not This event handler is overrideable!. This is useful for registering event handlers as default behaviour, such as error handlers.

# In the library...

client.on :command_error, override: true do |event, error|
  $stderr.puts "Command error:\n#{error.full_message}"
end

# In your code...

client.on :command_error do |event, error|
  event.message.reply "An error occurred while executing the command!\n#{error.full_message}"
end

Event reference

Client events

`event_receive(event_name, data)`

Fires when a event is received.

`ready()`

Fires when the client receives the READY event.

`standby()`

Fires when the client is standby. (When the client connects to Discord, and has cached guilds and members.)

`resumed()`

Fires when the client is resumed connection.

`error(event_name, args, error)`

Fires when an error occurs during an event. Defaults to printing the error to stderr, override to handle it yourself.

`setup()`

Fires when discorb setup is run. This is useful for setting up some dependencies, such as the database.

Guild events

`guild_join(guild)`

Fires when client joins a guild.

`guild_available(guild)`

Fires when a guild becomes available.

`guild_update(before, after)`

Fires when client updates a guild.

`guild_leave(guild)`

Fires when client leaves a guild.

`guild_destroy(guild)`

Fires when guild is destroyed.

`guild_integrations_update(guild)`

Fires when guild integrations are updated.

`guild_ban_add(guild, user)`

Fires when a user is banned from a guild.

`guild_ban_remove(guild, user)`

Fires when a user is unbanned from a guild.

Channel events

`channel_create(channel)`

Fires when a channel is created.

`channel_update(before, after)`

Fires when a channel is updated.

`channel_delete(channel)`

Fires when a channel is deleted.

`webhooks_update(event)`

Fires when a webhook is updated.

`thread_new(thread)`

Fires when a thread is created.

`thread_join(thread)`

Fires when client joins a thread.

`thread_delete(thread)`

Fires when a thread is deleted.

`thread_update(before, after)`

Fires when a thread is updated.

`thread_members_update(thread, added, removed)`

Fires when a thread's members are updated.

`thread_member_update(before, after)`

Fires when a thread member is updated.

Integration events

`integration_create(integration)`

Fires when a guild integration is created.

`integration_update(after)`

Fires when a guild integration is updated.

`integration_delete(integration)`

Fires when a guild integration is deleted.

Message events

`message(message)`

Fires when a message is created.

`message_update(event)`

Fires when a message is updated.

`message_delete(message, channel, guild)`

Fires when a message is deleted.

Note

This will fire when cached messages are deleted.

`message_delete_id(message_id, channel, guild)`

Fires when a message is deleted. Not like #message_delete this will fire even message is not cached.

`message_delete_bulk(messages)`

Fires when a bulk of messages are deleted.

`message_pin_update(event)`

Fires when a message is pinned or unpinned.

`typing_start(event)`

Fires when a user starts typing.

Reaction events

`reaction_add(event)`

Fires when a reaction is added to a message.

`reaction_remove(event)`

Fires when someone removes a reaction from a message.

`reaction_remove_all(event)`

Fires when all reactions are removed from a message.

`reaction_remove_emoji(event)`

Fires when a reaction is removed from a message.

Role events

`role_create(role)`

Fires when a role is created.

`role_update(before, after)`

Fires when a role is updated.

`role_remove(role)`

Fires when a role is deleted.

Member events

Note

These events requires the guild_members intent.

`member_add(member)`

Fires when a member joins a guild.

`member_update(before, after)`

Fires when a member is updated.

`member_remove(member)`

Fires when a member is removed from a guild.

Role events

`role_create(role)`

Fires when a role is created.

`role_update(before, after)`

Fires when a role is updated.

`role_remove(role)`

Fires when a role is deleted.

Invite events

`invite_create(invite)`

Fires when a invite is created.

`invite_delete(invite)`

Fires when a invite is deleted.

Interaction events

`button_click(interaction)`

Fires when a button is clicked.

`select_menu_select(interaction)`

Fires when a select menu is selected.

Voice events

Because it's big, it's documented in Voice Events.

Guild scheduled event events

`scheduled_event_create(event)`

Fires when a scheduled event is created.

`scheduled_event_cancel(event)`, `scheduled_event_delete(event)`

Fires when a scheduled event is canceled or deleted.

`scheduled_event_edit(before, after)`

Fires when a scheduled event is edited.

`scheduled_event_start(event)`

Fires when a scheduled event is started.

`scheduled_event_end(event)`

Fires when a scheduled event is ended.

Low-level events

`guild_create(guild)`

Fires when GUILD_CREATE is received.

`guild_delete(guild)`

Fires when GUILD_DELETE is received.

`thread_create(thread)`

Fires when THREAD_CREATE is received.

`scheduled_event_update(before, after)`

Fires when SCHEDULED_EVENT_UPDATE is received.

Events

How to use events

Event reference

Client events

event_receive(event_name, data)

ready()

standby()

resumed()

error(event_name, args, error)

setup()

Guild events

guild_join(guild)

guild_available(guild)

guild_update(before, after)

guild_leave(guild)

guild_destroy(guild)

guild_integrations_update(guild)

guild_ban_add(guild, user)

guild_ban_remove(guild, user)

Channel events

channel_create(channel)

channel_update(before, after)

channel_delete(channel)

webhooks_update(event)

thread_new(thread)

thread_join(thread)

thread_delete(thread)

thread_update(before, after)

thread_members_update(thread, added, removed)

thread_member_update(before, after)

Integration events

integration_create(integration)

integration_update(after)

integration_delete(integration)

Message events

message(message)

message_update(event)

message_delete(message, channel, guild)

Note

message_delete_id(message_id, channel, guild)

message_delete_bulk(messages)

message_pin_update(event)

typing_start(event)

Reaction events

reaction_add(event)

reaction_remove(event)

reaction_remove_all(event)

reaction_remove_emoji(event)

Role events

role_create(role)

role_update(before, after)

role_remove(role)

Member events

Note

member_add(member)

member_update(before, after)

member_remove(member)

Role events

role_create(role)

role_update(before, after)

role_remove(role)

Invite events

invite_create(invite)

invite_delete(invite)

Interaction events

button_click(interaction)

select_menu_select(interaction)

Voice events

Guild scheduled event events

scheduled_event_create(event)

scheduled_event_cancel(event), scheduled_event_delete(event)

scheduled_event_edit(before, after)

scheduled_event_start(event)

scheduled_event_end(event)

Low-level events

guild_create(guild)

guild_delete(guild)

thread_create(thread)

scheduled_event_update(before, after)

`event_receive(event_name, data)`

`ready()`

`standby()`

`resumed()`

`error(event_name, args, error)`

`setup()`

`guild_join(guild)`

`guild_available(guild)`

`guild_update(before, after)`

`guild_leave(guild)`

`guild_destroy(guild)`

`guild_integrations_update(guild)`

`guild_ban_add(guild, user)`

`guild_ban_remove(guild, user)`

`channel_create(channel)`

`channel_update(before, after)`

`channel_delete(channel)`

`webhooks_update(event)`

`thread_new(thread)`

`thread_join(thread)`

`thread_delete(thread)`

`thread_update(before, after)`

`thread_members_update(thread, added, removed)`

`thread_member_update(before, after)`

`integration_create(integration)`

`integration_update(after)`

`integration_delete(integration)`

`message(message)`

`message_update(event)`

`message_delete(message, channel, guild)`

`message_delete_id(message_id, channel, guild)`

`message_delete_bulk(messages)`

`message_pin_update(event)`

`typing_start(event)`

`reaction_add(event)`

`reaction_remove(event)`

`reaction_remove_all(event)`

`reaction_remove_emoji(event)`

`role_create(role)`

`role_update(before, after)`

`role_remove(role)`

`member_add(member)`

`member_update(before, after)`

`member_remove(member)`

`role_create(role)`

`role_update(before, after)`

`role_remove(role)`

`invite_create(invite)`

`invite_delete(invite)`

`button_click(interaction)`

`select_menu_select(interaction)`

`scheduled_event_create(event)`

`scheduled_event_cancel(event)`, `scheduled_event_delete(event)`

`scheduled_event_edit(before, after)`

`scheduled_event_start(event)`

`scheduled_event_end(event)`

`guild_create(guild)`

`guild_delete(guild)`

`thread_create(thread)`

`scheduled_event_update(before, after)`