Skip to content
Embed & Message description

$description[]

The $description[] function defines the main body (description) of a Discord embed. This is the main text area of the embed, displayed below the title.

Syntax

$description[text;(embedIndex)]

Parameters

Parameter Description
text The text of the description. Supports Discord markdown, line breaks, emojis, and interpolation of BDFD functions/variables.
embedIndex Optional. Index of the targeted embed, from 1 to 10 (1 by default, also when empty). Any other value is an error.

Return value

This function returns nothing; it modifies the response currently being constructed. The pending embed is emitted automatically at the end of the script as the response; $sendMessage[text] does not send it, it posts a separate channel message and leaves the pending response untouched. See Execution model.

Behavior

  • $description[] is a response mutation.
  • The description is the core of the embed’s content: this is where you place the bulk of your text.
  • Maximum length: 4096 characters; a longer text is an error (“Embed text cannot exceed 4096 characters.”). The total text of all the embeds is limited to 6000 characters.
  • If the text is empty, the description will not be displayed.

Examples

Simple description

$title[Information]
$description[Here is the requested information. Use the buttons below to navigate.]
$color[#5865F2]

Multi-line description with markdown

$title[Server Rules]
$description[
**Server Rules:**
1. Respect other members
2. No spam
3. No NSFW content

*Thank you for your understanding!*
]
$color[#ED4245]

Description with dynamic variables

$title[Profile]
$description[
**Name:** $username
**ID:** $authorID
**Registration Date:** $creationDate[$authorID]
]
$color[#5865F2]

Notes

  • The description supports full Discord markdown: **bold**, *italics*, __underline__, ~~strikethrough~~, lists, code blocks, etc.
  • To structure complex information, combine $description[] with $addField[].

Try it

Paste an example into the playground to preview its message (functions that act on Discord are not run), or build the same thing with blocks.