Embeds

This page covers building a Discord embed: every property you can set on it, its fields, and what you get back when you read the embeds already on a message. You're assumed to have a bot named "my-bot" logged in and to know how to send a message.

How embeds work

A new discord embed creates an empty embed, entirely in memory; every set <property> of {_e} line only fills it further, with no call to Discord. Nothing is sent until you hand the embed to something that talks to a channel: post it, reply with it, or set it as the embed of a message builder and read the build result of that builder. An embed is simpler than the full builder contract on that page: it has no await and no build result of its own, because on its own it never talks to Discord.

on message received seen by "my-bot":
    if discord content of event-message is "!embed":
        set {_e} to a new discord embed
        set title of {_e} to "DiSky V5"
        set description of {_e} to "An embed built entirely in Skript."
        set color of {_e} to orange
        post {_e} to event-channel

Options

Every property is set with set <property> of {_e} to <value>. DiSky enforces the length and url limits from JDA's EmbedBuilder immediately, on the set line itself; the field count and total-length limits only apply once the embed is attached somewhere (see Errors you may see).

Reading a property back only works for two of them: description of {_e} returns what you set, and fields of {_e} returns the list you added to. Every other property, including title and color, reads back nothing even right after you set it: JDA's EmbedBuilder keeps no getter for it, so DiSky has nothing to return.

on message received seen by "my-bot":
    if discord content of event-message is "!embed-full":
        set {_e} to a new discord embed
        set title of {_e} to "DiSky V5"
        set title url of {_e} to "https://disky.me"
        set description of {_e} to "An embed built entirely in Skript."
        set color of {_e} to orange
        set discord author of {_e} to "DiSky"
        set author icon of {_e} to "https://disky.me/icon.png"
        set footer of {_e} to "Powered by DiSky"
        set image of {_e} to "https://disky.me/banner.png"
        set thumbnail of {_e} to "https://disky.me/thumb.png"
        set timestamp of {_e} to now
        post {_e} to event-channel

Fields

A field is its own object, built separately and added to the embed's fields. Three spellings create one: bare (inline defaults to false), with an explicit inline value, or with inline forced by the new inline field form.

on message received seen by "my-bot":
    if discord content of event-message is "!embed-fields":
        set {_e} to a new discord embed
        set title of {_e} to "Ping results"
        add (a new embed field named "Region" with value "eu-west") to fields of {_e}
        add (a new embed field named "Status" with value "OK" inline true) to fields of {_e}
        loop fields of {_e}:
            send "%name of loop-value% = %value of loop-value% (inline: %inline of loop-value%)" to console
        post {_e} to event-channel

The three attested spellings:

set {_f1} to a new embed field named "Region" with value "eu-west"
set {_f2} to a new embed field named "Status" with value "OK" inline true
set {_f3} to a new inline embed field named "Latency" with value "42ms"

add {_f1} to fields of {_e} attaches one to an embed; a field itself only reads back through name of, value of and inline of (as used on loop-value above). A field name over 256 characters or a value over 1024 fails immediately, when the field is created, not when it's added.

Reading embeds

embeds of a sent message returns its embeds; a message built with DiSky carries a single embed, so the list usually holds one element. Each one comes back as JDA's own MessageEmbed, a read-only type with no Skript type of its own, but DiSky converts it to an embedbuilder wherever one is expected: store it in a variable, set more properties on it, and post it again as a new embed.

on message received seen by "my-bot":
    if discord content of event-message is "!requote":
        set {_e} to first element of embeds of event-message
        set footer of {_e} to "requoted by DiSky"
        post {_e} to event-channel

This never edits the original message: the converter copies the sent embed's content into a fresh EmbedBuilder, so post, reply with or a message builder is still what puts the result on Discord. To change the embed shown by an existing message in place, edit that message with the new embed instead (see managing messages).

Errors you may see