Denizen Script Meta Documentation Search


Learn about how Denizen works in The Beginner's Guide.
Showing 182 search results for ddiscordbot out of 3799 meta-documentation entries...

Semi-Decent Match Results



Command


Namediscordconnect
Related Guide Pagehttps://guide.denizenscript.com/guides/expanding/ddiscordbot.html
Syntaxdiscordconnect [id:<id>] [token:<secret>] (intents:<intent>|...)
Short DescriptionConnects to Discord.
Full DescriptionConnects to Discord.

The connection will automatically specify the following gateway intents:
GUILD_MEMBERS, GUILD_EMOJIS_AND_STICKERS, GUILD_MESSAGES, GUILD_MESSAGE_REACTIONS, DIRECT_MESSAGES, DIRECT_MESSAGE_REACTIONS, MESSAGE_CONTENT
Optionally specify additional Gateway Intents to use as a list of any of:
GUILD_BANS, GUILD_WEBHOOKS, GUILD_INVITES, GUILD_VOICE_STATES, GUILD_PRESENCES, GUILD_MESSAGE_TYPING, DIRECT_MESSAGE_TYPING

use "intents:clear|SOME_INTENT|etc" (ie the first entry as "clear") to clear out default intents and use only your manually specified choices.

Note that you need to enable the 'members' and 'message content' intent on your bot in Discord bot settings https://discord.com/developers/applications
And also may need to manually enable other intents if you specify any.
If the members intent is not enabled, a significant amount of dDiscordBot's functionality will not work.

Store your Discord bot token in the Denizen secrets file at 'plugins/Denizen/secrets.secret'. Refer to ObjectType:SecretTag for usage info.

The command should usually be ~waited for. See Language:~waitable.
Related Tags<discord[<bot_id>]> Returns the Discord bot for the given bot ID.
Usage Example
#Use to connect to Discord with a token stored in secret file 'plugins/Denizen/secrets.secret' and send a message once connected.
- ~discordconnect id:mybot token:<secret[discord_bot_token]>
- discordmessage id:mybot channel:<[my_log_channel]> "Connected!"
Groupexternal
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/commands/DiscordConnectCommand.java#L52

ObjectType


NameDiscordBotTag
Prefixdiscord@
Base TypeElementTag
ImplementsFlaggableObject
Identity FormatThe identity format for Discord bots is the bot ID (as chosen in Command:discord).
For example: mybot
DescriptionA DiscordBotTag is an object that represents a Discord bot powered by dDiscordBot.

This object type is flaggable.
Flags on this object type will be stored in: plugins/dDiscordBot/flags/bot_(botname).dat
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordBotTag.java#L19
NameDiscordButtonTag
Prefixdiscordbutton@
Base TypeElementTag
Identity FormatThe identity format for Discord button is a map of button data. Do not alter raw button data, use the with.as tag instead.
DescriptionA DiscordButtonTag is an object that represents a Discord button for use with dDiscordBot.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordButtonTag.java#L22
NameDiscordChannelTag
Prefixdiscordchannel@
Base TypeElementTag
ImplementsFlaggableObject
Identity FormatThe identity format for Discord channels is the bot ID (optional), followed by the channel ID (required).
For example: 1234
Or: mybot,1234
DescriptionA DiscordChannelTag is an object that represents a channel (text or voice) on Discord, either as a generic reference,
or as a bot-specific reference (the relevant guild is inherently linked, and does not need to be specified).

This object type is flaggable.
Flags on this object type will be stored in: plugins/dDiscordBot/flags/bot_(botname).dat, under special sub-key "__channels"
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L28
NameDiscordCommandTag
Prefixdiscordcommand@
Base TypeElementTag
ImplementsFlaggableObject
Identity FormatThe identity format for Discord commands is the bot ID (optional), followed by the guild ID (optional), followed by the command ID (required).
For example: 1234
Or: 12,1234
Or: mybot,12,1234
DescriptionA DiscordCommandTag is an object that represents a created slash command on Discord, as a bot-specific reference.

This object type is flaggable.
Flags on this object type will be stored in: plugins/dDiscordBot/flags/bot_(botname).dat, under special sub-key "__commands"
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordCommandTag.java#L25
NameDiscordEmbedTag
Prefixdiscordembed@
Base TypeElementTag
Identity FormatThe identity format for Discord embeds is a map of embed data.
The map matches the key set documented at Tag:DiscordEmbedTag.with.as, along with a "fields" key as a ListTag of MapTags with keys "title", "value", and "inline".
DescriptionA DiscordEmbedTag is an object that represents a Discord embed for use with dDiscordBot.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L21
NameDiscordGroupTag
Prefixdiscordgroup@
Base TypeElementTag
ImplementsFlaggableObject
Identity FormatThe identity format for Discord groups is the bot ID (optional), followed by the guild ID (required).
For example: 1234
Or: mybot,1234
DescriptionA DiscordGroupTag is an object that represents a group on Discord, either as a generic reference,
or as a bot-specific reference.

Note that the correct name for what we call here a 'group' is inconsistent between different people.
The Discord API calls it a "guild" (for historical reasons, not called that by *people* anymore usually),
messages in the Discord app call it a "server" (which is a convenient name but is factually inaccurate, as they are not servers),
many people will simply say "a Discord" (which is awkward for branding and also would be confusing if used in documentation).
So we're going with "group" (which is still confusing because "group" sometimes refers to DM groups, but... it's good enough).

This object type is flaggable.
Flags on this object type will be stored in: plugins/dDiscordBot/flags/bot_(botname).dat, under special sub-key "__guilds"
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L27
NameDiscordMessageTag
Prefixdiscordmessage@
Base TypeElementTag
ImplementsFlaggableObject
Identity FormatThe identity format for Discord messages is the bot ID (optional), followed by the channel ID (optional), followed by the message ID (required).
For example: 1234
Or: 12,1234
Or: mybot,12,1234
DescriptionA DiscordMessageTag is an object that represents a message already sent on Discord, either as a generic reference,
or as a bot-specific reference.
Note that this is not used for messages that *are going to be* sent.
Note that this often does not contain data for messages that have been deleted (unless that data is cached).

This object type is flaggable.
Flags on this object type will be stored in: plugins/dDiscordBot/flags/bot_(botname).dat, under special sub-key "__messages"
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L26
NameDiscordReactionTag
Prefixdiscordreaction@
Base TypeElementTag
ImplementsFlaggableObject
Identity FormatThe identity format for Discord reactions is the bot ID, followed by the channel ID, followed by the message ID, followed by the reaction ID.
Or: mybot,12,1234,99
The reaction ID for custom reactions is an ID number, and for default emojis is the unicode text format of the emoji.
DescriptionA DiscordReactionTag is an object that represents a reaction to a message already sent on Discord, as a generic reference.

This object type is flaggable.
Flags on this object type will be stored in: plugins/dDiscordBot/flags/bot_(botname).dat, under special sub-key "__reactions"
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordReactionTag.java#L27
NameDiscordRoleTag
Prefixdiscordrole@
Base TypeElementTag
ImplementsFlaggableObject
Identity FormatThe identity format for Discord roles is the bot ID (optional), followed by the guild ID (optional), followed by the role ID (required).
For example: 4321
Or: 1234,4321
Or: mybot,1234,4321
DescriptionA DiscordRoleTag is an object that represents a role on Discord, either as a generic reference,
or as a guild-specific reference, or as a bot+guild-specific reference.

This object type is flaggable.
Flags on this object type will be stored in: plugins/dDiscordBot/flags/bot_(botname).dat, under special sub-key "__roles"
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L26
NameDiscordSelectionTag
Prefixdiscordselection@
Base TypeElementTag
Identity FormatThe identity format for Discord selection menu is a map of menu data. Do not alter raw menu data, use the with.as tag instead.
DescriptionA DiscordSelectionTag is an object that represents a Discord selection menu for use with dDiscordBot.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordSelectionTag.java#L24
NameDiscordTextInputTag
Prefixdiscordtextinput@
Base TypeElementTag
Identity FormatThe identity format for Discord text input is a map of relevant data. Do not alter raw text input data, use the with.as tag instead.
DescriptionA DiscordTextInputTag is an object that represents a Discord text input for use with dDiscordBot.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordTextInputTag.java#L21
NameDiscordUserTag
Prefixdiscorduser@
Base TypeElementTag
ImplementsFlaggableObject
Identity FormatThe identity format for Discord users is the bot ID (optional), followed by the user ID (required).
For example: 1234
Or: mybot,1234
DescriptionA DiscordUserTag is an object that represents a user (human or bot) on Discord, either as a generic reference,
or as a bot-specific reference.

This object type is flaggable.
Flags on this object type will be stored in: plugins/dDiscordBot/flags/bot_(botname).dat, under special sub-key "__users"
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L28

Tag


