You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1297 lines
34 KiB
1297 lines
34 KiB
|
|
<!DOCTYPE HTML>
|
|
<html lang="" >
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<title>disco.bot.bot · Disco</title>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="description" content="">
|
|
<meta name="generator" content="GitBook 3.2.2">
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/style.css">
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-prism/prism.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-hints/plugin-hints.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-fontsettings/website.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<meta name="HandheldFriendly" content="true"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
|
|
<meta name="apple-mobile-web-app-capable" content="yes">
|
|
<meta name="apple-mobile-web-app-status-bar-style" content="black">
|
|
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png">
|
|
<link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">
|
|
|
|
|
|
<link rel="next" href="disco_bot_plugin.html" />
|
|
|
|
|
|
|
|
</head>
|
|
<body>
|
|
|
|
<div class="book">
|
|
<div class="book-summary">
|
|
|
|
|
|
<div id="book-search-input" role="search">
|
|
<input type="text" placeholder="Type to search" />
|
|
</div>
|
|
|
|
|
|
<nav role="navigation">
|
|
|
|
|
|
|
|
<ul class="summary">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.1" data-path="../">
|
|
|
|
<a href="../">
|
|
|
|
|
|
Introduction
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.2" data-path="../installation.html">
|
|
|
|
<a href="../installation.html">
|
|
|
|
|
|
Installation and Setup
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3" data-path="../bot_tutorial/intro.md">
|
|
|
|
<span>
|
|
|
|
|
|
Bot Tutorial
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.3.1" data-path="../bot_tutorial/first_steps.html">
|
|
|
|
<a href="../bot_tutorial/first_steps.html">
|
|
|
|
|
|
Creating and Running a Bot
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.2" data-path="../bot_tutorial/building_block_plugins.html">
|
|
|
|
<a href="../bot_tutorial/building_block_plugins.html">
|
|
|
|
|
|
Plugins
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.3" data-path="../bot_tutorial/building_block_commands.html">
|
|
|
|
<a href="../bot_tutorial/building_block_commands.html">
|
|
|
|
|
|
Commands
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.4" data-path="../bot_tutorial/building_block_listeners.html">
|
|
|
|
<a href="../bot_tutorial/building_block_listeners.html">
|
|
|
|
|
|
Listeners
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.5" data-path="../bot_tutorial/message_embeds.html">
|
|
|
|
<a href="../bot_tutorial/message_embeds.html">
|
|
|
|
|
|
Message Embeds
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.6" data-path="../bot_tutorial/advanced.html">
|
|
|
|
<a href="../bot_tutorial/advanced.html">
|
|
|
|
|
|
Advanced
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4" >
|
|
|
|
<span>
|
|
|
|
|
|
API Docs
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.4.1" data-path="disco_client.html">
|
|
|
|
<a href="disco_client.html">
|
|
|
|
|
|
disco.client
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.2" data-path="disco_state.html">
|
|
|
|
<a href="disco_state.html">
|
|
|
|
|
|
disco.state
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.3" data-path="disco_cli.html">
|
|
|
|
<a href="disco_cli.html">
|
|
|
|
|
|
disco.cli
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.4" >
|
|
|
|
<span>
|
|
|
|
|
|
Bot
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter active" data-level="1.4.4.1" data-path="disco_bot_bot.html">
|
|
|
|
<a href="disco_bot_bot.html">
|
|
|
|
|
|
disco.bot.bot
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.4.2" data-path="disco_bot_plugin.html">
|
|
|
|
<a href="disco_bot_plugin.html">
|
|
|
|
|
|
disco.bot.plugin
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.4.3" data-path="disco_bot_command.html">
|
|
|
|
<a href="disco_bot_command.html">
|
|
|
|
|
|
disco.bot.command
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.4.4" data-path="disco_bot_storage.html">
|
|
|
|
<a href="disco_bot_storage.html">
|
|
|
|
|
|
disco.bot.storage
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.4.5" data-path="disco_bot_parser.html">
|
|
|
|
<a href="disco_bot_parser.html">
|
|
|
|
|
|
disco.bot.parser
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.5" >
|
|
|
|
<span>
|
|
|
|
|
|
API
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.4.5.1" data-path="disco_api_client.html">
|
|
|
|
<a href="disco_api_client.html">
|
|
|
|
|
|
disco.api.client
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.5.2" data-path="disco_api_http.html">
|
|
|
|
<a href="disco_api_http.html">
|
|
|
|
|
|
disco.api.http
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.5.3" data-path="disco_api_ratelimit.html">
|
|
|
|
<a href="disco_api_ratelimit.html">
|
|
|
|
|
|
disco.api.ratelimit
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.6" >
|
|
|
|
<span>
|
|
|
|
|
|
Gateway
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.4.6.1" data-path="disco_gateway_client.html">
|
|
|
|
<a href="disco_gateway_client.html">
|
|
|
|
|
|
disco.gateway.client
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.6.2" data-path="disco_gateway_events.html">
|
|
|
|
<a href="disco_gateway_events.html">
|
|
|
|
|
|
disco.gateway.events
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.6.3" data-path="disco_gateway_packets.html">
|
|
|
|
<a href="disco_gateway_packets.html">
|
|
|
|
|
|
disco.gateway.packets
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.6.4" data-path="disco_gateway_sharder.html">
|
|
|
|
<a href="disco_gateway_sharder.html">
|
|
|
|
|
|
disco.gateway.sharder
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.6.5" data-path="disco_gateway_ipc.html">
|
|
|
|
<a href="disco_gateway_ipc.html">
|
|
|
|
|
|
disco.gateway.ipc
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7" >
|
|
|
|
<span>
|
|
|
|
|
|
Types
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.4.7.1" data-path="disco_types_base.html">
|
|
|
|
<a href="disco_types_base.html">
|
|
|
|
|
|
disco.types.base
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.2" data-path="disco_types_channel.html">
|
|
|
|
<a href="disco_types_channel.html">
|
|
|
|
|
|
disco.types.channel
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.3" data-path="disco_types_guild.html">
|
|
|
|
<a href="disco_types_guild.html">
|
|
|
|
|
|
disco.types.guild
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.4" data-path="disco_types_invite.html">
|
|
|
|
<a href="disco_types_invite.html">
|
|
|
|
|
|
disco.types.invite
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.5" data-path="disco_types_message.html">
|
|
|
|
<a href="disco_types_message.html">
|
|
|
|
|
|
disco.types.message
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.6" data-path="disco_types_permissions.html">
|
|
|
|
<a href="disco_types_permissions.html">
|
|
|
|
|
|
disco.types.permissions
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.7" data-path="disco_types_user.html">
|
|
|
|
<a href="disco_types_user.html">
|
|
|
|
|
|
disco.types.user
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.8" data-path="disco_types_voice.html">
|
|
|
|
<a href="disco_types_voice.html">
|
|
|
|
|
|
disco.types.voice
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.9" data-path="disco_types_webhook.html">
|
|
|
|
<a href="disco_types_webhook.html">
|
|
|
|
|
|
disco.types.webhook
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8" >
|
|
|
|
<span>
|
|
|
|
|
|
Util
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.4.8.1" data-path="disco_util.html">
|
|
|
|
<a href="disco_util.html">
|
|
|
|
|
|
disco.util
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.2" data-path="disco_util_backdoor.html">
|
|
|
|
<a href="disco_util_backdoor.html">
|
|
|
|
|
|
disco.util.backdoor
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.3" data-path="disco_util_chains.html">
|
|
|
|
<a href="disco_util_chains.html">
|
|
|
|
|
|
disco.util.chains
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.4" data-path="disco_util_config.html">
|
|
|
|
<a href="disco_util_config.html">
|
|
|
|
|
|
disco.util.config
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.5" data-path="disco_util_functional.html">
|
|
|
|
<a href="disco_util_functional.html">
|
|
|
|
|
|
disco.util.functional
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.6" data-path="disco_util_hashmap.html">
|
|
|
|
<a href="disco_util_hashmap.html">
|
|
|
|
|
|
disco.util.hashmap
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.7" data-path="disco_util_limiter.html">
|
|
|
|
<a href="disco_util_limiter.html">
|
|
|
|
|
|
disco.util.limiter
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.8" data-path="disco_util_logging.html">
|
|
|
|
<a href="disco_util_logging.html">
|
|
|
|
|
|
disco.util.logging
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.9" data-path="disco_util_sanitize.html">
|
|
|
|
<a href="disco_util_sanitize.html">
|
|
|
|
|
|
disco.util.sanitize
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.10" data-path="disco_util_snowflake.html">
|
|
|
|
<a href="disco_util_snowflake.html">
|
|
|
|
|
|
disco.util.snowflake
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.11" data-path="disco_util_token.html">
|
|
|
|
<a href="disco_util_token.html">
|
|
|
|
|
|
disco.util.token
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.12" data-path="disco_util_websocket.html">
|
|
|
|
<a href="disco_util_websocket.html">
|
|
|
|
|
|
disco.util.websocket
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.9" >
|
|
|
|
<span>
|
|
|
|
|
|
Voice
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.4.9.1" data-path="disco_voice_client.html">
|
|
|
|
<a href="disco_voice_client.html">
|
|
|
|
|
|
disco.voice.client
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.9.2" data-path="disco_voice_opus.html">
|
|
|
|
<a href="disco_voice_opus.html">
|
|
|
|
|
|
disco.voice.opus
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.9.3" data-path="disco_voice_packets.html">
|
|
|
|
<a href="disco_voice_packets.html">
|
|
|
|
|
|
disco.voice.packets
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.9.4" data-path="disco_voice_playable.html">
|
|
|
|
<a href="disco_voice_playable.html">
|
|
|
|
|
|
disco.voice.playable
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.9.5" data-path="disco_voice_player.html">
|
|
|
|
<a href="disco_voice_player.html">
|
|
|
|
|
|
disco.voice.player
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="divider"></li>
|
|
|
|
<li>
|
|
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
|
|
Published with GitBook
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
</nav>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="book-body">
|
|
|
|
<div class="body-inner">
|
|
|
|
|
|
|
|
<div class="book-header" role="navigation">
|
|
|
|
|
|
<!-- Title -->
|
|
<h1>
|
|
<i class="fa fa-circle-o-notch fa-spin"></i>
|
|
<a href=".." >disco.bot.bot</a>
|
|
</h1>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="page-wrapper" tabindex="-1" role="main">
|
|
<div class="page-inner">
|
|
|
|
<div id="book-search-results">
|
|
<div class="search-noresults">
|
|
|
|
<section class="normal markdown-section">
|
|
|
|
<h1 id="discobotbot">disco.bot.bot</h1>
|
|
<h2 id="classes">Classes</h2>
|
|
<h3 id="botconfig">BotConfig</h3>
|
|
<p><em>Inherits From <code>Config</code></em></p>
|
|
<p>An object which is used to configure and define the runtime configuration for
|
|
a bot.</p>
|
|
<h5 id="attributes">Attributes</h5>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>levels</td>
|
|
<td><code>dict(snowflake, str)</code></td>
|
|
<td>Mapping of user IDs/role IDs to :class:`disco.bot.commands.CommandLevesls` which is used for the default commands_level_getter.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>plugins</td>
|
|
<td><code>list[string]</code></td>
|
|
<td>List of plugin modules to load.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>commands_enabled</td>
|
|
<td><code>bool</code></td>
|
|
<td>Whether this bot instance should utilize command parsing. Generally this should be true, unless your bot is only handling events and has no user interaction.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>commands_require_mention</td>
|
|
<td><code>bool</code></td>
|
|
<td>Whether messages must mention the bot to be considered for command parsing.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>commands_mention_rules</td>
|
|
<td><code>dict(str, bool)</code></td>
|
|
<td>A dictionary describing what mention types can be considered a mention of the bot when using :attr:`commands_require_mention`. This dictionary can contain the following keys: `here`, `everyone`, `role`, `user`. When a keys value is set to true, the mention type will be considered for command parsing.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>commands_prefix</td>
|
|
<td><code>str</code></td>
|
|
<td>A string prefix that is required for a message to be considered for command parsing.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>commands_allow_edit</td>
|
|
<td><code>bool</code></td>
|
|
<td>If true, the bot will reparse an edited message if it was the last sent message in a channel, and did not previously trigger a command. This is helpful for allowing edits to typod commands.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>commands_level_getter</td>
|
|
<td><code>function</code></td>
|
|
<td>If set, a function which when given a GuildMember or User, returns the relevant :class:`disco.bot.commands.CommandLevels`.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>commands_group_abbrev</td>
|
|
<td><code>function</code></td>
|
|
<td>If true, command groups may be abbreviated to the least common variation. E.g. the grouping 'test' may be abbreviated down to 't', unless 'tag' exists, in which case it may be abbreviated down to 'te'.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>plugin_config_provider</td>
|
|
<td><code>Optional[function]</code></td>
|
|
<td>If set, this function will replace the default configuration loading function, which normally attempts to load a file located at config/plugin_name.fmt where fmt is the plugin_config_format. The function here should return a valid configuration object which the plugin understands.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>plugin_config_format</td>
|
|
<td><code>str</code></td>
|
|
<td>The serialization format plugin configuration files are in.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>plugin_config_dir</td>
|
|
<td><code>str</code></td>
|
|
<td>The directory plugin configuration is located within.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>http_enabled</td>
|
|
<td><code>bool</code></td>
|
|
<td>Whether to enable the built-in Flask server which allows plugins to handle and route HTTP requests.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>http_host</td>
|
|
<td><code>str</code></td>
|
|
<td>The host string for the HTTP Flask server (if enabled)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>http_port</td>
|
|
<td><code>int</code></td>
|
|
<td>The port for the HTTP Flask server (if enabled)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="bot">Bot</h3>
|
|
<p><em>Inherits From <code>LoggingClass</code></em></p>
|
|
<p>Disco's implementation of a simple but extendable Discord bot. Bots consist
|
|
of a set of plugins, and a Disco client.</p>
|
|
<h5 id="parameters">Parameters</h5>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>client</td>
|
|
<td><code>:class:`disco.client.Client`</code></td>
|
|
<td>The client this bot should utilize for its connection.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>config</td>
|
|
<td><code>Optional[:class:`BotConfig`]</code></td>
|
|
<td>The configuration to use for this bot. If not provided will use the defaults inside of :class:`BotConfig`.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="attributes">Attributes</h5>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>client</td>
|
|
<td><code>`disco.client.Client`</code></td>
|
|
<td>The client instance for this bot.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>config</td>
|
|
<td><code>`BotConfig`</code></td>
|
|
<td>The bot configuration instance for this bot.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>plugins</td>
|
|
<td><code>dict(str, :class:`disco.bot.plugin.Plugin`)</code></td>
|
|
<td>Any plugins this bot has loaded</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h4 id="functions">Functions</h4>
|
|
<h4 id="initself-client-config"><strong>init</strong>(<code>self, client, config)</code></h4>
|
|
<h4 id="fromcliclsplugins">from_cli(<code>cls,*plugins</code>)</h4>
|
|
<p>Creates a new instance of the bot using the utilities inside of the
|
|
:mod:<code>disco.cli</code> module. Allows passing in a set of uninitialized
|
|
plugin classes to load.</p>
|
|
<h5 id="parameters">Parameters</h5>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>plugins</td>
|
|
<td><code>Optional[list(:class:`disco.bot.plugin.Plugin`)]</code></td>
|
|
<td>Any plugins to load after creating the new bot instance</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h4 id="commandsself">commands(<code>self</code>)</h4>
|
|
<p>Generator of all commands this bots plugins have defined.</p>
|
|
<h4 id="recomputeself">recompute(<code>self</code>)</h4>
|
|
<p>Called when a plugin is loaded/unloaded to recompute internal state.</p>
|
|
<h4 id="computegroupabbrevself-groups">compute_group_abbrev(<code>self, groups)</code></h4>
|
|
<p>Computes all possible abbreviations for a command grouping.</p>
|
|
<h4 id="computecommandmatchesreself">compute_command_matches_re(<code>self</code>)</h4>
|
|
<p>Computes a single regex which matches all possible command combinations.</p>
|
|
<h4 id="getcommandsformessageself-requiremention-mentionrules-prefix-msg">get_commands_for_message(<code>self, require_mention, mention_rules, prefix, msg)</code></h4>
|
|
<p>Generator of all commands that a given message object triggers, based on
|
|
the bots plugins and configuration.</p>
|
|
<h5 id="yields">Yields</h5>
|
|
<p>tuple(:class:<code>disco.bot.command.Command</code>, <code>re.MatchObject</code>)
|
|
All commands the message triggers</p>
|
|
<h5 id="parameters">Parameters</h5>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>msg</td>
|
|
<td><code>:class:`disco.types.message.Message`</code></td>
|
|
<td>The message object to parse and find matching commands for</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h4 id="getlevelself-actor">get_level(<code>self, actor)</code></h4>
|
|
<h4 id="checkcommandpermissionsself-command-msg">check_command_permissions(<code>self, command, msg)</code></h4>
|
|
<h4 id="handlemessageself-msg">handle_message(<code>self, msg)</code></h4>
|
|
<p>Attempts to handle a newly created or edited message in the context of
|
|
command parsing/triggering. Calls all relevant commands the message triggers.</p>
|
|
<h5 id="returns">Returns</h5>
|
|
<pre class="language-"><code>whether any commands where successfully triggered by the message
|
|
</code></pre><h5 id="parameters">Parameters</h5>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>msg</td>
|
|
<td><code>:class:`disco.types.message.Message`</code></td>
|
|
<td>The newly created or updated message object to parse/handle.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h4 id="onmessagecreateself-event">on_message_create(<code>self, event)</code></h4>
|
|
<h4 id="onmessageupdateself-event">on_message_update(<code>self, event)</code></h4>
|
|
<h4 id="addpluginself-inst-config-ctxnone">add_plugin(<code>self, inst, config, ctx=None)</code></h4>
|
|
<p>Adds and loads a plugin, based on its class.</p>
|
|
<h5 id="parameters">Parameters</h5>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>inst</td>
|
|
<td><code>subclass (or instance therein) of `disco.bot.plugin.Plugin`</code></td>
|
|
<td>Plugin class to initialize and load.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>config</td>
|
|
<td><code>Optional</code></td>
|
|
<td>The configuration to load the plugin with.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ctx</td>
|
|
<td><code>Optional[dict]</code></td>
|
|
<td>Context (previous state) to pass the plugin. Usually used along w/ unload.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h4 id="rmvpluginself-cls">rmv_plugin(<code>self, cls)</code></h4>
|
|
<p>Unloads and removes a plugin based on its class.</p>
|
|
<h5 id="parameters">Parameters</h5>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>cls</td>
|
|
<td><code>subclass of :class:`disco.bot.plugin.Plugin`</code></td>
|
|
<td>Plugin class to unload and remove.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h4 id="reloadpluginself-cls">reload_plugin(<code>self, cls)</code></h4>
|
|
<p>Reloads a plugin.</p>
|
|
<h4 id="runforeverself">run_forever(<code>self</code>)</h4>
|
|
<p>Runs this bots core loop forever.</p>
|
|
<h4 id="addpluginmoduleself-path-config">add_plugin_module(<code>self, path, config)</code></h4>
|
|
<p>Adds and loads a plugin, based on its module path.</p>
|
|
<h4 id="loadpluginconfigself-cls">load_plugin_config(<code>self, cls)</code></h4>
|
|
|
|
|
|
</section>
|
|
|
|
</div>
|
|
<div class="search-results">
|
|
<div class="has-results">
|
|
|
|
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
|
|
<ul class="search-results-list"></ul>
|
|
|
|
</div>
|
|
<div class="no-results">
|
|
|
|
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<a href="disco_bot_plugin.html" class="navigation navigation-next navigation-unique" aria-label="Next page: disco.bot.plugin">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<script>
|
|
var gitbook = gitbook || [];
|
|
gitbook.push(function() {
|
|
gitbook.page.hasChanged({"page":{"title":"disco.bot.bot","level":"1.4.4.1","depth":3,"next":{"title":"disco.bot.plugin","level":"1.4.4.2","depth":3,"path":"api/disco_bot_plugin.md","ref":"api/disco_bot_plugin.md","articles":[]},"previous":{"title":"Bot","level":"1.4.4","depth":2,"ref":"","articles":[{"title":"disco.bot.bot","level":"1.4.4.1","depth":3,"path":"api/disco_bot_bot.md","ref":"api/disco_bot_bot.md","articles":[]},{"title":"disco.bot.plugin","level":"1.4.4.2","depth":3,"path":"api/disco_bot_plugin.md","ref":"api/disco_bot_plugin.md","articles":[]},{"title":"disco.bot.command","level":"1.4.4.3","depth":3,"path":"api/disco_bot_command.md","ref":"api/disco_bot_command.md","articles":[]},{"title":"disco.bot.storage","level":"1.4.4.4","depth":3,"path":"api/disco_bot_storage.md","ref":"api/disco_bot_storage.md","articles":[]},{"title":"disco.bot.parser","level":"1.4.4.5","depth":3,"path":"api/disco_bot_parser.md","ref":"api/disco_bot_parser.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["prism","-highlight","hints"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"anchorjs":{"placement":"left","visible":"always"},"prism":{},"hints":{"danger":"fa fa-exclamation-circle","info":"fa fa-info-circle","tip":"fa fa-mortar-board","working":"fa fa-wrench"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Disco","gitbook":"*"},"file":{"path":"api/disco_bot_bot.md","mtime":"2018-02-15T05:53:10.123Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2018-02-15T05:53:11.657Z"},"basePath":"..","book":{"language":""}});
|
|
});
|
|
</script>
|
|
</div>
|
|
|
|
|
|
<script src="../gitbook/gitbook.js"></script>
|
|
<script src="../gitbook/theme.js"></script>
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-search/search-engine.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-search/search.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-sharing/buttons.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|
|
|