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 2392 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 | QuaternionTag | QueueTag | schematic | ScriptTag | SecretTag | server | tern | TimeTag | util | ViveCraftPlayerTag | WorldTag | yaml | VectorObject | PropertyHolderObject | TradeTag | 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 | LuckPermsGroupTag | 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<&[<custom_color_name>]>
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'.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/CustomColorTagBase.java#L42

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

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

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

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

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

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

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

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

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

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

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

Name<&at>
ReturnsElementTag
DescriptionReturns a at symbol: @
Generated Example
- narrate <&at>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L19

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

Name<&bs>
ReturnsElementTag
DescriptionReturns a backslash symbol: \
Generated Example
- narrate <&bs>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L148

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

Name<&chr[<character>]>
ReturnsElementTag
DescriptionReturns the Unicode character specified. e.g. <&chr[2665]> returns a heart.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L156

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

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

Name<&co>
ReturnsElementTag
DescriptionReturns a colon symbol: :
Generated Example
- narrate <&co>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L84

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

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

Name<&dq>
ReturnsElementTag
DescriptionReturns a double-quote symbol: "
Generated Example
- narrate <&dq>
Synonyms (Search Aid)&quote
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L75

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

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

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

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

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

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

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

Name<&gt>
ReturnsElementTag
DescriptionReturns a greater than symbol: >
Generated Example
- narrate <&gt>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L140

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

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

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

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

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

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

Name<&lb>
ReturnsElementTag
DescriptionReturns a left-bracket symbol: [
Generated Example
- narrate <&lb>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L100

Name<&lc>
ReturnsElementTag
DescriptionReturns a left-brace symbol: {
Generated Example
- narrate <&lc>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L116

Name<&lt>
ReturnsElementTag
DescriptionReturns a less than symbol: <
Generated Example
- narrate <&lt>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L132

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

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

Name<&nbsp>
ReturnsElementTag
DescriptionReturns a non-breaking space symbol.
Generated Example
- narrate <&nbsp>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L67

Name<&nl>
ReturnsElementTag
DescriptionReturns a newline symbol.
Generated Example
- narrate <&nl>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L35

Name<&ns>
ReturnsElementTag
DescriptionReturns a number sign / hash / pound symbol: #
Generated Example
- narrate <&ns>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L124

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

Name<&optimize>
ReturnsElementTag
DescriptionReturns a chat code that tells the formatted text parser to try to produce mininalist JSON text.
This is useful in particular for very long text or where text is being sent rapidly/repeatedly.
It is not needed in most normal messages.
It will produce incompatibility issues if used in items or other locations where raw JSON matching is required.
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Generated Example
- narrate <&optimize>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L327

Name<&pc>
ReturnsElementTag
DescriptionReturns a percent symbol: %
Generated Example
- narrate <&pc>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L27

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

Name<&rb>
ReturnsElementTag
DescriptionReturns a right-bracket symbol: ]
Generated Example
- narrate <&rb>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L92

Name<&rc>
ReturnsElementTag
DescriptionReturns a right-brace symbol: }
Generated Example
- narrate <&rc>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L108

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

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

Name<&sp>
ReturnsElementTag
DescriptionReturns a space symbol.
Generated Example
- narrate <&sp>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L59

Name<&sq>
ReturnsElementTag
DescriptionReturns a single-quote symbol: '
Generated Example
- narrate <&sq>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L51

Name<&ss>
ReturnsElementTag
DescriptionReturns an internal coloring symbol: ยง
Generated Example
- narrate <&ss>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L43

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.
You can use Tag:ElementTag.strip_color to convert the translated output to plain text (pre-translated).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L182

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

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

Name<binary[<binary>]>
ReturnsBinaryTag
DescriptionReturns a BinaryTag constructed from the input binary data in hexadecimal format.
Refer to ObjectType:BinaryTag.
Generated Example
- filewrite path:data/mypath.dat data:<binary[ff0000]>
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 ObjectType:BiomeTag.
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#L121

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

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

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

Name<chunk[<chunk>]>
ReturnsChunkTag
DescriptionReturns a chunk object constructed from the input value.
Refer to ObjectType:ChunkTag.
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#L130

Name<color[<color>]>
ReturnsColorTag
DescriptionReturns a color object constructed from the input value.
Refer to ObjectType:ColorTag.
Generated Example
- narrate "<&color[<color[green]>]>hello there!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L81

Name<cuboid[<cuboid>]>
ReturnsCuboidTag
DescriptionReturns a cuboid object constructed from the input value.
Refer to ObjectType:CuboidTag.
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#L139

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

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

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

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

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

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

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

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

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

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

Name<ellipsoid[<ellipsoid>]>
ReturnsEllipsoidTag
DescriptionReturns an ellipsoid object constructed from the input value.
Refer to ObjectType:EllipsoidTag.
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#L148

Name<empty>
ReturnsElementTag
DescriptionReturns an empty element.
Generated Example
- narrate <empty>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L11

Name<enchantment[<enchantment>]>
ReturnsEnchantmentTag
DescriptionReturns an enchantment object constructed from the input value.
Refer to ObjectType:EnchantmentTag.
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#L157

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

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

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

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

Name<inventory[<inventory>]>
ReturnsInventoryTag
DescriptionReturns an inventory object constructed from the input value.
Refer to ObjectType:InventoryTag.
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#L228

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

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

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

Name<list[(<list>)]>
ReturnsListTag
DescriptionReturns a list object constructed from the input value.
Give no input to create an empty list.
Refer to ObjectType:ListTag.
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 ObjectType:LocationTag.
Generated Example
- teleport <player> <location[<player.location>]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L248

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

Name<map[(<map>)]>
ReturnsMapTag
DescriptionReturns a map object constructed from the input value.
Give no input to create an empty map.
Refer to ObjectType:MapTag.
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 ObjectType:MaterialTag.
Generated Example
- foreach <player.location.find_blocks[<material[stick]>].within[5]> as:loc:
    - modifyblock <[loc]> air
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L257

Name<n>
ReturnsElementTag
DescriptionReturns a newline symbol.
Generated Example
- narrate <n>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L164

Name<npc[(<npc>)]>
ReturnsNPCTag
DescriptionReturns an npc object constructed from the input value.
Refer to ObjectType:NPCTag.
If no input value is specified, returns the linked NPC.
Generated Example
- kill <npc>
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#L24

Name<player[(<player>)]>
ReturnsPlayerTag
DescriptionReturns a player object constructed from the input value.
Refer to ObjectType:PlayerTag.
If no input value is specified, returns the linked player.
Generated Example
- kill <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 ObjectType:PluginTag.
Generated Example
- narrate <plugin[Denizen]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L330

Name<polygon[<polygon>]>
ReturnsPolygonTag
DescriptionReturns a polygon object constructed from the input value.
Refer to ObjectType:PolygonTag.
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#L339

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<quaternion[<quaternion>]>
ReturnsQuaternionTag
DescriptionReturns a QuaternionTag object constructed from the input value.
Refer to ObjectType:QuaternionTag.
Generated Example
- narrate "TODO: Placeholder: quaternion is <quaternion[identity]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L156

Name<queue[(<queue>)]>
ReturnsQueueTag
DescriptionReturns a queue object constructed from the input value.
Refer to ObjectType:QueueTag.
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#L579

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

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

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 ObjectType:ScriptTag.
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 ObjectType:SecretTag.
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#L171