Name<discord_bots>
ReturnsListTag(DiscordBotTag)
DescriptionReturns a list of all Discord bots currently loaded in dDiscordBot.
Generated Example
- foreach <discord_bots> as:entry:
    - narrate "found <[entry]>"
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L102

Just Barely Matched Results



Command


Namediscord
Related Guide Pagehttps://guide.denizenscript.com/guides/expanding/ddiscordbot.html
Syntaxdiscord [id:<id>] [disconnect/add_role/start_typing/remove_role/status (status:<status>) (activity:<activity>)/rename] (<value>) (message_id:<id>) (channel:<channel>) (user:<user>) (group:<group>) (role:<role>) (url:<url>)
Short DescriptionInteracts with Discord.
Full DescriptionInteracts with Discord.

Commands may fail if the bot does not have permission within the Discord group to perform them.

When setting the status of the Discord bot, the status argument can be: ONLINE, DND, IDLE, or INVISIBLE,
and the activity argument can be: PLAYING, STREAMING, LISTENING, or WATCHING.
Streaming activity requires a 'url:' input.

The command should always be ~waited for. See Language:~waitable.
Related Tags<discord[<bot_id>]> Returns the Discord bot for the given bot ID.
Usage Example
#Use to disconnect from Discord.
- ~discord id:mybot disconnect
Usage Example
#Use to add a role on a user in a Discord guild.
- ~discord id:mybot add_role user:<[user]> role:<[role]> group:<[group]>
Usage Example
#Use to remove a role on a user in a Discord guild.
- ~discord id:mybot remove_role user:<[user]> role:<[role]> group:<[group]>
Usage Example
#Use to set the online status of the bot, and clear the game status.
- ~discord id:mybot status "Minecraft" "status:ONLINE"
Usage Example
#Use to set the game status of the bot.
- ~discord id:mybot status "Minecraft" "status:ONLINE" "activity:PLAYING"
Usage Example
#Use to change the bot's nickname.
- ~discord id:mybot rename "<[nickname]>" group:<[group]>
Usage Example
#Use to give a user a new nickname.
- ~discord id:mybot rename "<[nickname]>" user:<[user]> group:<[group]>
Usage Example
#Use to start typing in a specific channel.
- ~discord id:mybot start_typing channel:<[channel]>
Groupexternal
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/commands/DiscordCommand.java#L38
Namediscordban
Related Guide Pagehttps://guide.denizenscript.com/guides/expanding/ddiscordbot.html
Syntaxdiscordban (id:<bot>) ({add}/remove) [user:<user>] [group:<group>] (reason:<reason>) (deletion_timeframe:<time>/{0s})
Short DescriptionBans or unbans a member from a group.
Full DescriptionBans or unbans a member from a group.

To ban a user, use the "add" argument. To unban a user, use the "remove" argument.
The group is required for both "add" and "remove" arguments, but "reason" can only be used with "add".
Reasons show up in the group's Audit Logs.

The "deletion_timeframe" argument will, if set, delete all messages sent by the user being banned within the timeframe given.
The timeframe defaults to 0 seconds, which will not delete any messages. The timeframe cannot be greater than 7 days.
This argument can only be used when adding a ban using the "add" argument, although it is not required.

The command should usually be ~waited for. See Language:~waitable.
Related Tags<DiscordUserTag.is_banned[<group>]> returns if the user is banned from a certain group.
<DiscordGroupTag.banned_members> returns a list of all banned members in a group.
Usage Example
#Bans a user with a reason and deletes all messages sent by the user in the past 2 hours.
- ~discordban id:mybot add user:<[user]> group:<[group]> "reason:Was being mean!" deletion_timeframe:2h
Usage Example
#Bans a user with but does not delete any messages sent and does not have a reason.
- ~discordban id:mybot add user:<[user]> group:<[group]>
Usage Example
#Unbans a user.
- ~discordban id:mybot remove user:<[user]> group:<[group]>
Groupexternal
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/commands/DiscordBanCommand.java#L27
Namediscordcommand
Related Guide Pagehttps://guide.denizenscript.com/guides/expanding/ddiscordbot.html
Syntaxdiscordcommand (id:<bot>) [create/delete] (group:<group>) (name:<name>) (type:{slash}/user/message) (description:<description>) (options:<options>)
Short DescriptionManages Discord application commands.
Full DescriptionManages Discord application commands.

You can create a new command, edit the permissions of an existing command, or delete an existing command.

To create (or delete) a command in a specific Discord guild, use the "group" argument. If not present, a global command will be created. NOTE: Global commands take up to an hour to register.
When creating, both a name and description are required.

Commands can be slash commands - activated via typing "/", message commands - activated by right-clicking a message, or user commands - activated by right-clicking a user.
"Description" and "options" are only valid for slash commands.

The "options" argument controls the command parameters. It is a MapTag of ordered MapTags that can sometimes hold ordered MapTags. It is recommended to use Command:definemap or a data script key when creating commands.
All option MapTags must have "type", "name", and "description" keys, with an optional "required" key (defaulting to true). The "type" key can be one of: STRING, INTEGER, BOOLEAN, USER, CHANNEL, ROLE, MENTIONABLE, NUMBER, ATTACHMENT.
Additionally, the option map can include a "choices" key, which is a MapTag of ordered MapTags that have a "name" (what displays to the user) and a "value" (what gets passed to the client).
Instead of choices, the option map can also include an "autocomplete" key controlling whether dynamic suggestions can be provided to the client (defaulting to false). See Event:on discord command autocomplete.

Editing application command permissions has been moved to the "Integrations" section in the server settings.
Read more about it here: 🔗https://discord.com/blog/slash-commands-permissions-discord-apps-bots

You DO NOT need to create a command on startup every time! Once a command is created, it will persist until you delete it.
Using the "create" instruction on an existing command will update it.

Commands and replies to interactions have limitations. See 🔗https://gist.github.com/MinnDevelopment/b883b078fdb69d0e568249cc8bf37fe9.

See also Discord's internal API documentation for commands: 🔗https://discord.com/developers/docs/interactions/application-commands

Generally used alongside Command:discordinteraction

The command should usually be ~waited for. See Language:~waitable.
Related Tags<entry[saveName].command> returns the DiscordCommandTag of a command upon creation, when the command is ~waited for.
Usage Example
#Use to create a simple slash command without options and save it.
- ~discordcommand create group:<discord[mybot].group[Denizen]> name:hello "description:Hello world!" save:mycmd
- debug log <entry[mycmd].command.name>
Usage Example
#Use to create a global slash command with one option, using definemap.
- definemap options:
    1:
      type: string
      name: animal
      description: Your favorite animal
      required: true
