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 all 2255 tags...

Categories:

Base | AreaObject | BinaryTag | BiomeTag | ChunkTag | ColorTag | CuboidTag | DurationTag | ElementTag | EllipsoidTag | EnchantmentTag | EntityTag | FlaggableObject | InventoryTag | ItemTag | JavaReflectedObjectTag | ListTag | LocationTag | MapTag | MaterialTag | NPCTag | ObjectTag | PlayerTag | PluginTag | PolygonTag | proc | QueueTag | schematic | ScriptTag | SecretTag | server | tern | TimeTag | TradeTag | util | WorldTag | yaml | PropertyHolderObject | AreaShopTag | BigDoorsDoorTag | bungee | crackshot | DiscordBotTag | DiscordButtonTag | DiscordChannelTag | DiscordCommandTag | DiscordEmbedTag | DiscordGroupTag | DiscordInteractionTag | DiscordMessageTag | DiscordReactionTag | DiscordRoleTag | DiscordSelectionTag | DiscordTextInputTag | DiscordUserTag | essentials | factions | FactionTag | griefprevention | GriefPreventionClaimTag | JobsJobTag | LibsDisguiseTag | luckperms | LuckPermsTrackTag | mobarena | MobArenaArenaTag | mythicmobs | MythicMobsMobTag | MythicSpawnerTag | NationTag | paper | PartyTag | placeholder | playerpoints | PlotSquaredPlotTag | pvparena | PVPArenaArenaTag | quests | ResidenceTag | ShopKeeperTag | SkillAPIClassTag | skyblock | TownTag | towny | WorldGuardRegionTag


Category: Base


Name<&[<color>]>
ReturnsElementTag
DescriptionReturns a custom color value based on the common base color names defined in the Denizen config file.
If the color name is unrecognized, returns the value of color named 'default'.
Default color names are 'base', 'emphasis', 'warning', 'error'.
Generated Example
- narrate <&[red]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/CustomColorTagBase.java#L39

Name<&0>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Black.
Generated Example
- narrate <&0>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L541

Name<&1>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Dark Blue.
Generated Example
- narrate <&1>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L548

Name<&2>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Dark Green.
Generated Example
- narrate <&2>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L555

Name<&3>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Dark Cyan.
Generated Example
- narrate <&3>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L562

Name<&4>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Dark Red.
Generated Example
- narrate <&4>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L569

Name<&5>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Dark Magenta.
Generated Example
- narrate <&5>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L576

Name<&6>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Gold.
Generated Example
- narrate <&6>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L583

Name<&7>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Light Gray.
Generated Example
- narrate <&7>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L590

Name<&8>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Dark Gray.
Generated Example
- narrate <&8>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L597

Name<&9>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Light Blue.
Generated Example
- narrate <&9>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L604

Name<&a>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Light Green.
Generated Example
- narrate <&a>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L611

Name<&at>
ReturnsElementTag
DescriptionReturns a at symbol: @
Generated Example
- narrate <&at>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L89

Name<&b>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Cyan.
Generated Example
- narrate <&b>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L618

Name<&bs>
ReturnsElementTag
DescriptionReturns a backslash symbol: \
Generated Example
- narrate <&bs>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L218

Name<&c>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Light Red.
Generated Example
- narrate <&c>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L625

Name<&chr[<character>]>
ReturnsElementTag
DescriptionReturns the Unicode character specified. e.g. <&chr[2665]> returns a heart.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L226

Name<&click[<click_command>]>
ReturnsElementTag
DescriptionReturns a special chat code that makes the following text execute the input command line value when clicked.
To execute a command "/" should be used at the start. Otherwise, it will display as chat.
This tag must be followed by an <&end_click> tag.
For example: - narrate "You can <&click[wow]>click here<&end_click> to say wow!"
For example: - narrate "You can <&click[/help]>click here<&end_click> for help!"
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L284

Name<&click[<click_command>].type[<type>]>
ReturnsElementTag
DescriptionReturns a special chat code that makes the following text execute the input command when clicked.
This tag must be followed by an <&end_click> tag.
Available command types: OPEN_URL, OPEN_FILE, RUN_COMMAND, SUGGEST_COMMAND, COPY_TO_CLIPBOARD, or CHANGE_PAGE.
For example: - narrate "You can <&click[https://denizenscript.com].type[OPEN_URL]>click here<&end_click> to learn about Denizen!"
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L301

Name<&co>
ReturnsElementTag
DescriptionReturns a colon symbol: :
Generated Example
- narrate <&co>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L154

Name<&color[<color>]>
ReturnsElementTag
DescriptionReturns a chat code that makes the following text be the specified color.
Color can be a color name, color code, hex, or ColorTag... that is: "&color[gold]", "&color[6]", and "&color[#AABB00]" are all valid.
The ColorTag input option can be used for dynamic color effects, such as automatic rainbows.
Generated Example
- narrate <&color[blue]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L460

Name<&d>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Magenta.
Generated Example
- narrate <&d>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L632

Name<&dq>
ReturnsElementTag
DescriptionReturns a double-quote symbol: "
Generated Example
- narrate <&dq>
Synonyms (Search Aid)&quote
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L145

Name<&e>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Yellow.
Generated Example
- narrate <&e>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L639

Name<&end_click>
ReturnsElementTag
DescriptionReturns a special chat code that ends a '&click' tag.
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Generated Example
- narrate <&end_click>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L336

Name<&end_hover>
ReturnsElementTag
DescriptionReturns a special chat code that ends a '&hover' tag.
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Generated Example
- narrate <&end_hover>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L347

Name<&end_insertion>
ReturnsElementTag
DescriptionReturns a special chat code that ends an '&insertion' tag.
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Generated Example
- narrate <&end_insertion>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L358

Name<&f>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters White.
Generated Example
- narrate <&f>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L646

Name<&font[<font>]>
ReturnsElementTag
DescriptionReturns a chat code that makes the following text display with the specified font.
The default font is "minecraft:default".
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L526

Name<&gradient[from=<color>;to=<color>;(style={RGB}/HSB)]>
ReturnsElementTag
DescriptionReturns a chat code that makes the following text be the specified color.
Input works equivalently to Tag:ElementTag.color_gradient, return to that tag for more documentation detail and input examples.
The gradient runs from whatever text is after this gradient, until the next color tag (0-9, a-f, 'r' reset, or an RGB code. Does not get stop at formatting codes, they will be included in the gradient).
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Example
- narrate "<&gradient[from=black;to=white]>these are the shades of gray <white>that solidifies to pure white"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L501

Name<&gt>
ReturnsElementTag
DescriptionReturns a greater than symbol: >
Generated Example
- narrate <&gt>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L210

Name<&hover[<hover_text>]>
ReturnsElementTag
DescriptionReturns a special chat code that makes the following text display the input hover text when the mouse is left over it.
This tag must be followed by an <&end_hover> tag.
For example: - narrate "There is a <&hover[you found it!]>secret<&end_hover> in this message!"
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L250

Name<&hover[<hover_text>].type[<type>]>
ReturnsElementTag
DescriptionReturns a special chat code that makes the following text display the input hover text when the mouse is left over it.
This tag must be followed by an <&end_hover> tag.
Available hover types: SHOW_TEXT, SHOW_ACHIEVEMENT, SHOW_ITEM, or SHOW_ENTITY.
For example: - narrate "There is a <&hover[you found it!].type[SHOW_TEXT]>secret<&end_hover> in this message!"
Note: for "SHOW_ITEM", replace the text with a valid ItemTag. For "SHOW_ENTITY", replace the text with a valid spawned EntityTag (requires F3+H to see entities).
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L265

Name<&insertion[<message>]>
ReturnsElementTag
DescriptionReturns a special chat code that makes the following text insert the input message to chat when shift-clicked.
This tag must be followed by an <&end_insertion> tag.
For example: - narrate "You can <&insertion[wow]>click here<&end_insertion> to add 'wow' to your chat!"
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L319

Name<&k>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters obfuscated.
Generated Example
- narrate <&k>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L653

Name<&keybind[<key>]>
ReturnsElementTag
DescriptionReturns a special chat code that displays a keybind.
For example: - narrate "Press your <&keybind[key.jump]> key!"
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L369

Name<&l>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters bold.
Generated Example
- narrate <&l>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L660

Name<&lb>
ReturnsElementTag
DescriptionReturns a left-bracket symbol: [
Generated Example
- narrate <&lb>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L170

Name<&lc>
ReturnsElementTag
DescriptionReturns a left-brace symbol: {
Generated Example
- narrate <&lc>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L186

Name<&lt>
ReturnsElementTag
DescriptionReturns a less than symbol: <
Generated Example
- narrate <&lt>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L202

Name<&m>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters have a strike-through.
Generated Example
- narrate <&m>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L667

Name<&n>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters have an underline.
Generated Example
- narrate <&n>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L674

Name<&nbsp>
ReturnsElementTag
DescriptionReturns a non-breaking space symbol.
Generated Example
- narrate <&nbsp>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L137

Name<&nl>
ReturnsElementTag
DescriptionReturns a newline symbol.
Generated Example
- narrate <&nl>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L105

Name<&ns>
ReturnsElementTag
DescriptionReturns a number sign / hash / pound symbol: #
Generated Example
- narrate <&ns>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L194

Name<&o>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters italicized.
Generated Example
- narrate <&o>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L681

Name<&pc>
ReturnsElementTag
DescriptionReturns a percent symbol: %
Generated Example
- narrate <&pc>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L97

Name<&r>
ReturnsElementTag
DescriptionReturns the ChatColor that resets the following characters to normal.
Generated Example
- narrate <&r>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L688

Name<&rb>
ReturnsElementTag
DescriptionReturns a right-bracket symbol: ]
Generated Example
- narrate <&rb>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L162

Name<&rc>
ReturnsElementTag
DescriptionReturns a right-brace symbol: }
Generated Example
- narrate <&rc>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L178

Name<&score[<name>|<objective>(|<value>)]>
ReturnsElementTag
DescriptionReturns a special chat code that displays a scoreboard entry. Input is an escaped list of:
Name of the relevant entity, name of the objective, then optionally a value (if unspecified, will use current scoreboard value).
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Generated Example
- narrate <&score>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L437

Name<&selector[<key>]>
ReturnsElementTag
DescriptionReturns a special chat code that displays a vanilla selector.
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L385

Name<&sp>
ReturnsElementTag
DescriptionReturns a space symbol.
Generated Example
- narrate <&sp>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L129

Name<&sq>
ReturnsElementTag
DescriptionReturns a single-quote symbol: '
Generated Example
- narrate <&sq>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L121

Name<&ss>
ReturnsElementTag
DescriptionReturns an internal coloring symbol: ยง
Generated Example
- narrate <&ss>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L113

Name<&translate[<key>]>
ReturnsElementTag
DescriptionReturns a special chat code that displays an autotranslated message.
For example: - narrate "Reward: <&translate[item.minecraft.diamond_sword]>"
Be warned that language keys change between Minecraft versions.
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L400

Name<&translate[<key>].with[<text>|...]>
ReturnsElementTag
DescriptionReturns a special chat code that displays an autotranslated message.
Optionally, specify a list of escaped text values representing input data for the translatable message.
Be aware that missing 'with' values will cause exceptions in your console.
For example: - narrate "<&translate[commands.give.success.single].with[32|<&translate[item.minecraft.diamond_sword].escaped>|<player.name.escaped>]>"
Be warned that language keys change between Minecraft versions.
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L415

Name<aqua>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Cyan.
Generated Example
- narrate <aqua>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L772

Name<binary[<binary>]>
ReturnsBinaryTag
DescriptionReturns a BinaryTag constructed from the input binary data in hexadecimal format.
Refer to ObjectTypeBinaryTag.
Generated Example
- filewrite path:data/mypath.dat data:<binary[48454c4c4f20574f524c44]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L72

Name<biome[<biome>]>
ReturnsBiomeTag
DescriptionReturns a biome object constructed from the input value.
Refer to ObjectTypeBiomeTag.
Generated Example
- adjust <player.location.to_ellipsoid[60,3,10].blocks> biome:<biome[desert]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L122

Name<black>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Black.
Generated Example
- narrate <black>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L695

Name<blue>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Light Blue.
Generated Example
- narrate <blue>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L758

Name<bold>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters bold.
Generated Example
- narrate <bold>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L814

Name<chunk[<chunk>]>
ReturnsChunkTag
DescriptionReturns a chunk object constructed from the input value.
Refer to ObjectTypeChunkTag.
Generated Example
- adjust <chunk[<player.location.chunk>]> set_all_biomes:desert
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L131

Name<color[<color>]>
ReturnsColorTag
DescriptionReturns a color object constructed from the input value.
Refer to ObjectTypeColorTag.
Generated Example
- narrate "<&color[<color[green]>]>hello there!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L140

Name<cuboid[<cuboid>]>
ReturnsCuboidTag
DescriptionReturns a cuboid object constructed from the input value.
Refer to ObjectTypeCuboidTag.
Generated Example
- note <cuboid[my_cuboid_note]> as:my_new_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L150

Name<custom_object[<custom-object>]>
ReturnsCustomObjectTag
DescriptionReturns a custom object constructed from the input value.
Refer to ObjectTypeCustomObjectTag.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L81

Name<dark_aqua>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Dark Cyan.
Generated Example
- narrate <dark_aqua>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L716

Name<dark_blue>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Dark Blue.
Generated Example
- narrate <dark_blue>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L702

Name<dark_gray>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Dark Gray.
Generated Example
- narrate <dark_gray>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L751

Name<dark_green>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Dark Green.
Generated Example
- narrate <dark_green>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L709

Name<dark_purple>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Dark Magenta.
Generated Example
- narrate <dark_purple>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L730

Name<dark_red>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Dark Red.
Generated Example
- narrate <dark_red>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L723

Name<definition[<name>]>
ReturnsObjectTag
DescriptionReturns a definition from the current queue.
The object will be returned as the most-valid type based on the input.
In most usages, the tag name is left blank, like "<[defhere]>".
You can use "." in a definition name to read a submapped key if the root definition is a MapTag.
Example
- define x 3
# Narrates '3'
- narrate <[x]>
Example
- definemap mymap:
    mykey: example
# Narrates 'example'
- narrate <[mymap.mykey]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/DefinitionTagBase.java#L15

Name<duration[<duration>]>
ReturnsDurationTag
DescriptionReturns a duration object constructed from the input value.
Refer to ObjectTypeDurationTag.
Generated Example
- ratelimit <player> <duration[1m]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L90

Name<element[<element>]>
ReturnsElementTag
DescriptionReturns an element constructed from the input value.
Refer to ObjectTypeElementTag.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L100

Name<ellipsoid[<ellipsoid>]>
ReturnsEllipsoidTag
DescriptionReturns an ellipsoid object constructed from the input value.
Refer to ObjectTypeEllipsoidTag.
Generated Example
- note <ellipsoid[my_ellipsoid_note]> as:my_new_ellipsoid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L160

Name<empty>
ReturnsElementTag
DescriptionReturns an empty element.
Generated Example
- narrate <empty>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L81

Name<enchantment[<enchantment>]>
ReturnsEnchantmentTag
DescriptionReturns an enchantment object constructed from the input value.
Refer to ObjectTypeEnchantmentTag.
Generated Example
- inventory adjust slot:hand enchantments:[<enchantment[sharpness]>=5]
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L170

