Denizen Script Tags


Tags are always written with a <between these marks>, and are critical to scripts, as the primary way to read data.
Learn about how tags work in The Beginner's Guide.


Showing 134 out of 2441 tags...

Categories:

FlaggableObject | Base | DiscordBotTag | DiscordButtonTag | DiscordChannelTag | DiscordCommandTag | DiscordEmbedTag | DiscordGroupTag | DiscordInteractionTag | DiscordMessageTag | DiscordReactionTag | DiscordRoleTag | DiscordSelectionTag | DiscordTextInputTag | DiscordUserTag | ElementTag | TimeTag



Category: FlaggableObject


Name<FlaggableObject.flag[<flag_name>]>
ReturnsObjectTag
DescriptionReturns the specified flag from the flaggable object.
If the flag is expired, will return null.
Consider also using Tag:FlaggableObject.has_flag.
See Language:flag system.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L37

Name<FlaggableObject.flag_expiration[<flag_name>]>
ReturnsTimeTag
DescriptionReturns a TimeTag indicating when the specified flag will expire.
See Language:flag system.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L71

Name<FlaggableObject.flag_map[<name>|...]>
ReturnsMapTag
DescriptionReturns a raw map of the objects internal flag data for the flags with the given flag name. Names must be root names (no '.').
Output is a MapTag wherein each key is a flag name, and each value is a MapTag, containing keys '__value' and '__expiration', where '__value' contains the real object value.
Output also may contain key '__clear', which is a ListTag of flags that were listed in input but weren't present in output.
Using this without a parameter to get ALL flags is allowed exclusively for debug/testing reasons, and should never be used in a real script.
See Language:flag system.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L104

Name<FlaggableObject.has_flag[<flag_name>]>
ReturnsElementTag(Boolean)
DescriptionReturns true if the flaggable object has the specified flag, otherwise returns false.
See Language:flag system.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L55

Name<FlaggableObject.list_flags>
ReturnsListTag
DescriptionReturns a list of the flaggable object's flags.
Note that this is exclusively for debug/testing reasons, and should never be used in a real script.
See Language:flag system.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L87



Category: Base


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<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

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



Category: DiscordBotTag


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



Category: DiscordButtonTag


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



Category: DiscordChannelTag


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>
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.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.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



Category: DiscordCommandTag


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



Category: DiscordEmbedTag


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



Category: DiscordGroupTag


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



Category: DiscordInteractionTag


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



Category: DiscordMessageTag


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#L425

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#L343

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#L332

Name<DiscordMessageTag.is_pinned>
ReturnsElementTag(Boolean)
MechanismDiscordMessageTag.is_pinned
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#L317

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#L391

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#L373

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#L358

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#L409

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.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.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



Category: DiscordReactionTag


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



Category: DiscordRoleTag


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



Category: DiscordSelectionTag


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



Category: DiscordTextInputTag


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



Category: DiscordUserTag


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.display_name>
ReturnsElementTag
DescriptionReturns the global display name of the user, if any.
To obtain a server-specific display name, use Tag:DiscordUserTag.nickname.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L416

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#L480

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#L502

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#L455

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#L432

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



Category: ElementTag


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



Category: TimeTag


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