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.
1071 lines
32 KiB
1071 lines
32 KiB
|
|
<!DOCTYPE HTML>
|
|
<html lang="" >
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<title>Message Embeds · 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="advanced.html" />
|
|
|
|
|
|
<link rel="prev" href="building_block_listeners.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="intro.md">
|
|
|
|
<span>
|
|
|
|
|
|
Bot Tutorial
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.3.1" data-path="first_steps.html">
|
|
|
|
<a href="first_steps.html">
|
|
|
|
|
|
Creating and Running a Bot
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.2" data-path="building_block_plugins.html">
|
|
|
|
<a href="building_block_plugins.html">
|
|
|
|
|
|
Plugins
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.3" data-path="building_block_commands.html">
|
|
|
|
<a href="building_block_commands.html">
|
|
|
|
|
|
Commands
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.4" data-path="building_block_listeners.html">
|
|
|
|
<a href="building_block_listeners.html">
|
|
|
|
|
|
Listeners
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter active" data-level="1.3.5" data-path="message_embeds.html">
|
|
|
|
<a href="message_embeds.html">
|
|
|
|
|
|
Message Embeds
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.6" data-path="advanced.html">
|
|
|
|
<a href="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="../api/disco_client.html">
|
|
|
|
<a href="../api/disco_client.html">
|
|
|
|
|
|
disco.client
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.2" data-path="../api/disco_state.html">
|
|
|
|
<a href="../api/disco_state.html">
|
|
|
|
|
|
disco.state
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.3" data-path="../api/disco_cli.html">
|
|
|
|
<a href="../api/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="../api/disco_bot_bot.html">
|
|
|
|
<a href="../api/disco_bot_bot.html">
|
|
|
|
|
|
disco.bot.bot
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.4.2" data-path="../api/disco_bot_plugin.html">
|
|
|
|
<a href="../api/disco_bot_plugin.html">
|
|
|
|
|
|
disco.bot.plugin
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.4.3" data-path="../api/disco_bot_command.html">
|
|
|
|
<a href="../api/disco_bot_command.html">
|
|
|
|
|
|
disco.bot.command
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.4.4" data-path="../api/disco_bot_storage.html">
|
|
|
|
<a href="../api/disco_bot_storage.html">
|
|
|
|
|
|
disco.bot.storage
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.4.5" data-path="../api/disco_bot_parser.html">
|
|
|
|
<a href="../api/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="../api/disco_api_client.html">
|
|
|
|
<a href="../api/disco_api_client.html">
|
|
|
|
|
|
disco.api.client
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.5.2" data-path="../api/disco_api_http.html">
|
|
|
|
<a href="../api/disco_api_http.html">
|
|
|
|
|
|
disco.api.http
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.5.3" data-path="../api/disco_api_ratelimit.html">
|
|
|
|
<a href="../api/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="../api/disco_gateway_client.html">
|
|
|
|
<a href="../api/disco_gateway_client.html">
|
|
|
|
|
|
disco.gateway.client
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.6.2" data-path="../api/disco_gateway_events.html">
|
|
|
|
<a href="../api/disco_gateway_events.html">
|
|
|
|
|
|
disco.gateway.events
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.6.3" data-path="../api/disco_gateway_packets.html">
|
|
|
|
<a href="../api/disco_gateway_packets.html">
|
|
|
|
|
|
disco.gateway.packets
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.6.4" data-path="../api/disco_gateway_sharder.html">
|
|
|
|
<a href="../api/disco_gateway_sharder.html">
|
|
|
|
|
|
disco.gateway.sharder
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.6.5" data-path="../api/disco_gateway_ipc.html">
|
|
|
|
<a href="../api/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="../api/disco_types_base.html">
|
|
|
|
<a href="../api/disco_types_base.html">
|
|
|
|
|
|
disco.types.base
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.2" data-path="../api/disco_types_channel.html">
|
|
|
|
<a href="../api/disco_types_channel.html">
|
|
|
|
|
|
disco.types.channel
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.3" data-path="../api/disco_types_guild.html">
|
|
|
|
<a href="../api/disco_types_guild.html">
|
|
|
|
|
|
disco.types.guild
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.4" data-path="../api/disco_types_invite.html">
|
|
|
|
<a href="../api/disco_types_invite.html">
|
|
|
|
|
|
disco.types.invite
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.5" data-path="../api/disco_types_message.html">
|
|
|
|
<a href="../api/disco_types_message.html">
|
|
|
|
|
|
disco.types.message
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.6" data-path="../api/disco_types_permissions.html">
|
|
|
|
<a href="../api/disco_types_permissions.html">
|
|
|
|
|
|
disco.types.permissions
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.7" data-path="../api/disco_types_user.html">
|
|
|
|
<a href="../api/disco_types_user.html">
|
|
|
|
|
|
disco.types.user
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.8" data-path="../api/disco_types_voice.html">
|
|
|
|
<a href="../api/disco_types_voice.html">
|
|
|
|
|
|
disco.types.voice
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.9" data-path="../api/disco_types_webhook.html">
|
|
|
|
<a href="../api/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="../api/disco_util.html">
|
|
|
|
<a href="../api/disco_util.html">
|
|
|
|
|
|
disco.util
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.2" data-path="../api/disco_util_backdoor.html">
|
|
|
|
<a href="../api/disco_util_backdoor.html">
|
|
|
|
|
|
disco.util.backdoor
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.3" data-path="../api/disco_util_chains.html">
|
|
|
|
<a href="../api/disco_util_chains.html">
|
|
|
|
|
|
disco.util.chains
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.4" data-path="../api/disco_util_config.html">
|
|
|
|
<a href="../api/disco_util_config.html">
|
|
|
|
|
|
disco.util.config
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.5" data-path="../api/disco_util_functional.html">
|
|
|
|
<a href="../api/disco_util_functional.html">
|
|
|
|
|
|
disco.util.functional
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.6" data-path="../api/disco_util_hashmap.html">
|
|
|
|
<a href="../api/disco_util_hashmap.html">
|
|
|
|
|
|
disco.util.hashmap
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.7" data-path="../api/disco_util_limiter.html">
|
|
|
|
<a href="../api/disco_util_limiter.html">
|
|
|
|
|
|
disco.util.limiter
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.8" data-path="../api/disco_util_logging.html">
|
|
|
|
<a href="../api/disco_util_logging.html">
|
|
|
|
|
|
disco.util.logging
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.9" data-path="../api/disco_util_sanitize.html">
|
|
|
|
<a href="../api/disco_util_sanitize.html">
|
|
|
|
|
|
disco.util.sanitize
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.10" data-path="../api/disco_util_snowflake.html">
|
|
|
|
<a href="../api/disco_util_snowflake.html">
|
|
|
|
|
|
disco.util.snowflake
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.11" data-path="../api/disco_util_token.html">
|
|
|
|
<a href="../api/disco_util_token.html">
|
|
|
|
|
|
disco.util.token
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.12" data-path="../api/disco_util_websocket.html">
|
|
|
|
<a href="../api/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="../api/disco_voice_client.html">
|
|
|
|
<a href="../api/disco_voice_client.html">
|
|
|
|
|
|
disco.voice.client
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.9.2" data-path="../api/disco_voice_opus.html">
|
|
|
|
<a href="../api/disco_voice_opus.html">
|
|
|
|
|
|
disco.voice.opus
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.9.3" data-path="../api/disco_voice_packets.html">
|
|
|
|
<a href="../api/disco_voice_packets.html">
|
|
|
|
|
|
disco.voice.packets
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.9.4" data-path="../api/disco_voice_playable.html">
|
|
|
|
<a href="../api/disco_voice_playable.html">
|
|
|
|
|
|
disco.voice.playable
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.9.5" data-path="../api/disco_voice_player.html">
|
|
|
|
<a href="../api/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=".." >Message Embeds</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="message-embeds">Message Embeds</h1>
|
|
<p>A <a href="https://b1naryth1ef.github.io/disco/api/disco_types_message.html#messageembed" target="_blank">Message Embed</a> represents a Discord Embed object. An Embed object is another component of Discord messages that can be used to present data with special formatting and structure.</p>
|
|
<p>An example of a message embed: </p>
|
|
<p><img src="https://i.stack.imgur.com/HRWHk.png" alt="A discord embed" title="A discord embed"></p>
|
|
<p>An embed can contain the following components:</p>
|
|
<ul>
|
|
<li>Author, including link and avatar</li>
|
|
<li>Title</li>
|
|
<li>Description</li>
|
|
<li>Field(s)</li>
|
|
<li>Thumbnail image</li>
|
|
<li>Image</li>
|
|
<li>Footer, including text and icon</li>
|
|
<li>Timestamp</li>
|
|
<li>Color (sets the color of the left sidebar of the embed)</li>
|
|
</ul>
|
|
<h2 id="creating-an-embed">Creating an embed</h2>
|
|
<p>Creating an embed is simple, and can be done like this:</p>
|
|
<pre class="language-"><code class="lang-py"><span class="token keyword">from</span> disco<span class="token punctuation">.</span>types<span class="token punctuation">.</span>message <span class="token keyword">import</span> MessageEmbed <span class="token comment" spellcheck="true">#We need this to create the embed</span>
|
|
<span class="token keyword">from</span> datetime <span class="token keyword">import</span> datetime <span class="token comment" spellcheck="true">#We need this to set the timestamp</span>
|
|
|
|
embed <span class="token operator">=</span> MessageEmbed<span class="token punctuation">(</span><span class="token punctuation">)</span>
|
|
</code></pre>
|
|
<p>This will create a default, empty, Discord Embed object. Now that we have that, let's assign some values to it. First, lets set the author and the title, with a link that leads to this page. This can be done as follows:</p>
|
|
<pre class="language-"><code class="lang-py">embed<span class="token punctuation">.</span>set_author<span class="token punctuation">(</span>name<span class="token operator">=</span><span class="token string">'b1nzy#1337'</span><span class="token punctuation">,</span> url<span class="token operator">=</span><span class="token string">'https://b1naryth1ef.github.com/disco'</span><span class="token punctuation">,</span> icon_url<span class="token operator">=</span><span class="token string">'http://i.imgur.com/1tjdUId.jpg'</span><span class="token punctuation">)</span>
|
|
embed<span class="token punctuation">.</span>title <span class="token operator">=</span> <span class="token string">'How to create an embed'</span>
|
|
embed<span class="token punctuation">.</span>url <span class="token operator">=</span> <span class="token string">'https://b1naryth1ef.github.io/disco/bot_tutorial/message_embeds.html'</span> <span class="token comment" spellcheck="true">#This URL will be hooked up to the title of the embed</span>
|
|
</code></pre>
|
|
<p>Now, we can add a description and a few fields:</p>
|
|
<pre class="language-"><code class="lang-py">embed<span class="token punctuation">.</span>add_field<span class="token punctuation">(</span>name<span class="token operator">=</span><span class="token string">'Inline field 1'</span><span class="token punctuation">,</span> value<span class="token operator">=</span><span class="token string">'Some value for this field'</span><span class="token punctuation">,</span> inline<span class="token operator">=</span><span class="token boolean">True</span><span class="token punctuation">)</span>
|
|
embed<span class="token punctuation">.</span>add_field<span class="token punctuation">(</span>name<span class="token operator">=</span><span class="token string">'Inline field 2'</span><span class="token punctuation">,</span> value<span class="token operator">=</span><span class="token string">'Another value for another field'</span><span class="token punctuation">,</span> inline<span class="token operator">=</span><span class="token boolean">True</span><span class="token punctuation">)</span>
|
|
embed<span class="token punctuation">.</span>add_field<span class="token punctuation">(</span>name<span class="token operator">=</span><span class="token string">'Inline field 3'</span><span class="token punctuation">,</span> value<span class="token operator">=</span><span class="token string">'Third value for the third field'</span><span class="token punctuation">,</span> inline<span class="token operator">=</span><span class="token boolean">True</span><span class="token punctuation">)</span>
|
|
embed<span class="token punctuation">.</span>add_field<span class="token punctuation">(</span>name<span class="token operator">=</span><span class="token string">'A non-inline field'</span><span class="token punctuation">,</span> value<span class="token operator">=</span><span class="token string">'You can only have a max of 3 inline field on 1 line'</span><span class="token punctuation">,</span> inline<span class="token operator">=</span><span class="token boolean">False</span><span class="token punctuation">)</span>
|
|
embed<span class="token punctuation">.</span>description <span class="token operator">=</span> <span class="token string">'This is the general description of the embed, you can use the Discord supported MD in here too, to make it look extra fancy. For example, creating some **bold** or ~~strikethrough~~ text.'</span>
|
|
</code></pre>
|
|
<p>Last up, let's set a footer, color and add a timestamp:</p>
|
|
<pre class="language-"><code class="lang-py">embed<span class="token punctuation">.</span>timestamp <span class="token operator">=</span> datetime<span class="token punctuation">.</span>utcnow<span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">.</span>isoformat<span class="token punctuation">(</span><span class="token punctuation">)</span>
|
|
embed<span class="token punctuation">.</span>set_footer<span class="token punctuation">(</span>text<span class="token operator">=</span><span class="token string">'Disco Message Embeds tutorial'</span><span class="token punctuation">)</span>
|
|
embed<span class="token punctuation">.</span>color <span class="token operator">=</span> <span class="token string">'10038562'</span> <span class="token comment" spellcheck="true">#This can be any color, but I chose a nice dark red tint</span>
|
|
</code></pre>
|
|
<p>Once your embed is finshed, you can send it using the <code>channel.send_message()</code> message or the <code>event.msg.reply()</code> function.
|
|
With <code>channel.send_message()</code>:</p>
|
|
<pre class="language-"><code class="lang-py">self<span class="token punctuation">.</span>bot<span class="token punctuation">.</span>state<span class="token punctuation">.</span>channels<span class="token punctuation">.</span>get<span class="token punctuation">(</span><span class="token operator"><</span>ChannelID<span class="token operator">></span><span class="token punctuation">)</span><span class="token punctuation">.</span>send_message<span class="token punctuation">(</span><span class="token string">'[optional text]'</span><span class="token punctuation">,</span> embed<span class="token operator">=</span>embed<span class="token punctuation">)</span>
|
|
</code></pre>
|
|
<p>with the <code>event.msg.reply()</code> function:</p>
|
|
<pre class="language-"><code class="lang-py">event<span class="token punctuation">.</span>msg<span class="token punctuation">.</span>reply<span class="token punctuation">(</span><span class="token string">'[optional text]'</span><span class="token punctuation">,</span> embed<span class="token operator">=</span>embed<span class="token punctuation">)</span>
|
|
</code></pre>
|
|
<p>The final embed we created in this tutorial would look like this:</p>
|
|
<p><img src="http://i.imgur.com/G1sUcTm.png" alt="alt text" title="The final embed"></p>
|
|
|
|
|
|
</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="building_block_listeners.html" class="navigation navigation-prev " aria-label="Previous page: Listeners">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
|
|
<a href="advanced.html" class="navigation navigation-next " aria-label="Next page: Advanced">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<script>
|
|
var gitbook = gitbook || [];
|
|
gitbook.push(function() {
|
|
gitbook.page.hasChanged({"page":{"title":"Message Embeds","level":"1.3.5","depth":2,"next":{"title":"Advanced","level":"1.3.6","depth":2,"path":"bot_tutorial/advanced.md","ref":"bot_tutorial/advanced.md","articles":[]},"previous":{"title":"Listeners","level":"1.3.4","depth":2,"path":"bot_tutorial/building_block_listeners.md","ref":"bot_tutorial/building_block_listeners.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":"bot_tutorial/message_embeds.md","mtime":"2018-02-15T05:52:56.547Z","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>
|
|
|
|
|