Name<entity[<entity>]>
ReturnsEntityTag
DescriptionReturns an entity object constructed from the input value.
Refer to ObjectTypeEntityTag.
Generated Example
- kill <entity[<npc>]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L179

Name<gold>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Gold.
Generated Example
- narrate <gold>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L737

Name<gray>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Light Gray.
Generated Example
- narrate <gray>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L744

Name<green>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Light Green.
Generated Example
- narrate <green>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L765

Name<inventory[<inventory>]>
ReturnsInventoryTag
DescriptionReturns an inventory object constructed from the input value.
Refer to ObjectTypeInventoryTag.
Generated Example
- inventory set o:<inventory[<player.inventory>]> d:stick slot:5
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L241

Name<italic>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters italicized.
Generated Example
- narrate <italic>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L835

Name<item[<item>]>
ReturnsItemTag
DescriptionReturns an item object constructed from the input value.
Refer to ObjectTypeItemTag.
Generated Example
- give <item[iron_sword]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L251

Name<light_purple>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Magenta.
Generated Example
- narrate <light_purple>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L786

Name<list[(<list>)]>
ReturnsListTag
DescriptionReturns a list object constructed from the input value.
Give no input to create an empty list.
Refer to ObjectTypeListTag.
Generated Example
- foreach <list> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/ListTagBase.java#L10

Name<list_single[<object>]>
ReturnsListTag
DescriptionReturns a ListTag object with exactly 1 entry: whatever the input value is (even if that input is a list).
This is primarily useful for creating lists-within-lists.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/ListSingleTagBase.java#L11

Name<location[<location>]>
ReturnsLocationTag
DescriptionReturns a location object constructed from the input value.
Refer to ObjectTypeLocationTag.
Generated Example
- teleport <player> <location[<npc.location>]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L261

Name<magic>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters obfuscated.
Generated Example
- narrate <magic>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L807

Name<map[(<map>)]>
ReturnsMapTag
DescriptionReturns a map object constructed from the input value.
Give no input to create an empty map.
Refer to ObjectTypeMapTag.
For example: <map[a=1;b=2;c=3]>
Generated Example
- foreach <map> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/MapTagBase.java#L10

Name<material[<material>]>
ReturnsMaterialTag
DescriptionReturns a material object constructed from the input value.
Refer to ObjectTypeMaterialTag.
Generated Example
- modifyblock <player.location.below> <material[dirt]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L271

Name<n>
ReturnsElementTag
DescriptionReturns a newline symbol.
Generated Example
- narrate <n>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L234

Name<npc[(<npc>)]>
ReturnsNPCTag
DescriptionReturns an npc object constructed from the input value.
Refer to ObjectTypeNPCTag.
If no input value is specified, returns the linked NPC.
Generated Example
- walk <npc> <player.location>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/NPCTagBase.java#L45

Name<p>
ReturnsElementTag
DescriptionReturns a paragraph, for use in books.
Generated Example
- narrate <p>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L242

Name<player[(<player>)]>
ReturnsPlayerTag
DescriptionReturns a player object constructed from the input value.
Refer to ObjectTypePlayerTag.
If no input value is specified, returns the linked player.
Generated Example
- narrate "hello there!" targets:<player>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/PlayerTagBase.java#L20

Name<plugin[<plugin>]>
ReturnsPluginTag
DescriptionReturns a plugin object constructed from the input value.
Refer to ObjectTypePluginTag.
Generated Example
- narrate <plugin[Denizen]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L344

Name<polygon[<polygon>]>
ReturnsPolygonTag
DescriptionReturns a polygon object constructed from the input value.
Refer to ObjectTypePolygonTag.
Generated Example
- note <polygon[my_polygon_note]> as:my_new_polygon
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L353

Name<proc[<procedure_script_name>]>
ReturnsObjectTag
DescriptionReturns the 'determine' result of a procedure script.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/ProcedureScriptTagBase.java#L29

Name<queue[(<queue>)]>
ReturnsQueueTag
DescriptionReturns a queue object constructed from the input value.
Refer to ObjectTypeQueueTag.
If no input is given, returns the current queue.
Generated Example
- narrate <queue>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/QueueTagBase.java#L18

Name<red>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Light Red.
Generated Example
- narrate <red>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L779

Name<reflected[<reflected-tag>]>
ReturnsJavaReflectedObjectTag
DescriptionReturns a JavaReflectedObjectTag constructed from the input reference ID lookup.
Refer to ObjectTypeJavaReflectedObjectTag.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L111

Name<reset>
ReturnsElementTag
DescriptionReturns the ChatColor that resets the following characters to normal.
Generated Example
- narrate <reset>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L842

Name<script[(<script>)]>
ReturnsScriptTag
DescriptionReturns a script object constructed from the input value.
If no input is given, will return the current script that the tag is within.
Refer to ObjectTypeScriptTag.
Generated Example
- narrate <script>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/ScriptTagBase.java#L10

Name<secret[<secret>]>
ReturnsSecretTag
DescriptionReturns a SecretTag object constructed from the input value.
Refer to ObjectTypeSecretTag.
Example
- webget <secret[my_secret_url]> "post:Message to secret address!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L154

Name<strikethrough>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters have a strike-through.
Generated Example
- narrate <strikethrough>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L821

Name<time[<time>]>
ReturnsTimeTag
DescriptionReturns a time object constructed from the input value.
Refer to ObjectTypeTimeTag.
Generated Example
- flag server myflag expire:<time[<util.time_now>]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L165

Name<trade[<trade>]>
ReturnsTradeTag
DescriptionReturns a trade object constructed from the input value.
Refer to ObjectTypeTradeTag.
Generated Example
- narrate <trade[trade[result=diamond;max_use=10;inputs=stick]]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L363

Name<underline>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters have an underline.
Generated Example
- narrate <underline>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L828

Name<white>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters White.
Generated Example
- narrate <white>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L800

Name<world[<world>]>
ReturnsWorldTag
DescriptionReturns a world object constructed from the input value.
Refer to ObjectTypeWorldTag.
Generated Example
- adjust <world[<player.location.world>]> destroy
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L373

Name<yellow>
ReturnsElementTag
DescriptionReturns the ChatColor that makes the following characters Yellow.
Generated Example
- narrate <yellow>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L793

Name<bigdoor[<door>]>
ReturnsBigDoorsDoorTag
DescriptionReturns a BigDoorsDoorTag object constructed from the input value.
Refer to ObjectTypeBigDoorsDoorTag.
RequiresDepenizen, Big Doors
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/BigDoorsBridge.java#L32

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

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

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 ObjectTypeDiscordButtonTag.
Generated Example
- narrate <discord_button>
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L130

Name<discord_channel[<channel>]>
ReturnsDiscordChannelTag
DescriptionReturns a Discord Channel object constructed from the input value.
Refer to ObjectTypeDiscordChannelTag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L146

Name<discord_command[<command>]>
ReturnsDiscordCommandTag
DescriptionReturns a Discord Command object constructed from the input value.
Refer to ObjectTypeDiscordCommandTag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L162

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 ObjectTypeDiscordEmbedTag.
Generated Example
- narrate <discord_embed>
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L178

Name<discord_group[<group>]>
ReturnsDiscordGroupTag
DescriptionReturns a Discord Group object constructed from the input value.
Refer to ObjectTypeDiscordGroupTag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L194

Name<discord_interaction[<interaction>]>
ReturnsDiscordInteractionTag
DescriptionReturns a Discord Interaction object constructed from the input value.
Refer to ObjectTypeDiscordInteractionTag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L210

Name<discord_message[<message>]>
ReturnsDiscordMessageTag
DescriptionReturns a Discord Message object constructed from the input value.
Refer to ObjectTypeDiscordMessageTag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L226

Name<discord_reaction[<reaction>]>
ReturnsDiscordReactionTag
DescriptionReturns a Discord Reaction object constructed from the input value.
Refer to ObjectTypeDiscordReactionTag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L242

Name<discord_role[<role>]>
ReturnsDiscordRoleTag
DescriptionReturns a Discord Role object constructed from the input value.
Refer to ObjectTypeDiscordRoleTag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L258

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 ObjectTypeDiscordSelectionTag.
Generated Example
- narrate <discord_selection>
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L274

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 ObjectTypeDiscordTextInputTag.
Generated Example
- narrate <discord_text_input>
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L290

Name<discord_user[<user>]>
ReturnsDiscordUserTag
DescriptionReturns a Discord User object constructed from the input value.
Refer to ObjectTypeDiscordUserTag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L306

Name<faction[<name>]>
ReturnsFactionTag
DescriptionReturns the faction for the input name.
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/FactionsBridge.java#L49

Name<jobs>
ReturnsListTag(JobsJobTag)
DescriptionReturns the list of all jobs on the server.
Generated Example
- foreach <jobs> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, Jobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/JobsBridge.java#L34

Name<jobs_job[<name>]>
ReturnsJobsJobTag
DescriptionReturns the job tag with the given name.
RequiresDepenizen, Jobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/JobsBridge.java#L53

Name<mobarena[<name>]>
ReturnsMobArenaArenaTag
DescriptionReturns the mob arena for the input name.
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/MobArenaBridge.java#L47

Name<mythic_item[<name>]>
ReturnsItemTag
DescriptionReturns an ItemTag of the named mythic item.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/MythicMobsBridge.java#L58

Name<mythicmob[<name>]>
ReturnsMythicMobsMobTag
DescriptionReturns a MythicMobsMobTag based on the name input.
Refer to ObjectTypeMythicMobsMobTag.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/MythicMobsBridge.java#L80

Name<mythicspawner[<name>]>
ReturnsMythicSpawnerTag
DescriptionReturns a MythicSpawnerTag based on the name input.
Refer to ObjectTypeMythicSpawnerTag.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/MythicMobsBridge.java#L96

Name<nation[<name>]>
ReturnsNationTag
DescriptionReturns the nation by the input name.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/TownyBridge.java#L141

Name<party[<party>]>
ReturnsPartyTag
DescriptionReturns a party object constructed from the input value.
Refer to ObjectTypePartyTag.
RequiresDepenizen, mcMMO
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/McMMOBridge.java#L48

Name<placeholder[<name>]>
ReturnsElementTag
DescriptionReturns the value of the placeholder.
For example, <placeholder[server_name]>
Note that you do not need to include the "%" marks on the placeholder.
The queue's linked player, if any, will be linked to the placeholder as well for any player-specific placeholder usage.
Note: this should generally only be used for reading values from other plugins not already supported by Depenizen.
This should not be used for cases where a Denizen tag already exists, or should exist.
RequiresDepenizen, PlaceholderAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/PlaceholderAPIBridge.java#L48

Name<pvparena[<name>]>
ReturnsPVPArenaArenaTag
DescriptionReturns the PVPArena by the input name.
RequiresDepenizen, PVPArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/PVPArenaBridge.java#L43

Name<region[<region>]>
ReturnsWorldGuardRegionTag
DescriptionReturns a WorldGuard region object constructed from the input value.
Refer to ObjectTypeWorldGuardRegionTag.
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/WorldGuardBridge.java#L46

Name<town[<name>]>
ReturnsTownTag
DescriptionReturns the town by the input name.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/TownyBridge.java#L113



Category: AreaObject


Name<AreaObject.blocks[(<matcher>)]>
ReturnsListTag(LocationTag)
DescriptionReturns each block location within the area.
Optionally, specify a material matcher to only return locations with that block type.
Generated Example
- foreach <cuboid[my_noted_cuboid].blocks> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L197

Name<AreaObject.blocks_flagged[<flag_name>]>
ReturnsListTag(LocationTag)
DescriptionGets a list of all block locations with a specified flag within the area.
Searches the internal flag lists, rather than through all possible blocks.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L242

Name<AreaObject.bounding_box>
ReturnsCuboidTag
DescriptionReturns a cuboid approximately representing the maximal bounding box of the area (anything this cuboid does not contain, is also not contained by the area, but not vice versa).
For single-member CuboidTags, this tag returns a copy of the cuboid.
Generated Example
- note <cuboid[my_noted_cuboid].bounding_box> as:my_new_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L93

Name<AreaObject.contains[<location>]>
ReturnsElementTag(Boolean)
DescriptionReturns a boolean indicating whether the specified location is inside this area.
Generated Example
- if <cuboid[my_noted_cuboid].contains[<player.location>]>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L187

Name<AreaObject.entities[(<matcher>)]>
ReturnsListTag(EntityTag)
DescriptionGets a list of all entities currently within the area, with an optional search parameter for the entity.
Generated Example
- foreach <cuboid[my_noted_cuboid].entities> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L150