- ~discordcommand id:mybot create name:animal "description:Pick your favorite!" options:<[options]>
Groupexternal
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/commands/DiscordCommandCommand.java#L40
Namediscordcreatechannel
Syntaxdiscordcreatechannel (id:<bot>) [group:<group>] [name:<name>] (description:<description>) (type:<type>) (category:<category_id>) (position:<#>) (roles:<list>) (users:<list>)
Short DescriptionCreates text channels on Discord.
Full DescriptionCreates text channels on Discord.

This functionality requires the Manage Channels permission.

You can optionally specify the channel description (aka "topic") with the "description" argument.

You can optionally specify the channel type. Valid types are TEXT, NEWS, CATEGORY, and VOICE.
Only text and news channels can have a description.
Categories cannot have a parent category.

You can optionally specify the channel's parent category with the "category" argument.
By default, the channel will not be attached to any category.

You can optionally specify the channel's position in the list as an integer with the "position" argument.

You can optionally specify the roles or users that are able to view the channel.
The "roles" argument takes a list of DiscordRoleTags, and the "users" argument takes a list of DiscordUserTags.
Specifying either of these arguments will create a private channel (hidden for anyone not in the lists).

The command can be ~waited for. See Language:~waitable.
Related Tags<entry[saveName].channel> returns the DiscordChannelTag of a channel upon creation when the command is ~waited for.
Usage Example
#Use to create a channel in a category.
- discordcreatechannel id:mybot group:1234 name:my-channel category:5678
Usage Example
#Use to create a voice channel and log its name upon creation.
- ~discordcreatechannel id:mybot group:1234 name:very-important-channel type:voice save:stuff
- debug log "Created channel '<entry[stuff].channel.name>'"
Groupexternal
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/commands/DiscordCreateChannelCommand.java#L30
Namediscordcreatethread
Related Guide Pagehttps://guide.denizenscript.com/guides/expanding/ddiscordbot.html
Syntaxdiscordcreatethread (id:<bot>) [name:<name>] [message:<message>/parent:<channel> (private)]
Short DescriptionCreates a new Discord thread.
Full DescriptionCreates a new Discord thread.

You must specify the bot object ID, and the thread name.

You can either specify a full DiscordMessageTag instance to create a thread based on that message,
OR specify a DiscordChannelTag parent and optionally mark it private (otherwise it's public).

The command can be ~waited for. See Language:~waitable.
Related Tags<entry[saveName].created_thread> returns the newly created thread.
Usage Example
#Use to create a new thread for a specific message and send a bot message to it.
- ~discordcreatethread id:mybot "name:The bot's awesome thread" message:<context.message> save:thread
- discordmessage id:mybot channel:<entry[thread].created_thread> "Here I made this thread just for you"
Usage Example
#Use to create a new thread in a channel and link to it in some channel.
- ~discordcreatethread id:mybot "name:The bot's awesome thread" parent:<[some_channel]> save:thread
- discordmessage id:mybot channel:<[some_channel]> "I created thread <&lt>#<entry[thread].created_thread.id><&gt>!"
Groupexternal
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/commands/DiscordCreateThreadCommand.java#L30
Namediscordinteraction
Related Guide Pagehttps://guide.denizenscript.com/guides/expanding/ddiscordbot.html
Syntaxdiscordinteraction [defer/reply/delete] [interaction:<interaction>] (ephemeral) (rows:<rows>) (<message>) (embed:<embed>|...) (attach_files:<map>)
Short DescriptionManages Discord interactions.
Full DescriptionManages Discord interactions.

You can defer, reply to, edit, or delete an interaction. These instructions all require the "interaction" argument.

The "ephemeral" argument can be used to have the reply message be visible to that one user.

You can defer an interaction before replying, which is useful if your reply may take more than a few seconds to be selected.
If you defer, the 'ephemeral' option can only be set by the defer - you cannot change it with the later reply.
Replying to an interaction uses similar logic to normal messaging. See Command:discordmessage.
If you deferred without using 'ephemeral', the 'delete' option will delete the "Thinking..." message.
Ephemeral replies cannot have files.

Slash commands, and replies to interactions, have limitations. See 🔗https://gist.github.com/MinnDevelopment/b883b078fdb69d0e568249cc8bf37fe9.

Generally used alongside Command:discordcommand

The command can be ~waited for. See Language:~waitable.
Related Tags<entry[saveName].command> returns the DiscordCommandTag of a slash command upon creation, when the command is ~waited for.
Usage Example
#Use to quickly reply to a slash command interaction.
- discordinteraction reply interaction:<context.interaction> "hello!"
Usage Example
#Use to defer and reply to a slash command interaction.
- ~discordinteraction defer interaction:<context.interaction>
- discordinteraction reply interaction:<context.interaction> <context.options.get[hello].if_null[world]>
Usage Example
#Use to defer and reply to an interaction ephemerally.
- ~discordinteraction defer interaction:<context.interaction> ephemeral:true
- discordinteraction reply interaction:<context.interaction> "Shh, don't tell anyone!"
Groupexternal
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/commands/DiscordInteractionCommand.java#L31
Namediscordmessage
Related Guide Pagehttps://guide.denizenscript.com/guides/expanding/ddiscordbot.html
Syntaxdiscordmessage (id:<id>) [reply:<message>/edit:<message>/channel:<channel>/user:<user>] (<message>) (no_mention) (rows:<rows>) (embed:<embed>|...) (attach_files:<map>) (post_title:<name>)
Short DescriptionSends a message to a Discord channel.
Full DescriptionSends a message to a Discord channel.

Command may fail if the bot does not have permission within the Discord group to send a message in that channel.

You can send the message to: a channel, user, or in reply to a previous message.
If sending as a reply, optionally use "no_mention" to disable the default reply pinging the original user.

Channels can be specified as either a copied ID, or using any tag that returns a valid DiscordChannelTag.
To get IDs, enable "Developer Mode" in your Discord settings, then right click on the channel and press "Copy ID".

You can edit an existing message by using "edit:<message>".

You can use "attach_file_name:<name>" and "attach_file_text:<text>" to attach a text file with longer content than a normal message allows.
Alternatively, you can use "attach_files:<map>" to attach files as a MapTag of the name of the file to the text or a BinaryTag.

To send embeds, use "embed:<embed>|...".

You can use "rows" to attach action rows of components, such as buttons to the message, using ObjectType:DiscordButtonTag, and ObjectType:DiscordSelectionTag.

You can send a message into a Forum Channel with "post_title" specified to create a post in that forum.

The command can be ~waited for. See Language:~waitable.
Related Tags<entry[saveName].message> returns the DiscordMessageTag of the sent message, when the command is ~waited for.
<discord[mybot].group[Denizen].channel[bot-spam]> is an example of a tag that will return an appropriate channel object for a named channel in a named group.
Usage Example
#Use to message a Discord channel with a copied channel ID.
- discordmessage id:mybot channel:1234 "Hello world!"
Usage Example
#Use to reply to a message from a message received event.
- discordmessage id:mybot reply:<context.message> "Hello world!"
Usage Example
#Use to message an embed to a Discord channel.
- discordmessage id:mybot channel:1234 embed:<discord_embed[title=hi;description=this is an embed!]>
Usage Example
#Use to message a Discord channel and record the new message ID.
- ~discordmessage id:mybot channel:1234 "Hello world!" save:sent
- announce "Sent as <entry[sent].message.id>"
Usage Example
#Use to send a message to a user through a private channel.
- discordmessage id:mybot user:<[user]> "Hello world!"
Usage Example
#Use to send a short and simple text-file message to a channel.
- discordmessage id:mybot channel:<[channel]> attach_files:<map[quote.xml=<&lt>mcmonkey<&gt> haha text files amirite<n>gotta abuse em]>
Usage Example
#Use to send a message and attach a button to it.
- define my_button <discord_button.with_map[style=primary;id=my_button;label=Hello]>
- discordmessage id:mybot channel:<[channel]> rows:<[my_button]> "Hello world!"
Usage Example
#Use to send a message to a Discord channel, then edit it after 5 seconds.
- ~discordmessage id:mybot channel:<[channel]> "Hello world!" save:msg
- wait 5s
- discordmessage id:mybot edit:<entry[msg].message> "Goodbye!"
Usage Example
#Use to send multiple embeds in a single message
- ~discordmessage id:mybot channel:<[channel]> embed:<discord_embed[title=embed 1]>|<discord_embed[title=embed 2]>
Usage Example
#Use to send files in a single message, including an image file, using a MapTag.
- ~fileread path:my_information.yml save:info
- ~fileread path:my_image.png save:image
- definemap files:
    text.txt: Wow! Denizen is so cool!
    info.yml: <entry[info].data>
    my_image.png: <entry[image].data>
- ~discordmessage id:mybot channel:<[channel]> attach_files:<[files]>
Groupexternal
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/commands/DiscordMessageCommand.java#L43
Namediscordmodal
Related Guide Pagehttps://guide.denizenscript.com/guides/expanding/ddiscordbot.html
Syntaxdiscordmodal [interaction:<interaction>] [name:<name>] [rows:<rows>] (title:<title>)
Short DescriptionManages Discord modals.
Full DescriptionWith this command you can respond to an interaction using a modal.
A "modal" is a popup window that presents the user with a form to fill out.

You can specify the modal's internal name for matching with in events.
You can specify the title as text to display to the user.
You can specify rows of user-inputs using ObjectType:DiscordTextInputTag. At time of writing, Selection input is not supported.

You can listen to the responses to forms using Event:discord modal submitted.

You cannot defer an interaction before using a modal. It must be sent immediately.

Note that the interaction can be any button or application command, but cannot be a modal submission - you cannot reply to a modal submit with a second modal.

The command can be ~waited for. See Language:~waitable.
Related TagsNone
Usage Example
#Use to create a modal that only requests one single direct text input.
- definemap rows:
     1:
         1: <discord_text_input.with[id].as[textinput].with[label].as[Type here!].with[style].as[short]>
- discordmodal interaction:<context.interaction> name:example_modal title:Modal! rows:<[rows]>
Groupexternal
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/commands/DiscordModalCommand.java#L34
Namediscordreact
Related Guide Pagehttps://guide.denizenscript.com/guides/expanding/ddiscordbot.html
Syntaxdiscordreact (id:<bot>) (channel:<channel>) [message:<message>] [add/remove/clear] [reaction:<reaction>/all] (user:<user>)
Short DescriptionManages message reactions on Discord.
Full DescriptionManages message reactions on Discord.

The message can be a ObjectType:DiscordMessageTag, or just the message ID, with a channel ID also given.

You can add or remove reactions from the bot, or clear all reactions of a specific ID, or clear all reactions from a message entirely.

Reactions can be unicode symbols, or custom emoji IDs.

Optionally specify a user for 'remove' to remove only a specific user's reaction.

'Add' requires basic add-reaction permissions.
'Clear' requires 'manage messages' permission.

For custom emoji, the ID is the numeric ID. For default emoji, the ID is the unicode symbol of the emoji.
In both cases, you can copy the correct value by typing the emoji into Discord and prefixing it with a "\" symbol, like "\:myemoji:" and sending it - the sent message will show the internal form of the emoji.

The command can be ~waited for. See Language:~waitable.
Related Tags<DiscordMessageTag.reactions> Returns a list of reaction on this message.
Usage Example
#Use to react to a previously sent message.
- discordreact id:mybot message:<[some_message]> add reaction:<[my_emoji_id]>
Usage Example
#Use to remove a reaction from a previously sent message.
- discordreact id:mybot message:<[some_message]> remove reaction:<[some_reaction_emoji]>
Usage Example
#Use to clear all reactions from a message.
- discordreact id:mybot message:<[some_message]> clear reaction:all
Groupexternal
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/commands/DiscordReactCommand.java#L33
Namediscordtimeout
Related Guide Pagehttps://guide.denizenscript.com/guides/expanding/ddiscordbot.html
Syntaxdiscordtimeout (id:<bot>) ({add}/remove) [user:<user>] [group:<group>] (reason:<reason>) (duration:<duration>/{60s})
Short DescriptionPuts a user in timeout.
Full DescriptionPuts a user in timeout.

To put a user in timeout, use the "add" argument. To remove the timeout, use the "remove" argument.
The group is required for both "add" and "remove" arguments, but "reason" can only be used with "add".
Reasons show up in the group's Audit Logs.

The timeout duration defaults to 60 seconds. The duration cannot be greater than 28 days.
This argument can only be used when putting a user in timeout using the "add" argument, although it is not required.

The command can be ~waited for. See Language:~waitable.
Related Tags<DiscordUserTag.is_timed_out[<group>]> returns if the user is timed out in a certain group.
Usage Example
#Put a user in timeout.
- discordtimeout id:my_bot add user:<[user]> group:<[group]>
Usage Example
#Put a user in timeout for a duration of 3 hours with a reason.
- discordtimeout id:my_bot add user:<[user]> group:<[group]> "reason:Was being troublesome!" duration:3h
Usage Example
#Remove a user from timeout.
- discordtimeout id:my_bot remove user:<[user]> group:<[group]>
Groupexternal
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/commands/DiscordTimeoutCommand.java#L31

Event


Namediscord application|slash|message|user command
Event Lines discord application|slash|message|user command
Triggerswhen a Discord user uses an application command.
Generated Exampleson discord message command:
on discord application command:
Switchesfor:<bot> to only process the event for a specified Discord bot.
channel:<channel_id> to only process the event when it occurs in a specified Discord channel.
group:<group_id> to only process the event for a specified Discord group.
name:<command_name> to only process the event for a specified Discord application command. Spaces are replaced with underscores.
Contexts<context.bot> returns the relevant DiscordBotTag.
<context.channel> returns the DiscordChannelTag.
<context.group> returns the DiscordGroupTag.
<context.interaction> returns the DiscordInteractionTag.
<context.command> returns the DiscordCommandTag.
<context.options> returns the supplied options as a MapTag.
GroupDiscord
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/events/DiscordApplicationCommandScriptEvent.java#L8
Namediscord button clicked
Event Lines discord button clicked
Triggerswhen a Discord user clicks a button.
Generated Examplesafter discord button clicked:
Switchesfor:<bot> to only process the event for a specified Discord bot.
channel:<channel_id> to only process the event when it occurs in a specified Discord channel.
group:<group_id> to only process the event for a specified Discord group.
id:<button_id> to only process the event for a specified Discord button.
Contexts<context.bot> returns the relevant DiscordBotTag.
<context.channel> returns the DiscordChannelTag.
<context.group> returns the DiscordGroupTag.
<context.interaction> returns the DiscordInteractionTag.
<context.button> returns the DiscordButtonTag.
<context.message> returns the relevant message the button was on.
GroupDiscord
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/events/DiscordButtonClickedScriptEvent.java#L10
Namediscord channel created
Event Lines discord channel created
Triggerswhen a Discord channel is created.
Generated Examplesafter discord channel created:
Switchesfor:<bot> to only process the event for a specified Discord bot.
group:<group_id> to only process the event for a specified Discord group.
type:<type> to only process the event if the channel is a specific channel_type.
Contexts<context.bot> returns the relevant DiscordBotTag.
<context.group> returns the DiscordGroupTag.
<context.channel> returns the new DiscordChannelTag.
GroupDiscord
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/events/DiscordChannelCreateScriptEvent.java#L11
Namediscord channel deleted
Event Lines discord channel deleted
Triggerswhen a Discord channel is created.
Generated Examplesafter discord channel deleted:
on discord channel deleted:
Switchesfor:<bot> to only process the event for a specified Discord bot.
group:<group_id> to only process the event for a specified Discord group.
Contexts<context.bot> returns the relevant DiscordBotTag.
<context.group> returns the DiscordGroupTag.
<context.channel> returns the DiscordChannelTag.
GroupDiscord
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/events/DiscordChannelDeleteScriptEvent.java#L11
Namediscord command autocomplete
Event Lines discord command autocomplete
Triggerswhen a Discord user queries a slash command option that can be autocompleted.
Example
# Suggests fruits that are only longer in length than the current input.
on discord command autocomplete name:eat option:fruit:
- define length <context.options.get[fruit].length>
- define fruits <list[lime|apple|orange|blueberry|dragonfruit]>
- determine choices:<[fruits].filter_tag[<[filter_value].length.is_more_than[<[length]>]>]>
Example
# Suggests the 25 best-matching selections from some dataset against the current input.
on discord command autocomplete:
- define value <context.options.get[<context.focused_option>]>
- determine choices:<server.flag[dataset].sort_by_number[difference[<[value]>]].first[25].if_null[<list>]>
Switchesfor:<bot> to only process the event for a specified Discord bot.
channel:<channel_id> to only process the event when it occurs in a specified Discord channel.
group:<group_id> to only process the event for a specified Discord group.
name:<command_name> to only process the event for a specified Discord application command. Spaces are replaced with underscores.
option:<option_name> to only process the event for a specified autocompletable option.
Contexts<context.bot> returns the relevant DiscordBotTag.
<context.channel> returns the DiscordChannelTag.
<context.group> returns the DiscordGroupTag.
<context.interaction> returns the DiscordInteractionTag.
<context.command> returns the DiscordCommandTag.
<context.options> returns the supplied options as a MapTag.
<context.focused_option> returns the name of the focused option.
Determine"CHOICES:<ListTag>" to suggest values to the Discord client. Up to 25 suggestions are allowed to be sent. Each entry can be an ElementTag which controls both the value and display of the choice or a MapTag with "name" and "value" keys to control both separately.
GroupDiscord
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/events/DiscordCommandAutocompleteScriptEvent.java#L18
Namediscord message deleted
Event Lines discord message deleted
Triggerswhen a Discord user deletes a message.
Generated Examplesafter discord message deleted:
Switchesfor:<bot> to only process the event for a specified Discord bot.
channel:<channel_id> to only process the event when it occurs in a specified Discord channel.
group:<group_id> to only process the event for a specified Discord group.
Contexts<context.bot> returns the relevant DiscordBotTag.
<context.channel> returns the DiscordChannelTag.
<context.group> returns the DiscordGroupTag.
<context.old_message_valid> returns whether the old message is available (it may be lost due to caching).
<context.old_message> returns the original DiscordMessageTag (data may be missing if not cached).
GroupDiscord
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/events/DiscordMessageDeletedScriptEvent.java#L18
Namediscord message modified
Event Lines discord message modified
Triggerswhen a Discord user modified a message.
Generated Exampleson discord message modified:
after discord message modified:
Switchesfor:<bot> to only process the event for a specified Discord bot.
channel:<channel_id> to only process the event when it occurs in a specified Discord channel.
group:<group_id> to only process the event for a specified Discord group.
Contexts<context.bot> returns the relevant DiscordBotTag.
<context.channel> returns the DiscordChannelTag.
<context.group> returns the DiscordGroupTag.
<context.new_message> returns the message as it now exists, as a DiscordMessageTag.
<context.old_message_valid> returns whether the old message is available (it may be lost due to caching).
<context.old_message> returns the original DiscordMessageTag (data may be missing if not cached).
GroupDiscord
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/events/DiscordMessageModifiedScriptEvent.java#L20
Namediscord message reaction added
Event Lines discord message reaction added
Triggerswhen a Discord user added a reaction to a message.
Generated Examplesafter discord message reaction added:
on discord message reaction added:
Switchesfor:<bot> to only process the event for a specified Discord bot.
channel:<channel_id> to only process the event when it occurs in a specified Discord channel.
group:<group_id> to only process the event for a specified Discord group.
Contexts<context.bot> returns the relevant DiscordBotTag.
<context.channel> returns the DiscordChannelTag.
<context.group> returns the DiscordGroupTag.
<context.message> returns the message.
<context.user> returns the user that added the reaction.
<context.reaction> returns the new reaction.
GroupDiscord
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/events/DiscordMessageReactionAddScriptEvent.java#L10
Namediscord message reaction removed
Event Lines discord message reaction removed
Triggerswhen a Discord user removes a reaction from a message.
Generated Examplesafter discord message reaction removed:
on discord message reaction removed:
Switchesfor:<bot> to only process the event for a specified Discord bot.
channel:<channel_id> to only process the event when it occurs in a specified Discord channel.
group:<group_id> to only process the event for a specified Discord group.
Contexts<context.bot> returns the relevant DiscordBotTag.
<context.channel> returns the DiscordChannelTag.
<context.group> returns the DiscordGroupTag.
<context.message> returns the DiscordMessageTag.
<context.user> returns the DiscordUserTag that removed the reaction.
<context.reaction> returns the old DiscordReactionTag.
GroupDiscord
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/events/DiscordMessageReactionRemoveScriptEvent.java#L10
Namediscord message received
Event Lines discord message received
Triggerswhen a Discord bot receives a message.
Generated Examplesafter discord message received:
Switchesfor:<bot> to only process the event for a specified Discord bot.
channel:<channel_id> to only process the event when it occurs in a specified Discord channel.
group:<group_id> to only process the event for a specified Discord group.
message:<message> to only process the event if the message matches some matcher text, like 'message:*hello*' to match any message that contains the word 'hello'.
Contexts<context.bot> returns the relevant DiscordBotTag.
<context.channel> returns the DiscordChannelTag.
<context.group> returns the DiscordGroupTag.
<context.new_message> returns the message received, as a DiscordMessageTag.
GroupDiscord
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/events/DiscordMessageReceivedScriptEvent.java#L19
Namediscord modal submitted
Event Lines discord modal submitted
Triggerswhen a Discord user submits a modal.
Generated Exampleson discord modal submitted:
after discord modal submitted:
Switchesfor:<bot> to only process the event for a specified Discord bot.
channel:<channel_id> to only process the event when it occurs in a specified Discord channel.
group:<group_id> to only process the event for a specified Discord group.
name:<modal_name> to only process the event for a specified Discord modal.
Contexts<context.bot> returns the relevant DiscordBotTag.
<context.channel> returns the DiscordChannelTag.
<context.group> returns the DiscordGroupTag.
<context.interaction> returns the DiscordInteractionTag.
<context.name> returns the name of the modal.
<context.values> returns a MapTag of the values submitted by the user.
GroupDiscord
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/events/DiscordModalSubmittedScriptEvent.java#L18
Namediscord selection used
Event Lines discord selection used
Triggerswhen a Discord user uses a selection menu.
Generated Examplesafter discord selection used:
Switchesfor:<bot> to only process the event for a specified Discord bot.
channel:<channel_id> to only process the event when it occurs in a specified Discord channel.
group:<group_id> to only process the event for a specified Discord group.
id:<menu_id> to only process the event for a specified Discord selection menu.
Contexts<context.bot> returns the relevant DiscordBotTag.
<context.channel> returns the DiscordChannelTag.
<context.group> returns the DiscordGroupTag.
<context.interaction> returns the DiscordInteractionTag.
<context.menu> returns the selection menu as a DiscordSelectionTag.
<context.option> returns the selected option as a MapTag.
<context.message> returns the relevant message the selection was on.
GroupDiscord
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/events/DiscordSelectionUsedScriptEvent.java#L11
Namediscord thread archived
Event Lines discord thread archived
Triggerswhen a Discord thread is archived.
Generated Examplesafter discord thread archived:
on discord thread archived:
Switchesfor:<bot> to only process the event for a specified Discord bot.
group:<group_id> to only process the event for a specified Discord group.
parent:<channel_id> to only process the event for a specific parent channel ID.
Contexts<context.bot> returns the relevant DiscordBotTag.
<context.group> returns the DiscordGroupTag.
<context.thread> returns the thread DiscordChannelTag.
GroupDiscord
RequiresdDiscordBot
Warning(s)Not currently function. Will likely function in the future.
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/events/DiscordThreadArchivedScriptEvent.java#L11
Namediscord thread revealed
Event Lines discord thread revealed
Triggerswhen a Discord thread is pulled out of archive.
Generated Examplesafter discord thread revealed:
on discord thread revealed:
Switchesfor:<bot> to only process the event for a specified Discord bot.
group:<group_id> to only process the event for a specified Discord group.
parent:<channel_id> to only process the event for a specific parent channel ID.
Contexts<context.bot> returns the relevant DiscordBotTag.
<context.group> returns the DiscordGroupTag.
<context.thread> returns the thread DiscordChannelTag.
GroupDiscord
RequiresdDiscordBot
Warning(s)Not currently function. Will likely function in the future.
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/events/DiscordThreadRevealedScriptEvent.java#L11
Namediscord user joins
Event Lines discord user joins
Triggerswhen a Discord user joins a guild.
Generated Examplesafter discord user joins:
on discord user joins:
Switchesfor:<bot> to only process the event for a specified Discord bot.
group:<group_id> to only process the event for a specified Discord group.
Contexts<context.bot> returns the relevant DiscordBotTag.
<context.group> returns the DiscordGroupTag.
<context.user> returns the DiscordUserTag.
GroupDiscord
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/events/DiscordUserJoinsScriptEvent.java#L11
Namediscord user leaves
Event Lines discord user leaves
Triggerswhen a Discord user leaves a guild.
Generated Exampleson discord user leaves:
after discord user leaves:
Switchesfor:<bot> to only process the event for a specified Discord bot.
group:<group_id> to only process the event for a specified Discord group.
Contexts<context.bot> returns the relevant DiscordBotTag.
<context.group> returns the DiscordGroupTag.
<context.user> returns the DiscordUserTag.
GroupDiscord
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/events/DiscordUserLeavesScriptEvent.java#L11
Namediscord user nickname changes
Event Lines discord user nickname changes
Triggerswhen a Discord user's nickname change.
Generated Examplesafter discord user nickname changes:
Switchesfor:<bot> to only process the event for a specified Discord bot.
group:<group_id> to only process the event for a specified Discord group.
Contexts<context.bot> returns the relevant DiscordBotTag.
<context.group> returns the DiscordGroupTag.
<context.user> returns the DiscordUserTag.
<context.old_name> returns the user's previous nickname (if any).
<context.new_name> returns the user's new nickname (if any).
GroupDiscord
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/events/DiscordUserNicknameChangeScriptEvent.java#L12
Namediscord user role changes
Event Lines discord user role changes
Triggerswhen a Discord user's roles change.
Generated Exampleson discord user role changes:
Switchesfor:<bot> to only process the event for a specified Discord bot.
group:<group_id> to only process the event for a specified Discord group.
Contexts<context.bot> returns the relevant DiscordBotTag.
<context.group> returns the DiscordGroupTag.
<context.user> returns the DiscordUserTag.
<context.old_roles> returns a ListTag of the user's previous DiscordRoleTag set.
<context.new_roles> returns a ListTag of the user's new DiscordRoleTag set.
<context.added_roles> returns a ListTag of the user's added DiscordRoleTag set.
<context.removed_roles> returns a ListTag of the user's removed DiscordRoleTag set.
GroupDiscord
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/events/DiscordUserRoleChangeScriptEvent.java#L18

Mechanism


Nameadd_thread_member
ObjectDiscordChannelTag
InputDiscordUserTag
DescriptionAdds the specified user to this thread.
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L444
Namedelete
ObjectDiscordChannelTag
InputNone
DescriptionDeletes this channel.
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L514
Nameis_thread_archived
ObjectDiscordChannelTag
InputElementTag(Boolean)
Related Tags<DiscordChannelTag.is_thread_archived> Returns true if the thread is archived, or false if it is still open. (...)
DescriptionChanges whether this thread is archived.
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L478
Nameis_thread_locked
ObjectDiscordChannelTag
InputElementTag(Boolean)
Related Tags<DiscordChannelTag.is_thread_locked> Returns true if the thread is locked (cannot be pulled from archive). (...)
DescriptionChanges whether this thread is locked (can't be pulled from archive by non-moderators).
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L496
Namename
ObjectDiscordChannelTag
InputElementTag
Related Tags<DiscordChannelTag.name> Returns the name of the channel.
DescriptionRenames this channel.
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L525
Nameremove_thread_member
ObjectDiscordChannelTag
InputDiscordUserTag
DescriptionRemoves the specified user from this thread.
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L461
Nametopic
ObjectDiscordChannelTag
InputElementTag
Related Tags<DiscordChannelTag.topic> Returns the topic for this channel.
DescriptionChanges the topic for this channel. The topic can only be 1024 characters or fewer.
Does not work for thread or forum channels. Provide no input to reset the topic.
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L538
Namecrosspost
ObjectDiscordMessageTag
InputNone
DescriptionCrossposts the message, ie publishes a message in an announcement channel.
Synonyms (Search Aid)discordmessagetag.publish
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L457
Namedelete
ObjectDiscordMessageTag
InputNone
DescriptionDeletes the message.
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L440
Namecolor
ObjectDiscordRoleTag
InputColorTag
Related Tags<DiscordRoleTag.color> Returns the display color of the role, if any.
DescriptionAdjusts the specified role's color to the given ObjectType:ColorTag.
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L258
Namementionable
ObjectDiscordRoleTag
InputElementTag(Boolean)
DescriptionAdjusts whether the specified role is mentionable by anyone (if not, can only be mentioned by users with mention-everyone permission).
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L271
Namemove
ObjectDiscordUserTag
InputDiscordChannelTag
DescriptionIf this user is connected to a voice channel, moves them to the specified voice channel.
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L503

ObjectType


NameDiscordInteractionTag
Prefixdiscordinteraction@
Base TypeElementTag
ImplementsFlaggableObject
Identity FormatThe identity format for Discord interactions is the bot ID, followed by the interaction ID.
For example: mybot,5678
DescriptionA DiscordInteractionTag is an object that represents an interaction on Discord, either as a generic reference, or as a bot-specific reference.
Interactions are temporary - they only exist for 15 minutes.

This object type is flaggable.
Flags on this object type will be stored in temporary memory.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordInteractionTag.java#L28

Tag


Name<discord_button[(<button>)]>
ReturnsDiscordButtonTag
DescriptionReturns a blank DiscordButtonTag instance, to be filled with data via the with.as tag.
Or, if given an input, returns a Discord Button object constructed from the input value.
Refer to ObjectType:DiscordButtonTag.
Generated Example
- narrate <discord_button>
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L132
Name<discord_channel[<channel>]>
ReturnsDiscordChannelTag
DescriptionReturns a Discord Channel object constructed from the input value.
Refer to ObjectType:DiscordChannelTag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L148
Name<discord_command[<command>]>
ReturnsDiscordCommandTag
DescriptionReturns a Discord Command object constructed from the input value.
Refer to ObjectType:DiscordCommandTag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L164
Name<discord_embed[(<embed>)]>
ReturnsDiscordEmbedTag
DescriptionReturns a blank DiscordEmbedTag instance, to be filled with data via the with.as tag.
Or, if given an input, returns a Discord Embed object constructed from the input value.
Refer to ObjectType:DiscordEmbedTag.
Generated Example
- narrate <discord_embed>
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L180
Name<discord_group[<group>]>
ReturnsDiscordGroupTag
DescriptionReturns a Discord Group object constructed from the input value.
Refer to ObjectType:DiscordGroupTag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L196
Name<discord_interaction[<interaction>]>
ReturnsDiscordInteractionTag
DescriptionReturns a Discord Interaction object constructed from the input value.
Refer to ObjectType:DiscordInteractionTag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L212
Name<discord_message[<message>]>
ReturnsDiscordMessageTag
DescriptionReturns a Discord Message object constructed from the input value.
Refer to ObjectType:DiscordMessageTag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L228
Name<discord_reaction[<reaction>]>
ReturnsDiscordReactionTag
DescriptionReturns a Discord Reaction object constructed from the input value.
Refer to ObjectType:DiscordReactionTag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L244
Name<discord_role[<role>]>
ReturnsDiscordRoleTag
DescriptionReturns a Discord Role object constructed from the input value.
Refer to ObjectType:DiscordRoleTag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L260
Name<discord_selection[(<menu>)]>
ReturnsDiscordSelectionTag
DescriptionReturns a blank DiscordSelectionTag instance, to be filled with data via the with.as tag.
Or, if given an input, returns a Discord Selection object constructed from the input value.
Refer to ObjectType:DiscordSelectionTag.
Generated Example
- narrate <discord_selection>
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L276
Name<discord_text_input[(<button>)]>
ReturnsDiscordTextInputTag
DescriptionReturns a blank DiscordTextInputTag instance, to be filled with data via the with.as tag.
Or, if given an input, returns a Discord TextInput object constructed from the input value.
Refer to ObjectType:DiscordTextInputTag.
Generated Example
- narrate <discord_text_input>
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L292
Name<discord_user[<user>]>
ReturnsDiscordUserTag
DescriptionReturns a Discord User object constructed from the input value.
Refer to ObjectType:DiscordUserTag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L308
Name<discord[<bot-id>]>
ReturnsDiscordBotTag
DescriptionReturns the Discord bot for the given bot ID.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L117
Name<DiscordBotTag.command[<name>]>
ReturnsDiscordCommandTag
DescriptionReturns the application command that best matches the input name, or null if there's no match.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordBotTag.java#L194
Name<DiscordBotTag.commands>
ReturnsListTag(DiscordCommandTag)
DescriptionReturns a list of all application commands.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordBotTag.java#L141
Name<DiscordBotTag.group[<name>]>
ReturnsDiscordGroupTag
DescriptionReturns the Discord group (aka 'guild' or 'server') that best matches the input name, or null if there's no match.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordBotTag.java#L160
Name<DiscordBotTag.groups>
ReturnsListTag(DiscordGroupTag)
DescriptionReturns a list of all groups (aka 'guilds' or 'servers') that this Discord bot has access to.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordBotTag.java#L122
Name<DiscordBotTag.name>
ReturnsElementTag
DescriptionReturns the name of the bot.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordBotTag.java#L94
Name<DiscordBotTag.self_user>
ReturnsDiscordUserTag
DescriptionReturns the bot's own Discord user object.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordBotTag.java#L106
Name<DiscordButtonTag.map>
ReturnsMapTag
DescriptionReturns the MapTag internally backing this button tag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordButtonTag.java#L169
Name<DiscordButtonTag.with_map[<map>]>
ReturnsDiscordButtonTag
DescriptionReturns a copy of this Button tag, with the map of keys to values applied.
Refer to Tag:DiscordButtonTag.with.as.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordButtonTag.java#L101
Name<DiscordButtonTag.with[<key>].as[<value>]>
ReturnsDiscordButtonTag
DescriptionReturns a copy of this Button tag, with the specified data key set to the specified value.
The following keys are accepted, with values of the listed type:
style: ElementTag of either primary, secondary, success, danger, or link
id: ElementTag, can be a URL
label: ElementTag
disabled: ElementTag(Boolean)
emoji: ElementTag
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordButtonTag.java#L132
Name<DiscordChannelTag.active_threads>
ReturnsListTag(DiscordChannelTag)
DescriptionReturns the list of all current (non-archived) thread channels inside this text channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L282
Name<DiscordChannelTag.archived_threads>
ReturnsListTag(DiscordChannelTag)
DescriptionReturns the list of all archived thread channels inside this text channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L304
Name<DiscordChannelTag.channel_type>
ReturnsElementTag
DescriptionReturns the type of the channel.
Will be any of: TEXT, PRIVATE, VOICE, GROUP, CATEGORY, NEWS, STAGE, GUILD_NEWS_THREAD, GUILD_PUBLIC_THREAD, GUILD_PRIVATE_THREAD, FORUM, or UNKNOWN.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L155
Name<DiscordChannelTag.connected_users>
ReturnsListTag(DiscordUserTag)
DescriptionIf the channel is a voice channel, returns the users connected to it.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L411
Name<DiscordChannelTag.first_message>
ReturnsDiscordMessageTag
DescriptionReturns the first message sent in the channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L375
Name<DiscordChannelTag.group>
ReturnsDiscordGroupTag
DescriptionReturns the group that owns this channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L337
Name<DiscordChannelTag.id>
ReturnsElementTag(Number)
DescriptionReturns the ID number of the channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L167
Name<DiscordChannelTag.is_thread_archived>
ReturnsElementTag(Boolean)
MechanismDiscordChannelTag.is_thread_archived
DescriptionReturns true if the thread is archived, or false if it is still open.
Only applicable to thread-channels.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L226
Name<DiscordChannelTag.is_thread_locked>
ReturnsElementTag(Boolean)
MechanismDiscordChannelTag.is_thread_locked
DescriptionReturns true if the thread is locked (cannot be pulled from archive).
Only applicable to thread-channels.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L244
Name<DiscordChannelTag.is_thread>
ReturnsElementTag(Boolean)
DescriptionReturns true if the channel is a thread, or false if it is some other type of channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L215
Name<DiscordChannelTag.last_message>
ReturnsDiscordMessageTag
DescriptionReturns the last message sent in the channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L391
Name<DiscordChannelTag.mention>
ReturnsElementTag
DescriptionReturns the raw mention string for the channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L326
Name<DiscordChannelTag.name>
ReturnsElementTag
MechanismDiscordChannelTag.name
DescriptionReturns the name of the channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L143
Name<DiscordChannelTag.parent>
ReturnsDiscordChannelTag
DescriptionReturns the parent channel of this thread channel (if this channel is a thread).
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L178
Name<DiscordChannelTag.pinned_messages>
ReturnsListTag(DiscordMessageTag)
DescriptionReturns a list of the messages that are pinned in the channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L356
Name<DiscordChannelTag.thread_members>
ReturnsListTag(DiscordUserTag)
DescriptionReturns the list of users joined into this thread channel (if this channel is a thread).
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L195
Name<DiscordChannelTag.threads>
ReturnsListTag(DiscordChannelTag)
DescriptionReturns the list of all (archived or not) thread channels inside this text channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L262
Name<DiscordChannelTag.topic>
ReturnsElementTag
MechanismDiscordChannelTag.topic
DescriptionReturns the topic for this channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L432
Name<DiscordCommandTag.description>
ReturnsElementTag
DescriptionReturns the description of the command.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordCommandTag.java#L199
Name<DiscordCommandTag.id>
ReturnsElementTag(Number)
DescriptionReturns the ID of the command.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordCommandTag.java#L177
Name<DiscordCommandTag.name>
ReturnsElementTag
DescriptionReturns the name of the command.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordCommandTag.java#L188
Name<DiscordCommandTag.options>
ReturnsListTag(MapTag)
DescriptionReturns the option MapTags of the command. This is the same value as the one provided when creating a command, as documented in Command:DiscordCommand.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordCommandTag.java#L210
Name<DiscordEmbedTag.add_field[<title>].value[<value>]>
ReturnsDiscordEmbedTag
DescriptionReturns a copy of this Embed tag, with a field added with the given title and value.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L310
Name<DiscordEmbedTag.add_inline_field[<title>].value[<value>]>
ReturnsDiscordEmbedTag
DescriptionReturns a copy of this Embed tag, with an inline field added with the given title and value.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L341
Name<DiscordEmbedTag.map>
ReturnsMapTag
DescriptionReturns the MapTag internally backing this embed tag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L299
Name<DiscordEmbedTag.output_length>
ReturnsElementTag(Number)
DescriptionReturns the total number of displayed characters this embed contains.
Discord rejects embeds with a total character count above 6000.
There are other limits for embed objects, refer to 🔗https://discordjs.guide/popular-topics/embeds.html#embed-limits
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L373
Name<DiscordEmbedTag.to_json>
ReturnsElementTag
DescriptionReturns the raw Discord-API-compatible JSON text of this embed.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L387
Name<DiscordEmbedTag.with_map[<map>]>
ReturnsDiscordEmbedTag
DescriptionReturns a copy of this Embed tag, with the map of keys to values applied.
Refer to Tag:DiscordEmbedTag.with.as.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L210
Name<DiscordEmbedTag.with[<key>].as[<value>]>
ReturnsDiscordEmbedTag
DescriptionReturns a copy of this Embed tag, with the specified data key set to the specified value.
The following keys are accepted, with values of the listed type:
author_name: ElementTag
author_url: ElementTag of a URL (requires author_name set)
author_icon_url: ElementTag of a URL (requires author_name set)
color: ColorTag
description: ElementTag
footer: ElementTag
footer_icon: ElementTag of a URL (requires footer set)
image: ElementTag of a URL
thumbnail: ElementTag of a URL
timestamp: TimeTag
title: ElementTag
title_url: ElementTag of a URL (requires title set)
fields: generally don't use directly, but can be set to a list of maps wherein each sub-map has keys "title", "value", and "inline" (boolean)
For fields, instead prefer Tag:DiscordEmbedTag.add_field.value and Tag:DiscordEmbedTag.add_inline_field.value.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L247
Name<DiscordGroupTag.banned_members>
ReturnsListTag(DiscordUserTag)
DescriptionReturns a list of all banned users in the group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L192
Name<DiscordGroupTag.channel[<name>]>
ReturnsDiscordChannelTag
DescriptionReturns the channel that best matches the input name, or null if there's no match.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L269
Name<DiscordGroupTag.channels>
ReturnsListTag(DiscordChannelTag)
DescriptionReturns a list of all channels in the group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L162
Name<DiscordGroupTag.command[<name>]>
ReturnsDiscordCommandTag
DescriptionReturns the guild command that best matches the input name, or null if there's no match.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L327
Name<DiscordGroupTag.commands>
ReturnsListTag(DiscordCommandTag)
DescriptionReturns a list of all commands in the group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L222
Name<DiscordGroupTag.emoji_id[<name>]>
ReturnsElementTag
DescriptionReturns the ID of the emoji that best matches the input name, or null if there's no match.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L371
Name<DiscordGroupTag.emoji_names>
ReturnsListTag
DescriptionReturns a list of emoji names in the group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L356
Name<DiscordGroupTag.id>
ReturnsElementTag(Number)
DescriptionReturns the ID number of the group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L151
Name<DiscordGroupTag.member[<name>]>
ReturnsDiscordUserTag
DescriptionReturns the group member that best matches the input name, or null if there's no match.
For input of username#id, will always only match for the exact user.
For input of only the username, return value might be unexpected if multiple members have the same username
(this happens more often than you might expect - many users accidentally join new Discord groups from the
web on a temporary web account, then rejoin on a local client with their 'real' account).
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L237
Name<DiscordGroupTag.members>
ReturnsListTag(DiscordUserTag)
DescriptionReturns a list of all users in the group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L177
Name<DiscordGroupTag.name>
ReturnsElementTag
DescriptionReturns the name of the group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L140
Name<DiscordGroupTag.role[<name>]>
ReturnsDiscordRoleTag
DescriptionReturns the role that best matches the input name, or null if there's no match.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L298
Name<DiscordGroupTag.roles>
ReturnsListTag(DiscordRoleTag)
DescriptionReturns a list of all roles in the group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L207
Name<DiscordGroupTag.users_with_roles[<role>|...]>
ReturnsListTag(DiscordUserTag)
DescriptionReturns a list of all users in the group who have all the specified roles.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L400
Name<DiscordInteractionTag.channel>
ReturnsDiscordChannelTag
DescriptionReturns the channel that the interaction was created in.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordInteractionTag.java#L168
Name<DiscordInteractionTag.id>
ReturnsElementTag(Number)
DescriptionReturns the ID of the interaction.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordInteractionTag.java#L157
Name<DiscordInteractionTag.is_direct>
ReturnsElementTag(Boolean)
DescriptionReturns true if the interaction was sent in a direct (private) channel, or false if in a public channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordInteractionTag.java#L179
Name<DiscordInteractionTag.target_message>
ReturnsDiscordMessageTag
DescriptionReturns the message being targeted by a MESSAGE application interaction.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordInteractionTag.java#L216
Name<DiscordInteractionTag.target_user>
ReturnsDiscordUserTag
DescriptionReturns the user being targeted by a USER application interaction.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordInteractionTag.java#L202
Name<DiscordInteractionTag.user>
ReturnsDiscordUserTag
DescriptionReturns the user of the interaction.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordInteractionTag.java#L191
Name<DiscordMessageTag.attachments>
ReturnsListTag
DescriptionReturns a list of attachment URLs for this message. Most messages will return an empty list, or a single-entry list,
however it is possible in some cases for a single message to have multiple attachments.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L424
Name<DiscordMessageTag.author>
ReturnsDiscordUserTag
DescriptionReturns the author of the message.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L283
Name<DiscordMessageTag.channel>
ReturnsDiscordChannelTag
DescriptionReturns the channel that the message was sent to.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L228
Name<DiscordMessageTag.embed>
ReturnsListTag(DiscordEmbedTag)
DescriptionReturns a list of "embed" formatted data on this message.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L342
Name<DiscordMessageTag.id>
ReturnsElementTag(Number)
DescriptionReturns the ID of the message.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L203
Name<DiscordMessageTag.is_direct>
ReturnsElementTag(Boolean)
DescriptionReturns true if the message was sent in a direct (private) channel, or false if in a public channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L331
Name<DiscordMessageTag.is_pinned>
ReturnsElementTag(Boolean)
DescriptionReturns whether this message is pinned.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L305
Name<DiscordMessageTag.mentioned_users>
ReturnsListTag(DiscordUserTag)
DescriptionReturns a list of users mentioned (pinged) by this message.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L316
Name<DiscordMessageTag.next_messages[<#>]>
ReturnsListTag(DiscordMessageTag)
DescriptionReturns a list of the next (specified number) messages sent in the channel after this message.
The list is ordered from most recent to least recent.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L390
Name<DiscordMessageTag.previous_messages[<#>]>
ReturnsListTag(DiscordMessageTag)
DescriptionReturns a list of the last (specified number) messages sent in the channel prior to this message.
The list is ordered from most recent to least recent.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L372
Name<DiscordMessageTag.reactions>
ReturnsListTag
DescriptionReturns a list of reaction on this message.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L357
Name<DiscordMessageTag.replied_to>
ReturnsDiscordMessageTag
DescriptionReturns the message that this message was in reply to (if any).
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L408
Name<DiscordMessageTag.text_display>
ReturnsElementTag
DescriptionReturns the display text of the message (special codes like pings formatted to how they should look for users).
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L261
Name<DiscordMessageTag.text_no_mentions>
ReturnsElementTag
DescriptionReturns the text of the message, with '@' mentions removed.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L272
Name<DiscordMessageTag.text_stripped>
ReturnsElementTag
DescriptionReturns the stripped text of the message (format codes like bold removed).
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L250
Name<DiscordMessageTag.text>
ReturnsElementTag
DescriptionReturns the full text of the message.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L239
Name<DiscordMessageTag.url>
ReturnsElementTag
DescriptionReturns the full jump URL to this message.
This returns link text that looks something like "https://discord.com/channels/315163488085475337/315163488085475337/980909305589026906"
Where the URL is Discord's webserver, followed by Group ID, Channel ID, then Message ID.
DM messages follow a slightly different but very similar format.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L214
Name<DiscordMessageTag.was_edited>
ReturnsElementTag(Boolean)
DescriptionReturns whether this message was edited.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L294
Name<DiscordReactionTag.count>
ReturnsElementTag(Number)
DescriptionReturns the amount of times this reaction exists on the message.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordReactionTag.java#L228
Name<DiscordReactionTag.id>
ReturnsElementTag
DescriptionReturns the ID of the reaction emote.
For custom emoji, this is a numeric ID. For default emoji, this is the unicode symbol.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordReactionTag.java#L200
Name<DiscordReactionTag.is_animated>
ReturnsElementTag
DescriptionReturns whether the emote reacted is animated (an "animoji").
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordReactionTag.java#L253
Name<DiscordReactionTag.message>
ReturnsDiscordMessageTag
DescriptionReturns the message this reaction is attached to.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordReactionTag.java#L212
Name<DiscordReactionTag.name>
ReturnsElementTag
DescriptionReturns the name of the emoji.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordReactionTag.java#L242
Name<DiscordReactionTag.reactors>
ReturnsListTag(DiscordUserTag)
DescriptionReturns the list of users that added this reaction to the message.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordReactionTag.java#L264
Name<DiscordRoleTag.color>
ReturnsColorTag
MechanismDiscordRoleTag.color
DescriptionReturns the display color of the role, if any.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L212
Name<DiscordRoleTag.group>
ReturnsDiscordGroupTag
DescriptionReturns the group that owns this role.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L201
Name<DiscordRoleTag.id>
ReturnsElementTag(Number)
DescriptionReturns the ID number of the role.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L179
Name<DiscordRoleTag.mention>
ReturnsElementTag
DescriptionReturns the raw mention string of the role.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L190
Name<DiscordRoleTag.name>
ReturnsElementTag
DescriptionReturns the name of the role.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L168
Name<DiscordRoleTag.permissions>
ReturnsListTag
DescriptionReturns a list of permissions that the role provides for users. You can get a list of possible outputs here: 🔗https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/Permission.html
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L243
Name<DiscordRoleTag.users>
ReturnsListTag(DiscordUserTag)
DescriptionReturns a list of all users with this role.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L228
Name<DiscordSelectionTag.map>
ReturnsMapTag
DescriptionReturns the MapTag internally backing this selection tag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordSelectionTag.java#L222
Name<DiscordSelectionTag.with_map[<map>]>
ReturnsDiscordSelectionTag
DescriptionReturns a copy of this Selection tag, with the map of keys to values applied.
Refer to Tag:DiscordSelectionTag.with.as.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordSelectionTag.java#L152
Name<DiscordSelectionTag.with[<key>].as[<value>]>
ReturnsDiscordSelectionTag
DescriptionReturns a copy of this Selection tag, with the specified data key set to the specified value.
The following keys are accepted, with values of the listed type:
id: ElementTag
placeholder: ElementTag
options: MapTag where the values are also a MapTag consisting of:
- label: ElementTag
- value: ElementTag
- description: ElementTag
- emoji: ElementTag
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordSelectionTag.java#L183
Name<DiscordTextInputTag.map>
ReturnsMapTag
DescriptionReturns the MapTag internally backing this text input tag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordTextInputTag.java#L193
Name<DiscordTextInputTag.with_map[<map>]>
ReturnsDiscordTextInputTag
DescriptionReturns a copy of this TextInput tag, with the map of keys to values applied.
Refer to Tag:DiscordTextInputTag.with.as.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordTextInputTag.java#L122
Name<DiscordTextInputTag.with[<key>].as[<value>]>
ReturnsDiscordTextInputTag
DescriptionReturns a copy of this TextInput tag, with the specified data key set to the specified value.
The following keys are accepted, with values of the listed type:
style: short or paragraph
id: ElementTag
label: ElementTag
min_length: ElementTag(Number)
max_length: ElementTag(Number)
is_required: ElementTag(Boolean)
value: ElementTag
placeholder: ElementTag
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordTextInputTag.java#L153
Name<DiscordUserTag.activity_name[<group>]>
ReturnsElementTag
DescriptionReturns the name of the activity of the user, as seen from the given group.
Not present for all users.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L361
Name<DiscordUserTag.activity_type[<group>]>
ReturnsElementTag
DescriptionReturns the activity type of the user, as seen from the given group.
Can be any of: DEFAULT, STREAMING, LISTENING, WATCHING, CUSTOM_STATUS, COMPETING.
Not present for all users.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L334
Name<DiscordUserTag.activity_url[<group>]>
ReturnsElementTag
DescriptionReturns the stream URL of the activity of the user, as seen from the given group.
Not present for all users.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L387
Name<DiscordUserTag.avatar_url>
ReturnsElementTag
DescriptionReturns the URL to the user's avatar.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L243
Name<DiscordUserTag.discriminator>
ReturnsElementTag
DescriptionReturns the discriminator ID of the user.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L215
Name<DiscordUserTag.id>
ReturnsElementTag(Number)
DescriptionReturns the ID number of the user.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L289
Name<DiscordUserTag.is_banned[<group>]>
ReturnsElementTag(boolean)
DescriptionReturns whether the user is banned from a certain group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L464
Name<DiscordUserTag.is_bot>
ReturnsElementTag(Boolean)
DescriptionReturns a boolean indicating whether the user is a bot.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L229
Name<DiscordUserTag.is_in_group[<group>]>
ReturnsElementTag(Boolean)
DescriptionReturns true if the user exists and is recognized, or false if it can't be seen.
If this returns false, some usages of the object may still be valid.
It may return false due to caching issues or because the user doesn't share a guild with the bot.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L197
Name<DiscordUserTag.is_timed_out[<group>]>
ReturnsElementTag(boolean)
DescriptionReturns whether the user is timed out in a certain group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L486
Name<DiscordUserTag.is_valid>
ReturnsElementTag(Boolean)
DescriptionReturns true if the user exists and is recognized, or false if it can't be seen.
If this returns false, some usages of the object may still be valid.
It may return false due to caching issues or because the user doesn't share a guild with the bot.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L184
Name<DiscordUserTag.mention>
ReturnsElementTag
DescriptionReturns the raw mention string for the user.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L301
Name<DiscordUserTag.name>
ReturnsElementTag
DescriptionReturns the base username of the user.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L170
Name<DiscordUserTag.nickname[<group>]>
ReturnsElementTag
DescriptionReturns the group-specific nickname of the user (if any).
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L257
Name<DiscordUserTag.permissions[<group>]>
ReturnsListTag
DescriptionReturns a list of permissions that the user has in a certain group. You can get a list of possible outputs here: 🔗https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/Permission.html
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L439
Name<DiscordUserTag.roles[<group>]>
ReturnsListTag(DiscordRoleTag)
DescriptionReturns a list of all roles the user has in the given group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L416
Name<DiscordUserTag.status[<group>]>
ReturnsElementTag
DescriptionReturns the status of the user, as seen from the given group.
Can be any of: online, dnd, idle, invisible, offline.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L312
Name<ElementTag.discord_id_to_time>
ReturnsTimeTag
DescriptionReturns the TimeTag converted from the given discord ID.
Discord IDs internally are just timestamps in a Discord-specific numeric format.
Example
# Find out when a message was sent.
- narrate "You wrote <[message].text> at <[message].id.discord_id_to_time.format>"
Groupextensions
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/properties/DiscordElementTagExtensions.java#L11
Name<TimeTag.format_discord[(<style>)]>
ReturnsElementTag
DescriptionReturns the time formatted for display on Discord, optionally using the specified style from 🔗https://discord.com/developers/docs/reference#message-formatting-timestamp-styles.
For example: <util.time_now.format_discord> or <util.time_now.format_discord[R]>
Note that style input, if used, is case sensitive.
Generated Example
- narrate <util.time_now.format_discord>
Groupextensions
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/properties/DiscordTimeTagExtensions.java#L10