Name<static[<tagged-value>]>
ReturnsObjectTag
DescriptionForces the tag inside to static-parse.
That is, any value, no matter how dynamic, will parse only exactly once at reload time.
Example
# This example will narrate the same number every time it's ran, until "/ex reload" is used.
- narrate <static[<util.random_decimal>]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/StaticTagBase.java#L10

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

Name<time[<time>]>
ReturnsTimeTag
DescriptionReturns a time object constructed from the input value.
Refer to ObjectType:TimeTag.
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#L182

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

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

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

Name<world[<world>]>
ReturnsWorldTag
DescriptionReturns a world object constructed from the input value.
Refer to ObjectType:WorldTag.
Generated Example
- adjust <world[space]> full_time:0
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L358

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

Name<bigdoor[<door>]>
ReturnsBigDoorsDoorTag
DescriptionReturns a BigDoorsDoorTag object constructed from the input value.
Refer to ObjectType:BigDoorsDoorTag.
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#L116

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

Name<discord_button[(<button>)]>
ReturnsDiscordButtonTag
DescriptionReturns a blank DiscordButtonTag instance, to be filled with data via the with.as tag.
Or, if given an input, returns a Discord Button object constructed from the input value.
Refer to ObjectType:DiscordButtonTag.
Generated Example
- narrate <discord_button>
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L131

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

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

Name<discord_embed[(<embed>)]>
ReturnsDiscordEmbedTag
DescriptionReturns a blank DiscordEmbedTag instance, to be filled with data via the with.as tag.
Or, if given an input, returns a Discord Embed object constructed from the input value.
Refer to ObjectType:DiscordEmbedTag.
Generated Example
- narrate <discord_embed>
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L179

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

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

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

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

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

Name<discord_selection[(<menu>)]>
ReturnsDiscordSelectionTag
DescriptionReturns a blank DiscordSelectionTag instance, to be filled with data via the with.as tag.
Or, if given an input, returns a Discord Selection object constructed from the input value.
Refer to ObjectType:DiscordSelectionTag.
Generated Example
- narrate <discord_selection>
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L275

Name<discord_text_input[(<button>)]>
ReturnsDiscordTextInputTag
DescriptionReturns a blank DiscordTextInputTag instance, to be filled with data via the with.as tag.
Or, if given an input, returns a Discord TextInput object constructed from the input value.
Refer to ObjectType:DiscordTextInputTag.
Generated Example
- narrate <discord_text_input>
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L291

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

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

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

Name<luckperms_group[<name>]>
ReturnsLuckPermsGroupTag
DescriptionReturns the luckperms group tag with the given name.
RequiresDepenizen, LuckPerms
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/LuckPermsBridge.java#L73

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

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

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

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

Name<party[<party>]>
ReturnsPartyTag
DescriptionReturns a party object constructed from the input value.
Refer to ObjectType:PartyTag.
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#L53

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 ObjectType:WorldGuardRegionTag.
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/WorldGuardBridge.java#L37

Name<residence[<name>]>
ReturnsResidenceTag
DescriptionReturns a residence object constructed from the input value.
Refer to ObjectType:ResidenceTag.
RequiresDepenizen, Residence
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/ResidenceBridge.java#L16

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



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.
Example
# Spawns a debugblock to highlight every plank-type block in the area.
- debugblock <cuboid[my_cuboid].blocks[*planks]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L224

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.
Example
# Spawns a debugblock to highlight every block in the cuboid that has the location flag 'my_flag'.
- debugblock <cuboid[my_cuboid].blocks_flagged[my_flag]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L275

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.
Example
# Notes the polygon's bounding box to efficiently check when things are near the polygon, even if not exactly inside.
- note <polygon[my_poly].bounding_box> my_bound_box
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.
Example
# Checks to see if "my_cuboid" contains the player's location.
- if <cuboid[my_cuboid].contains[<player.location>]>:
     - narrate "You are within 'my_cuboid'!"
- else:
     - narrate "You are NOT within 'my_cuboid'!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L208

Name<AreaObject.entities[(<matcher>)]>
ReturnsListTag(EntityTag)
DescriptionGets a list of all entities currently within the area, with an optional search parameter for the entity.
Example
# Spawns a flash particle at the location of every axolotl in the cuboid.
- foreach <cuboid[my_cuboid].entities[axolotl]> as:entity:
    - playeffect effect:flash at:<[entity].location>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L163

