Class: Discordrb::Bot
- Inherits:
-
Object
- Object
- Discordrb::Bot
- Includes:
- Cache, EventContainer
- Defined in:
- lib/discordrb/bot.rb
Overview
Represents a Discord bot, including servers, users, etc.
Direct Known Subclasses
Instance Attribute Summary collapse
-
#awaits ⇒ Hash<Symbol => Await>
readonly
The list of registered Awaits.
-
#event_threads ⇒ Array<Thread>
readonly
The list of currently running threads used to parse and call events.
-
#gateway ⇒ Gateway
readonly
The gateway connection is an internal detail that is useless to most people.
-
#name ⇒ String
The bot's name which discordrb sends to Discord when making any request, so Discord can identify bots with the same codebase.
-
#shard_key ⇒ Array(Integer, Integer)
readonly
The current shard key.
-
#should_parse_self ⇒ true, false
Whether or not the bot should parse its own messages.
-
#voices ⇒ Hash<Integer => VoiceBot>
readonly
The voice connections this bot currently has, by the server ID to which they are connected.
Instance Method Summary collapse
-
#accept_invite(invite) ⇒ Object
Makes the bot join an invite to a server.
-
#add_await(key, type, attributes = {}) {|event| ... } ⇒ Await
deprecated
Deprecated.
Will be changed to blocking behavior in v4.0. Use #add_await! instead.
-
#add_await!(type, attributes = {}) {|event| ... } ⇒ Event?
Awaits an event, blocking the current thread until a response is received.
-
#add_thread_member(channel, member) ⇒ Object
Add a member to a thread.
-
#bot_application ⇒ Application?
(also: #bot_app)
The bot's OAuth application.
-
#competing=(name) ⇒ String
Sets the currently competing status to the specified name.
-
#connected? ⇒ true, false
Whether or not the bot is currently connected to Discord.
-
#create_oauth_application(name, redirect_uris) ⇒ Array(String, String)
Creates a new application to do OAuth authorization with.
-
#create_server(name, region = :'eu-central') ⇒ Server
Creates a server on Discord with a specified name and a region.
- #debug(message) ⇒ Object
-
#debug=(new_debug) ⇒ Object
Sets debug mode.
-
#delete_application_command(command_id, server_id: nil) ⇒ Object
Remove an application command from the commands registered with discord.
-
#delete_invite(code) ⇒ Object
Revokes an invite to a server.
-
#dispatch(type, data) ⇒ Object
Dispatches an event to this bot.
-
#dnd ⇒ Object
Sets the bot's status to DnD (red icon).
- #edit_application_command(command_id, server_id: nil, name: nil, description: nil, default_permission: nil, type: :chat_input) {|, | ... } ⇒ Object
- #edit_application_command_permissions(command_id, server_id, permissions = []) {|builder| ... } ⇒ Object
- #emoji(id = nil) ⇒ Object (also: #emojis, #all_emoji)
-
#find_emoji(name) ⇒ GlobalEmoji?
Finds an emoji by its name.
-
#game=(name) ⇒ String
(also: #playing=)
Sets the currently playing game to the specified game.
-
#get_application_command(command_id, server_id: nil) ⇒ Object
Get an application command by ID.
-
#get_application_commands(server_id: nil) ⇒ Array<ApplicationCommand>
Get all application commands.
-
#idle ⇒ Object
(also: #away)
Sets status to idle.
-
#ignore_user(user) ⇒ Object
Add a user to the list of ignored users.
-
#ignored?(user) ⇒ true, false
Checks whether a user is being ignored.
-
#initialize(log_mode: :normal, token: nil, client_id: nil, type: nil, name: '', fancy_log: false, suppress_ready: false, parse_self: false, shard_id: nil, num_shards: nil, redact_token: true, ignore_bots: false, compress_mode: :large, intents: :all) ⇒ Bot
constructor
Makes a new bot with the given authentication data.
-
#invisible ⇒ Object
Sets the bot's status to invisible (appears offline).
-
#invite_url(server: nil, permission_bits: nil, redirect_uri: nil, scopes: ['bot']) ⇒ String
Creates an OAuth invite URL that can be used to invite this bot to a particular server.
-
#join ⇒ Object
(also: #sync)
Joins the bot's connection thread with the current thread.
-
#join_thread(channel) ⇒ Object
Join a thread.
-
#leave_thread(channel) ⇒ Object
Leave a thread.
-
#listening=(name) ⇒ String
Sets the current listening status to the specified name.
- #log_exception(e) ⇒ Object
-
#mode=(new_mode) ⇒ Object
Sets the logging mode.
-
#online ⇒ Object
(also: #on)
Sets status to online.
-
#parse_mention(mention, server = nil) ⇒ User, ...
Gets the user, channel, role or emoji from a string.
-
#parse_mentions(mentions, server = nil) ⇒ Array<User, Channel, Role, Emoji>
Gets the users, channels, roles and emoji from a string.
-
#profile ⇒ Profile
(also: #bot_user)
The bot's user profile.
-
#prune_empty_groups ⇒ Object
Makes the bot leave any groups with no recipients remaining.
-
#raise_heartbeat_event ⇒ Object
Raises a heartbeat event.
-
#raw_token ⇒ String
The raw token, without any prefix.
- #register_application_command(name, description, server_id: nil, default_permission: nil, type: :chat_input) {|, | ... } ⇒ Object
-
#remove_thread_member(channel, member) ⇒ Object
Remove a member from a thread.
-
#run(background = false) ⇒ Object
Runs the bot, which logs into Discord and connects the WebSocket.
-
#send_file(channel, file, caption: nil, tts: false, filename: nil, spoiler: nil) ⇒ Object
Sends a file to a channel.
-
#send_message(channel, content, tts = false, embeds = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil) ⇒ Message
Sends a text message to a channel given its ID and the message's content.
-
#send_temporary_message(channel, content, timeout, tts = false, embeds = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil) ⇒ Object
Sends a text message to a channel given its ID and the message's content, then deletes it after the specified timeout in seconds.
-
#servers ⇒ Hash<Integer => Server>
The list of servers the bot is currently in.
-
#stop(_no_sync = nil) ⇒ Object
Stops the bot gracefully, disconnecting the websocket without immediately killing the thread.
-
#stream(name, url) ⇒ String
Sets the currently online stream to the specified name and Twitch URL.
-
#suppress_ready_debug ⇒ Object
Prevents the READY packet from being printed regardless of debug mode.
-
#thread_members ⇒ Hash<Integer => Hash<Integer => Hash<String => Object>>]
The list of members in threads the bot can see.
-
#token ⇒ String
The Discord API token received when logging in.
-
#unignore_user(user) ⇒ Object
Remove a user from the ignore list.
-
#update_oauth_application(name, redirect_uris, description = '', icon = nil) ⇒ Object
Changes information about your OAuth application.
-
#update_status(status, activity, url, since = 0, afk = false, activity_type = 0) ⇒ Object
Updates presence status.
-
#users ⇒ Hash<Integer => User>
The list of users the bot shares a server with.
-
#voice(thing) ⇒ Voice::VoiceBot?
Gets the voice bot for a particular server or channel.
-
#voice_connect(chan, encrypted = true) ⇒ Voice::VoiceBot
Connects to a voice channel, initializes network connections and returns the Voice::VoiceBot over which audio data can then be sent.
-
#voice_destroy(server, destroy_vws = true) ⇒ Object
Disconnects the client from a specific voice connection given the server ID.
-
#watching=(name) ⇒ String
Sets the current watching status to the specified name.
Methods included from Cache
#channel, #ensure_channel, #ensure_server, #ensure_thread_member, #ensure_user, #find_channel, #find_user, #init_cache, #invite, #member, #pm_channel, #request_chunks, #resolve_invite_code, #server, #user, #voice_regions
Methods included from EventContainer
#add_handler, #application_command, #await, #button, #channel_create, #channel_delete, #channel_recipient_add, #channel_recipient_remove, #channel_select, #channel_update, class_from_string, #clear!, #disconnected, event_class, handler_class, #heartbeat, #include_events, #interaction_create, #invite_create, #invite_delete, #member_join, #member_leave, #member_update, #mention, #mentionable_select, #message, #message_delete, #message_edit, #message_update, #modal_submit, #playing, #pm, #presence, #raw, #reaction_add, #reaction_remove, #reaction_remove_all, #ready, #remove_application_command_handler, #remove_handler, #role_select, #server_create, #server_delete, #server_emoji, #server_emoji_create, #server_emoji_delete, #server_emoji_update, #server_role_create, #server_role_delete, #server_role_update, #server_update, #string_select, #typing, #unknown, #user_ban, #user_select, #user_unban, #voice_server_update, #voice_state_update, #webhook_update
Methods included from Events
Constructor Details
#initialize(log_mode: :normal, token: nil, client_id: nil, type: nil, name: '', fancy_log: false, suppress_ready: false, parse_self: false, shard_id: nil, num_shards: nil, redact_token: true, ignore_bots: false, compress_mode: :large, intents: :all) ⇒ Bot
Makes a new bot with the given authentication data. It will be ready to be added event handlers to and can eventually be run with #run.
As support for logging in using username and password has been removed in version 3.0.0, only a token login is
possible. Be sure to specify the type
parameter as :user
if you're logging in as a user.
Simply creating a bot won't be enough to start sending messages etc. with, only a limited set of methods can be used after logging in. If you want to do something when the bot has connected successfully, either do it in the EventContainer#ready event, or use the #run method with the :async parameter and do the processing after that.
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/discordrb/bot.rb', line 114 def initialize( log_mode: :normal, token: nil, client_id: nil, type: nil, name: '', fancy_log: false, suppress_ready: false, parse_self: false, shard_id: nil, num_shards: nil, redact_token: true, ignore_bots: false, compress_mode: :large, intents: :all ) LOGGER.mode = log_mode LOGGER.token = token if redact_token @should_parse_self = parse_self @client_id = client_id @type = type || :bot @name = name @shard_key = num_shards ? [shard_id, num_shards] : nil LOGGER.fancy = fancy_log @prevent_ready = suppress_ready @compress_mode = compress_mode raise 'Token string is empty or nil' if token.nil? || token.empty? @intents = case intents when :all ALL_INTENTS when :unprivileged UNPRIVILEGED_INTENTS when :none NO_INTENTS else calculate_intents(intents) end @token = process_token(@type, token) @gateway = Gateway.new(self, @token, @shard_key, @compress_mode, @intents) init_cache @voices = {} @should_connect_to_voice = {} @ignored_ids = Set.new @ignore_bots = ignore_bots @event_threads = [] @current_thread = 0 @status = :online @application_commands = {} end |
Instance Attribute Details
#awaits ⇒ Hash<Symbol => Await> (readonly)
Returns the list of registered Awaits.
64 65 66 |
# File 'lib/discordrb/bot.rb', line 64 def awaits @awaits end |
#event_threads ⇒ Array<Thread> (readonly)
The list of currently running threads used to parse and call events.
The threads will have a local variable :discordrb_name
in the format of et-1234
, where
"et" stands for "event thread" and the number is a continually incrementing number representing
how many events were executed before.
50 51 52 |
# File 'lib/discordrb/bot.rb', line 50 def event_threads @event_threads end |
#gateway ⇒ Gateway (readonly)
The gateway connection is an internal detail that is useless to most people. It is however essential while debugging or developing discordrb itself, or while writing very custom bots.
69 70 71 |
# File 'lib/discordrb/bot.rb', line 69 def gateway @gateway end |
#name ⇒ String
The bot's name which discordrb sends to Discord when making any request, so Discord can identify bots with the same codebase. Not required but I recommend setting it anyway.
58 59 60 |
# File 'lib/discordrb/bot.rb', line 58 def name @name end |
#shard_key ⇒ Array(Integer, Integer) (readonly)
Returns the current shard key.
61 62 63 |
# File 'lib/discordrb/bot.rb', line 61 def shard_key @shard_key end |
#should_parse_self ⇒ true, false
Returns whether or not the bot should parse its own messages. Off by default.
53 54 55 |
# File 'lib/discordrb/bot.rb', line 53 def should_parse_self @should_parse_self end |
#voices ⇒ Hash<Integer => VoiceBot> (readonly)
Returns the voice connections this bot currently has, by the server ID to which they are connected.
328 329 330 |
# File 'lib/discordrb/bot.rb', line 328 def voices @voices end |
Instance Method Details
#accept_invite(invite) ⇒ Object
Makes the bot join an invite to a server.
302 303 304 305 |
# File 'lib/discordrb/bot.rb', line 302 def accept_invite(invite) resolved = invite(invite).code API::Invite.accept(token, resolved) end |
#add_await(key, type, attributes = {}) {|event| ... } ⇒ Await
Will be changed to blocking behavior in v4.0. Use #add_await! instead.
Add an await the bot should listen to. For information on awaits, see Await.
692 693 694 695 696 697 698 |
# File 'lib/discordrb/bot.rb', line 692 def add_await(key, type, attributes = {}, &block) raise "You can't await an AwaitEvent!" if type == Discordrb::Events::AwaitEvent await = Await.new(self, key, type, attributes, block) @awaits ||= {} @awaits[key] = await end |
#add_await!(type, attributes = {}) {|event| ... } ⇒ Event?
Awaits an event, blocking the current thread until a response is received.
708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 |
# File 'lib/discordrb/bot.rb', line 708 def add_await!(type, attributes = {}) raise "You can't await an AwaitEvent!" if type == Discordrb::Events::AwaitEvent timeout = attributes[:timeout] raise ArgumentError, 'Timeout must be a number > 0' if timeout.is_a?(Numeric) && !timeout.positive? mutex = Mutex.new cv = ConditionVariable.new response = nil block = lambda do |event| mutex.synchronize do response = event if block_given? result = yield(event) cv.signal if result.is_a?(TrueClass) else cv.signal end end end handler = register_event(type, attributes, block) if timeout Thread.new do sleep timeout mutex.synchronize { cv.signal } end end mutex.synchronize { cv.wait(mutex) } remove_handler(handler) raise 'ConditionVariable was signaled without returning an event!' if response.nil? && timeout.nil? response end |
#add_thread_member(channel, member) ⇒ Object
Add a member to a thread
655 656 657 658 |
# File 'lib/discordrb/bot.rb', line 655 def add_thread_member(channel, member) API::Channel.add_thread_member(@token, channel.resolve_id, member.resolve_id) nil end |
#bot_application ⇒ Application? Also known as: bot_app
The bot's OAuth application.
236 237 238 239 240 241 |
# File 'lib/discordrb/bot.rb', line 236 def bot_application return unless @type == :bot response = API.oauth_application(token) Application.new(JSON.parse(response), self) end |
#competing=(name) ⇒ String
Sets the currently competing status to the specified name.
605 606 607 608 |
# File 'lib/discordrb/bot.rb', line 605 def competing=(name) gateway_check update_status(@status, name, nil, nil, nil, 5) end |
#connected? ⇒ true, false
Returns whether or not the bot is currently connected to Discord.
296 297 298 |
# File 'lib/discordrb/bot.rb', line 296 def connected? @gateway.open? end |
#create_oauth_application(name, redirect_uris) ⇒ Array(String, String)
Creates a new application to do OAuth authorization with. This allows you to use OAuth to authorize users using Discord. For information how to use this, see the docs: https://discord.com/developers/docs/topics/oauth2
485 486 487 488 |
# File 'lib/discordrb/bot.rb', line 485 def create_oauth_application(name, redirect_uris) response = JSON.parse(API.create_oauth_application(@token, name, redirect_uris)) [response['id'], response['secret']] end |
#create_server(name, region = :'eu-central') ⇒ Server
Discord's API doesn't directly return the server when creating it, so this method waits until the data has been received via the websocket. This may make the execution take a while.
Creates a server on Discord with a specified name and a region.
472 473 474 475 476 477 478 |
# File 'lib/discordrb/bot.rb', line 472 def create_server(name, region = :'eu-central') response = API::Server.create(token, name, region) id = JSON.parse(response)['id'].to_i sleep 0.1 until (server = @servers[id]) debug "Successfully created server #{server.id} with name #{server.name}" server end |
#debug(message) ⇒ Object
768 769 770 |
# File 'lib/discordrb/bot.rb', line 768 def debug() LOGGER.debug() end |
#debug=(new_debug) ⇒ Object
Sets debug mode. If debug mode is on, many things will be outputted to STDOUT.
669 670 671 |
# File 'lib/discordrb/bot.rb', line 669 def debug=(new_debug) LOGGER.debug = new_debug end |
#delete_application_command(command_id, server_id: nil) ⇒ Object
Remove an application command from the commands registered with discord.
887 888 889 890 891 892 893 |
# File 'lib/discordrb/bot.rb', line 887 def delete_application_command(command_id, server_id: nil) if server_id API::Application.delete_guild_command(@token, profile.id, server_id, command_id) else API::Application.delete_global_command(@token, profile.id, command_id) end end |
#delete_invite(code) ⇒ Object
Revokes an invite to a server. Will fail unless you have the Manage Server permission. It is recommended that you use Invite#delete instead.
392 393 394 395 |
# File 'lib/discordrb/bot.rb', line 392 def delete_invite(code) invite = resolve_invite_code(code) API::Invite.delete(token, invite) end |
#dispatch(type, data) ⇒ Object
Dispatches an event to this bot. Called by the gateway connection handler used internally.
778 779 780 |
# File 'lib/discordrb/bot.rb', line 778 def dispatch(type, data) handle_dispatch(type, data) end |
#dnd ⇒ Object
Sets the bot's status to DnD (red icon).
627 628 629 630 |
# File 'lib/discordrb/bot.rb', line 627 def dnd gateway_check update_status(:dnd, @activity, nil) end |
#edit_application_command(command_id, server_id: nil, name: nil, description: nil, default_permission: nil, type: :chat_input) {|, | ... } ⇒ Object
860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 |
# File 'lib/discordrb/bot.rb', line 860 def edit_application_command(command_id, server_id: nil, name: nil, description: nil, default_permission: nil, type: :chat_input) type = ApplicationCommand::TYPES[type] || type builder = Interactions::OptionBuilder.new = Interactions::PermissionBuilder.new yield(builder, ) if block_given? resp = if server_id API::Application.edit_guild_command(@token, profile.id, server_id, command_id, name, description, builder.to_a, , type) else API::Application.edit_guild_command(@token, profile.id, command_id, name, description, builder.to_a, .type) end cmd = ApplicationCommand.new(JSON.parse(resp), self, server_id) if .to_a.any? raise ArgumentError, 'Permissions can only be set for guild commands' unless server_id (cmd.id, server_id, .to_a) end cmd end |
#edit_application_command_permissions(command_id, server_id, permissions = []) {|builder| ... } ⇒ Object
898 899 900 901 902 903 904 |
# File 'lib/discordrb/bot.rb', line 898 def (command_id, server_id, = []) builder = Interactions::PermissionBuilder.new yield builder if block_given? += builder.to_a API::Application.(@token, profile.id, server_id, command_id, ) end |
#emoji(id) ⇒ Emoji? #emoji ⇒ Array<Emoji> Also known as: emojis, all_emoji
201 202 203 204 205 206 207 208 209 |
# File 'lib/discordrb/bot.rb', line 201 def emoji(id = nil) emoji_hash = servers.values.map(&:emoji).reduce(&:merge) if id id = id.resolve_id emoji_hash[id] else emoji_hash.values end end |
#find_emoji(name) ⇒ GlobalEmoji?
Finds an emoji by its name.
217 218 219 220 |
# File 'lib/discordrb/bot.rb', line 217 def find_emoji(name) LOGGER.out("Resolving emoji #{name}") emoji.find { |element| element.name == name } end |
#game=(name) ⇒ String Also known as: playing=
Sets the currently playing game to the specified game.
569 570 571 572 |
# File 'lib/discordrb/bot.rb', line 569 def game=(name) gateway_check update_status(@status, name, nil) end |
#get_application_command(command_id, server_id: nil) ⇒ Object
Get an application command by ID.
812 813 814 815 816 817 818 819 |
# File 'lib/discordrb/bot.rb', line 812 def get_application_command(command_id, server_id: nil) resp = if server_id API::Application.get_guild_command(@token, profile.id, server_id, command_id) else API::Application.get_global_command(@token, profile.id, command_id) end ApplicationCommand.new(JSON.parse(resp), self, server_id) end |
#get_application_commands(server_id: nil) ⇒ Array<ApplicationCommand>
Get all application commands.
797 798 799 800 801 802 803 804 805 806 807 |
# File 'lib/discordrb/bot.rb', line 797 def get_application_commands(server_id: nil) resp = if server_id API::Application.get_guild_commands(@token, profile.id, server_id) else API::Application.get_global_commands(@token, profile.id) end JSON.parse(resp).map do |command_data| ApplicationCommand.new(command_data, self, server_id) end end |
#idle ⇒ Object Also known as: away
Sets status to idle.
619 620 621 622 |
# File 'lib/discordrb/bot.rb', line 619 def idle gateway_check update_status(:idle, @activity, nil) end |
#ignore_user(user) ⇒ Object
Ignoring a user only prevents any message events (including mentions, commands etc.) from them! Typing and presence and any other events will still be received.
Add a user to the list of ignored users. Those users will be ignored in message events at event processing level.
750 751 752 |
# File 'lib/discordrb/bot.rb', line 750 def ignore_user(user) @ignored_ids << user.resolve_id end |
#ignored?(user) ⇒ true, false
Checks whether a user is being ignored.
763 764 765 |
# File 'lib/discordrb/bot.rb', line 763 def ignored?(user) @ignored_ids.include?(user.resolve_id) end |
#invisible ⇒ Object
Sets the bot's status to invisible (appears offline).
633 634 635 636 |
# File 'lib/discordrb/bot.rb', line 633 def invisible gateway_check update_status(:invisible, @activity, nil) end |
#invite_url(server: nil, permission_bits: nil, redirect_uri: nil, scopes: ['bot']) ⇒ String
Creates an OAuth invite URL that can be used to invite this bot to a particular server.
313 314 315 316 317 318 319 320 321 322 323 324 325 |
# File 'lib/discordrb/bot.rb', line 313 def invite_url(server: nil, permission_bits: nil, redirect_uri: nil, scopes: ['bot']) @client_id ||= bot_application.id query = URI.encode_www_form({ client_id: @client_id, guild_id: server&.id, permissions: , redirect_uri: redirect_uri, scope: scopes.join(' ') }.compact) "https://discord.com/oauth2/authorize?#{query}" end |
#join ⇒ Object Also known as: sync
Joins the bot's connection thread with the current thread. This blocks execution until the websocket stops, which should only happen manually triggered. or due to an error. This is necessary to have a continuously running bot.
283 284 285 |
# File 'lib/discordrb/bot.rb', line 283 def join @gateway.sync end |
#join_thread(channel) ⇒ Object
Join a thread
640 641 642 643 |
# File 'lib/discordrb/bot.rb', line 640 def join_thread(channel) API::Channel.join_thread(@token, channel.resolve_id) nil end |
#leave_thread(channel) ⇒ Object
Leave a thread
647 648 649 650 |
# File 'lib/discordrb/bot.rb', line 647 def leave_thread(channel) API::Channel.leave_thread(@token, channel.resolve_id) nil end |
#listening=(name) ⇒ String
Sets the current listening status to the specified name.
579 580 581 582 |
# File 'lib/discordrb/bot.rb', line 579 def listening=(name) gateway_check update_status(@status, name, nil, nil, nil, 2) end |
#log_exception(e) ⇒ Object
773 774 775 |
# File 'lib/discordrb/bot.rb', line 773 def log_exception(e) LOGGER.log_exception(e) end |
#mode=(new_mode) ⇒ Object
Sets the logging mode
675 676 677 |
# File 'lib/discordrb/bot.rb', line 675 def mode=(new_mode) LOGGER.mode = new_mode end |
#online ⇒ Object Also known as: on
Sets status to online.
611 612 613 614 |
# File 'lib/discordrb/bot.rb', line 611 def online gateway_check update_status(:online, @activity, @streamurl) end |
#parse_mention(mention, server = nil) ⇒ User, ...
Gets the user, channel, role or emoji from a string.
538 539 540 |
# File 'lib/discordrb/bot.rb', line 538 def parse_mention(mention, server = nil) parse_mentions(mention, server).first end |
#parse_mentions(mentions, server = nil) ⇒ Array<User, Channel, Role, Emoji>
Gets the users, channels, roles and emoji from a string.
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 |
# File 'lib/discordrb/bot.rb', line 504 def parse_mentions(mentions, server = nil) array_to_return = [] # While possible mentions may be in message while mentions.include?('<') && mentions.include?('>') # Removing all content before the next possible mention mentions = mentions.split('<', 2)[1] # Locate the first valid mention enclosed in `<...>`, otherwise advance to the next open `<` next unless mentions.split('>', 2).first.length < mentions.split('<', 2).first.length # Store the possible mention value to be validated with RegEx mention = mentions.split('>', 2).first if /@!?(?<id>\d+)/ =~ mention array_to_return << user(id) unless user(id).nil? elsif /#(?<id>\d+)/ =~ mention array_to_return << channel(id, server) unless channel(id, server).nil? elsif /@&(?<id>\d+)/ =~ mention if server array_to_return << server.role(id) unless server.role(id).nil? else @servers.each_value do |element| array_to_return << element.role(id) unless element.role(id).nil? end end elsif /(?<animated>^a|^${0}):(?<name>\w+):(?<id>\d+)/ =~ mention array_to_return << (emoji(id) || Emoji.new({ 'animated' => !animated.nil?, 'name' => name, 'id' => id }, self, nil)) end end array_to_return end |
#profile ⇒ Profile Also known as: bot_user
The bot's user profile. This special user object can be used to edit user data like the current username (see Profile#username=).
225 226 227 228 229 230 |
# File 'lib/discordrb/bot.rb', line 225 def profile return @profile if @profile response = Discordrb::API::User.profile(@token) @profile = Profile.new(JSON.parse(response), self) end |
#prune_empty_groups ⇒ Object
Makes the bot leave any groups with no recipients remaining
788 789 790 791 792 |
# File 'lib/discordrb/bot.rb', line 788 def prune_empty_groups @channels.each_value do |channel| channel.leave_group if channel.group? && channel.recipients.empty? end end |
#raise_heartbeat_event ⇒ Object
Raises a heartbeat event. Called by the gateway connection handler used internally.
783 784 785 |
# File 'lib/discordrb/bot.rb', line 783 def raise_heartbeat_event raise_event(HeartbeatEvent.new(self)) end |
#raw_token ⇒ String
Returns the raw token, without any prefix.
255 256 257 |
# File 'lib/discordrb/bot.rb', line 255 def raw_token @token.split(' ').last end |
#register_application_command(name, description, server_id: nil, default_permission: nil, type: :chat_input) {|, | ... } ⇒ Object
835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 |
# File 'lib/discordrb/bot.rb', line 835 def register_application_command(name, description, server_id: nil, default_permission: nil, type: :chat_input) type = ApplicationCommand::TYPES[type] || type builder = Interactions::OptionBuilder.new = Interactions::PermissionBuilder.new yield(builder, ) if block_given? resp = if server_id API::Application.create_guild_command(@token, profile.id, server_id, name, description, builder.to_a, , type) else API::Application.create_global_command(@token, profile.id, name, description, builder.to_a, , type) end cmd = ApplicationCommand.new(JSON.parse(resp), self, server_id) if .to_a.any? raise ArgumentError, 'Permissions can only be set for guild commands' unless server_id (cmd.id, server_id, .to_a) end cmd end |
#remove_thread_member(channel, member) ⇒ Object
Remove a member from a thread
663 664 665 666 |
# File 'lib/discordrb/bot.rb', line 663 def remove_thread_member(channel, member) API::Channel.remove_thread_member(@token, channel.resolve_id, member.resolve_id) nil end |
#run(background = false) ⇒ Object
Running the bot in the background means that you can call some methods that require a gateway connection before that connection is established. In most cases an exception will be raised if you try to do this. If you need a way to safely run code after the bot is fully connected, use a EventContainer#ready event handler instead.
Runs the bot, which logs into Discord and connects the WebSocket. This
prevents all further execution unless it is executed with
background
= true
.
271 272 273 274 275 276 277 |
# File 'lib/discordrb/bot.rb', line 271 def run(background = false) @gateway.run_async return if background debug('Oh wait! Not exiting yet as run was run synchronously.') @gateway.sync end |
#send_file(channel, file, caption: nil, tts: false, filename: nil, spoiler: nil) ⇒ Object
This executes in a blocking way, so if you're sending long files, be wary of delays.
Sends a file to a channel. If it is an image, it will automatically be embedded.
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 |
# File 'lib/discordrb/bot.rb', line 450 def send_file(channel, file, caption: nil, tts: false, filename: nil, spoiler: nil) if file.respond_to?(:read) if spoiler filename ||= File.basename(file.path) filename = "SPOILER_#{filename}" unless filename.start_with? 'SPOILER_' end # https://github.com/rest-client/rest-client/blob/v2.0.2/lib/restclient/payload.rb#L160 file.define_singleton_method(:original_filename) { filename } if filename file.define_singleton_method(:path) { filename } if filename end channel = channel.resolve_id response = API::Channel.upload_file(token, channel, file, caption: , tts: tts) Message.new(JSON.parse(response), self) end |
#send_message(channel, content, tts = false, embeds = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil) ⇒ Message
Sends a text message to a channel given its ID and the message's content.
406 407 408 409 410 411 412 413 414 415 |
# File 'lib/discordrb/bot.rb', line 406 def (channel, content, tts = false, = nil, = nil, allowed_mentions = nil, = nil, components = nil) channel = channel.resolve_id debug("Sending message to #{channel} with content '#{content}'") allowed_mentions = { parse: [] } if allowed_mentions == false = { message_id: .id } if .respond_to?(:id) = (.instance_of?(Array) ? .map(&:to_hash) : [&.to_hash]).compact response = API::Channel.(token, channel, content, tts, , nil, , allowed_mentions&.to_hash, , components) Message.new(JSON.parse(response), self) end |
#send_temporary_message(channel, content, timeout, tts = false, embeds = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil) ⇒ Object
Sends a text message to a channel given its ID and the message's content, then deletes it after the specified timeout in seconds.
428 429 430 431 432 433 434 435 436 437 438 |
# File 'lib/discordrb/bot.rb', line 428 def (channel, content, timeout, tts = false, = nil, = nil, allowed_mentions = nil, = nil, components = nil) Thread.new do Thread.current[:discordrb_name] = "#{@current_thread}-temp-msg" = (channel, content, tts, , , allowed_mentions, , components) sleep(timeout) .delete end nil end |
#servers ⇒ Hash<Integer => Server>
The list of servers the bot is currently in.
180 181 182 183 184 |
# File 'lib/discordrb/bot.rb', line 180 def servers gateway_check unavailable_servers_check @servers end |
#stop(_no_sync = nil) ⇒ Object
This method no longer takes an argument as of 3.4.0
Stops the bot gracefully, disconnecting the websocket without immediately killing the thread. This means that Discord is immediately aware of the closed connection and makes the bot appear offline instantly.
291 292 293 |
# File 'lib/discordrb/bot.rb', line 291 def stop(_no_sync = nil) @gateway.stop end |
#stream(name, url) ⇒ String
Sets the currently online stream to the specified name and Twitch URL.
596 597 598 599 600 |
# File 'lib/discordrb/bot.rb', line 596 def stream(name, url) gateway_check update_status(@status, name, url) name end |
#suppress_ready_debug ⇒ Object
Prevents the READY packet from being printed regardless of debug mode.
680 681 682 |
# File 'lib/discordrb/bot.rb', line 680 def suppress_ready_debug @prevent_ready = true end |
#thread_members ⇒ Hash<Integer => Hash<Integer => Hash<String => Object>>]
The list of members in threads the bot can see.
188 189 190 191 192 |
# File 'lib/discordrb/bot.rb', line 188 def thread_members gateway_check unavailable_servers_check @thread_members end |
#token ⇒ String
The Discord API token received when logging in. Useful to explicitly call API methods.
248 249 250 251 |
# File 'lib/discordrb/bot.rb', line 248 def token API.bot_name = @name @token end |
#unignore_user(user) ⇒ Object
Remove a user from the ignore list.
756 757 758 |
# File 'lib/discordrb/bot.rb', line 756 def unignore_user(user) @ignored_ids.delete(user.resolve_id) end |
#update_oauth_application(name, redirect_uris, description = '', icon = nil) ⇒ Object
Changes information about your OAuth application
496 497 498 |
# File 'lib/discordrb/bot.rb', line 496 def update_oauth_application(name, redirect_uris, description = '', icon = nil) API.update_oauth_application(@token, name, redirect_uris, description, icon) end |
#update_status(status, activity, url, since = 0, afk = false, activity_type = 0) ⇒ Object
Updates presence status.
551 552 553 554 555 556 557 558 559 560 561 562 563 564 |
# File 'lib/discordrb/bot.rb', line 551 def update_status(status, activity, url, since = 0, afk = false, activity_type = 0) gateway_check @activity = activity @status = status @streamurl = url type = url ? 1 : activity_type activity_obj = activity || url ? { 'name' => activity, 'url' => url, 'type' => type } : nil @gateway.send_status_update(status, since, activity_obj, afk) # Update the status in the cache profile.update_presence('status' => status.to_s, 'activities' => [activity_obj].compact) end |
#users ⇒ Hash<Integer => User>
The list of users the bot shares a server with.
172 173 174 175 176 |
# File 'lib/discordrb/bot.rb', line 172 def users gateway_check unavailable_servers_check @users end |
#voice(thing) ⇒ Voice::VoiceBot?
Gets the voice bot for a particular server or channel. You can connect to a new channel using the #voice_connect method.
334 335 336 337 338 339 340 341 342 343 |
# File 'lib/discordrb/bot.rb', line 334 def voice(thing) id = thing.resolve_id return @voices[id] if @voices[id] channel = channel(id) return nil unless channel server_id = channel.server.id return @voices[server_id] if @voices[server_id] end |
#voice_connect(chan, encrypted = true) ⇒ Voice::VoiceBot
Connects to a voice channel, initializes network connections and returns the Voice::VoiceBot over which audio data can then be sent. After connecting, the bot can also be accessed using #voice. If the bot is already connected to voice, the existing connection will be terminated - you don't have to call Voice::VoiceBot#destroy before calling this method.
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 |
# File 'lib/discordrb/bot.rb', line 353 def voice_connect(chan, encrypted = true) raise ArgumentError, 'Unencrypted voice connections are no longer supported.' unless encrypted chan = channel(chan.resolve_id) server_id = chan.server.id if @voices[chan.id] debug('Voice bot exists already! Destroying it') @voices[chan.id].destroy @voices.delete(chan.id) end debug("Got voice channel: #{chan}") @should_connect_to_voice[server_id] = chan @gateway.send_voice_state_update(server_id.to_s, chan.id.to_s, false, false) debug('Voice channel init packet sent! Now waiting.') sleep(0.05) until @voices[server_id] debug('Voice connect succeeded!') @voices[server_id] end |
#voice_destroy(server, destroy_vws = true) ⇒ Object
Disconnects the client from a specific voice connection given the server ID. Usually it's more convenient to use Voice::VoiceBot#destroy rather than this.
382 383 384 385 386 387 |
# File 'lib/discordrb/bot.rb', line 382 def voice_destroy(server, destroy_vws = true) server = server.resolve_id @gateway.send_voice_state_update(server.to_s, nil, false, false) @voices[server].destroy if @voices[server] && destroy_vws @voices.delete(server) end |
#watching=(name) ⇒ String
Sets the current watching status to the specified name.
587 588 589 590 |
# File 'lib/discordrb/bot.rb', line 587 def watching=(name) gateway_check update_status(@status, name, nil, nil, nil, 3) end |