Name<AreaObject.is_within[<cuboid>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this area is fully inside another cuboid.
Generated Example
- if <cuboid[my_noted_cuboid].is_within[my_cuboid_note]>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L263

Name<AreaObject.living_entities>
ReturnsListTag(EntityTag)
DescriptionGets a list of all living entities currently within the area.
This includes Players, mobs, NPCs, etc., but excludes dropped items, experience orbs, etc.
Generated Example
- foreach <cuboid[my_noted_cuboid].living_entities> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L170

Name<AreaObject.npcs>
ReturnsListTag(NPCTag)
DescriptionGets a list of all NPCs currently within the area.
Generated Example
- foreach <cuboid[my_noted_cuboid].npcs> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L131

Name<AreaObject.players>
ReturnsListTag(PlayerTag)
DescriptionGets a list of all players currently within the area.
Generated Example
- foreach <cuboid[my_noted_cuboid].players> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L115

Name<AreaObject.shell>
ReturnsListTag(LocationTag)
DescriptionReturns each block location on the 3D outer shell of the area.
This tag is useful for displaying particles or blocks to mark the boundary of the area.
Generated Example
- foreach <cuboid[my_noted_cuboid].shell> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L253

Name<AreaObject.spawnable_blocks[(<matcher>)]>
ReturnsListTag(LocationTag)
DescriptionReturns each LocationTag within the area that is safe for players or similar entities to spawn in.
Optionally, specify a material matcher to only return locations with that block type.
Uses the same spawnable check as Tag:LocationTag.is_spawnable
Generated Example
- foreach <cuboid[my_noted_cuboid].spawnable_blocks> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L219

Name<AreaObject.with_world[<world>]>
ReturnsAreaObject
DescriptionReturns a copy of the area, with the specified world.
Generated Example
- note <cuboid[my_noted_cuboid].with_world[<player.location.world>]> as:my_new_area
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L299

Name<AreaObject.world>
ReturnsWorldTag
DescriptionReturns the area's world.
Generated Example
- adjust <cuboid[my_noted_cuboid].world> full_time:0
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L105



Category: BinaryTag


Name<BinaryTag.decode_integer>
ReturnsElementTag(Number)
DescriptionReturns the integer number represented by this binary data.
Data must be 1, 2, 4, or 8 bytes long.
Uses big-endian twos-complement format.
See also Tag:ElementTag.integer_to_binary
Example
# Narrates '255'
- narrate <binary[000000ff].decode_integer>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L232

Name<BinaryTag.gzip_compress>
ReturnsBinaryTag
DescriptionReturns the binary data, compressed via gzip.
See also Tag:BinaryTag.gzip_decompress
Example
- define data <binary[48454c4c4f20574f524c44]>
- define compressed <[data].gzip_compress>
- define decompressed <[data].gzip_decompress>
- if <[decompressed].to_hex> == <[data].to_hex>:
    - narrate "Everything works!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L264

Name<BinaryTag.gzip_decompress>
ReturnsBinaryTag
DescriptionReturns the binary data, compressed via gzip.
See also Tag:BinaryTag.gzip_compress
Example
- define data <binary[48454c4c4f20574f524c44]>
- define compressed <[data].gzip_compress>
- define decompressed <[data].gzip_decompress>
- if <[decompressed].to_hex> == <[data].to_hex>:
    - narrate "Everything works!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L281

Name<BinaryTag.hash[<format>]>
ReturnsBinaryTag
DescriptionReturns the raw binary hash of the binary data, using the given hashing algorithm.
Algorithm can be "MD5", "SHA-1", "SHA-256", or any other algorithm supported by your Java runtime environment per 🔗https://docs.oracle.com/javase/8/docs/api/java/security/MessageDigest.html.
Example
# Narrates binary data "4b68507f1746b0e5f3efe99b8ef42afef79da017", the exact SHA-1 hash of ASCII "HELLO WORLD".
- narrate <binary[48454c4c4f20574f524c44].hash[SHA-1]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L298

Name<BinaryTag.length>
ReturnsElementTag(Number)
DescriptionReturns the number of bytes in this BinaryTag.
Example
# Narrates 3
- narrate <binary[010203].length>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L154

Name<BinaryTag.text_decode[<encoding>]>
ReturnsElementTag
DescriptionReturns the raw text represented by this binary data, decoding using the specified encoding method.
Input can be for example "utf-8" or "iso-8859-1".
See also Tag:ElementTag.text_encode
Example
# narrates "HELLO WORLD"
- narrate <binary[48454c4c4f20574f524c44].text_decode[us-ascii]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L211

Name<BinaryTag.to_base64>
ReturnsElementTag
DescriptionReturns a base64 encoding of the binary data.
See also Tag:ElementTag.base64_to_binary
Example
- define data <binary[48454c4c4f20574f524c44]>
- define encoded <[data].to_base64>
- define decoded <[encoded].base64_to_binary>
- if <[decoded].to_hex> == <[data].to_hex>:
    - narrate "Everything works!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L180

Name<BinaryTag.to_hex>
ReturnsElementTag
DescriptionReturns a flat hexadecimal encoding of the binary data.
Example
# Narrates 010203
- narrate <binary[010203].to_hex>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L167

Name<BinaryTag.utf8_decode>
ReturnsElementTag
DescriptionReturns the raw text represented by this binary data, decoding using the standard UTF-8 encoding.
See also Tag:ElementTag.utf8_encode
Example
# narrates "HELLO WORLD"
- narrate <binary[48454c4c4f20574f524c44].utf8_decode>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L197

Name<BinaryTag.nbt_to_map>
ReturnsMapTag
DescriptionConverts raw NBT binary data to a MapTag.
This under some circumstances might not return a map, depending on the underlying data.
Refer to Language:Raw NBT Encoding
Example
# Reads a player ".dat" file's NBT data
- ~fileread path:data/<player.uuid>.dat save:x
- define data <entry[x].data.gzip_decompress.nbt_to_map>
# Now do something with "<[data]>"
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitBinaryTagExtensions.java#L16



Category: BiomeTag


Name<BiomeTag.downfall_type>
ReturnsElementTag
MechanismBiomeTag.downfall_type
DescriptionReturns this biome's downfall type for when a world has weather.
This can be RAIN, SNOW, or NONE.
Generated Example
- narrate <biome[desert].downfall_type>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L176

Name<BiomeTag.humidity>
ReturnsElementTag(Decimal)
MechanismBiomeTag.humidity
DescriptionReturns the humidity of this biome.
Generated Example
- narrate "the decimal value is <biome[desert].humidity>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L198

Name<BiomeTag.name>
ReturnsElementTag
DescriptionReturns this biome's name.
Generated Example
- narrate <biome[desert].name>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L188

Name<BiomeTag.spawnable_entities[(<type>)]>
ReturnsListTag(EntityTag)
DescriptionReturns all entities that spawn naturally in this biome.
Optionally specify a type as: AMBIENT, CREATURES, MONSTERS, WATER, or ALL.
(By default, will be "ALL").
Generated Example
- foreach <biome[desert].spawnable_entities> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L218

Name<BiomeTag.temperature>
ReturnsElementTag(Decimal)
MechanismBiomeTag.temperature
DescriptionReturns the temperature of this biome.
Generated Example
- narrate "the decimal value is <biome[desert].temperature>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L208



Category: ChunkTag


Name<ChunkTag.add[<#>,<#>]>
ReturnsChunkTag
DescriptionReturns the chunk with the specified coordinates added to it.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L287

Name<ChunkTag.average_height>
ReturnsElementTag(Decimal)
DescriptionReturns the average height of the blocks in the chunk.
Generated Example
- narrate "the decimal value is <player.location.chunk.average_height>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L564

Name<ChunkTag.blocks_flagged[<flag_name>]>
ReturnsListTag(LocationTag)
DescriptionGets a list of all block locations with a specified flag within the CuboidTag.
Searches the internal flag lists, rather than through all possible blocks.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L632

Name<ChunkTag.cuboid>
ReturnsCuboidTag
DescriptionReturns a cuboid of this chunk.
Generated Example
- note <player.location.chunk.cuboid> as:my_new_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L418

Name<ChunkTag.entities[(<entity>|...)]>
ReturnsListTag(EntityTag)
DescriptionReturns a list of entities in the chunk.
Optionally specify entity types to filter down to.
Generated Example
- foreach <player.location.chunk.entities> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L461

Name<ChunkTag.force_loaded>
ReturnsElementTag(Boolean)
MechanismChunkTag.force_loaded
DescriptionReturns whether the chunk is forced to stay loaded at all times.
Generated Example
- if <player.location.chunk.force_loaded>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L353

Name<ChunkTag.height_map>
ReturnsListTag
DescriptionReturns a list of the height of each block in the chunk.
Generated Example
- foreach <player.location.chunk.height_map> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L545

Name<ChunkTag.inhabited_time>
ReturnsDurationTag
MechanismChunkTag.inhabited_time
DescriptionReturns the total time the chunk has been inhabited for.
This is a primary deciding factor in the "local difficulty" setting.
Generated Example
- flag server myflag expire:<player.location.chunk.inhabited_time>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L666

Name<ChunkTag.is_flat[(<#>)]>
ReturnsElementTag(Boolean)
DescriptionScans the heights of the blocks to check variance between them.
If no number is supplied, is_flat will return true if all the blocks are less than 2 blocks apart in height.
Specifying a number will modify the number criteria for determining if it is flat.
Generated Example
- if <player.location.chunk.is_flat>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L583

Name<ChunkTag.is_generated>
ReturnsElementTag(Boolean)
DescriptionReturns true if the chunk has already been generated.
Generated Example
- if <player.location.chunk.is_generated>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L333

Name<ChunkTag.is_loaded>
ReturnsElementTag(Boolean)
DescriptionReturns true if the chunk is currently loaded into memory.
Generated Example
- if <player.location.chunk.is_loaded>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L343

Name<ChunkTag.living_entities>
ReturnsListTag(EntityTag)
DescriptionReturns a list of living entities in the chunk.
This includes Players, mobs, NPCs, etc., but excludes dropped items, experience orbs, etc.
Generated Example
- foreach <player.location.chunk.living_entities> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L498

Name<ChunkTag.players>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of players in the chunk.
Generated Example
- foreach <player.location.chunk.players> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L525

Name<ChunkTag.plugin_tickets>
ReturnsListTag(PluginTag)
MechanismChunkTag.clear_plugin_tickets
DescriptionReturns a list of plugins that are keeping this chunk loaded.
This is related to the Command:chunkload command.
Generated Example
- foreach <player.location.chunk.plugin_tickets> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L368

Name<ChunkTag.spawn_slimes>
ReturnsElementTag(Boolean)
DescriptionReturns whether the chunk is a specially located 'slime spawner' chunk.
Generated Example
- if <player.location.chunk.spawn_slimes>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L652

Name<ChunkTag.sub[<#>,<#>]>
ReturnsChunkTag
DescriptionReturns the chunk with the specified coordinates subtracted from it.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L310

Name<ChunkTag.surface_blocks>
ReturnsListTag(LocationTag)
DescriptionReturns a list of the highest non-air surface blocks in the chunk.
Generated Example
- foreach <player.location.chunk.surface_blocks> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L611

Name<ChunkTag.tile_entities>
ReturnsListTag(LocationTag)
DescriptionReturns a list of tile entity locations in the chunk.
Generated Example
- foreach <player.location.chunk.tile_entities> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L437

Name<ChunkTag.world>
ReturnsWorldTag
DescriptionReturns the world associated with the chunk.
Generated Example
- adjust <player.location.chunk.world> destroy
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L408

Name<ChunkTag.x>
ReturnsElementTag(Number)
DescriptionReturns the x coordinate of the chunk.
Generated Example
- narrate "the number value is <player.location.chunk.x>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L388

Name<ChunkTag.z>
ReturnsElementTag(Number)
DescriptionReturns the z coordinate of the chunk.
Generated Example
- narrate "the number value is <player.location.chunk.z>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L398



Category: ColorTag


Name<ColorTag.alpha>
ReturnsElementTag(Number)
DescriptionReturns the alpha value of this color (0 to 255).
Generated Example
- narrate "the number value is <color[red].alpha>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L336

Name<ColorTag.argb_integer>
ReturnsElementTag(Number)
DescriptionReturns the Alpha, Red, Green, and Blue values of this ColorTag as an integer number, equivalent to an integer reparse of Tag:ColorTag.hex.
Highest order bits are alpha, then red, then green, then lowest is blue.
This is a rare special case encoding usually avoided by most systems, but may be necessary for some obscure tools.
Generated Example
- narrate "the number value is <color[red].argb_integer>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L294

Name<ColorTag.blue>
ReturnsElementTag(Number)
DescriptionReturns the blue value of this color (0 to 255).
Generated Example
- narrate "the number value is <color[red].blue>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L326

Name<ColorTag.brightness>
ReturnsElementTag(Number)
DescriptionReturns the brightness value of this color (0 to 255).
Generated Example
- narrate "the number value is <color[red].brightness>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L388

Name<ColorTag.green>
ReturnsElementTag(Number)
DescriptionReturns the green value of this color (0 to 255).
Generated Example
- narrate "the number value is <color[red].green>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L316

Name<ColorTag.hex>
ReturnsElementTag
DescriptionReturns a hex code formatting of this color, like '#ff00ff'.
Generated Example
- narrate <color[red].hex>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L267

Name<ColorTag.hsv>
ReturnsElementTag
DescriptionReturns the HSV value of this color.
EG, 100,100,255
Generated Example
- narrate <color[red].hsv>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L398

Name<ColorTag.hue>
ReturnsElementTag(Number)
DescriptionReturns the hue value of this color (0 to 255).
Generated Example
- narrate "the number value is <color[red].hue>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L368

Name<ColorTag.mix[<color>]>
ReturnsColorTag
DescriptionReturns the color that results if you mix this color with another.
Generated Example
- narrate "<&color[<color[red].mix[green]>]>hello there!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L496

Name<ColorTag.name>
ReturnsElementTag
DescriptionReturns the name of this color (or red,green,blue if none).
Generated Example
- narrate <color[red].name>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L486

Name<ColorTag.red>
ReturnsElementTag(Number)
DescriptionReturns the red value of this color (0 to 255).
Generated Example
- narrate "the number value is <color[red].red>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L306

Name<ColorTag.rgb>
ReturnsElementTag
DescriptionReturns the RGB value of this color.
EG, 255,0,255
Generated Example
- narrate <color[red].rgb>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L346

Name<ColorTag.rgb_integer>
ReturnsElementTag(Number)
DescriptionReturns the Red, Green, and Blue values of this ColorTag as an integer number, equivalent to an integer reparse of Tag:ColorTag.hex.
Highest order bits are red, then green, then lowest is blue.
This is a rare special case encoding usually avoided by most systems, but may be necessary for some obscure tools.
Generated Example
- narrate "the number value is <color[red].rgb_integer>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L282

Name<ColorTag.rgba>
ReturnsElementTag
DescriptionReturns the RGBA value of this color.
EG, 255,0,255,255
Generated Example
- narrate <color[red].rgba>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L357

Name<ColorTag.saturation>
ReturnsElementTag(Number)
DescriptionReturns the saturation value of this color (0 to 255).
Generated Example
- narrate "the number value is <color[red].saturation>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L378

Name<ColorTag.to_particle_offset>
ReturnsLocationTag
DescriptionReturns the color as a particle offset, for use with Command:playeffect.
Generated Example
- teleport <player> <color[red].to_particle_offset>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L506

Name<ColorTag.with_alpha[<alpha>]>
ReturnsColorTag
DescriptionReturns a copy of this color object with a different alpha value (0 to 255).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L440

Name<ColorTag.with_blue[<blue>]>
ReturnsColorTag
DescriptionReturns a copy of this color object with a different blue value (0 to 255).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L430

Name<ColorTag.with_brightness[<brightness>]>
ReturnsColorTag
DescriptionReturns a copy of this color object with a different brightness value (0 to 255).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L474

Name<ColorTag.with_green[<green>]>
ReturnsColorTag
DescriptionReturns a copy of this color object with a different green value (0 to 255).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L420

Name<ColorTag.with_hue[<hue>]>
ReturnsColorTag
DescriptionReturns a copy of this color object with a different hue value (0 to 255).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L450

Name<ColorTag.with_red[<red>]>
ReturnsColorTag
DescriptionReturns a copy of this color object with a different red value (0 to 255).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L410

Name<ColorTag.with_saturation[<saturation>]>
ReturnsColorTag
DescriptionReturns a copy of this color object with a different saturation value (0 to 255).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L462



Category: CuboidTag


Name<CuboidTag.add_member[<cuboid>|...]>
ReturnsCuboidTag
MechanismCuboidTag.add_member
DescriptionReturns a modified copy of this cuboid, with the input cuboid(s) added at the end.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L884

Name<CuboidTag.add_member[<cuboid>|...].at[<index>]>
ReturnsCuboidTag
MechanismCuboidTag.add_member
DescriptionReturns a modified copy of this cuboid, with the input cuboid(s) added at the specified index.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L900

Name<CuboidTag.center>
ReturnsLocationTag
DescriptionReturns the location of the exact center of the cuboid.
Not valid for multi-member CuboidTags.
Generated Example
- teleport <player> <cuboid[my_noted_cuboid].center>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L963

Name<CuboidTag.chunks>
ReturnsListTag(ChunkTag)
DescriptionGets a list of all chunks entirely within the CuboidTag (ignoring the Y axis).
Generated Example
- foreach <cuboid[my_noted_cuboid].chunks> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1370

Name<CuboidTag.corners>
ReturnsListTag(LocationTag)
DescriptionReturns all 8 corners of the cuboid.
The 4 low corners, then the 4 high corners.
In order X-Z-, X+Z-, X-Z+, X+Z+
If the object is a multi-member cuboid, returns corners for all members in sequence.
Generated Example
- foreach <cuboid[my_noted_cuboid].corners> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1079

Name<CuboidTag.expand[<location>]>
ReturnsCuboidTag
DescriptionExpands the cuboid by the given amount, and returns the changed cuboid.
This will decrease the min coordinates by the given vector location, and increase the max coordinates by it.
Supplying a negative input will therefore contract the cuboid.
Note that you can also specify a single number to expand all coordinates by the same amount (equivalent to specifying a location that is that value on X, Y, and Z).
Not valid for multi-member CuboidTags.
Generated Example
- note <cuboid[my_noted_cuboid].expand[<player.location>]> as:my_new_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1248

Name<CuboidTag.expand_one_side[<location>]>
ReturnsCuboidTag
DescriptionExpands the cuboid by the given amount in just one direction, and returns the changed cuboid.
If a coordinate is positive, it will expand the high value. If it is negative, it will expand the low value.
Note that you can also specify a single number to expand all coordinates by the same amount (equivalent to specifying a location that is that value on X, Y, and Z).
Inverted by Tag:CuboidTag.shrink_one_side
Not valid for multi-member CuboidTags.
Generated Example
- note <cuboid[my_noted_cuboid].expand_one_side[<player.location>]> as:my_new_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1275

Name<CuboidTag.get[<index>]>
ReturnsCuboidTag
DescriptionReturns a cuboid representing the one component of this cuboid (for cuboids that contain multiple sub-cuboids).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L823

Name<CuboidTag.include[<location>/<cuboid>]>
ReturnsCuboidTag
DescriptionExpands the first member of the CuboidTag to contain the given location (or entire cuboid), and returns the expanded cuboid.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1122

Name<CuboidTag.include_x[<number>]>
ReturnsCuboidTag
DescriptionExpands the first member of the CuboidTag to contain the given X value, and returns the expanded cuboid.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1144

Name<CuboidTag.include_y[<number>]>
ReturnsCuboidTag
DescriptionExpands the first member of the CuboidTag to contain the given Y value, and returns the expanded cuboid.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1166

Name<CuboidTag.include_z[<number>]>
ReturnsCuboidTag
DescriptionExpands the first member of the CuboidTag to contain the given Z value, and returns the expanded cuboid.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1188

Name<CuboidTag.intersects[<cuboid>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this cuboid and another intersect.
Generated Example
- if <cuboid[my_noted_cuboid].intersects[my_cuboid_note]>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L772

Name<CuboidTag.list_members>
ReturnsListTag(CuboidTag)
DescriptionReturns a list of all sub-cuboids in this CuboidTag (for cuboids that contain multiple sub-cuboids).
Generated Example
- foreach <cuboid[my_noted_cuboid].list_members> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L808

Name<CuboidTag.max>
ReturnsLocationTag
DescriptionReturns the highest-numbered (maximum) corner location.
Not valid for multi-member CuboidTags.
Generated Example
- teleport <player> <cuboid[my_noted_cuboid].max>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1033

Name<CuboidTag.members_size>
ReturnsElementTag(Number)
DescriptionReturns the number of cuboids defined in the CuboidTag.
Generated Example
- narrate "the number value is <cuboid[my_noted_cuboid].members_size>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L737

Name<CuboidTag.min>
ReturnsLocationTag
DescriptionReturns the lowest-numbered (minimum) corner location.
Not valid for multi-member CuboidTags.
Generated Example
- teleport <player> <cuboid[my_noted_cuboid].min>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1056

Name<CuboidTag.note_name>
ReturnsElementTag
DescriptionGets the name of a noted CuboidTag. If the cuboid isn't noted, this is null.
Generated Example
- narrate <cuboid[my_noted_cuboid].note_name>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1423

Name<CuboidTag.outline>
ReturnsListTag(LocationTag)
DescriptionReturns each block location on the outline of the CuboidTag.
Generated Example
- foreach <cuboid[my_noted_cuboid].outline> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L747

Name<CuboidTag.outline_2d[<#.#>]>
ReturnsListTag(LocationTag)
DescriptionReturns a list of block locations along the 2D outline of this CuboidTag, at the specified Y level.
Generated Example
- foreach <cuboid[my_noted_cuboid].outline_2d[1.5]> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L757

Name<CuboidTag.partial_chunks>
ReturnsListTag(ChunkTag)
DescriptionGets a list of all chunks partially or entirely within the CuboidTag.
Generated Example
- foreach <cuboid[my_noted_cuboid].partial_chunks> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1403

Name<CuboidTag.random>
ReturnsLocationTag
DescriptionReturns a random block location within the cuboid.
(Note: random selection will not be fairly weighted for multi-member cuboids).
Generated Example
- teleport <player> <cuboid[my_noted_cuboid].random>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L719

Name<CuboidTag.remove_member[<#>]>
ReturnsCuboidTag
MechanismCuboidTag.remove_member
DescriptionReturns a modified copy of this cuboid, with member at the input index removed.
Generated Example
- note <cuboid[my_noted_cuboid].remove_member[2]> as:my_new_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L936

Name<CuboidTag.set[<cuboid>].at[<index>]>
ReturnsCuboidTag
MechanismCuboidTag.set_member
DescriptionReturns a modified copy of this cuboid, with the specific sub-cuboid index changed to hold the input cuboid.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L847

Name<CuboidTag.shift[<vector>]>
ReturnsCuboidTag
DescriptionReturns a copy of this cuboid, with all members shifted by the given vector LocationTag.
For example, a cuboid from 5,5,5 to 10,10,10, shifted 100,0,100, would return a cuboid from 105,5,105 to 110,10,110.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1103

Name<CuboidTag.shrink_one_side[<location>]>
ReturnsCuboidTag
DescriptionShrinks the cuboid by the given amount in just one direction, and returns the changed cuboid.
If a coordinate is positive, it will shrink the high value. If it is negative, it will shrink the low value.
Note that you can also specify a single number to expand all coordinates by the same amount (equivalent to specifying a location that is that value on X, Y, and Z).
Inverted by Tag:CuboidTag.expand_one_side
Not valid for multi-member CuboidTags.
If you shrink past the limits of the cuboid's size, the cuboid will flip and start expanding the opposite direction.
Generated Example
- note <cuboid[my_noted_cuboid].shrink_one_side[<npc.location>]> as:my_new_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1322

Name<CuboidTag.size>
ReturnsLocationTag
DescriptionReturns the size of the cuboid.
Effectively equivalent to: (max - min) + (1,1,1)
Not valid for multi-member CuboidTags.
Generated Example
- teleport <player> <cuboid[my_noted_cuboid].size>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1006

Name<CuboidTag.volume>
ReturnsElementTag(Number)
DescriptionReturns the volume of the cuboid.
Effectively equivalent to: (size.x * size.y * size.z).
Not valid for multi-member CuboidTags.
Generated Example
- narrate "the number value is <cuboid[my_noted_cuboid].volume>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L992

Name<CuboidTag.with_max[<location>]>
ReturnsCuboidTag
DescriptionChanges the cuboid to have the given maximum location, and returns the changed cuboid.
If values in the new max are lower than the existing min, the output min will contain the new max values,
and the output max will contain the old min values.
Note that this is equivalent to constructing a cuboid with the input value and the original cuboids min value.
Not valid for multi-member CuboidTags.
Generated Example
- note <cuboid[my_noted_cuboid].with_max[<npc.location>]> as:my_new_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1229

Name<CuboidTag.with_min[<location>]>
ReturnsCuboidTag
DescriptionChanges the cuboid to have the given minimum location, and returns the changed cuboid.
If values in the new min are higher than the existing max, the output max will contain the new min values,
and the output min will contain the old max values.
Note that this is equivalent to constructing a cuboid with the input value and the original cuboids max value.
Not valid for multi-member CuboidTags.
Generated Example
- note <cuboid[my_noted_cuboid].with_min[<player.location>]> as:my_new_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1210

Name<CuboidTag.has_region>
ReturnsElementTag(Boolean)
DescriptionReturns whether the cuboid contains any region.
Generated Example
- if <cuboid[my_noted_cuboid].has_region>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardCuboidProperties.java#L90

Name<CuboidTag.has_town>
ReturnsElementTag(Boolean)
DescriptionReturns whether the cuboid contains any town at all.
Generated Example
- if <cuboid[my_noted_cuboid].has_town>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyCuboidProperties.java#L64

Name<CuboidTag.list_towns>
ReturnsListTag(TownTag)
DescriptionReturns all the towns within the cuboid.
Generated Example
- foreach <cuboid[my_noted_cuboid].list_towns> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyCuboidProperties.java#L80

Name<CuboidTag.regions>
ReturnsListTag(WorldGuardRegionTag)
DescriptionReturns a list of regions that are in this cuboid.
Generated Example
- foreach <cuboid[my_noted_cuboid].regions> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardCuboidProperties.java#L101



Category: DurationTag


Name<DurationTag.add[<duration>]>
ReturnsDurationTag
DescriptionReturns this duration plus another.
Generated Example
- ratelimit <player> <duration[5m].add[12h]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L412

Name<DurationTag.formatted>
ReturnsElementTag
DescriptionReturns the value of the duration in an easily readable format like 2h 30m,
where minutes are only shown if there is less than a day left and seconds are only shown if there are less than 10 minutes left.
Will show seconds, minutes, hours, days, and/or years.
Generated Example
- narrate <duration[5m].formatted>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L479

Name<DurationTag.formatted_words>
ReturnsElementTag
DescriptionReturns the value of the duration in an easily readable format like "2 hours 30 minutes",
where minutes are only shown if there is less than a day left and seconds are only shown if there are less than 10 minutes left.
Will show seconds, minutes, hours, days, and/or years.
Generated Example
- narrate <duration[5m].formatted_words>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L491

Name<DurationTag.in_days>
ReturnsElementTag(Decimal)
DescriptionReturns the number of days in the duration.
Generated Example
- narrate "the decimal value is <duration[5m].in_days>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L342

Name<DurationTag.in_hours>
ReturnsElementTag(Decimal)
DescriptionReturns the number of hours in the duration.
Generated Example
- narrate "the decimal value is <duration[5m].in_hours>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L352

Name<DurationTag.in_milliseconds>
ReturnsElementTag(Decimal)
DescriptionReturns the number of milliseconds in the duration.
Generated Example
- narrate "the decimal value is <duration[5m].in_milliseconds>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L382

Name<DurationTag.in_minutes>
ReturnsElementTag(Decimal)
DescriptionReturns the number of minutes in the duration.
Generated Example
- narrate "the decimal value is <duration[5m].in_minutes>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L362

Name<DurationTag.in_seconds>
ReturnsElementTag(Decimal)
DescriptionReturns the number of seconds in the duration.
Generated Example
- narrate "the decimal value is <duration[5m].in_seconds>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L372

Name<DurationTag.in_ticks>
ReturnsElementTag(Number)
DescriptionReturns the number of ticks in the duration. (20t/second)
Generated Example
- narrate "the number value is <duration[5m].in_ticks>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L392

Name<DurationTag.in_weeks>
ReturnsElementTag(Decimal)
DescriptionReturns the number of weeks in the duration.
Generated Example
- narrate "the decimal value is <duration[5m].in_weeks>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L332

Name<DurationTag.in_years>
ReturnsElementTag(Decimal)
DescriptionReturns the number of years in the duration.
Generated Example
- narrate "the decimal value is <duration[5m].in_years>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L322

Name<DurationTag.sub[<duration>]>
ReturnsDurationTag
DescriptionReturns this duration minus another.
Generated Example
- flag server myflag expire:<duration[5m].sub[5m]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L402

Name<DurationTag.is_less_than[<duration>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this duration is less than the input duration.
Equivalent to if comparison: <
Generated Example
- if <duration[5m].is_less_than[12h]>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L434

Name<DurationTag.is_less_than_or_equal_to[<duration>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this duration is less than or equal to the input duration.
Equivalent to if comparison: <=
Generated Example
- if <duration[5m].is_less_than_or_equal_to[12h]>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L458

Name<DurationTag.is_more_than[<duration>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this duration is greater than the input duration.
Equivalent to if comparison: >
Generated Example
- if <duration[5m].is_more_than[5m]>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L422

Name<DurationTag.is_more_than_or_equal_to[<duration>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this duration is greater than or equal to the input duration.
Equivalent to if comparison: >=
Generated Example
- if <duration[5m].is_more_than_or_equal_to[1m]>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L446



Category: ElementTag


Name<ElementTag.parse_yaml>
ReturnsMapTag
DescriptionParses the input YAML or JSON text into a MapTag.
Generated Example
- foreach <element[hello_world].parse_yaml> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2485

Name<ElementTag.equals[<element>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the element is equal to another element.
Equivalent to if comparison: ==
You should never ever use this tag inside any 'if', 'while', etc. command.
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L436

Name<ElementTag.is_boolean>
ReturnsElementTag(Boolean)
DescriptionReturns whether the element is a boolean ('true' or 'false').
Generated Example
- if <element[hello_world].is_boolean>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L501

Name<ElementTag.is_decimal>
ReturnsElementTag(Boolean)
DescriptionReturns whether the element is a valid decimal number (the decimal point is optional).
Generated Example
- if <element[hello_world].is_decimal>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L532

Name<ElementTag.is_even>
ReturnsElementTag(Boolean)
DescriptionReturns whether the element is an even-valued decimal number. Returns 'false' for non-numbers.
Generated Example
- if <element[hello_world].is_even>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L563

Name<ElementTag.is_integer>
ReturnsElementTag(Boolean)
DescriptionReturns whether the element is an integer number (a number without a decimal point), within the limits of a Java "long" (64-bit signed integer).
Generated Example
- if <element[hello_world].is_integer>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L512

Name<ElementTag.is_less_than[<number>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this decimal number is less than the input decimal number.
Equivalent to if comparison: <
You should never ever use this tag inside any 'if', 'while', etc. command.
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L462

Name<ElementTag.is_less_than_or_equal_to[<number>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this decimal number is less than or equal to the input decimal number.
Equivalent to if comparison: <=
You should never ever use this tag inside any 'if', 'while', etc. command.
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L488

Name<ElementTag.is_more_than[<number>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this decimal number is greater than the input decimal number.
Equivalent to if comparison: >
You should never ever use this tag inside any 'if', 'while', etc. command.
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L449

Name<ElementTag.is_more_than_or_equal_to[<number>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this decimal number is greater than or equal to the input decimal number.
Equivalent to if comparison: >=
You should never ever use this tag inside any 'if', 'while', etc. command.
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L475

Name<ElementTag.is_odd>
ReturnsElementTag(Boolean)
DescriptionReturns whether the element is an odd-valued decimal number. Returns 'false' for non-numbers.
Generated Example
- if <element[hello_world].is_odd>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L551

Name<ElementTag.as_biome>
ReturnsBiomeTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- adjust <player.location.to_ellipsoid[60,3,10].blocks> biome:<element[hello_world].as_biome>
Groupconversion
Deprecateduse as[biome]
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L47

Name<ElementTag.as_boolean>
ReturnsElementTag(Boolean)
DescriptionReturns the element as true/false.
'true', 't', or '1' become 'true', anything else becomes 'false'.
Generated Example
- if <element[hello_world].as_boolean>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L587

Name<ElementTag.as_chunk>
ReturnsChunkTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- adjust <element[hello_world].as_chunk> set_all_biomes:desert
Groupconversion
Deprecateduse as[chunk]
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L60

Name<ElementTag.as_color>
ReturnsColorTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- inventory adjust slot:hand color:<element[hello_world].as_color>
Groupconversion
Deprecateduse as[color]
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L73

Name<ElementTag.as_cuboid>
ReturnsCuboidTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- note <element[hello_world].as_cuboid> as:my_new_cuboid
Groupconversion
Deprecateduse as[cuboid]
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L86

Name<ElementTag.as_custom>
ReturnsCustomObjectTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- narrate <element[hello_world].as_custom>
Groupconversion
Deprecateduse as[custom]
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L708

Name<ElementTag.as_decimal>
ReturnsElementTag(Decimal)
DescriptionReturns the element as a decimal number, or shows an error.
Essentially an error-check-in-a-tag. Produces no functional output change in most cases.
Generated Example
- narrate "the decimal value is <element[hello_world].as_decimal>"
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L602

Name<ElementTag.as_duration>
ReturnsDurationTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- ratelimit <player> <element[hello_world].as_duration>
Groupconversion
Deprecateduse as[duration]
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L750

Name<ElementTag.as_element>
ReturnsElementTag
DescriptionReturns the element as itself.
For use in special cases, generally not very useful.
Generated Example
- narrate <element[hello_world].as_element>
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L575

Name<ElementTag.as_ellipsoid>
ReturnsEllipsoidTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- note <element[hello_world].as_ellipsoid> as:my_new_ellipsoid
Groupconversion
Deprecateduse as[ellipsoid]
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L99

Name<ElementTag.as_enchantment>
ReturnsEnchantmentTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- inventory adjust slot:hand enchantments:[<element[hello_world].as_enchantment>=5]
Groupconversion
Deprecateduse as[enchantment]
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L112

Name<ElementTag.as_entity>
ReturnsEntityTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- heal <element[hello_world].as_entity>
Groupconversion
Deprecateduse as[entity]
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L125

Name<ElementTag.as_inventory>
ReturnsInventoryTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- note <element[hello_world].as_inventory> as:my_new_inventory
Groupconversion
Deprecateduse as[inventory]
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L138

Name<ElementTag.as_item>
ReturnsItemTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- give <element[hello_world].as_item>
Groupconversion
Deprecateduse as[item]
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L151

Name<ElementTag.as_list>
ReturnsListTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- foreach <element[hello_world].as_list> as:entry:
    - narrate "found <[entry]>"
Groupconversion
Deprecateduse as[list]
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L680

Name<ElementTag.as_location>
ReturnsLocationTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- teleport <player> <element[hello_world].as_location>
Groupconversion
Deprecateduse as[location]
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L164

Name<ElementTag.as_map>
ReturnsMapTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- foreach <element[hello_world].as_map> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Groupconversion
Deprecateduse as[map]
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L694

Name<ElementTag.as_material>
ReturnsMaterialTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- foreach <player.location.find_blocks[<element[hello_world].as_material>].within[5]> as:loc:
    - modifyblock <[loc]> air
Groupconversion
Deprecateduse as[material]
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L177

Name<ElementTag.as_money>
ReturnsElementTag(Decimal)
DescriptionReturns the element as a number with two decimal places.
Generated Example
- narrate "the decimal value is <element[hello_world].as_money>"
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L659

Name<ElementTag.as_npc>
ReturnsNPCTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- walk <element[hello_world].as_npc> <player.location>
Groupconversion
Deprecateduse as[npc]
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L190

Name<ElementTag.as_player>
ReturnsPlayerTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- kill <element[hello_world].as_player>
Groupconversion
Deprecateduse as[player]
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L203

Name<ElementTag.as_plugin>
ReturnsPluginTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- narrate <element[hello_world].as_plugin>
Groupconversion
Deprecateduse as[plugin]
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L216

Name<ElementTag.as_polygon>
ReturnsPolygonTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- note <element[hello_world].as_polygon> as:my_new_polygon
Groupconversion
Deprecateduse as[polygon]
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L229

Name<ElementTag.as_queue>
ReturnsQueueTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- narrate <element[hello_world].as_queue>
Groupconversion
Deprecateduse as[queue]
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L736

Name<ElementTag.as_script>
ReturnsScriptTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- narrate <element[hello_world].as_script>
Groupconversion
Deprecateduse as[script]
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L722

Name<ElementTag.as_trade>
ReturnsTradeTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- narrate <element[hello_world].as_trade>
Groupconversion
Deprecateduse as[trade]
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L242

Name<ElementTag.as_world>
ReturnsWorldTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- adjust <element[hello_world].as_world> destroy
Groupconversion
Deprecateduse as[world]
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L255

Name<ElementTag.base64_decode>
ReturnsElementTag
DescriptionDecodes a Base64 UTF-8 encoded text to its original text.
Equivalent to using Tag:ElementTag.base64_to_binary and then Tag:BinaryTag.utf8_decode.
Generated Example
- narrate <element[hello_world].base64_decode>
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2298

Name<ElementTag.base64_encode>
ReturnsElementTag
DescriptionEncodes some text to UTF-8 Base64.
Equivalent to using Tag:ElementTag.utf8_encode and then Tag:BinaryTag.to_base64.
Generated Example
- narrate <element[hello_world].base64_encode>
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2285

Name<ElementTag.base64_to_binary>
ReturnsBinaryTag
DescriptionConverts base64 encoded text to its raw binary form.
See also Tag:BinaryTag.to_base64
Example
- define data <binary[48454c4c4f20574f524c44]>
- define encoded <[data].to_base64>
- define decoded <[encoded].base64_to_binary>
- if <[decoded].to_hex> == <[data].to_hex>:
    - narrate "Everything works!"
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2311

Name<ElementTag.escaped>
ReturnsElementTag
DescriptionReturns the element, escaped for safe reuse.
Inverts Tag:ElementTag.unescaped.
See Language:Escaping System.
Generated Example
- narrate <element[hello_world].escaped>
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L764

Name<ElementTag.from_raw_json>
ReturnsElementTag
DescriptionUn-hides the element's text from invisible color codes back to normal text.
Inverts Tag:ElementTag.to_raw_json.
Generated Example
- narrate <element[hello_world].from_raw_json>
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L432

Name<ElementTag.from_secret_colors>
ReturnsElementTag
DescriptionUn-hides the element's text from invisible color codes back to normal text.
Inverts Tag:ElementTag.to_secret_colors.
Generated Example
- narrate <element[hello_world].from_secret_colors>
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L406

Name<ElementTag.hex_decode>
ReturnsElementTag
DescriptionDeprecated in favor of Tag:BinaryTag.utf8_decode or Tag:BinaryTag.text_decode
Generated Example
- narrate <element[hello_world].hex_decode>
Groupconversion
Deprecateduse BinaryTag.utf8_decode
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2381

Name<ElementTag.hex_encode>
ReturnsElementTag
DescriptionDeprecated in favor of Tag:ElementTag.utf8_encode or Tag:ElementTag.text_encode
Generated Example
- narrate <element[hello_world].hex_encode>
Groupconversion
Deprecateduse utf8_encode
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2367

Name<ElementTag.hex_to_number>
ReturnsElementTag(Number)
DescriptionEncodes base-16 hexadecimal value to an integer number.
For example input of "F" will return "15".
See also Tag:ElementTag.number_to_hex
Consider instead Tag:BinaryTag.decode_integer
Generated Example
- narrate "the number value is <element[hello_world].hex_to_number>"
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2251

Name<ElementTag.integer_to_binary>
ReturnsBinaryTag
DescriptionReturns a BinaryTag holding 8 bytes of this integer number converted to binary format using big-endian 64-bit integer twos-complement encoding.
Example
# Narrates '00000000000000ff'
- narrate <element[255].to_binary>
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2269

Name<ElementTag.number_to_hex>
ReturnsElementTag
DescriptionEncodes base-10 integer number to hexadecimal (base-16) format.
For example input of "15" will return "F".
See also Tag:ElementTag.hex_to_number
Consider instead Tag:ElementTag.integer_to_binary
Generated Example
- narrate <element[hello_world].number_to_hex>
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2233

Name<ElementTag.parsed>
ReturnsObjectTag
DescriptionReturns the element, with any contained tags parsed.
WARNING: THIS TAG IS DANGEROUS TO USE, DO NOT USE IT UNLESS
YOU KNOW WHAT YOU ARE DOING. USE AT YOUR OWN RISK.
Generated Example
- narrate "debug - the object is: <element[hello_world].parsed>"
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L804

Name<ElementTag.sql_escaped>
ReturnsElementTag
DescriptionReturns the element, escaped for safe use in SQL.
Generated Example
- narrate <element[hello_world].sql_escaped>
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L778

Name<ElementTag.text_encode[<encoding>]>
ReturnsBinaryTag
DescriptionConverts the text to a binary representation encoded using the specified encoding method.
Input can be for example "utf-8" or "iso-8859-1".
"encoding" label corresponds to the standard charset names listed at 🔗https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html, or any other charsets added by your Java environment.
See also Tag:BinaryTag.text_decode
Example
# narrates "48454c4c4f20574f524c44"
- narrate "<element[HELLO WORLD].text_encode[us-ascii].to_hex>"
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2344

Name<ElementTag.to_itemscript_hash>
ReturnsElementTag
DescriptionShortens the element down to an itemscript hash ID, made of invisible color codes.
This is considered a historical system, no longer relevant to modern Denizen.
Generated Example
- narrate <element[hello_world].to_itemscript_hash>
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L375

Name<ElementTag.to_raw_json>
ReturnsElementTag
DescriptionConverts normal colored text to Minecraft-style "raw JSON" format.
Inverts Tag:ElementTag.from_raw_json.
Generated Example
- narrate <element[hello_world].to_raw_json>
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L420

Name<ElementTag.to_secret_colors>
ReturnsElementTag
DescriptionHides the element's text in invisible color codes.
Inverts Tag:ElementTag.from_secret_colors.
Generated Example
- narrate <element[hello_world].to_secret_colors>
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L387

Name<ElementTag.trim_to_character_set[<characters>]>
ReturnsElementTag
DescriptionReturns only the characters within the element that match the character set.
The character set is expected to be ASCII only.
This tag is case-sensitive.
For example:
"alphabet" .trim_to_character_set[abcdefghijklmnopqrstuvwxyz]> returns "alphabet",
"Alphabet" .trim_to_character_set[abcdefghijklmnopqrstuvwxyz]> returns "lphabet" without the capital "A".
and "alphabet1" .trim_to_character_set[abcdefghijklmnopqrstuvwxyz]> returns "alphabet" without the "1".
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2448

Name<ElementTag.truncate>
ReturnsElementTag(Number)
DescriptionReturns the element as a number without a decimal by way of stripping the decimal value off the end.
That is, rounds towards zero.
This is an extremely special case tag that should only be used in very specific situations.
If at all unsure, this is probably the wrong tag. Consider Tag:elementtag.round or Tag:elementtag.round_down instead.
Generated Example
- narrate "the number value is <element[hello_world].truncate>"
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L637

Name<ElementTag.unescaped>
ReturnsElementTag
DescriptionReturns the element, unescaped.
Inverts Tag:ElementTag.escaped.
See Language:Escaping System.
Generated Example
- narrate <element[hello_world].unescaped>
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L790

Name<ElementTag.url_decode>
ReturnsElementTag
DescriptionDecodes the element using URL encoding. Must be valid URL-encoded input.
Generated Example
- narrate <element[hello_world].url_decode>
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2413

Name<ElementTag.url_encode>
ReturnsElementTag
DescriptionEncodes the element using URL encoding.
Generated Example
- narrate <element[hello_world].url_encode>
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2395

Name<ElementTag.utf8_encode>
ReturnsBinaryTag
DescriptionConverts the text to a binary representation encoded with the standard UTF-8 encoding.
See also Tag:BinaryTag.utf8_decode
Example
# narrates "48454c4c4f20574f524c44"
- narrate "<element[HELLO WORLD].utf8_encode.to_hex>"
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2329

Name<ElementTag.and[<element>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether both the element and the second element are true.
You should never ever use this tag inside any 'if', 'while', etc. command.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1054

Name<ElementTag.char_at[<#>]>
ReturnsElementTag
DescriptionReturns the character at a specified index.
Returns null if the index is outside the range of the element.
Generated Example
- narrate <element[hello_world].char_at[3]>
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1126

Name<ElementTag.contains_all_case_sensitive_text[<element>|...]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the element contains all of the specified strings, case sensitive.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L932

Name<ElementTag.contains_all_text[<element>|...]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the element contains all of the specified strings, case insensitive.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L913

Name<ElementTag.contains_any_case_sensitive_text[<element>|...]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the element contains any of a list of specified elements, case sensitive.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L832

Name<ElementTag.contains_any_text[<element>|...]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the element contains any of a list of specified elements, case insensitive.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L850

Name<ElementTag.contains_case_sensitive_text[<element>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the element contains a specified element, case sensitive.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L869

Name<ElementTag.contains_text[<element>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the element contains a specified element, case insensitive. Can use
regular expression by prefixing the element with regex:
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L886

Name<ElementTag.difference[<element>]>
ReturnsElementTag(Number)
DescriptionReturns a number representing the difference between the two elements. (Uses Levenshtein logic).
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L821

Name<ElementTag.ends_with[<element>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the element ends with a specified element.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L950

Name<ElementTag.equals_case_sensitive[<element>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the element matches another element, case-sensitive.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L962

Name<ElementTag.if_true[<object>].if_false[<object>]>
ReturnsObjectTag
DescriptionIf this element is 'true', returns the first given object. If it isn't 'true', returns the second given object.
If the input objects are tags, only the matching tag will be parsed.
For example: "<player.exists.if_true[<player.name>].if_false[server]>"
will return the player's name if there's a player present, or if not will return 'server', and won't show any errors from the '<player.name>' tag even without a player linked.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2465

Name<ElementTag.index_of[<element>]>
ReturnsElementTag(Number)
DescriptionReturns the index of the first occurrence of a specified element.
Returns 0 if the element never occurs within the element.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1100

Name<ElementTag.is_in[<list>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the element is contained by a list.
Essentially equivalent to Tag:ListTag.contains_single, but with input order reversed.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1013

Name<ElementTag.last_index_of[<element>]>
ReturnsElementTag(Number)
DescriptionReturns the index of the last occurrence of a specified element.
Returns 0 if the element never occurs within the element.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1113

Name<ElementTag.length>
ReturnsElementTag(Number)
DescriptionReturns the length of the element.
Generated Example
- narrate "the number value is <element[hello_world].length>"
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1030

Name<ElementTag.matches_character_set[<characters>]>
ReturnsElementTag(Boolean)
DescriptionReturns true if the element contains only symbols from the given character set.
The character set is expected to be ASCII only.
This tag is case-sensitive.
For example:
"alphabet" .matches_character_set[abcdefghijklmnopqrstuvwxyz]> returns "true",
"Alphabet" .matches_character_set[abcdefghijklmnopqrstuvwxyz]> returns "false" because it has a capital "A",
and "alphabet1" .matches_character_set[abcdefghijklmnopqrstuvwxyz]> returns "false" because it has a "1".
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2431

Name<ElementTag.not>
ReturnsElementTag(Boolean)
DescriptionReturns the opposite of the element
IE, true returns false and false returns true.
You should never ever use this tag inside any 'if', 'while', etc. command (instead, use the '!' negation prefix).
Generated Example
- if <element[hello_world].not>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1041

Name<ElementTag.or[<element>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether either the element or the second element are true.
You should never ever use this tag inside any 'if', 'while', etc. command.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1066

Name<ElementTag.regex_matches[<regex>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the element matches a regex input.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L973

Name<ElementTag.regex[<regex>].group[<group>]>
ReturnsElementTag
DescriptionReturns the specific group from a regex match.
Specify group 0 for the whole match.
For example, <element[hello5world].regex[.*(\d).*].group[1]> returns '5'.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L984

Name<ElementTag.starts_with[<element>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the element starts with a specified element.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1089

Name<ElementTag.xor[<element>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the element and the second element are true and false (exclusive or).
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1078

Name<ElementTag.after[<element>]>
ReturnsElementTag
DescriptionReturns the portion of an element after the first occurrence of a specified element.
For example: HelloWorld .after[Hello] returns World.
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1184

Name<ElementTag.after_last[<element>]>
ReturnsElementTag
DescriptionReturns the portion of an element after the last occurrence of a specified element.
For example: abcabc .after_last[b] returns c.
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1166

Name<ElementTag.before[<element>]>
ReturnsElementTag
DescriptionReturns the portion of an element before the first occurrence of specified element.
For example: abcd .before[c] returns ab.
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1220

Name<ElementTag.before_last[<element>]>
ReturnsElementTag
DescriptionReturns the portion of an element before the last occurrence of a specified element.
For example: abcabc .before_last[b] returns abca.
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1202

Name<ElementTag.format_number[(<format>)]>
ReturnsElementTag
DescriptionReturns a number reformatted for easier reading.
For example: 1234567 will become 1,234,567.
Optionally, specify a standard number format code to instead use that.
For information on that optional input, refer to 🔗https://docs.oracle.com/javase/7/docs/api/java/text/DecimalFormat.html.
Generated Example
- narrate <element[hello_world].format_number>
Synonyms (Search Aid)elementtag.number_with_commas, elementtag.thousands_separated
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1285

Name<ElementTag.from_roman_numerals>
ReturnsElementTag
DescriptionReturns the roman numeral string in integer form.
For example: <element[MCLXIX].from_roman_numerals> returns 1169.
Generated Example
- narrate <element[hello_world].from_roman_numerals>
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1489

Name<ElementTag.is_lowercase>
ReturnsElementTag(Boolean)
DescriptionReturns whether all characters in the element are lowercase.
Numbers and symbols will return false.
Generated Example
- if <element[hello_world].is_lowercase>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1387

Name<ElementTag.is_uppercase>
ReturnsElementTag(Boolean)
DescriptionReturns whether all characters in the element are uppercase letters.
Numbers and symbols will return false.
Generated Example
- if <element[hello_world].is_uppercase>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1370

Name<ElementTag.lines_to_colored_list>
ReturnsListTag
DescriptionReturns a list of lines in the element, with colors spread over the lines manually.
Useful for things like item lore.
Generated Example
- foreach <element[hello_world].lines_to_colored_list> as:entry:
    - narrate "found <[entry]>"
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L316

Name<ElementTag.pad_left[<#>]>
ReturnsElementTag
DescriptionReturns the value of an element extended to reach a minimum specified length by adding spaces to the left side.
Generated Example
- narrate <element[hello_world].pad_left[4]>
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1594

Name<ElementTag.pad_left[<#>].with[<element>]>
ReturnsElementTag
DescriptionReturns the value of an element extended to reach a minimum specified length
by adding a specific symbol to the left side.
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1605

Name<ElementTag.pad_right[<#>]>
ReturnsElementTag
DescriptionReturns the value of an element extended to reach a minimum specified length by adding spaces to the right side.
Generated Example
- narrate <element[hello_world].pad_right[3]>
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1626

Name<ElementTag.pad_right[<#>].with[<element>]>
ReturnsElementTag
DescriptionReturns the value of an element extended to reach a minimum specified length by adding a specific symbol to the right side.
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1637

Name<ElementTag.repeat[<#>]>
ReturnsElementTag
DescriptionReturns a copy of the element, repeated the specified number of times.
For example, "hello" .repeat[3] returns "hellohellohello"
An input value or zero or a negative number will result in an empty element.
Generated Example
- narrate <element[hello_world].repeat[3]>
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1148

Name<ElementTag.replace_text[((first)regex:)<element>]>
ReturnsElementTag
DescriptionReturns the element with all instances of an element removed.
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1238

Name<ElementTag.replace_text[((first)regex:)<element>].with[<element>]>
ReturnsElementTag
DescriptionReturns the element with all instances of a element replaced with another.
Specify regex: at the start of the replace element to use Regex replacement.
Specify firstregex: at the start of the replace element to Regex 'replaceFirst'
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1246

Name<ElementTag.split[((regex:)<string>)]>
ReturnsListTag
DescriptionReturns a list of portions of this element, split by the specified string.
If a split string is unspecified, splits by space.
Generated Example
- foreach <element[hello_world].split> as:entry:
    - narrate "found <[entry]>"
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1553

Name<ElementTag.split_args>
ReturnsListTag
DescriptionReturns a list of portions of this element, split the same way command arguments are split.
That is, split by spaces but respecting the use of "quotes" to contain spaces within a single argument.
Generated Example
- foreach <element[hello_world].split_args> as:entry:
    - narrate "found <[entry]>"
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1541

Name<ElementTag.split_lines[<#>]>
ReturnsElementTag
DescriptionReturns the element split into separate lines based on a maximum number of characters per line.
This does not account for character width, so for example 20 "W"s and 20 "i"s will be treated as the same number of characters.
Spaces will be preferred to become newlines, unless a line does not contain any spaces.
Generated Example
- narrate <element[hello_world].split_lines[4]>
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1356

Name<ElementTag.split_lines_by_width[<#>]>
ReturnsElementTag
DescriptionReturns the element split into separate lines based on a maximum width in pixels per line.
This uses character width, so for example 20 "W"s and 20 "i"s will be treated differently.
The width used is based on the vanilla minecraft font. This will not be accurate for other fonts.
This only currently supports ASCII symbols properly. Unicode symbols will be estimated as 6 pixels.
Spaces will be preferred to become newlines, unless a line does not contain any spaces.
Generated Example
- narrate <element[hello_world].split_lines_by_width[1]>
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L287

Name<ElementTag.split[((regex:)<string>)].limit[<#>]>
ReturnsListTag
DescriptionReturns a list of portions of this element, split by the specified string,
and capped at the specified number of max list items.
If a split string is unspecified, splits by space.
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1574

Name<ElementTag.substring[<#>(,<#>)]>
ReturnsElementTag
DescriptionReturns the portion of an element between two element indices.
If no second index is specified, it will return the portion of an
element after the specified index.
For example: <element[hello].substring[2,4]> returns "ell"
Generated Example
- narrate <element[hello_world].substring>
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1506

Name<ElementTag.text_width>
ReturnsElementTag(Number)
DescriptionReturns the width, in pixels, of the text.
The width used is based on the vanilla minecraft font. This will not be accurate for other fonts.
This only currently supports ASCII symbols properly. Unicode symbols will be estimated as 6 pixels.
If the element contains newlines, will return the widest line width.
Generated Example
- narrate "the number value is <element[hello_world].text_width>"
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L302

Name<ElementTag.to_list>
ReturnsListTag
DescriptionReturns a ListTag of each letter in the element.
Generated Example
- foreach <element[hello_world].to_list> as:entry:
    - narrate "found <[entry]>"
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1330

Name<ElementTag.to_lowercase>
ReturnsElementTag
DescriptionReturns the value of an element in all lowercase letters.
Generated Example
- narrate <element[hello_world].to_lowercase>
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1415

Name<ElementTag.to_roman_numerals>
ReturnsElementTag
DescriptionReturns the element in roman numeral form. Must be in the range of 1 and 4000 (inclusive).
For example: <element[1169].to_roman_numerals> returns MCLXIX.
Generated Example
- narrate <element[hello_world].to_roman_numerals>
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1468

Name<ElementTag.to_sentence_case>
ReturnsElementTag
DescriptionReturns the value in sentence case (the first letter capitalized, the rest lowercase).
Generated Example
- narrate <element[hello_world].to_sentence_case>
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1454

Name<ElementTag.to_titlecase>
ReturnsElementTag
DescriptionReturns The Value Of An ElementTag In Title Case.
Generated Example
- narrate <element[hello_world].to_titlecase>
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1427

Name<ElementTag.to_uppercase>
ReturnsElementTag
DescriptionReturns the value of an element in all uppercase letters.
Generated Example
- narrate <element[hello_world].to_uppercase>
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1404

Name<ElementTag.trim>
ReturnsElementTag
DescriptionReturns the value of an element minus any leading or trailing whitespace.
Generated Example
- narrate <element[hello_world].trim>
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1345

Name<ElementTag.abs>
ReturnsElementTag(Decimal)
DescriptionReturns the absolute value of the element.
For example: <element[-5].abs> returns 5.
Generated Example
- narrate "the decimal value is <element[hello_world].abs>"
Synonyms (Search Aid)elementtag.absolute_value
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1659

Name<ElementTag.acos>
ReturnsElementTag(Decimal)
DescriptionReturns the arc-cosine of the element in radians.
Generated Example
- narrate "the decimal value is <element[hello_world].acos>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1975

Name<ElementTag.add[<#.#>]>
ReturnsElementTag(Decimal)
DescriptionReturns the element plus a number.
Generated Example
- narrate "the decimal value is <element[hello_world].add[1.5]>"
Synonyms (Search Aid)elementtag.plus, elementtag.addition, elementtag.+
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1774

Name<ElementTag.add_int[<#>]>
ReturnsElementTag(Number)
DescriptionReturns the element plus a number, using integer math.
This is a special-case Java Long Integer logic tag, and generally you should use the variant without "_int" instead.
Generated Example
- narrate "the number value is <element[hello_world].add_int[2]>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1710

Name<ElementTag.asin>
ReturnsElementTag(Decimal)
DescriptionReturns the arc-sine of the element in radians.
Generated Example
- narrate "the decimal value is <element[hello_world].asin>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1960

Name<ElementTag.atan>
ReturnsElementTag(Decimal)
DescriptionReturns the arc-tangent of the element in radians.
Generated Example
- narrate "the decimal value is <element[hello_world].atan>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1990

Name<ElementTag.atan2[<#.#>]>
ReturnsElementTag(Decimal)
DescriptionInterprets the element to be a Y value and the input value to be an X value (meaning: <Y.atan2[X]>),
and returns an angle in radians representing the vector of (X,Y).
Generated Example
- narrate "the decimal value is <element[hello_world].atan2[1.5]>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2005

Name<ElementTag.cos>
ReturnsElementTag(Decimal)
DescriptionReturns the cosine of the input radian angle.
Generated Example
- narrate "the decimal value is <element[hello_world].cos>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2021

Name<ElementTag.div[<#.#>]>
ReturnsElementTag(Decimal)
DescriptionReturns the element divided by a number.
Generated Example
- narrate "the decimal value is <element[hello_world].div[0]>"
Synonyms (Search Aid)elementtag.divide, elementtag./
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1797

Name<ElementTag.div_int[<#>]>
ReturnsElementTag(Number)
DescriptionReturns the element divided by a number.
This is a special-case Java Long Integer logic tag, and generally you should use the variant without "_int" instead.
Generated Example
- narrate "the number value is <element[hello_world].div_int[3]>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1726

Name<ElementTag.factorial>
ReturnsElementTag(Number)
DescriptionReturns the factorial of the element. This should only be used for small values (generally: less than 20), and will become ridiculous/unusable at larger values.
Generated Example
- narrate "the number value is <element[hello_world].factorial>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2066

Name<ElementTag.ln>
ReturnsElementTag(Decimal)
DescriptionReturns the natural logarithm of the element.
Generated Example
- narrate "the decimal value is <element[hello_world].ln>"
Synonyms (Search Aid)elementtag.natural_logarithm
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1927

Name<ElementTag.log[<#.#>]>
ReturnsElementTag(Decimal)
DescriptionReturns the logarithm of the element, with the base of the specified number.
Generated Example
- narrate "the decimal value is <element[hello_world].log[1.5]>"
Synonyms (Search Aid)elementtag.logarithm
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1911

Name<ElementTag.max[<#.#>]>
ReturnsElementTag(Decimal)
DescriptionReturns the higher number: this element or the specified one.
For example: <element[5].max[10]> returns 10.
Generated Example
- narrate "the decimal value is <element[hello_world].max[0]>"
Synonyms (Search Aid)elementtag.larger, elementtag.greater, elementtag.higher, elementtag.bigger, elementtag.maximum
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1676

Name<ElementTag.min[<#.#>]>
ReturnsElementTag(Decimal)
DescriptionReturns the lower number: this element or the specified one.
For example: <element[5].min[10]> returns 5.
Generated Example
- narrate "the decimal value is <element[hello_world].min[1]>"
Synonyms (Search Aid)elementtag.smaller, elementtag.lesser, elementtag.lower, elementtag.minimum
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1693

Name<ElementTag.mod[<#.#>]>
ReturnsElementTag(Decimal)
DescriptionReturns the remainder of the element divided by a number.
Generated Example
- narrate "the decimal value is <element[hello_world].mod[1.5]>"
Synonyms (Search Aid)elementtag.modulo, elementtag.modulus, elementtag.remainder/elementtag.%
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1820

Name<ElementTag.mul[<#.#>]>
ReturnsElementTag(Decimal)
DescriptionReturns the element multiplied by a number.
Generated Example
- narrate "the decimal value is <element[hello_world].mul[0]>"
Synonyms (Search Aid)elementtag.multiply, elementtag.times, elementtag.*
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1845

Name<ElementTag.mul_int[<#>]>
ReturnsElementTag(Number)
DescriptionReturns the element multiplied by a number.
This is a special-case Java Long Integer logic tag, and generally you should use the variant without "_int" instead.
Generated Example
- narrate "the number value is <element[hello_world].mul_int[3]>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1742

Name<ElementTag.power[<#.#>]>
ReturnsElementTag(Decimal)
DescriptionReturns the element to the power of a number.
Generated Example
- narrate "the decimal value is <element[hello_world].power[0]>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1943

Name<ElementTag.round>
ReturnsElementTag(Number)
DescriptionRounds a decimal.
Generated Example
- narrate "the number value is <element[hello_world].round>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2218

Name<ElementTag.round_down>
ReturnsElementTag(Number)
DescriptionRounds a decimal downward.
Generated Example
- narrate "the number value is <element[hello_world].round_down>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2131

Name<ElementTag.round_down_to_precision[<#.#>]>
ReturnsElementTag(Decimal)
DescriptionRounds a decimal downward to the specified precision.
Generated Example
- narrate "the decimal value is <element[hello_world].round_down_to_precision[1.5]>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2184

Name<ElementTag.round_to[<#>]>
ReturnsElementTag(Decimal)
DescriptionRounds a decimal to the specified place.
For example, 0.12345 .round_to[3] returns "0.123".
Generated Example
- narrate "the decimal value is <element[hello_world].round_to[2]>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2146

Name<ElementTag.round_to_precision[<#.#>]>
ReturnsElementTag(Decimal)
DescriptionRounds a decimal to the specified precision.
For example, 0.12345 .round_to_precision[0.005] returns "0.125".
Generated Example
- narrate "the decimal value is <element[hello_world].round_to_precision[0]>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2166

Name<ElementTag.round_up>
ReturnsElementTag(Number)
DescriptionRounds a decimal upward.
Generated Example
- narrate "the number value is <element[hello_world].round_up>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2116

Name<ElementTag.round_up_to_precision[<#.#>]>
ReturnsElementTag(Decimal)
DescriptionRounds a decimal upward to the specified precision.
Generated Example
- narrate "the decimal value is <element[hello_world].round_up_to_precision[0]>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2201

Name<ElementTag.sin>
ReturnsElementTag(Decimal)
DescriptionReturns the sine of the input radian angle.
Generated Example
- narrate "the decimal value is <element[hello_world].sin>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2036

Name<ElementTag.sqrt>
ReturnsElementTag(Decimal)
DescriptionReturns the square root of the element.
Null for negative numbers.
Generated Example
- narrate "the decimal value is <element[hello_world].sqrt>"
Synonyms (Search Aid)elementtag.square_root
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1891

Name<ElementTag.sub[<#.#>]>
ReturnsElementTag(Decimal)
DescriptionReturns the element minus a number.
Generated Example
- narrate "the decimal value is <element[hello_world].sub[2]>"
Synonyms (Search Aid)elementtag.subtract, elementtag.-
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1868

Name<ElementTag.sub_int[<#>]>
ReturnsElementTag(Number)
DescriptionReturns the element minus a number.
This is a special-case Java Long Integer logic tag, and generally you should use the variant without "_int" instead.
Generated Example
- narrate "the number value is <element[hello_world].sub_int[2]>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1758

Name<ElementTag.tan>
ReturnsElementTag(Decimal)
DescriptionReturns the tangent of the input radian angle.
Generated Example
- narrate "the decimal value is <element[hello_world].tan>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2051

Name<ElementTag.to_degrees>
ReturnsElementTag(Decimal)
DescriptionConverts the element from radians to degrees.
Generated Example
- narrate "the decimal value is <element[hello_world].to_degrees>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2086

Name<ElementTag.to_radians>
ReturnsElementTag(Decimal)
DescriptionConverts the element from degrees to radians.
Generated Example
- narrate "the decimal value is <element[hello_world].to_radians>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2101

Name<ElementTag.last_color>
ReturnsElementTag
DescriptionReturns the ChatColors used last in an element.
Generated Example
- narrate <element[hello_world].last_color>
Grouptext checking
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L334

Name<ElementTag.bold>
ReturnsElementTag
DescriptionMakes the input text bold. Equivalent to "<&l><ELEMENT_HERE><&l.end_format>"
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Generated Example
- narrate <element[hello_world].bold>
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L617

Name<ElementTag.click_chat[<message>]>
ReturnsElementTag
DescriptionAdds a click command to the element, which makes the element pseudo-chat the input message when clicked, for activating interact script chat triggers (Language:Chat Triggers).
This internally uses the command "/denizenclickable chat SOME MESSAGE HERE" (requires players have permission "denizen.clickable")
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Example
- narrate "You can <element[click here].click_chat[hello]> to say hello to an NPC's interact script!"
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L503

Name<ElementTag.click_url[<url>]>
ReturnsElementTag
DescriptionAdds a click command to the element, which makes the element open the given URL when clicked.
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Example
- narrate "You can <element[click here].custom_color[emphasis].on_hover[Click me!].click_url[https://denizenscript.com]> to learn about Denizen!"
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L489

Name<ElementTag.color[<color>]>
ReturnsElementTag
DescriptionMakes the input text colored by the input color. Equivalent to "<COLOR><ELEMENT_HERE><COLOR.end_format>"
Color can be a color name, color code, hex, or ColorTag... that is: ".color[gold]", ".color[6]", and ".color[#AABB00]" are all valid.
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Generated Example
- narrate <element[hello_world].color[blue]>
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L679

Name<ElementTag.color_gradient[from=<color>;to=<color>;(style={RGB}/HSB)]>
ReturnsElementTag
DescriptionReturns the element with an RGB color gradient applied, with a unique color per character.
Specify the input as a map with keys 'from' and 'to' both set to hex colors (or any valid ColorTag).
You can also choose a style (defaults to RGB):
"style=RGB" tends to produce smooth gradients,
"style=HSB" tends to produce bright rainbow-like color patterns.
Example
- narrate "<element[these are the shades of gray].color_gradient[from=white;to=black]>"
Example
- narrate "<element[this looks kinda like fire doesn't it].color_gradient[from=#FF0000;to=#FFFF00]>"
Example
- narrate "<element[this also looks like fire with a different spread].color_gradient[from=#FF0000;to=#FFFF00;style=hsb]>"
Example
- narrate "<element[what a beautiful rainbow this line is].color_gradient[from=#FF0000;to=#0000FF;style=hsb]>"
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L813

Name<ElementTag.custom_color[<name>]>
ReturnsElementTag
DescriptionMakes the input text colored by the custom color value based on the common base color names defined in the Denizen config file.
If the color name is unrecognized, returns the value of color named 'default'.
Default color names are 'base', 'emphasis', 'warning', 'error'.
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L665

Name<ElementTag.end_format>
ReturnsElementTag
DescriptionMakes a chat format code (&klmno, or &[font=...]) be the end of a format, as opposed to the start.
Use like '<&o.end_format>' or '<italic.end_format>'.
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Generated Example
- narrate <element[hello_world].end_format>
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L586

Name<ElementTag.font[<font>]>
ReturnsElementTag
DescriptionMakes the input text display with the input font name. Equivalent to "<&font[new-font]><ELEMENT_HERE><&font[new-font].end_format>"
The default font is "minecraft:default".
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L725

Name<ElementTag.format[<script>]>
ReturnsElementTag
DescriptionReturns the text re-formatted according to a format script.
Generated Example
- narrate <element[hello_world].format[<script>]>
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L268

Name<ElementTag.hex_rainbow[(<length>)]>
ReturnsElementTag
DescriptionReturns the element with RGB rainbow colors applied.
Optionally, specify a length (how many characters before the colors repeat). If unspecified, will use the input element length.
If the element starts with a hex color code, that will be used as the starting color of the rainbow.
Generated Example
- narrate <element[hello_world].hex_rainbow>
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L760

Name<ElementTag.hover_item[<item>]>
ReturnsElementTag
DescriptionAdds a hover message to the element, which makes the element display the input ItemTag when the mouse is left over it.
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Example
- narrate "You can <element[hover here].custom_color[emphasis].hover_item[<player.item_in_hand>]> to see what you held!"
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L444

Name<ElementTag.hsb_color_gradient[from=<color>;to=<color>]>
ReturnsElementTag
DescriptionDeprecated in favor of using Tag:ElementTag.color_gradient with "style=hsb"
Grouptext manipulation
Deprecateduse color_gradient[from=color;to=color;style=HSB]
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L850

Name<ElementTag.italicize>
ReturnsElementTag
DescriptionMakes the input text italic. Equivalent to "<&o><ELEMENT_HERE><&o.end_format>"
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Generated Example
- narrate <element[hello_world].italicize>
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L605

Name<ElementTag.no_reset>
ReturnsElementTag
DescriptionMakes a color code (&0123456789abcdef) not reset other formatting details.
Use like '<&c.no_reset>' or '<red.no_reset>'.
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Generated Example
- narrate <element[hello_world].no_reset>
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L570

Name<ElementTag.obfuscate>
ReturnsElementTag
DescriptionMakes the input text obfuscated. Equivalent to "<&k><ELEMENT_HERE><&k.end_format>"
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Generated Example
- narrate <element[hello_world].obfuscate>
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L653

Name<ElementTag.on_click[<command>]>
ReturnsElementTag
DescriptionAdds a click command to the element, which makes the element execute the input command when clicked.
To execute a command "/" should be used at the start. Prior to 1.19, leaving off the "/" would display the text as chat. This feature was removed as part of the 1.19 secure chat system.
For activating interact script chat triggers (Language:Chat Triggers), you can use the command "/denizenclickable chat SOME MESSAGE HERE" (requires players have permission "denizen.clickable")
For that, instead prefer Tag:ElementTag.click_chat
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Example
- narrate "You can <element[click here].on_click[/help]> for help!"
Example
- narrate "You can <element[click here].on_click[/denizenclickable chat hello]> to say hello to an NPC's interact script!"
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L518

Name<ElementTag.on_click[<message>].type[<type>]>
ReturnsElementTag
DescriptionAdds a click command to the element, which makes the element execute the input command when clicked.
Available command types: OPEN_URL, OPEN_FILE, RUN_COMMAND, SUGGEST_COMMAND, COPY_TO_CLIPBOARD, or CHANGE_PAGE.
For example: - narrate "You can <element[click here].on_click[https://denizenscript.com].type[OPEN_URL]> to learn about Denizen!"
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
For run_command, prefer Tag:ElementTag.on_click
For chat, prefer Tag:ElementTag.click_chat
For URLs, prefer Tag:ElementTag.click_url
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L536

Name<ElementTag.on_hover[<message>]>
ReturnsElementTag
DescriptionAdds a hover message to the element, which makes the element display the input hover text when the mouse is left over it.
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L458

Name<ElementTag.on_hover[<message>].type[<type>]>
ReturnsElementTag
DescriptionAdds a hover message to the element, which makes the element display the input hover text when the mouse is left over it.
Available hover types: SHOW_TEXT, SHOW_ACHIEVEMENT, SHOW_ITEM, or SHOW_ENTITY.
Note: for "SHOW_ITEM", replace the text with a valid ItemTag. For "SHOW_ENTITY", replace the text with a valid spawned EntityTag (requires F3+H to see entities).
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
For show_text, prefer Tag:ElementTag.on_hover
For show_item, prefer Tag:ElementTag.hover_item
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L469

Name<ElementTag.parse_color[(<prefix>)]>
ReturnsElementTag
DescriptionReturns the element with all color codes parsed.
Optionally, specify a character to prefix the color ids. Defaults to '&' if not specified.
This allows old-style colors like '&b', or Essentials-style hex codes like '&#ff00ff'
Generated Example
- narrate <element[hello_world].parse_color>
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L356

Name<ElementTag.rainbow[(<pattern>)]>
ReturnsElementTag
DescriptionReturns the element with rainbow colors applied.
Optionally, specify a color pattern to follow. By default, this is "4c6e2ab319d5".
That is, a repeating color of: Red, Orange, Yellow, Green, Cyan, Blue, Purple.
Generated Example
- narrate <element[hello_world].rainbow>
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L738

Name<ElementTag.strikethrough>
ReturnsElementTag
DescriptionMakes the input text struck-through. Equivalent to "<&m><ELEMENT_HERE><&m.end_format>"
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Generated Example
- narrate <element[hello_world].strikethrough>
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L641

Name<ElementTag.strip_color>
ReturnsElementTag
DescriptionReturns the element with all color encoding stripped.
Generated Example
- narrate <element[hello_world].strip_color>
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L345

Name<ElementTag.underline>
ReturnsElementTag
DescriptionMakes the input text underlined. Equivalent to "<&n><ELEMENT_HERE><&n.end_format>"
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Generated Example
- narrate <element[hello_world].underline>
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L629

Name<ElementTag.with_insertion[<message>]>
ReturnsElementTag
DescriptionAdds an insertion message to the element, which makes the element insert the input message to chat when shift-clicked.
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L557



Category: EllipsoidTag


Name<EllipsoidTag.add[<location>]>
ReturnsEllipsoidTag
DescriptionReturns a copy of this ellipsoid, shifted by the input location.
Generated Example
- note <ellipsoid[my_noted_ellipsoid].add[<player.location>]> as:my_new_ellipsoid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L462

Name<EllipsoidTag.chunks>
ReturnsListTag(ChunkTag)
DescriptionReturns a list of all chunks that this ellipsoid touches at all (note that no valid ellipsoid tag can ever totally contain a chunk, due to vertical limits and roundness).
Generated Example
- foreach <ellipsoid[my_noted_ellipsoid].chunks> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L554

Name<EllipsoidTag.include[<location>]>
ReturnsEllipsoidTag
DescriptionReturns a copy of this ellipsoid, with the size value adapted to include the specified world location.
Generated Example
- note <ellipsoid[my_noted_ellipsoid].include[<npc.location>]> as:my_new_ellipsoid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L476

Name<EllipsoidTag.location>
ReturnsLocationTag
DescriptionReturns the center location of the ellipsoid.
Generated Example
- teleport <player> <ellipsoid[my_noted_ellipsoid].location>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L442

Name<EllipsoidTag.note_name>
ReturnsElementTag
DescriptionGets the name of a noted EllipsoidTag. If the ellipsoid isn't noted, this is null.
Generated Example
- narrate <ellipsoid[my_noted_ellipsoid].note_name>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L583

Name<EllipsoidTag.random>
ReturnsLocationTag
DescriptionReturns a random decimal location within the ellipsoid.
Note that distribution of results will not be completely even.
Generated Example
- teleport <player> <ellipsoid[my_noted_ellipsoid].random>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L419

Name<EllipsoidTag.size>
ReturnsLocationTag
DescriptionReturns the size of the ellipsoid.
Generated Example
- teleport <player> <ellipsoid[my_noted_ellipsoid].size>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L452

Name<EllipsoidTag.with_location[<location>]>
ReturnsEllipsoidTag
DescriptionReturns a copy of this ellipsoid, set to the specified location.
Generated Example
- note <ellipsoid[my_noted_ellipsoid].with_location[<npc.location>]> as:my_new_ellipsoid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L526

Name<EllipsoidTag.with_size[<location>]>
ReturnsEllipsoidTag
DescriptionReturns a copy of this ellipsoid, set to the specified size.
Generated Example
- note <ellipsoid[my_noted_ellipsoid].with_size[<player.location>]> as:my_new_ellipsoid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L540



Category: EnchantmentTag


Name<EnchantmentTag.can_enchant[<item>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this enchantment can enchant the given ItemTag (based on material mainly).
This is internally based on multiple factors, such as the enchantment's category and its own specific compatibility checks.
Generated Example
- if <enchantment[sharpness].can_enchant[<player.item_in_hand>]>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L298

Name<EnchantmentTag.category>
ReturnsElementTag
DescriptionReturns the category of this enchantment. Can be any of: ARMOR, ARMOR_FEET, ARMOR_LEGS, ARMOR_CHEST, ARMOR_HEAD,
WEAPON, DIGGER, FISHING_ROD, TRIDENT, BREAKABLE, BOW, WEARABLE, CROSSBOW, VANISHABLE
Generated Example
- narrate <enchantment[sharpness].category>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L277

Name<EnchantmentTag.damage_bonus[level=<level>;type=<type>]>
ReturnsElementTag(Decimal)
DescriptionReturns the damage bonus this enchantment applies against the given monster type.
The input is a MapTag with a level value and a monster type specified, where the type can be any of: ARTHROPOD, ILLAGER, WATER, UNDEAD, or UNDEFINED
For example, <[my_enchantment].damage_bonus[level=3;type=undead]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L351

Name<EnchantmentTag.damage_protection[level=<level>;type=<cause>;(attacker=<entity>)]>
ReturnsElementTag(Number)
DescriptionReturns the damage protection this enchantment applies against the given damage cause and optional attacker.
The input is a MapTag with a level value and a damage type specified, where the damage type must be from Language:Damage Cause.
For entity damage causes, optionally specify the entity attacker.
For example, <[my_enchantment].damage_protection[level=3;type=undead]>
Generated Example
- narrate "the number value is <enchantment[sharpness].damage_protection>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L369

Name<EnchantmentTag.full_name[<level>]>
ReturnsElementTag
DescriptionReturns the full name for this enchantment for a given level, like "Sharpness V".
For vanilla enchantments, uses language translation keys.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L185

Name<EnchantmentTag.is_compatible[<enchantment>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this enchantment is compatible with another given enchantment.
Generated Example
- if <enchantment[sharpness].is_compatible[sharpness]>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L312

Name<EnchantmentTag.is_curse>
ReturnsElementTag(Boolean)
DescriptionReturns whether this enchantment is only considered to be a curse. Curses are removed at grindstones, and spread from crafting table repairs.
Generated Example
- if <enchantment[sharpness].is_curse>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L267

Name<EnchantmentTag.is_discoverable>
ReturnsElementTag(Boolean)
DescriptionReturns whether this enchantment is only considered to be discoverable.
If true, this will spawn from vanilla sources like the enchanting table. If false, it can only be given directly by script.
Generated Example
- if <enchantment[sharpness].is_discoverable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L256

Name<EnchantmentTag.is_tradable>
ReturnsElementTag(Boolean)
DescriptionReturns whether this enchantment is only considered to be tradable. Villagers won't trade this enchantment if set to false.
Generated Example
- if <enchantment[sharpness].is_tradable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L246

Name<EnchantmentTag.key>
ReturnsElementTag
DescriptionReturns the full key for this enchantment, like "minecraft:sharpness".
Generated Example
- narrate <enchantment[sharpness].key>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L175

Name<EnchantmentTag.max_cost[<level>]>
ReturnsElementTag(Decimal)
DescriptionReturns the maximum cost for this enchantment for the given level.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L338

Name<EnchantmentTag.max_level>
ReturnsElementTag(Number)
DescriptionReturns the maximum level of this enchantment. Usually between 1 and 5.
Generated Example
- narrate "the number value is <enchantment[sharpness].max_level>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L226

Name<EnchantmentTag.min_cost[<level>]>
ReturnsElementTag(Decimal)
DescriptionReturns the minimum cost for this enchantment for the given level.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L325

Name<EnchantmentTag.min_level>
ReturnsElementTag(Number)
DescriptionReturns the minimum level of this enchantment. Usually '1'.
Generated Example
- narrate "the number value is <enchantment[sharpness].min_level>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L216

Name<EnchantmentTag.name>
ReturnsElementTag
DescriptionGets the name of this enchantment. For vanilla enchantments, uses the vanilla name like 'sharpness'.
For Denizen custom enchantments, returns the 'id' specified in the script.
For any other enchantments, returns the full key.
Generated Example
- narrate <enchantment[sharpness].name>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L163

Name<EnchantmentTag.rarity>
ReturnsElementTag
DescriptionReturns the rarity of this enchantment. Can be any of: COMMON, UNCOMMON, RARE, VERY_RARE
Generated Example
- narrate <enchantment[sharpness].rarity>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L288

Name<EnchantmentTag.script>
ReturnsScriptTag
DescriptionReturns the script that created this enchantment type, if any.
Generated Example
- narrate <enchantment[sharpness].script>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L199

Name<EnchantmentTag.treasure_only>
ReturnsElementTag(Boolean)
DescriptionReturns whether this enchantment is only for spawning as treasure.
Generated Example
- if <enchantment[sharpness].treasure_only>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L236



Category: EntityTag


Name<EntityTag.absorption_health>
ReturnsElementTag(Decimal)
MechanismEntityTag.absorption_health
DescriptionReturns the living entity's absorption health.
Generated Example
- narrate "the decimal value is <player.absorption_health>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2052

Name<EntityTag.attached_entities[(<player>)]>
ReturnsListTag(EntityTag)
DescriptionReturns the entities attached to this entity by Command:attach.
Optionally, specify a player. If specified, will return entities attached visible to that player. If not specified, returns entities globally attached.
Generated Example
- foreach <player.attached_entities> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2765

Name<EntityTag.attached_offset[(<player>)]>
ReturnsLocationTag
DescriptionReturns the offset of an attachment for this entity to another that was attached by Command:attach.
Optionally, specify a player. If specified, will return entity attachment visible to that player. If not specified, returns any entity global attachment.
Generated Example
- teleport <player> <player.attached_offset>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2807

Name<EntityTag.attached_to[(<player>)]>
ReturnsEntityTag
DescriptionReturns the entity that this entity was attached to by Command:attach.
Optionally, specify a player. If specified, will return entity attachment visible to that player. If not specified, returns any entity global attachment.
Generated Example
- heal <player.attached_to>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2787

Name<EntityTag.attack_cooldown_duration>
ReturnsDurationTag
MechanismEntityTag.attack_cooldown
DescriptionReturns the amount of time that passed since the start of the attack cooldown.
Generated Example
- flag server myflag expire:<player.attack_cooldown_duration>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2827

Name<EntityTag.attack_cooldown_max_duration>
ReturnsDurationTag
MechanismEntityTag.attack_cooldown
DescriptionReturns the maximum amount of time that can pass before the player's main hand has returned
to its original place after the cooldown has ended.
NOTE: This is slightly inaccurate and may not necessarily match with the actual attack
cooldown progress.
Generated Example
- flag server myflag expire:<player.attack_cooldown_max_duration>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2842

Name<EntityTag.attack_cooldown_percent>
ReturnsElementTag(Decimal)
MechanismEntityTag.attack_cooldown_percent
DescriptionReturns the progress of the attack cooldown. 0 means that the attack cooldown has just
started, while 100 means that the attack cooldown has finished.
NOTE: This may not match exactly with the clientside attack cooldown indicator.
Generated Example
- narrate "the decimal value is <player.attack_cooldown_percent>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2860

Name<EntityTag.fish_hook_apply_lure>
ReturnsElementTag(Boolean)
MechanismEntityTag.fish_hook_apply_lure
DescriptionReturns whether this fish hook should respect the lure enchantment.
Every level of lure enchantment reduces lure time by 5 seconds.
Generated Example
- if <player.fish_hook_apply_lure>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2734

Name<EntityTag.fish_hook_hooked_entity>
ReturnsEntityTag
MechanismEntityTag.fish_hook_hooked_entity
DescriptionReturns the entity this fish hook is attached to.
Generated Example
- remove <player.fish_hook_hooked_entity>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2718

Name<EntityTag.fish_hook_in_open_water>
ReturnsElementTag(Boolean)
DescriptionReturns whether this fish hook is in open water. Fish hooks in open water can catch treasure.
See 🔗https://minecraft.fandom.com/wiki/Fishing for more info.
Generated Example
- if <player.fish_hook_in_open_water>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2750

Name<EntityTag.fish_hook_lure_time>
ReturnsDurationTag
MechanismEntityTag.fish_hook_lure_time
DescriptionReturns the remaining time before this fish hook will lure a fish.
Generated Example
- ratelimit <player> <player.fish_hook_lure_time>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2673

Name<EntityTag.fish_hook_max_lure_time>
ReturnsDurationTag
MechanismEntityTag.fish_hook_max_lure_time
DescriptionReturns the maximum possible time before this fish hook will lure a fish.
Generated Example
- ratelimit <player> <player.fish_hook_max_lure_time>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2703

Name<EntityTag.fish_hook_min_lure_time>
ReturnsDurationTag
MechanismEntityTag.fish_hook_min_lure_time
DescriptionReturns the minimum possible time before this fish hook can lure a fish.
Generated Example
- flag server myflag expire:<player.fish_hook_min_lure_time>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2688

Name<EntityTag.fish_hook_state>
ReturnsElementTag
DescriptionReturns the current state of the fish hook, as any of: UNHOOKED, HOOKED_ENTITY, BOBBING (unhooked means the fishing hook is in the air or on ground).
Generated Example
- narrate <player.fish_hook_state>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2659

Name<EntityTag.is_hand_raised>
ReturnsElementTag(Boolean)
MechanismEntityTag.attack_cooldown_percent
DescriptionReturns whether the player's hand is currently raised. Valid for players and player-type NPCs.
A player's hand is raised when they are blocking with a shield, aiming a crossbow, looking through a spyglass, etc.
Generated Example
- if <player.is_hand_raised>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2877

Name<EntityTag.is_sleeping>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player, NPC, or villager is currently sleeping.
Generated Example
- if <player.is_sleeping>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1972

Name<EntityTag.is_trading>
ReturnsElementTag(Boolean)
DescriptionReturns whether the villager entity is trading.
Generated Example
- if <player.is_trading>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1430

Name<EntityTag.left_shoulder>
ReturnsEntityTag
MechanismEntityTag.left_shoulder
DescriptionReturns the entity on the entity's left shoulder.
Only applies to player-typed entities.
NOTE: The returned entity will not be spawned within the world,
so most operations are invalid unless the entity is first spawned in.
Generated Example
- heal <player.left_shoulder>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1777

Name<EntityTag.loot_table_id>
ReturnsElementTag
MechanismEntityTag.loot_table_id
DescriptionReturns an element indicating the minecraft key for the loot-table for the entity (if any).
Generated Example
- narrate <player.loot_table_id>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2642

Name<EntityTag.precise_target[(<range>)]>
ReturnsEntityTag
DescriptionReturns the entity this entity is looking at, using precise ray trace logic.
Optionally, specify a maximum range to find the entity from (defaults to 200).
Generated Example
- heal <player.precise_target>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2122

Name<EntityTag.precise_target_position[(<range>)]>
ReturnsLocationTag
DescriptionReturns the location this entity is looking at, using precise ray trace (against entities) logic.
Optionally, specify a maximum range to find the target from (defaults to 200).
Generated Example
- teleport <player> <player.precise_target_position>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2158

Name<EntityTag.precise_target_position[(<range>)].type[<matcher>]>
ReturnsLocationTag
DescriptionReturns the location this entity is looking at, using precise ray trace (against entities) logic.
Optionally, specify a maximum range to find the target from (defaults to 200).
Specify an entity type matcher to only count matches as possible ray trace hits (types not listed will be ignored).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2171

Name<EntityTag.precise_target[(<range>)].type[<matcher>]>
ReturnsEntityTag
DescriptionReturns the entity this entity is looking at, using precise ray trace logic.
Optionally, specify a maximum range to find the entity from (defaults to 200).
Specify an entity type matcher to only count matches as possible ray trace hits (types not listed will be ignored).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2135

Name<EntityTag.right_shoulder>
ReturnsEntityTag
MechanismEntityTag.right_shoulder
DescriptionReturns the entity on the entity's right shoulder.
Only applies to player-typed entities.
NOTE: The returned entity will not be spawned within the world,
so most operations are invalid unless the entity is first spawned in.
Generated Example
- remove <player.right_shoulder>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1798

Name<EntityTag.skin_layers>
ReturnsListTag
MechanismEntityTag.skin_layers
DescriptionReturns the skin layers currently visible on a player-type entity.
Output is a list of values from the set of:
CAPE, HAT, JACKET, LEFT_PANTS, LEFT_SLEEVE, RIGHT_PANTS, or RIGHT_SLEEVE.
Generated Example
- foreach <player.skin_layers> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2490

Name<EntityTag.trades>
ReturnsListTag(TradeTag)
MechanismEntityTag.trades
DescriptionReturns a list of the Villager's trade recipes.
Generated Example
- foreach <player.trades> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityTrades.java#L64

Name<EntityTag.trading_with>
ReturnsPlayerTag
DescriptionReturns the player who is trading with the villager entity, or null if it is not trading.
Generated Example
- narrate "hello there!" targets:<player.trading_with>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1443

Name<EntityTag.translated_name>
ReturnsElementTag
DescriptionReturns the localized name of the entity.
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Generated Example
- narrate <player.translated_name>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1261

Name<EntityTag.vanilla_tags>
ReturnsListTag
DescriptionReturns a list of vanilla tags that apply to this entity type. See also 🔗https://minecraft.fandom.com/wiki/Tag.
Generated Example
- foreach <player.vanilla_tags> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1273

Name<EntityTag.effects_data>
ReturnsListTag(MapTag)
MechanismEntityTag.potion_effects
DescriptionReturns the active potion effects on the entity, in the MapTag format of the mechanism.
Generated Example
- foreach <player.effects_data> as:entry:
    - narrate "found <[entry]>"
Groupattribute
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPotionEffects.java#L109

Name<EntityTag.list_effects>
ReturnsListTag
MechanismEntityTag.potion_effects
DescriptionDeprecated in favor of Tag:EntityTag.effects_data
Generated Example
- foreach <player.list_effects> as:entry:
    - narrate "found <[entry]>"
Groupattribute
Deprecateduse 'effects_data' instead
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPotionEffects.java#L95

Name<EntityTag.armor_bonus>
ReturnsElementTag(Decimal)
MechanismEntityTag.armor_bonus
DescriptionReturns the entity's base armor bonus.
Generated Example
- narrate "the decimal value is <player.armor_bonus>"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityArmorBonus.java#L55

Name<EntityTag.armor_pose>
ReturnsLocationTag
MechanismEntityTag.armor_pose
DescriptionDeprecated in favor of Tag:EntityTag.armor_pose_map
Generated Example
- teleport <player> <player.armor_pose>
Groupattributes
DeprecatedUse 'armor_pose_map'
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityArmorPose.java#L105

Name<EntityTag.armor_pose_list>
ReturnsListTag
MechanismEntityTag.armor_pose
DescriptionDeprecated in favor of Tag:EntityTag.armor_pose_map
Generated Example
- foreach <player.armor_pose_list> as:entry:
    - narrate "found <[entry]>"
Groupattributes
DeprecatedUse 'armor_pose_map'
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityArmorPose.java#L91

Name<EntityTag.armor_pose_map>
ReturnsMapTag
MechanismEntityTag.armor_pose
DescriptionReturns a map of all poses and angles for the armor stand.
For example, head=4.5,3,4.5;body=5.4,3.2,1
Angles are in radians!
Generated Example
- foreach <player.armor_pose_map> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityArmorPose.java#L77

Name<EntityTag.attached_block>
ReturnsLocationTag
DescriptionReturns the location of the block that the arrow/trident or hanging entity is attached to.
Generated Example
- teleport <player> <player.attached_block>
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2235

Name<EntityTag.breeding>
ReturnsElementTag(Boolean)
MechanismEntityTag.breed
DescriptionReturns whether the animal entity is trying to mate with another of its kind.
Generated Example
- if <player.breeding>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1848

Name<EntityTag.can_breed>
ReturnsElementTag(Boolean)
MechanismEntityTag.can_breed
DescriptionReturns whether the animal entity is capable of mating with another of its kind.
Generated Example
- if <player.can_breed>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1833

Name<EntityTag.can_pickup_items>
ReturnsElementTag(Boolean)
MechanismEntityTag.can_pickup_items
DescriptionReturns whether the entity can pick up items.
Generated Example
- if <player.can_pickup_items>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1649

Name<EntityTag.custom_name>
ReturnsElementTag
MechanismEntityTag.custom_name
DescriptionReturns the entity's custom name (as set by plugin or name tag item), if any.