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.
1169 lines
32 KiB
1169 lines
32 KiB
|
|
<!DOCTYPE HTML>
|
|
<html lang="" >
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<title>disco.bot.command · 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_storage.html" />
|
|
|
|
|
|
<link rel="prev" 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 " 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 active" 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.command</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="discobotcommand">disco.bot.command</h1>
|
|
<h2 id="constants">Constants</h2>
|
|
<p>{'type': 'assign', 'targets': ['ARGS_REGEX'], 'value': '(?: ((?:\n|.)*)$|$)'}</p>
|
|
<p>{'type': 'assign', 'targets': ['ARGS_UNGROUPED_REGEX'], 'value': '(?: (?:\n|.)*$|$)'}</p>
|
|
<pre class="language-"><code class="lang-python">SPLIT_SPACES_NO_QUOTE <span class="token operator">=</span> compile<span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token string">"|\']([^"</span>\'<span class="token punctuation">]</span><span class="token operator">+</span><span class="token punctuation">)</span><span class="token punctuation">[</span>"<span class="token operator">|</span>\'<span class="token punctuation">]</span><span class="token operator">|</span><span class="token punctuation">(</span>\S<span class="token operator">+</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
|
|
</code></pre>
|
|
<pre class="language-"><code class="lang-python">USER_MENTION_RE <span class="token operator">=</span> compile<span class="token punctuation">(</span><span class="token operator"><</span>@!?<span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token number">0</span><span class="token operator">-</span><span class="token number">9</span><span class="token punctuation">]</span><span class="token operator">+</span><span class="token punctuation">)</span><span class="token operator">></span><span class="token punctuation">)</span>
|
|
</code></pre>
|
|
<pre class="language-"><code class="lang-python">ROLE_MENTION_RE <span class="token operator">=</span> compile<span class="token punctuation">(</span><span class="token operator"><</span>@<span class="token operator">&</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token number">0</span><span class="token operator">-</span><span class="token number">9</span><span class="token punctuation">]</span><span class="token operator">+</span><span class="token punctuation">)</span><span class="token operator">></span><span class="token punctuation">)</span>
|
|
</code></pre>
|
|
<pre class="language-"><code class="lang-python">CHANNEL_MENTION_RE <span class="token operator">=</span> compile<span class="token punctuation">(</span><span class="token operator"><</span><span class="token comment" spellcheck="true">#([0-9]+)>)</span>
|
|
</code></pre>
|
|
<pre class="language-"><code class="lang-python">CommandLevels <span class="token operator">=</span> Enum<span class="token punctuation">(</span>
|
|
DEFAULT <span class="token operator">=</span> <span class="token number">0</span><span class="token punctuation">,</span>
|
|
TRUSTED <span class="token operator">=</span> <span class="token number">10</span><span class="token punctuation">,</span>
|
|
MOD <span class="token operator">=</span> <span class="token number">50</span><span class="token punctuation">,</span>
|
|
ADMIN <span class="token operator">=</span> <span class="token number">100</span><span class="token punctuation">,</span>
|
|
OWNER <span class="token operator">=</span> <span class="token number">500</span><span class="token punctuation">)</span>
|
|
</code></pre>
|
|
<h2 id="classes">Classes</h2>
|
|
<h3 id="pluginargumentparser">PluginArgumentParser</h3>
|
|
<p><em>Inherits From <code>ArgumentParser</code></em></p>
|
|
<h4 id="functions">Functions</h4>
|
|
<h4 id="errorself-message">error(<code>self, message)</code></h4>
|
|
<h3 id="commandevent">CommandEvent</h3>
|
|
<p>An event which is created when a command is triggered. Contains information
|
|
about the message, command, and parsed arguments (along with shortcuts to
|
|
message information).</p>
|
|
<h5 id="attributes">Attributes</h5>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>command</td>
|
|
<td><code>:class:`Command`</code></td>
|
|
<td>The command this event was created for (aka the triggered command).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>msg</td>
|
|
<td><code>:class:`disco.types.message.Message`</code></td>
|
|
<td>The message object which triggered this command.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>match</td>
|
|
<td><code>:class:`re.MatchObject`</code></td>
|
|
<td>The regex match object for the command.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>name</td>
|
|
<td><code>str</code></td>
|
|
<td>The command name (or alias) which was triggered by the command</td>
|
|
</tr>
|
|
<tr>
|
|
<td>args</td>
|
|
<td><code>list(str)</code></td>
|
|
<td>Arguments passed to the command</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h4 id="functions">Functions</h4>
|
|
<h4 id="initself-command-msg-match"><strong>init</strong>(<code>self, command, msg, match)</code></h4>
|
|
<h4 id="codeblockself">codeblock(<code>self</code>)</h4>
|
|
<h4 id="memberself">member(<code>self</code>)</h4>
|
|
<p>Guild member (if relevant) for the user that created the message.</p>
|
|
<h4 id="channelself">channel(<code>self</code>)</h4>
|
|
<p>Channel the message was created in.</p>
|
|
<h4 id="guildself">guild(<code>self</code>)</h4>
|
|
<p>Guild (if relevant) the message was created in.</p>
|
|
<h4 id="authorself">author(<code>self</code>)</h4>
|
|
<p>Author of the message.</p>
|
|
<h3 id="commanderror">CommandError</h3>
|
|
<p><em>Inherits From <code>Exception</code></em></p>
|
|
<p>An exception which is thrown when the arguments for a command are invalid,
|
|
or don't match the command's specifications.</p>
|
|
<h4 id="functions">Functions</h4>
|
|
<h4 id="initself-msg"><strong>init</strong>(<code>self, msg)</code></h4>
|
|
<h3 id="command">Command</h3>
|
|
<p>An object which defines and handles the triggering of a function based on
|
|
user input (aka a command).</p>
|
|
<h5 id="attributes">Attributes</h5>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>plugin</td>
|
|
<td><code>:class:`disco.bot.plugin.Plugin`</code></td>
|
|
<td>The plugin this command is a member of.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>func</td>
|
|
<td><code>function</code></td>
|
|
<td>The function which is called when this command is triggered.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>trigger</td>
|
|
<td><code>str</code></td>
|
|
<td>The primary trigger (aka name).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>args</td>
|
|
<td><code>Optional[str]</code></td>
|
|
<td>The argument format specification.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>aliases</td>
|
|
<td><code>Optional[list(str)]</code></td>
|
|
<td>List of trigger aliases.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>group</td>
|
|
<td><code>Optional[str]</code></td>
|
|
<td>The group this command is a member of.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>is_regex</td>
|
|
<td><code>Optional[bool]</code></td>
|
|
<td>Whether the triggers for this command should be treated as raw regex.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h4 id="functions">Functions</h4>
|
|
<h4 id="initself-plugin-func-triggerargskwargs"><strong>init</strong>(<code>self, plugin, func, trigger,*args,**kwargs)</code></h4>
|
|
<h4 id="nameself">name(<code>self</code>)</h4>
|
|
<h4 id="callselfargskwargs"><strong>call</strong>(<code>self,*args,**kwargs</code>)</h4>
|
|
<h4 id="getdocstringself">get_docstring(<code>self</code>)</h4>
|
|
<h4 id="updateself-args-levelnone-aliasesnone-groupnone-isregexnone-oobfalse-contextnone-parserfalsekwargs">update(<code>self, args, level=None, aliases=None, group=None, is_regex=None, oob=False, context=None, parser=False,**kwargs)</code></h4>
|
|
<h4 id="mentiontypegetters-reg-userfalse-allowplainfalse">mention_type(<code>getters, reg, user=False, allow_plain=False)</code></h4>
|
|
<h4 id="compiledregexself">compiled_regex(<code>self</code>)</h4>
|
|
<p>A compiled version of this command's regex.</p>
|
|
<h4 id="regexself-grouped">regex(<code>self, grouped)</code></h4>
|
|
<p>The regex string that defines/triggers this command.</p>
|
|
<h4 id="executeself-event">execute(<code>self, event)</code></h4>
|
|
<p>Handles the execution of this command given a :class:<code>CommandEvent</code></p>
|
|
<h5 id="returns">Returns</h5>
|
|
<pre class="language-"><code>Whether this command was successful
|
|
</code></pre>
|
|
|
|
</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-prev " aria-label="Previous page: disco.bot.plugin">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
|
|
<a href="disco_bot_storage.html" class="navigation navigation-next " aria-label="Next page: disco.bot.storage">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<script>
|
|
var gitbook = gitbook || [];
|
|
gitbook.push(function() {
|
|
gitbook.page.hasChanged({"page":{"title":"disco.bot.command","level":"1.4.4.3","depth":3,"next":{"title":"disco.bot.storage","level":"1.4.4.4","depth":3,"path":"api/disco_bot_storage.md","ref":"api/disco_bot_storage.md","articles":[]},"previous":{"title":"disco.bot.plugin","level":"1.4.4.2","depth":3,"path":"api/disco_bot_plugin.md","ref":"api/disco_bot_plugin.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_command.md","mtime":"2018-02-15T05:53:10.127Z","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>
|
|
|
|
|