Name<AreaObject.is_within[<cuboid>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this area is fully inside another cuboid.
Example
# Checks to see if "my_cuboid" is within "my_bigger_cuboid".
- if <cuboid[my_cuboid].is_within[<cuboid[my_bigger_cuboid]>]>:
     - narrate "It is fully within 'my_bigger_cuboid'!"
- else:
     - narrate "It is not fully within 'my_bigger_cuboid'!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L303

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.
Example
# Narrates the name of all the living entities within the area.
- foreach <cuboid[my_cuboid].living_entities> as:entity:
     - narrate <[entity].name>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L187

Name<AreaObject.npcs>
ReturnsListTag(NPCTag)
DescriptionGets a list of all NPCs currently within the area.
Example
# Narrates a list of NPCs' names that are within the area.
# For example: "List of NPCs in 'my_cuboid': steve, alex, john, jane"
- narrate "List of NPCs in 'my_cuboid': <cuboid[my_cuboid].npcs.formatted>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L140

Name<AreaObject.players>
ReturnsListTag(PlayerTag)
DescriptionGets a list of all players currently within the area.
Example
# Narrates a list of players' names that are within the area.
# For example: "List of players in 'my_cuboid': steve, alex, john, jane"
- narrate "List of players in 'my_cuboid': <cuboid[my_cuboid].players.formatted>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L120

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.
Example
# Spawns a hollow sphere of fire around the player.
- playeffect effect:flame at:<player.location.to_ellipsoid[5,5,5].shell> offset:0
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L289

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
Example
# Spawns a creeper at a random spawnable block within the area.
- spawn creeper <cuboid[my_cuboid].spawnable_blocks.random>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L249

Name<AreaObject.with_world[<world>]>
ReturnsAreaObject
DescriptionReturns a copy of the area, with the specified world.
Example
# Notes a copy of "my_cuboid" with the same coordinates transposed from the overworld to the end world.
- note my_new_cuboid <cuboid[my_cuboid].with_world[world_the_end]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L345

Name<AreaObject.world>
ReturnsWorldTag
DescriptionReturns the area's world.
Example
- narrate "The cuboid, 'my_cuboid', is in world: <cuboid[my_cuboid].world.name>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L108



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

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

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

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

Name<BinaryTag.hmac[type=<type>;key=<secret>]>
ReturnsBinaryTag
DescriptionReturns the raw binary HMAC ("hash-based message authentication code") of the binary data, using the given HMAC algorithm and key.
Type can be "HmacMD5", "HmacSHA1", "HmacSHA256", or any other algorithm supported by your Java runtime environment per 🔗https://docs.oracle.com/javase/8/docs/api/javax/crypto/Mac.html.
Key can be a SecretTag, BinaryTag, or ElementTag.
Example
# Narrates "f7bc83f430538424b13298e6aa6fb143ef4d59a14946175997479dbc2d1a3cd8".
- narrate <element[The quick brown fox jumps over the lazy dog].utf8_encode.hmac[type=HmacSHA256;key=key].to_hex>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L355

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

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

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

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

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

Name<BinaryTag.zlib_compress>
ReturnsBinaryTag
DescriptionReturns the binary data, compressed via zlib.
See also Tag:BinaryTag.zlib_decompress
Example
- define data <binary[48454c4c4f20574f524c44]>
- define compressed <[data].zlib_compress>
- define decompressed <[data].zlib_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#L299

Name<BinaryTag.zlib_decompress>
ReturnsBinaryTag
DescriptionReturns the binary data, compressed via zlib.
See also Tag:BinaryTag.zlib_compress
Example
- define data <binary[48454c4c4f20574f524c44]>
- define compressed <[data].zlib_compress>
- define decompressed <[data].zlib_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#L316

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.base_temperature>
ReturnsElementTag(Decimal)
MechanismBiomeTag.base_temperature
DescriptionReturns the base temperature of this biome, which is used for per-location temperature calculations (see Tag:BiomeTag.temperature_at).
Example
# In a plains biome, this fills with '0.8'.
- narrate "Stay warm! In a plains biome, the base temperature is <biome[plains].base_temperature>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L220

Name<BiomeTag.downfall_at[<location>]>
ReturnsElementTag
DescriptionReturns this biome's downfall type at a location (for when a world has weather).
This can be RAIN, SNOW, or NONE.
Generally Tag:LocationTag.downfall_type should be preferred, other than some special cases.
Example
# Tells the linked player what the downfall type at their location is.
- narrate "The downfall type at your location is: <player.location.biome.downfall_at[<player.location>]>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L312

Name<BiomeTag.downfall_type>
ReturnsElementTag
MechanismBiomeTag.downfall_type
DescriptionDeprecated in favor of Tag:BiomeTag.downfall_at on 1.19+, as downfall is block-specific now.
Returns this biome's downfall type for when a world has weather.
This can be RAIN, SNOW, or NONE.
Example
# In a plains biome, this fills with 'RAIN'.
- narrate "The downfall type in plains biomes is: <biome[plains].downfall_type>!"
DeprecatedMinecraft changed the way biome downfall works, use Tag:BiomeTag.downfall_at on 1.19+.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L173

Name<BiomeTag.fog_color>
ReturnsColorTag
MechanismBiomeTag.fog_color
DescriptionReturns the biome's fog color, which is visible when outside water (see also Tag:BiomeTag.water_fog_color).
Example
# Sends the player a message in their current biome's fog color.
- narrate "You are currently seeing fog that looks like <&color[<player.location.biome.fog_color>]>this!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L344

Name<BiomeTag.foliage_color>
ReturnsColorTag
MechanismBiomeTag.foliage_color
DescriptionReturns the approximate foliage color of this biome. Foliage includes leaves and vines.
The "swamp", "mangrove_swamp", "badlands", "wooded_badlands", and "eroded_badlands" biomes are the only biomes with hard-coded foliage colors.
Biomes with no set foliage color already will have their foliage colors based on temperature and humidity of the biome.
Generated Example
- inventory adjust slot:hand color:<biome[desert].foliage_color>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L281

Name<BiomeTag.has_downfall>
ReturnsElementTag(Boolean)
MechanismBiomeTag.has_downfall
DescriptionReturns whether the biome has downfall (rain/snow).
Example
# Tells the linked player whether there's a possibility of rain.
- if <player.location.biome.has_downfall>:
  - narrate "It might rain or snow!"
- else:
  - narrate "It will be dry."
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L327

Name<BiomeTag.humidity>
ReturnsElementTag(Decimal)
MechanismBiomeTag.humidity
DescriptionReturns the humidity of this biome.
Example
# In a plains biome, this fills with '0.4'.
- narrate "Humidity in a plains biome is <biome[plains].humidity>! So humid!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L206

Name<BiomeTag.name>
ReturnsElementTag
DescriptionReturns this biome's name.
Example
# In a plains biome, this fills with 'plains'.
- narrate "You are currently in a <biome[plains].name> biome!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L193

Name<BiomeTag.spawnable_entities[(<type>)]>
ReturnsListTag
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").
Example
# Narrates the types of entities of type MONSTERS that can spawn in the player's biome.
# For example, in a plains biome this could contain "SPIDER", "ZOMBIE", "CREEPER", etc.
- narrate <player.location.biome.spawnable_entities[MONSTERS].formatted>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L234

Name<BiomeTag.temperature_at[<location>]>
ReturnsElementTag(Decimal)
DescriptionReturns the temperature of a specific location in this biome.
If this is less than 0.15, snow will form on the ground when weather occurs in the world and a layer of ice will form over water.
Generally Tag:LocationTag.temperature should be preferred, other than some special cases.
Example
# Gives the player water if they are standing in a warm location.
- if <player.location.biome.temperature_at[<player.location]> > 0.5:
  - give water_bucket
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L296

Name<BiomeTag.water_fog_color>
ReturnsColorTag
MechanismBiomeTag.water_fog_color
DescriptionReturns the biome's water fog color, which is visible when underwater (see also Tag:BiomeTag.fog_color).
Example
# Sends the player a message in their current biome's water fog color.
- narrate "If you are underwater, everything looks like <&color[<player.location.biome.water_fog_color>]>this!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L358



Category: ChunkTag


Name<ChunkTag.add[<#>,<#>]>
ReturnsChunkTag
DescriptionReturns the chunk with the specified coordinates added to it.
Example
# Adds 10 to the X and Z coordinates of the player's current chunk and loads it.
- chunkload <player.location.chunk.add[10,10]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L263

Name<ChunkTag.average_height>
ReturnsElementTag(Decimal)
DescriptionReturns the average height of the blocks in the chunk.
Example
# Narrates the average height of each block in the player's chunk rounded.
- narrate "The average height of blocks in this chunk is <player.location.chunk.average_height.round>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L603

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.
Example
# Spawns a debugblock to highlight every block in the chunk flagged "my_flag"
- debugblock <player.location.chunk.blocks_flagged[my_flag]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L688

Name<ChunkTag.cuboid>
ReturnsCuboidTag
DescriptionReturns a cuboid of this chunk.
Example
# Plays the "flame" effect at the player's chunk as a cuboid outlined along the player's Y coordinate.
- playeffect effect:flame at:<player.location.chunk.cuboid.outline_2d[<player.location.y>]> offset:0.0
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L434

Name<ChunkTag.entities[(<entity>|...)]>
ReturnsListTag(EntityTag)
DescriptionReturns a list of entities in the chunk.
Optionally specify entity types to filter down to.
Example
# Loops though the entities found in the player's chunk and narrates the name and location of it.
- foreach <player.location.chunk.entities> as:entity:
    - narrate "Found a <[entity].name> at <[entity].location.simple>!"
Example
# Loops though the axolotls found in the player's chunk and narrates the name and location of it.
- foreach <player.location.chunk.entities[axolotl]> as:entity:
    - narrate "Found an axolotl at <[entity].location.simple>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L481

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

Name<ChunkTag.height_map>
ReturnsListTag
DescriptionReturns a list of the height of each block in the chunk.
Example
# Narrates the height as a number of the highest block in the chunk.
- narrate "The block with the tallest height has a height of <player.location.chunk.height_map.highest>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L581

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.
Example
# Narrates the time inhabited in the chunk by the player formatted into words.
# For example: "You have been in this chunk for a total of 2 hours 26 minutes!"
- narrate "You have been in this chunk for a total of <player.location.chunk.inhabited_time.formatted_words>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L730

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.
Example
- if <player.location.chunk.is_flat>:
    - narrate "Wow! That is a flat chunk!"
- else:
    - narrate "Watch out! This chunk has a more rugged terrain!"
Example
- if <player.location.chunk.is_flat[4]>:
    - narrate "Wow! This chunk's blocks are all less than 4 blocks apart in height!"
- else:
    - narrate "This chunk's blocks do not meet the criteria of being flat."
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L625

Name<ChunkTag.is_generated>
ReturnsElementTag(Boolean)
DescriptionReturns true if the chunk has already been generated.
Example
# Loops though the chunks surrounding the player in a 20x20 radius and loads the chunk if it has not been generated yet.
# Loading the chunk will generate it if it has not been generated already.
- repeat 20 from:-10 as:x:
    - repeat 20 from:-10 as:z:
        - if !<player.location.chunk.add[<[x]>,<[z]>].is_generated>:
            - chunkload <player.location.chunk.add[<[x]>,<[z]>]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L315

Name<ChunkTag.is_loaded>
ReturnsElementTag(Boolean)
DescriptionReturns true if the chunk is currently loaded into memory.
Example
# Loops though the chunks surrounding the player in a 20x20 radius and loads the chunk if it is not already loaded.
- repeat 20 from:-10 as:x:
    - repeat 20 from:-10 as:z:
        - if !<player.location.chunk.add[<[x]>,<[z]>].is_loaded>:
            - chunkload <player.location.chunk.add[<[x]>,<[z]>]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L332

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.
Example
# Loops though the living entities found in the player's chunk and narrates the name and location of it.
- foreach <player.location.chunk.living_entities> as:entity:
    - narrate "Found a <[entity].name> at <[entity].location.simple>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L526

Name<ChunkTag.players>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of players in the chunk.
Example
# Narrates a list of players excluding the original player in the chunk formatted into a readable format.
# For example, this can return: "steve, alex, john, and jane".
- narrate "Wow! Look at all these players in the same chunk as you: <player.location.chunk.players.exclude[<player>].formatted>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L557

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.
Example
# Narrates the list of plugin names keeping the player's chunk loaded formatted into readable format.
# Example: "Plugins keeping your chunk loaded: Denizen and Citizens".
- narrate "Plugins keeping your chunk loaded: <player.location.chunk.plugin_tickets.formatted>"
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.
Example
- if <player.location.chunk.spawn_slimes>:
    - narrate "Watch out! Slimes can spawn here!"
- else:
    - narrate "No slimes can spawn here! You are safe for now!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L711

Name<ChunkTag.sub[<#>,<#>]>
ReturnsChunkTag
DescriptionReturns the chunk with the specified coordinates subtracted from it.
Example
# Subtracts 10 from the X and Z coordinates of the player's current chunk and loads it.
- chunkload <player.location.chunk.sub[10,10]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L289

Name<ChunkTag.surface_blocks>
ReturnsListTag(LocationTag)
DescriptionReturns a list of the highest non-air surface blocks in the chunk.
Example
# Spawns a creeper above a random surface block to prevent the creeper from suffocating.
- spawn creeper <player.location.chunk.surface_blocks.random.above>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L663

Name<ChunkTag.tile_entities>
ReturnsListTag(LocationTag)
DescriptionReturns a list of tile entity locations in the chunk.
Example
# Spawns a debugblock to highlight every tile entity in the chunk.
- debugblock <player.location.chunk.tile_entities>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L454

Name<ChunkTag.world>
ReturnsWorldTag
DescriptionReturns the world associated with the chunk.
Example
# Narrates the name of the player's chunk's associated world.
# For example, if the player was in <chunk[5,10,world]>, the world the chunk is in would be "world".
- narrate "The world your chunk is in is: <player.location.chunk.world.name>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L420

Name<ChunkTag.x>
ReturnsElementTag(Number)
DescriptionReturns the x coordinate of the chunk.
Example
# Narrates the player's chunk's X coordinate.
# For example, if the player was in <chunk[5,10,world]>, the X coordinate would be "5".
- narrate "Your current X chunk coordinate is: <player.location.chunk.x>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L392

Name<ChunkTag.z>
ReturnsElementTag(Number)
DescriptionReturns the z coordinate of the chunk.
Example
# Narrates the player's chunk's Z coordinate.
# For example, if the player was in <chunk[5,10,world]>, the Z coordinate would be "10".
- narrate "Your current Z chunk coordinate is: <player.location.chunk.z>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L406



Category: ColorTag


Name<ColorTag.alpha>
ReturnsElementTag(Number)
DescriptionReturns the alpha value of this color (0 to 255).
Example
# Narrates "255".
- narrate <color[fuchsia].alpha>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L344

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-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L293

Name<ColorTag.blue>
ReturnsElementTag(Number)
DescriptionReturns the blue value of this color (0 to 255).
Example
# Narrates "255".
- narrate <color[fuchsia].blue>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L331

Name<ColorTag.brightness>
ReturnsElementTag(Number)
DescriptionReturns the brightness value of this color (0 to 255).
Example
# Narrates "255".
- narrate <color[fuchsia].brightness>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L409

Name<ColorTag.green>
ReturnsElementTag(Number)
DescriptionReturns the green value of this color (0 to 255).
Example
# Narrates "0".
- narrate <color[fuchsia].green>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L318

Name<ColorTag.hex>
ReturnsElementTag
DescriptionReturns a hex code formatting of this color.
Example
# Narrates "#ff00ff".
- narrate <color[fuchsia].hex>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L263

Name<ColorTag.hsv>
ReturnsElementTag
DescriptionReturns the HSV value of this color.
Example
# Narrates "213,255,255".
- narrate <color[fuchsia].hsv>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L422

Name<ColorTag.hue>
ReturnsElementTag(Number)
DescriptionReturns the hue value of this color (0 to 255).
Example
# Narrates "213".
- narrate <color[fuchsia].hue>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L383

Name<ColorTag.mix[<color>]>
ReturnsColorTag
DescriptionReturns the color that results if you mix this color with another.
Example
# Colors the text with a rgb value of "127,127,255", which is a a dark purple.
- narrate "<&color[<color[fuchsia].mix[aqua]>]>This is fuchsia mixed with aqua!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L549

Name<ColorTag.name>
ReturnsElementTag
DescriptionReturns the name of this color (or red,green,blue if none).
Example
# Narrates "fuchsia".
- narrate <color[fuchsia].name>
Example
# Narrates "255,105,184".
- narrate <color[#ff69b8].name>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L533

Name<ColorTag.red>
ReturnsElementTag(Number)
DescriptionReturns the red value of this color (0 to 255).
Example
# Narrates "255".
- narrate <color[fuchsia].red>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L305

Name<ColorTag.rgb>
ReturnsElementTag
DescriptionReturns the RGB value of this color.
Example
# Narrates "255,0,255".
- narrate <color[fuchsia].rgb>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L357

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-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L281

Name<ColorTag.rgba>
ReturnsElementTag
DescriptionReturns the RGBA value of this color.
Example
# Narrates "255,0,255,255".
- narrate <color[fuchsia].rgba>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L370

Name<ColorTag.saturation>
ReturnsElementTag(Number)
DescriptionReturns the saturation value of this color (0 to 255).
Example
# Narrates "255".
- narrate <color[fuchsia].saturation>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L396

Name<ColorTag.to_particle_offset>
ReturnsLocationTag
DescriptionReturns the color as a particle offset, for use with Command:playeffect.
Example
# Plays the "SPELL_MOB" effect above the player's head with the particle offset applied to color the particle.
- playeffect at:<player.location.add[0,3,0]> effect:SPELL_MOB data:1 quantity:0 offset:<color[fuchsia].to_particle_offset>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitColorExtensions.java#L29

Name<ColorTag.with_alpha[<alpha>]>
ReturnsColorTag
DescriptionReturns a copy of this color object with a different alpha value (0 to 255).
Example
# Narrates "213,255,255,150".
- narrate <color[fuchsia].with_alpha[150].rgba>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L475

Name<ColorTag.with_blue[<blue>]>
ReturnsColorTag
DescriptionReturns a copy of this color object with a different blue value (0 to 255).
Example
# Colors the text with a rgb value of "255,0,150", which is a hot pink.
- narrate "<&color[<color[fuchsia].with_blue[150]>]>This is fuchsia with a different blue value!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L462

Name<ColorTag.with_brightness[<brightness>]>
ReturnsColorTag
DescriptionReturns a copy of this color object with a different brightness value (0 to 255).
Example
# Colors the text with a rgb value of "150,0,148", which is a magenta.
- narrate "<&color[<color[fuchsia].with_brightness[150]>]>This is fuchsia with a different brightness!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L518

Name<ColorTag.with_green[<green>]>
ReturnsColorTag
DescriptionReturns a copy of this color object with a different green value (0 to 255).
Example
# Colors the text with a rgb value of "255,150,255", which is a light pink.
- narrate "<&color[<color[fuchsia].with_green[150]>]>This is fuchsia with a different green value!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L449

Name<ColorTag.with_hue[<hue>]>
ReturnsColorTag
DescriptionReturns a copy of this color object with a different hue value (0 to 255).
Example
# Colors the text with a rgb value of "0,120,255", which is a dark blue.
- narrate "<&color[<color[fuchsia].with_hue[150]>]>This is fuchsia with a different hue!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L488

Name<ColorTag.with_red[<red>]>
ReturnsColorTag
DescriptionReturns a copy of this color object with a different red value (0 to 255).
Example
# Colors the text with a rgb value of "150,0,255", which is a dark purple.
- narrate "<&color[<color[fuchsia].with_red[150]>]>This is fuchsia with a different red value!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L436

Name<ColorTag.with_saturation[<saturation>]>
ReturnsColorTag
DescriptionReturns a copy of this color object with a different saturation value (0 to 255).
Example
# Colors the text with a rgb value of "255,105,253", which is a light pink.
- narrate "<&color[<color[fuchsia].with_saturation[150]>]>This is fuchsia with a different saturation!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L503



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.
Example
# Creates a new cuboid named "my_third_cuboid" and adds "my_cuboid" and "my_second_cuboid" as members.
# You can also use the "add_member" mechanism.
- note <cuboid[my_cuboid].add_member[my_second_cuboid]> as:my_third_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L920

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.
Example
# Adds "my_second_cuboid" as a member of "my_cuboid" at an index of 3.
# You can also use the "add_member" mechanism.
- note <cuboid[my_cuboid].add_member[my_second_cuboid].at[3]> as:my_third_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L940

Name<CuboidTag.center>
ReturnsLocationTag
DescriptionReturns the location of the exact center of the cuboid.
Not valid for multi-member CuboidTags.
Example
# Displays a debugblock at the center of the cuboid.
- debugblock <cuboid[my_cuboid].center>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1011

Name<CuboidTag.chunks>
ReturnsListTag(ChunkTag)
DescriptionGets a list of all chunks entirely within the CuboidTag (ignoring the Y axis).
Example
# Loads the chunks that are fully within the cuboid "my_cuboid".
# If "my_cuboid" spans from "15,50,15" (max) to "7,64,5" (min), then this will return an empty list and not load any chunks
# because no chunks are fully enclosed within it. But, for example, if it spans from "21,70,21" (max) to "-10,64,-9" (min),
# then this will return a list with chunk 0,0 and load it because the cuboid surrounds that chunk.
- chunkload <cuboid[my_cuboid].chunks>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1492

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.
Example
# Displays a glowstone block marker effect at each corner of the cuboid.
- playeffect effect:block_marker special_data:glowstone at:<cuboid[my_cuboid].corners> offset:0.0
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1142

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.
Example
# If "my_cuboid" spans from 10,10,10 to 5,5,5 and gets expanded by 15 (15,15,15),
# then "my_expanded_cuboid" will span -10,-10,-10 (min) to 25,25,25 (max).
- note <cuboid[my_cuboid].expand[15]> as:my_expanded_cuboid
Example
# If "my_cuboid" spans from 10,10,10 to 5,5,5 and gets expanded by 15,20,25,
# then "my_expanded_cuboid" will span -10,-15,-20 (min) to 25,30,35 (max).
- note <cuboid[my_cuboid].expand[15,20,25]> as:my_expanded_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1342

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.
Example
# Expands the high value of the cuboid "my_cuboid" by 15,16,17 on one side and notes it as "my_expanded_cuboid".
# If "my_cuboid" spans from 10,10,10 (max) to 5,5,5 (min), then expanding it by 15,16,17 will make "my_expanded_cuboid"
# span from 25,26,27 (max) to 5,5,5 (min).
- note <cuboid[my_cuboid].expand_one_side[15,16,17]> as:my_expanded_cuboid
Example
# Expands the low value of the cuboid "my_cuboid" by -15 (-15,-15,-15) on one side and notes it as "my_expanded_cuboid".
# If "my_cuboid" spans from 10,10,10 (max) to 5,5,5 (min), then shrinking it by -15 will make "my_expanded_cuboid"
# span from 10,10,10 (max) to -10,-10,-10 (min).
- note <cuboid[my_cuboid].expand_one_side[-15]> as:my_expanded_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1377

Name<CuboidTag.get[<index>]>
ReturnsCuboidTag
DescriptionReturns a cuboid representing the one component of this cuboid (for cuboids that contain multiple sub-cuboids).
Example
# Displays a debugblock at the corners of the second member of "my_cuboid".
- debugblock <cuboid[my_cuboid].get[2].corners>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L856

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.
Example
# Expands the cuboid to contain the player's location and notes it as "my_new_cuboid".
- note <cuboid[my_cuboid].include[<player.location>]> as:my_new_cuboid
Example
# Expands the cuboid to contain the cuboid "my_second_cuboid" and notes it as "my_new_cuboid".
- note <cuboid[my_cuboid].include[my_second_cuboid]> as:my_new_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1191

Name<CuboidTag.include_x[<number>]>
ReturnsCuboidTag
DescriptionExpands the first member of the CuboidTag to contain the given X value, and returns the expanded cuboid.
Example
# Expands the cuboid to include a block with an X location of 25 and notes it as "my_expanded_cuboid".
- note <cuboid[my_cuboid].include_x[25]> as:my_expanded_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1219

Name<CuboidTag.include_y[<number>]>
ReturnsCuboidTag
DescriptionExpands the first member of the CuboidTag to contain the given Y value, and returns the expanded cuboid.
Example
# Expands the cuboid to include a block with a Y location of 25 and notes it as "my_expanded_cuboid".
- note <cuboid[my_cuboid].include_y[25]> as:my_expanded_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1244

Name<CuboidTag.include_z[<number>]>
ReturnsCuboidTag
DescriptionExpands the first member of the CuboidTag to contain the given Z value, and returns the expanded cuboid.
Example
# Expands the cuboid to include a block with a Z location of 25 and notes it as "my_expanded_cuboid".
- note <cuboid[my_cuboid].include_z[25]> as:my_expanded_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1269

Name<CuboidTag.intersection[<cuboid>]>
ReturnsCuboidTag
DescriptionReturns the intersection of two intersecting cuboids - in other words, returns a cuboid of just the overlap between the two cuboids.
Returns null if the cuboids do not intersect.
Example
# Notes the intersection as "intersecting_area".
- note <cuboid[my_cuboid].intersection[my_second_cuboid]> as:intersecting_area
Example
# Highlights the outline of the intersecting_area.
- debugblock <cuboid[intersecting_area].outline>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L806

Name<CuboidTag.intersects[<cuboid>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this cuboid and another intersect.
Example
# Checks if the cuboid, "my_cuboid", intersects "my_second_cuboid".
- if <cuboid[my_cuboid].intersects[my_second_cuboid]>:
    - narrate "Both cuboids intersect each other!"
- else:
    - narrate "These cuboids do NOT intersect each other!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L782

Name<CuboidTag.list_members>
ReturnsListTag(CuboidTag)
DescriptionReturns a list of all sub-cuboids in this CuboidTag (for cuboids that contain multiple sub-cuboids).
Example
# Loops through the members of the cuboid and plays a "flame" effect at their outlines.
- foreach <cuboid[my_cuboid].list_members> as:member:
    - playeffect effect:flame at:<[member].outline> offset:0.0
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L837

Name<CuboidTag.max>
ReturnsLocationTag
DescriptionReturns the highest-numbered (maximum) corner location.
Not valid for multi-member CuboidTags.
Example
# Displays a glowstone "block_marker" effect at maximum corner location of the cuboid.
- playeffect effect:block_marker special_data:glowstone at:<cuboid[my_cuboid].max> offset:0.0
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1090

Name<CuboidTag.members_size>
ReturnsElementTag(Number)
DescriptionReturns the number of cuboids defined in the CuboidTag.
Example
# Narrates the amount of cuboids are defined in "my_cuboid".
# For example, if there are 3 cuboids defined in "my_cuboid", this will return "3".
- narrate "The cuboid, 'my_cuboid', has <cuboid[my_cuboid].members_size> members!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L738

Name<CuboidTag.min>
ReturnsLocationTag
DescriptionReturns the lowest-numbered (minimum) corner location.
Not valid for multi-member CuboidTags.
Example
# Displays a glowstone "block_marker" effect at minimum corner location of the cuboid.
- playeffect effect:block_marker special_data:glowstone at:<cuboid[my_cuboid].min> offset:0.0
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1116

Name<CuboidTag.note_name>
ReturnsElementTag
DescriptionGets the name of a noted CuboidTag. If the cuboid isn't noted, this is null.
Example
# For example, this might return something like:
# "The cuboid you are currently in is noted as: my_cuboid!"
- narrate "The cuboid you are currently in is noted as: <player.location.areas[cuboid].first.note_name.if_null[null! You aren't in a cuboid]>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1556

Name<CuboidTag.outline>
ReturnsListTag(LocationTag)
DescriptionReturns each block location on the outline of the CuboidTag.
Example
# Plays the "flame" effect at the outline of the cuboid.
- playeffect effect:flame at:<cuboid[my_cuboid].outline> offset:0.0
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L752

Name<CuboidTag.outline_2d[<#.#>]>
ReturnsListTag(LocationTag)
DescriptionReturns a list of block locations along the 2D outline of this CuboidTag, at the specified Y level.
# Plays the "flame" effect at the 2D outline of the cuboid on the player's Y level.
- playeffect effect:flame at:<cuboid[my_cuboid].outline_2d[<player.location.y>]> offset:0.0
Generated Example
- foreach <cuboid[my_noted_cuboid].outline_2d[1]> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L765

Name<CuboidTag.partial_chunks>
ReturnsListTag(ChunkTag)
DescriptionGets a list of all chunks partially or entirely within the CuboidTag.
Example
# Loads the chunks that are within the cuboid "my_cuboid", even if they are partially within the cuboid.
# If "my_cuboid" spans from "15,50,15" (max) to "7,64,5" (min), then this will return a list with chunk 0,0
# in it, because the chunk is partially contained by the cuboid.
- chunkload <cuboid[my_cuboid].partial_chunks>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1531

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

Name<CuboidTag.remove_member[<#>]>
ReturnsCuboidTag
MechanismCuboidTag.remove_member
DescriptionReturns a modified copy of this cuboid, with member at the input index removed.
Example
# Removes the third member in the cuboid "my_cuboid" and notes it as "my_new_cuboid".
# You can also use the "remove_member" mechanism.
- note <cuboid[my_cuboid].remove_member[3]> as:my_new_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L980

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

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.
Example
# Notes the cuboid "my_cuboid" as "my_shifted_cuboid" but shifted over by 25,25,25.
- note <cuboid[my_cuboid].shift[25,25,25]> as:my_shifted_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1169

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.
Example
# Shrinks the high value of the cuboid "my_cuboid" by 15,16,17 on one side and notes it as "my_smaller_cuboid".
# If "my_cuboid" spans from 10,10,10 (max) to 5,5,5 (min), then shrinking it by 15,16,17 will make "my_smaller_cuboid"
# span from 5,5,5 (max) to -5,-6,-7 (min).
- note <cuboid[my_cuboid].shrink_one_side[15,16,17]> as:my_smaller_cuboid
Example
# Shrinks the low value of the cuboid "my_cuboid" by -15 (-15,-15,-15) on one side and notes it as "my_smaller_cuboid".
# If "my_cuboid" spans from 10,10,10 (max) to 5,5,5 (min), then shrinking it by -15 will make "my_smaller_cuboid"
# span from 20,20,20 (max) to 10,10,10 (min).
- note <cuboid[my_cuboid].shrink_one_side[-15]> as:my_smaller_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1434

Name<CuboidTag.size>
ReturnsLocationTag
DescriptionReturns the size of the cuboid.
Effectively equivalent to: (max - min) + (1,1,1)
Not valid for multi-member CuboidTags.
Example
# For example, this can return "6,7,8", meaning the cuboid is 6 blocks wide, 7 blocks high, and 8 blocks deep.
- narrate "The size of the cuboid 'my_cuboid' is: <cuboid[my_cuboid].size.xyz>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1060

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.
Example
# For example, a cuboid with a size of "6,7,8" will have a volume of "336". 6 * 7 * 8 = 336.
- narrate "The volume of the cuboid 'my_cuboid' is: <cuboid[my_cuboid].volume>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1043

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.
Example
# Notes a new cuboid with the player's location as the new maximum location of the cuboid.
# For example: if "my_cuboid" spans from 10,10,10 (max) to 5,5,5 (min) and the player had a location of 15,10,15,
# then "my_new_cuboid" will span from 15,10,15 (max) to 5,5,5 (min).
- note <cuboid[my_cuboid].with_max[<player.location>]> as:my_new_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1318

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.
Example
# Notes a new cuboid with the player's location as the new minimum location of the cuboid.
# For example: if "my_cuboid" spans from 10,10,10 (max) to 5,5,5 (min) and the player had a location of -5,5,-5,
# then "my_new_cuboid" will have a minimum location of -5,5,-5.
- note <cuboid[my_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#L1294

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[1m]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L416

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

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

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

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

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

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

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

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

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

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

Name<DurationTag.sub[<duration>]>
ReturnsDurationTag
DescriptionReturns this duration minus another.
Generated Example
- ratelimit <player> <duration[5m].sub[1s]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L406

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[1s]>:
    - 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#L438

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

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[1s]>:
    - 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#L426

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[1s]>:
    - 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#L450



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

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

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

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

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

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

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

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

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

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

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

Name<ElementTag.as_biome>
ReturnsBiomeTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- adjust <player.location.chunk> set_all_biomes:<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#L44

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

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

Name<ElementTag.as_color>
ReturnsColorTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- narrate "<&color[<element[hello_world].as_color>]>hello there!"
Groupconversion
Deprecateduse as[color]
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L70

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

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

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

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

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

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

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

Name<ElementTag.as_entity>
ReturnsEntityTag
DescriptionDeprecated in favor of Tag:ObjectTag.as
Generated Example
- remove <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#L122

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name<ElementTag.optimize_json>
ReturnsElementTag
DescriptionTells the formatted text parser to try to produce mininalist JSON text.
This is useful in particular for very long text or where text is being sent rapidly/repeatedly.
It is not needed in most normal messages.
It will produce incompatibility issues if used in items or other locations where raw JSON matching is required.
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
Generated Example
- narrate <element[hello_world].optimize_json>
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L444

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

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

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

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

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

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

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

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

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

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 elements, case sensitive.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L922

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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[1]>
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[2]>
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[3]>
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1355

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

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

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

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

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

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

Name<ElementTag.add[<#.#>]>
ReturnsElementTag(Decimal)
DescriptionReturns the element plus a number.
Generated Example
- narrate "the decimal value is <element[hello_world].add[0]>"
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#L1777

Name<ElementTag.add_int[<#>]>
ReturnsElementTag(Number)
DescriptionDon't use this, just use "add".
Generated Example
- narrate "the number value is <element[hello_world].add_int[2]>"
Groupmath
DeprecatedThis tag hasn't conferred any real benefit for years.
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#L1963

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

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]>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2008

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

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

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

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

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

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]>"
Synonyms (Search Aid)elementtag.logarithm
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1914

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[1]>"
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.5]>"
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]>"
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#L1823

Name<ElementTag.mul[<#.#>]>
ReturnsElementTag(Decimal)
DescriptionReturns the element multiplied by a number.
Generated Example
- narrate "the decimal value is <element[hello_world].mul[2]>"
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#L1848

Name<ElementTag.mul_int[<#>]>
ReturnsElementTag(Number)
DescriptionDon't use this, just use "mul".
Generated Example
- narrate "the number value is <element[hello_world].mul_int[1]>"
Groupmath
DeprecatedThis tag hasn't conferred any real benefit for years.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1743

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

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

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

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[2]>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2187

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[1]>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2149

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[1]>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2169

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

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[2]>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2204

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

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

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

Name<ElementTag.sub_int[<#>]>
ReturnsElementTag(Number)
DescriptionDon't use this, just use "sub".
Generated Example
- narrate "the number value is <element[hello_world].sub_int[4]>"
Groupmath
DeprecatedThis tag hasn't conferred any real benefit for years.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1760

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

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

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

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

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

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

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

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[green]>
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L702

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

Name<ElementTag.custom_color[<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#L684

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

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

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

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

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

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

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

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

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

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

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

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

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

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'
See also Tag:ElementTag.parse_minimessage
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#L355

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

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

Name<ElementTag.strip_color>
ReturnsElementTag
DescriptionReturns the element with all color encoding stripped.
This will remove any/all colors, formats (bold/italic/etc), advanced formats (fonts/clickables/etc), and translate any translatables (&translate, &score, etc).
This will automatically translate translatable sections
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#L342

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

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

Name<ElementTag.parse_minimessage>
ReturnsElementTag
DescriptionReturns the element with all MiniMessage tags parsed, see 🔗https://docs.adventure.kyori.net/minimessage/format.html for more information.
This may be useful for reading data from external plugins, but should not be used in normal scripts.
Generated Example
- narrate <element[hello_world].parse_minimessage>
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperElementExtensions.java#L16

Name<ElementTag.to_minimessage>
ReturnsElementTag
DescriptionReturns the element with all text formatting parsed into MiniMessage format.
This may be useful for sending data to external plugins, but should not be used in normal scripts.
Generated Example
- narrate <element[hello_world].to_minimessage>
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperElementExtensions.java#L28



Category: EllipsoidTag


Name<EllipsoidTag.add[<location>]>
ReturnsEllipsoidTag
DescriptionReturns a copy of this ellipsoid, shifted by the input location.
Example
# Shifts the ellipsoid by 10,10,10 and notes it as "my_shifted_ellipsoid".
# For example, if "my_ellipsoid" has a location of "5,5,5", and it's added by "10,10,10",
# "my_shifted_cuboid" will have a location of "15,15,15".
- note <ellipsoid[my_ellipsoid].add[10,10,10]> as:my_shifted_ellipsoid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L461

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).
Example
# Loads the chunks that touch the ellipsoid "my_ellipsoid".
# For example, if "my_ellipsoid" had a size of "9,4,6" and a location of "-10,70,-9",
# this will return a list containing chunks -2,-1 and -1,-1.
- chunkload <ellipsoid[my_ellipsoid].chunks>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L571

Name<EllipsoidTag.include[<location>]>
ReturnsEllipsoidTag
DescriptionReturns a copy of this ellipsoid, with the size value adapted to include the specified world location.
Example
# Expands "my_ellipsoid" to include the player's location and notes it as "my_new_ellipsoid".
# For example, if "my_ellipsoid" has a location of "5,5,5" and a size of "8,8,8",
# and the player had a location of 20,22,24, then "my_new_ellipsoid" will have a location of
# "5,5,5" and a size of "26,29,33" (rounded).
- note <ellipsoid[my_ellipsoid].include[<player.location>]> as:my_new_ellipsoid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L480

Name<EllipsoidTag.location>
ReturnsLocationTag
DescriptionReturns the center location of the ellipsoid.
Example
# Displays a debugblock at center location of the ellipsoid "my_ellipsoid".
- debugblock <ellipsoid[my_ellipsoid].location>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L435

Name<EllipsoidTag.note_name>
ReturnsElementTag
DescriptionGets the name of a noted EllipsoidTag. If the ellipsoid isn't noted, this is null.
Example
# For example, this might return something like:
# "The ellipsoid you are currently in is noted as: my_ellipsoid!"
- narrate "The ellipsoid you are currently in is noted as: <player.location.areas[ellipsoid].first.note_name.if_null[null! You aren't in an ellipsoid]>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L605

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

Name<EllipsoidTag.size>
ReturnsLocationTag
DescriptionReturns the size of the ellipsoid.
Example
# For example, this can return: "The size of the ellipsoid 'my_ellipsoid' is: 10,10,10!"
- narrate "The size of the ellipsoid 'my_ellipsoid' is: <ellipsoid[my_ellipsoid].size.xyz>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L448

Name<EllipsoidTag.with_location[<location>]>
ReturnsEllipsoidTag
DescriptionReturns a copy of this ellipsoid, set to the specified location.
Example
# Sets the location of "my_ellipsoid" to be the player's location.
# For example, if the player's location is 10,15,20, then "my_new_ellipsoid" will have a location of 10,15,20.
- note <ellipsoid[my_ellipsoid].with_location[<player.location>]> as:my_new_ellipsoid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L536

Name<EllipsoidTag.with_size[<location>]>
ReturnsEllipsoidTag
DescriptionReturns a copy of this ellipsoid, set to the specified size.
Example
# Changes the size of "my_ellipsoid" to be 20,20,20 and notes it as "my_new_ellipsoid".
- note <ellipsoid[my_ellipsoid].with_size[20,20,20]> as:my_new_ellipsoid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L554



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.
Example
# In the case of the "knockback" enchantment, this narrates
# "You can apply the knockback enchantment in a diamond sword!"
- if <enchantment[knockback].can_enchant[diamond_sword]>:
    - narrate "You can apply the knockback enchantment in a diamond sword!"
- else:
    - narrate "You cannot apply the knockback enchantment in a diamond sword!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L352

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
Example
# This narrates "The bane_of_arthropods enchantment is in the WEAPON category!"
- narrate "The bane_of_arthropods enchantment is in the <enchantment[bane_of_arthropods].category> category!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L325

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
Example
# Narrates "With Bane of Arthropods 2, you get a damage bonus of 5 on arthropods!"
- narrate "With Bane of Arthropods 2, you get a damage bonus of <enchantment[bane_of_arthropods].damage_bonus[level=2;type=arthropod]> on arthropods!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L425

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.
Example
# Narrates "With the Protection 3 enchantment, there is fall damage protection of 3!"
- narrate "With the Protection 3 enchantment, there is fall damage protection of <enchantment[protection].damage_protection[level=3;type=fall]>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L445

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.
Example
# Narrates "You don your Thorns III armor."
# Note: vanilla enchantments have a color applied to them, such as grey or red.
- narrate "You don your <enchantment[thorns].full_name[3]><reset> armor."
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L191

Name<EnchantmentTag.is_compatible[<enchantment>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this enchantment is compatible with another given enchantment.
Example
# In the case of the "silk_touch" and "mending" enchantments, this narrates
# "These enchantments are compatible together!"
- if <enchantment[silk_touch].is_compatible[mending]>:
    - narrate "These enchantments are compatible together!"
- else:
    - narrate "These enchantments are not compatible with each other!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L373

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.
Example
# In the case of the "vanishing_curse" enchantment, this will narrate:
# "Watch out! This enchantment is a curse!"
- if <enchantment[vanishing_curse].is_curse>:
    - narrate "Watch out! This enchantment is a curse!"
- else:
    - narrate "Phew, this enchantment is not a curse!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L308

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.
Example
# In the case of the "loyalty" enchantment, this will narrate:
# "Time to do some discovering!"
- if <enchantment[loyalty].is_discoverable>:
    - narrate "Time to do some discovering!"
- else:
    - narrate "You'll have to be given this enchantment through a script!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L290

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.
Example
# In the case of the "loyalty" enchantment, this will narrate:
# "Let's do some haggling to get this enchantment!"
- if <enchantment[loyalty].is_tradable>:
    - narrate "Let's do some haggling to get this enchantment!"
- else:
    - narrate "Villagers don't seem to want to trade this enchantment!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L273

Name<EnchantmentTag.key>
ReturnsElementTag
DescriptionReturns the full key for this enchantment, like "minecraft:sharpness".
Example
# Narrates "The key for the flame enchantment is: minecraft:flame!"
- narrate "The key for the flame enchantment is: <enchantment[flame].key>!"
Example
# This example uses a custom Denizen enchantment.
# Narrates "The key for the my_enchantment enchantment is: denizen:my_enchantment!"
- narrate "The key for the my_enchantment enchantment is: <enchantment[my_enchantment].key>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L174

Name<EnchantmentTag.max_cost[<level>]>
ReturnsElementTag(Decimal)
DescriptionReturns the maximum cost for this enchantment for the given level.
Example
# This narrates "The maximum cost for the efficiency 3 enchantment is: 81!"
- narrate "The maximum cost for the efficiency 3 enchantment is: <enchantment[efficiency].max_cost[3]>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L409

Name<EnchantmentTag.max_level>
ReturnsElementTag(Number)
DescriptionReturns the maximum level of this enchantment. Usually between 1 and 5.
Example
# Narrates "The maximum enchantment level that you can get for Feather Falling is: 4!"
- narrate "The maximum enchantment level that you can get for Feather Falling is: <enchantment[feather_falling].max_level>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L243

Name<EnchantmentTag.min_cost[<level>]>
ReturnsElementTag(Decimal)
DescriptionReturns the minimum cost for this enchantment for the given level.
Example
# This narrates "The minimum cost for the efficiency 3 enchantment is: 21!"
- narrate "The minimum cost for the efficiency 3 enchantment is: <enchantment[efficiency].min_cost[3]>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L393

Name<EnchantmentTag.min_level>
ReturnsElementTag(Number)
DescriptionReturns the minimum level of this enchantment. Usually '1'.
Example
# Narrates "The minimum enchantment level that you can get for Feather Falling is: 1!"
- narrate "The minimum enchantment level that you can get for Feather Falling is: <enchantment[feather_falling].min_level>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L230

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.
Example
# This can narrate something like this:
# "The item in your hand's first enchantment is sharpness!"
- narrate "The item in your hand's first enchantment is <player.item_in_hand.enchantment_types.get[1].name||nothing>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L158

Name<EnchantmentTag.rarity>
ReturnsElementTag
DescriptionReturns the rarity of this enchantment. Can be any of: COMMON, UNCOMMON, RARE, VERY_RARE
Example
# This narrates "The infinity enchantment is VERY_RARE!"
- narrate "The infinity enchantment is <enchantment[infinity].rarity>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L339

Name<EnchantmentTag.script>
ReturnsScriptTag
DescriptionReturns the script that created this enchantment type, if any.
Example
# This can narrate something like this:
# "The script used to create the my_enchantment enchantment is: my_enchantment_script"
- narrate "The script used to create the my_enchantment enchantment is: <enchantment[my_enchantment].script.name>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L209

Name<EnchantmentTag.treasure_only>
ReturnsElementTag(Boolean)
DescriptionReturns whether this enchantment is only for spawning as treasure.
Example
# In the case of the "loyalty" enchantment, this will narrate:
# "You cannot find this enchantment as treasure!"
- if <enchantment[loyalty].treasure_only>:
    - narrate "You can only find this enchantment as treasure!"
- else:
    - narrate "You cannot find this enchantment as treasure!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L256



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

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

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

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
- remove <player.attached_to>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2785

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

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
- ratelimit <player> <player.attack_cooldown_max_duration>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2840

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

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

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

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

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

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

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

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

Name<EntityTag.is_hand_raised>
ReturnsElementTag(Boolean)
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#L2875

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

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

Name<EntityTag.last_attack>
ReturnsMapTag
DescriptionReturns an interaction entity's last attack interaction, if any.
The returned map contains:
- 'player' (PlayerTag): the player who interacted
- 'duration' (DurationTag): the amount of time since the interaction. Note that this is a delta time (same limitations as Event:delta time), and may become inaccurate if the interaction entity changes worlds.
- 'raw_game_time' (ElementTag(Number)): the raw game time the interaction occurred at, used to calculate the time above.
Generated Example
- foreach <player.last_attack> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2892

Name<EntityTag.last_interaction>
ReturnsMapTag
DescriptionReturns an interaction entity's last right click interaction, if any.
The returned map contains:
- 'player' (PlayerTag): the player who interacted
- 'duration' (DurationTag): the amount of time since the interaction. Note that this is a delta time (same limitations as Event:delta time), and may become inaccurate if the interaction entity changes worlds.
- 'raw_game_time' (ElementTag(Number)): the raw game time the interaction occurred at, used to calculate the time above.
Generated Example
- foreach <player.last_interaction> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2910

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
- kill <player.left_shoulder>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1769

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

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
- kill <player.precise_target>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2120

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

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

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

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.