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

Categories:

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


Category: Base


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name<chunk[<chunk>]>
ReturnsChunkTag
DescriptionReturns a chunk object constructed from the input value.
Refer to ObjectTypeChunkTag.
Generated Example
- chunkload <chunk[<player.location.chunk>]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ChunkTagBase.java#L10

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

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

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

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

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

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

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

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

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

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 ObjectTypeDurationTag.
Generated Example
- ratelimit <player> <duration[5m]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/DurationTagBase.java#L10

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

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

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

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

Name<entity[<entity>]>
ReturnsEntityTag
DescriptionReturns an entity object constructed from the input value.
Refer to ObjectTypeEntityTag.
Generated Example
- remove <entity[<player>]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/EntityTagBase.java#L10

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

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

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

Name<inventory[<inventory>]>
ReturnsInventoryTag
DescriptionReturns an inventory object constructed from the input value.
Refer to ObjectTypeInventoryTag.
Generated Example
- note <inventory[<player.inventory>]> as:my_new_inventory
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/InventoryTagBase.java#L10

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

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

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

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

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

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

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

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

Name<material[<material>]>
ReturnsMaterialTag
DescriptionReturns a material object constructed from the input value.
Refer to ObjectTypeMaterialTag.
Generated Example
- foreach <player.location.find_blocks[<material[stone]>].within[5]> as:loc:
    - modifyblock <[loc]> air
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/MaterialTagBase.java#L10

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

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

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

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

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

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

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

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

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

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

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

Name<secret[<secret>]>
ReturnsSecretTag
DescriptionReturns a SecretTag object constructed from the input value.
Refer to ObjectTypeSecretTag.
Example
- webget <secret[my_secret_url]> "post:Message to secret address!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/SecretTagBase.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#L825

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

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

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

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

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

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

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

Name<discord[<bot-id>]>
ReturnsDiscordBotTag
DescriptionReturns the Discord bot for the given bot ID.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L115

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name<jobs[(<name>)]>
ReturnsListTag(JobsJobTag)/JobsJobTag
DescriptionReturns a list of all known jobs, or the job by the given input name if one is given.
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#L50

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

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

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

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

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

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

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

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

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



Category: AreaObject


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

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

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

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

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

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

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

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

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

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

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

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

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



Category: BinaryTag


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

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

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

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

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

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

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

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

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

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/BukkitBinaryTagProperties.java#L41



Category: BiomeTag


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

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

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

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

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



Category: ChunkTag


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



Category: ColorTag


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

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

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

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

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

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

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

Name<ColorTag.mix[<color>]>
ReturnsColorTag
DescriptionReturns the color that results if you mix this color with another.
Generated Example
- inventory adjust slot:hand color:<color[red].mix[blue]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L477

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

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

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

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

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

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

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

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

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

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

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

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

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



Category: CuboidTag


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name<DurationTag.is_less_than[<number>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this duration is less than the input duration.
Equivalent to if comparison: <
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L450

Name<DurationTag.is_less_than_or_equal_to[<number>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this duration is less than or equal to the input duration.
Equivalent to if comparison: <=
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L480

Name<DurationTag.is_more_than[<number>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this duration is greater than the input duration.
Equivalent to if comparison: >
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L435

Name<DurationTag.is_more_than_or_equal_to[<number>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this duration is greater than or equal to the input duration.
Equivalent to if comparison: >=
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L465



Category: EllipsoidTag


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

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

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

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

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

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

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

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

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



Category: EnchantmentTag


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name<EntityTag.custom_name>
ReturnsElementTag
MechanismEntityTag.custom_name
DescriptionReturns the entity's custom name (as set by plugin or name tag item), if any.
Generated Example
- narrate <player.custom_name>
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityCustomName.java#L49

Name<EntityTag.custom_name_visible>
ReturnsElementTag(Boolean)
MechanismEntityTag.custom_name_visible
DescriptionReturns whether the entity's custom name is visible.
Generated Example
- if <player.custom_name_visible>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityCustomNameVisible.java#L47

Name<EntityTag.dark_duration>
ReturnsDurationTag
MechanismEntityTag.dark_duration
DescriptionReturns the duration remaining before a glow squid starts glowing.
Generated Example
- ratelimit <player> <player.dark_duration>
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityDarkDuration.java#L53

Name<EntityTag.direction>
ReturnsLocationTag
MechanismEntityTag.direction
DescriptionReturns the movement/acceleration direction of a fireball entity, as a LocationTag vector.
Generated Example
- teleport <player> <player.direction>
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityDirection.java#L53

Name<EntityTag.fall_distance>
ReturnsElementTag(Decimal)
MechanismEntityTag.fall_distance
DescriptionReturns how far the entity has fallen.
Generated Example
- narrate "the decimal value is <player.fall_distance>"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1678

Name<EntityTag.fallingblock_material>
ReturnsMaterialTag
MechanismEntityTag.fallingblock_type
DescriptionReturns the material of a fallingblock-type entity.
Generated Example
- foreach <player.location.find_blocks[<player.fallingblock_material>].within[5]> as:loc:
    - modifyblock <[loc]> air
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1663

Name<EntityTag.fire_time>
ReturnsDurationTag
MechanismEntityTag.fire_time
DescriptionReturns the duration for which the entity will remain on fire
Generated Example
- flag server myflag expire:<player.fire_time>
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1690

Name<EntityTag.fixed>
ReturnsElementTag(Boolean)
MechanismEntityTag.fixed
DescriptionReturns whether the item frame is fixed. (Meaning, it can't be altered by players).
Generated Example
- if <player.fixed>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityFixed.java#L57

Name<EntityTag.formatted_health>
ReturnsElementTag
MechanismEntityTag.health_data
DescriptionReturns a formatted value of the player's current health level.
May be 'dying', 'seriously wounded', 'injured', 'scraped', or 'healthy'.
Generated Example
- narrate <player.formatted_health>
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityHealth.java#L83

Name<EntityTag.freeze_duration>
ReturnsDurationTag
MechanismEntityTag.freeze_duration
DescriptionReturns the duration an entity has been freezing for (from powdered snow).
Generated Example
- ratelimit <player> <player.freeze_duration>
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityFreezeDuration.java#L57

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

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

Name<EntityTag.has_ai>
ReturnsElementTag(Boolean)
MechanismEntityTag.has_ai
DescriptionReturns whether the entity uses the default Minecraft AI to roam and look around.
This tends to have implications for other vanilla functionality, including gravity.
This generally shouldn't be used with NPCs. NPCs do not have vanilla AI, regardless of what this tag returns.
Other programmatic methods of blocking AI might also not be accounted for by this tag.
Generated Example
- if <player.has_ai>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAI.java#L48

Name<EntityTag.has_effect[<effect>]>
ReturnsElementTag(Boolean)
MechanismEntityTag.potion_effects
DescriptionReturns whether the entity has a specified effect.
If no effect is specified, returns whether the entity has any effect.
The effect type must be from 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionEffectType.html.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPotionEffects.java#L121

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

Name<EntityTag.health>
ReturnsElementTag(Decimal)
MechanismEntityTag.health
DescriptionReturns the current health of the entity.
Generated Example
- narrate "the decimal value is <player.health>"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityHealth.java#L157

Name<EntityTag.health_data>
ReturnsElementTag
MechanismEntityTag.health
DescriptionReturns the current health data of the entity, in the format of current/max.
Generated Example
- narrate <player.health_data>
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityHealth.java#L144

Name<EntityTag.health_max>
ReturnsElementTag(Decimal)
MechanismEntityTag.max_health
DescriptionReturns the maximum health of the entity.
Generated Example
- narrate "the decimal value is <player.health_max>"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityHealth.java#L100

Name<EntityTag.health_percentage>
ReturnsElementTag(Decimal)
MechanismEntityTag.health
DescriptionReturns the entity's current health as a percentage.
Generated Example
- narrate "the decimal value is <player.health_percentage>"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityHealth.java#L118

Name<EntityTag.is_aware>
ReturnsElementTag(Boolean)
MechanismEntityTag.is_aware
DescriptionReturns whether the entity is aware of its surroundings.
Unaware entities will not perform any actions on their own, such as pathfinding or attacking.
Similar to Tag:EntityTag.has_ai, except allows the entity to be moved by gravity, being pushed or attacked, etc.
Generated Example
- if <player.is_aware>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAware.java#L53

Name<EntityTag.is_collidable>
ReturnsElementTag(Boolean)
MechanismEntityTag.collidable
DescriptionReturns whether the entity is collidable.
Returns the persistent collidable value for NPCs.
Generated Example
- if <player.is_collidable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1955

Name<EntityTag.is_empty>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity does not have a passenger.
Generated Example
- if <player.is_empty>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1874

Name<EntityTag.is_in_block>
ReturnsElementTag(Boolean)
DescriptionReturns whether or not the arrow/trident entity is in a block.
Generated Example
- if <player.is_in_block>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2220

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

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

Name<EntityTag.is_on_ground>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity is supported by a block.
This can be inaccurate for players.
Generated Example
- if <player.is_on_ground>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1921

Name<EntityTag.is_persistent>
ReturnsElementTag(Boolean)
MechanismEntityTag.persistent
DescriptionReturns whether the entity will not be removed completely when far away from players.
In other words: whether the entity should be saved to file when chunks unload (otherwise, the entity is gone entirely if despawned for any reason).
Generated Example
- if <player.is_persistent>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1933

Name<EntityTag.is_sheared>
ReturnsElementTag(Boolean)
DescriptionReturns whether a sheep is sheared.
Generated Example
- if <player.is_sheared>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1907

Name<EntityTag.killer>
ReturnsPlayerTag
DescriptionReturns the player that last killed the entity.
Generated Example
- heal <player.killer>
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1987

Name<EntityTag.last_damage.amount>
ReturnsElementTag(Decimal)
DescriptionReturns the amount of the last damage taken by the entity.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1999

Name<EntityTag.last_damage.cause>
ReturnsElementTag
DescriptionReturns the cause of the last damage taken by the entity.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2010

Name<EntityTag.last_damage.duration>
ReturnsDurationTag
MechanismEntityTag.no_damage_duration
DescriptionReturns the duration of the last damage taken by the entity.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2024

Name<EntityTag.last_damage.max_duration>
ReturnsDurationTag
MechanismEntityTag.max_no_damage_duration
DescriptionReturns the maximum duration of the last damage taken by the entity.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2036

Name<EntityTag.leash_holder>
ReturnsEntityTag
MechanismEntityTag.leash_holder
DescriptionReturns the leash holder of entity.
Generated Example
- heal <player.leash_holder>
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1713

Name<EntityTag.max_freeze_duration>
ReturnsDurationTag
MechanismEntityTag.freeze_duration
DescriptionReturns the maximum duration an entity can be freezing for (from powdered snow). (When reached, an entity is fully frozen over).
Generated Example
- ratelimit <player> <player.max_freeze_duration>
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityFreezeDuration.java#L45

Name<EntityTag.max_oxygen>
ReturnsDurationTag
DescriptionReturns the maximum duration of oxygen the entity can have.
Works with offline players.
Generated Example
- ratelimit <player> <player.max_oxygen>
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2062

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

Name<EntityTag.oxygen>
ReturnsDurationTag
MechanismEntityTag.oxygen
DescriptionReturns the duration of oxygen the entity has left.
Works with offline players.
Generated Example
- flag server myflag expire:<player.oxygen>
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2074

Name<EntityTag.passenger>
ReturnsEntityTag
MechanismEntityTag.passenger
DescriptionReturns the entity's passenger, if any.
Generated Example
- heal <player.passenger>
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1744

Name<EntityTag.passengers>
ReturnsListTag(EntityTag)
MechanismEntityTag.passengers
DescriptionReturns a list of the entity's passengers, if any.
Generated Example
- foreach <player.passengers> as:entry:
    - narrate "found <[entry]>"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1728

Name<EntityTag.persistent>
ReturnsElementTag(Boolean)
MechanismEntityTag.persistent
DescriptionOutdated form of Tag:EntityTag.is_persistent
Generated Example
- if <player.persistent>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1942

Name<EntityTag.pickup_delay>
ReturnsDurationTag
MechanismEntityTag.pickup_delay
DescriptionReturns how long before the item-type entity can be picked up by a player.
Generated Example
- flag server myflag expire:<player.pickup_delay>
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2205

Name<EntityTag.scoreboard_tags>
ReturnsListTag
MechanismEntityTag.scoreboard_tags
DescriptionReturns a list of the scoreboard tags on the entity.
Generated Example
- foreach <player.scoreboard_tags> as:entry:
    - narrate "found <[entry]>"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityScoreboardTags.java#L64

Name<EntityTag.shooter>
ReturnsEntityTag
MechanismEntityTag.shooter
DescriptionReturns the projectile's shooter or TNT's priming source, if any.
Generated Example
- remove <player.shooter>
Synonyms (Search Aid)entitytag.arrow_firer, entitytag.fishhook_shooter, entitytag.snowball_thrower
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1759

Name<EntityTag.silent>
ReturnsElementTag(Boolean)
MechanismEntityTag.silent
DescriptionReturns whether the entity is silent. (Plays no sounds)
Generated Example
- if <player.silent>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntitySilent.java#L56

Name<EntityTag.speed>
ReturnsElementTag(Decimal)
MechanismEntityTag.speed
DescriptionReturns how fast the entity can move.
Generated Example
- narrate "the decimal value is <player.speed>"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntitySpeed.java#L81

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

Name<EntityTag.target>
ReturnsEntityTag
DescriptionReturns the target entity of the creature or shulker_bullet, if any.
This is the entity that a hostile mob is currently trying to attack.
Generated Example
- kill <player.target>
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2097

Name<EntityTag.time_lived>
ReturnsDurationTag
MechanismEntityTag.time_lived
DescriptionReturns how long the entity has lived.
Generated Example
- ratelimit <player> <player.time_lived>
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2193

Name<EntityTag.vehicle>
ReturnsEntityTag
DescriptionIf the entity is in a vehicle, returns the vehicle as a EntityTag.
Generated Example
- kill <player.vehicle>
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1818

Name<EntityTag.visible>
ReturnsElementTag(Boolean)
MechanismEntityTag.visible
DescriptionReturns whether the armor stand or item frame is visible.
Generated Example
- if <player.visible>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityVisible.java#L75

Name<EntityTag.visual_pose>
ReturnsElementTag
DescriptionReturns the name of the entity's current visual pose.
See 🔗https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Pose.html
Generated Example
- narrate <player.visual_pose>
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2279

Name<EntityTag.eid>
ReturnsElementTag(Number)
DescriptionReturns the entity's temporary server entity ID.
Generated Example
- narrate "the number value is <player.eid>"
Groupdata
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1297

Name<EntityTag.entity_type>
ReturnsElementTag
DescriptionReturns the type of the entity.
Generated Example
- narrate <player.entity_type>
Groupdata
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1249

Name<EntityTag.is_living>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity type is a living-type entity (eg a cow or a player or anything else that lives, as specifically opposed to non-living entities like paintings, etc).
Not to be confused with the idea of being alive - see Tag:EntityTag.is_spawned.
Generated Example
- if <player.is_living>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupdata
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2307

Name<EntityTag.is_mob>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity type is a mob (Not a player or NPC).
Generated Example
- if <player.is_mob>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupdata
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2330

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

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

Name<EntityTag.is_player>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity is a player.
Works with offline players.
Generated Example
- if <player.is_player>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupdata
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2352

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

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

Name<EntityTag.name>
ReturnsElementTag
DescriptionReturns the name of the entity.
This can be a player name, an NPC name, a custom_name, or the entity type.
Works with offline players.
Generated Example
- narrate <player.name>
Groupdata
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1364

Name<EntityTag.script>
ReturnsScriptTag
DescriptionReturns the entity script that spawned this entity, if any.
Generated Example
- narrate <player.script>
Groupdata
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1320

Name<EntityTag.scriptname>
ReturnsElementTag
DescriptionUse ".script.name" instead.
Generated Example
- narrate <player.scriptname>
Groupdata
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1334

Name<EntityTag.uuid>
ReturnsElementTag
DescriptionReturns the permanent unique ID of the entity.
Works with offline players.
Generated Example
- narrate <player.uuid>
Groupdata
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1308

Name<EntityTag.has_equipped[<item-matcher>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity has any armor equipment item that matches the given item matcher, using the system behind Language:Advanced Object Matching.
For example, has_equipped[diamond_*] will return true if the entity is wearing at least one piece of diamond armor.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2617

Name<EntityTag.equipment>
ReturnsListTag(ItemTag)
MechanismEntityTag.equipment
DescriptionReturns a ListTag containing the entity's equipment.
Output list is boots|leggings|chestplate|helmet
Generated Example
- foreach <player.equipment> as:entry:
    - narrate "found <[entry]>"
Groupinventory
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityEquipment.java#L55

Name<EntityTag.equipment_map>
ReturnsMapTag
MechanismEntityTag.equipment
DescriptionReturns a MapTag containing the entity's equipment.
Output keys are boots, leggings, chestplate, helmet.
Air items will be left out of the map.
Generated Example
- foreach <player.equipment_map> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Groupinventory
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityEquipment.java#L93

Name<EntityTag.has_saddle>
ReturnsElementTag(Boolean)
DescriptionIf the entity is a pig or horse, returns whether it has a saddle equipped.
Generated Example
- if <player.has_saddle>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupinventory
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1412

Name<EntityTag.horse_armor>
ReturnsItemTag
DescriptionIf the entity is a horse, returns the item equipped as the horses armor, or air if none.
Generated Example
- give <player.horse_armor>
Groupinventory
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1398

Name<EntityTag.inventory>
ReturnsInventoryTag
DescriptionReturns the entity's inventory, if it has one.
Generated Example
- inventory set o:<player.inventory> d:stick slot:5
Groupinventory
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityInventory.java#L61

Name<EntityTag.item_in_hand>
ReturnsItemTag
MechanismEntityTag.item_in_hand
DescriptionReturns the item the entity is holding, or air if none.
Generated Example
- give <player.item_in_hand>
Groupinventory
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityItemInHand.java#L69

Name<EntityTag.item_in_offhand>
ReturnsItemTag
MechanismEntityTag.item_in_offhand
DescriptionReturns the item the entity is holding in their off hand, or air if none.
Generated Example
- give <player.item_in_offhand>
Groupinventory
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityItemInOffHand.java#L69

Name<EntityTag.saddle>
ReturnsItemTag
DescriptionIf the entity is a horse or pig, returns the saddle as a ItemTag, or air if none.
Generated Example
- give <player.saddle>
Groupinventory
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1381

Name<EntityTag.body_yaw>
ReturnsElementTag(Decimal)
DescriptionReturns the entity's body yaw (separate from head yaw).
Generated Example
- narrate "the decimal value is <player.body_yaw>"
Grouplocation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1609

Name<EntityTag.can_see[<entity>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity can see the specified other entity (has an uninterrupted line-of-sight).
Generated Example
- if <player.can_see[<npc>]>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Grouplocation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1491

Name<EntityTag.cursor_on[(<range>)]>
ReturnsLocationTag
DescriptionReturns the location of the block the entity is looking at.
Optionally, specify a maximum range to find the location from (defaults to 200).
This uses logic equivalent to Tag:LocationTag.precise_cursor_on_block[(range)].
Note that this will return null if there is no block in range.
This uses all blocks, ie it includes passable blocks like tall-grass and water. Use Tag:EntityTag.cursor_on_solid to exclude passable blocks.
Equivalent to <EntityTag.eye_location.ray_trace[return=block;fluids=true;nonsolids=true]>
Generated Example
- teleport <player> <player.cursor_on>
Grouplocation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1556

Name<EntityTag.cursor_on_solid[(<range>)]>
ReturnsLocationTag
DescriptionReturns the location of the solid block the entity is looking at.
Optionally, specify a maximum range to find the location from (defaults to 200).
Note that this will return null if there is no solid block in range.
This only uses solid blocks, ie it ignores passable blocks like tall-grass. Use Tag:EntityTag.cursor_on to include passable blocks.
Equivalent to <EntityTag.eye_location.ray_trace[return=block]>
Generated Example
- teleport <player> <player.cursor_on_solid>
Grouplocation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1533

Name<EntityTag.eye_height>
ReturnsElementTag(Number)
DescriptionReturns the height of the entity's eyes above its location.
Generated Example
- narrate "the number value is <player.eye_height>"
Grouplocation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1519

Name<EntityTag.eye_location>
ReturnsLocationTag
DescriptionReturns the location of the entity's eyes.
Generated Example
- teleport <player> <player.eye_location>
Grouplocation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1508

Name<EntityTag.location>
ReturnsLocationTag
DescriptionReturns the location of the entity.
For living entities, this is at the center of their feet.
For eye location, use Tag:EntityTag.eye_location
Works with offline players.
Generated Example
- teleport <player> <player.location>
Grouplocation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1580

Name<EntityTag.map_trace>
ReturnsLocationTag
DescriptionDeprecated in favor of Tag:EntityTag.trace_framed_map
Generated Example
- teleport <player> <player.map_trace>
Grouplocation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1474

Name<EntityTag.standing_on>
ReturnsLocationTag
DescriptionReturns the location of the block the entity is standing on top of (if on the ground, returns null if in the air).
Generated Example
- teleport <player> <player.standing_on>
Grouplocation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1594

Name<EntityTag.trace_framed_map>
ReturnsMapTag
DescriptionReturns information at the framed item of a filled map that an entity is currently looking at, if any.
The map contains key "x" and "y" as coordinates in the range of 0 to 128. These will automatically correct for rotation, if the framed item is rotated.
The map contains "entity" as the EntityTag of the item frame.
The map also contains "map" as the ID of the targeted map.
Returns null if the entity is not looking at an item_frame holding a filled_map.
Generated Example
- foreach <player.trace_framed_map> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Grouplocation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1459

Name<EntityTag.velocity>
ReturnsLocationTag
MechanismEntityTag.velocity
DescriptionReturns the movement velocity of the entity.
Note: Does not accurately calculate player clientside movement velocity.
Generated Example
- teleport <player> <player.velocity>
Grouplocation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1620

Name<EntityTag.world>
ReturnsWorldTag
DescriptionReturns the world the entity is in. Works with offline players.
Generated Example
- adjust <player.world> destroy
Grouplocation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1633

Name<EntityTag.age>
ReturnsElementTag(Number)
MechanismEntityTag.age
DescriptionIf the entity is ageable, returns the entity's age number.
Age moves 1 towards zero each tick.
A newly spawned baby is -24000.
A standard adult is 0.
An adult that just bred is 6000.
Generated Example
- narrate "the number value is <player.age>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAge.java#L84

Name<EntityTag.ageable>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity is ageable.
If this returns true, it will enable access to:
Mechanism:EntityTag.age, Mechanism:EntityTag.age_lock,
Tag:EntityTag.is_baby, Tag:EntityTag.age,
and Tag:EntityTag.is_age_locked
Generated Example
- if <player.ageable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2396

Name<EntityTag.allowed_colors>
ReturnsListTag
MechanismEntityTag.color
DescriptionIf the entity can have a color, returns the list of allowed colors.
See also Language:Entity Color Types.
Generated Example
- foreach <player.allowed_colors> as:entry:
    - narrate "found <[entry]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityColor.java#L224

Name<EntityTag.anger>
ReturnsDurationTag
MechanismEntityTag.anger
DescriptionReturns the remaining anger time of a PigZombie or Bee.
Generated Example
- flag server myflag expire:<player.anger>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAnger.java#L76

Name<EntityTag.angry>
ReturnsElementTag(Boolean)
MechanismEntityTag.angry
DescriptionIf the entity is a wolf or PigZombie, returns whether the entity is angry.
If the entity is a Vindicator, returns whether it is in "Johnny" mode.
Generated Example
- if <player.angry>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAngry.java#L68

Name<EntityTag.arms>
ReturnsElementTag(Boolean)
MechanismEntityTag.arms
DescriptionIf the entity is an armor stand, returns whether the armor stand has arms.
Generated Example
- if <player.arms>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityArms.java#L53

Name<EntityTag.attribute_base_value[<attribute>]>
ReturnsElementTag(Decimal)
MechanismEntityTag.attribute_base_values
DescriptionReturns the base value of the named attribute for the entity.
See also Tag:EntityTag.has_attribute.
Valid attribute names are listed at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/attribute/Attribute.html
See also Language:attribute modifiers.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAttributeBaseValues.java#L115

Name<EntityTag.attribute_default_value[<attribute>]>
ReturnsElementTag(Decimal)
MechanismEntityTag.attribute_base_values
DescriptionReturns the default value of the named attribute for the entity.
See also Tag:EntityTag.has_attribute.
Valid attribute names are listed at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/attribute/Attribute.html
See also Language:attribute modifiers.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAttributeBaseValues.java#L140

Name<EntityTag.attribute_modifiers>
ReturnsMapTag
MechanismEntityTag.attribute_modifiers
DescriptionReturns a map of all attribute modifiers on the entity, with key as the attribute name and value as a list of modifiers,
where each modifier is a MapTag containing keys 'name', 'amount', 'slot', 'operation', and 'id'.
This is formatted in a way that can be sent back into the 'attribute_modifiers' mechanism.
See also Language:attribute modifiers.
Generated Example
- foreach <player.attribute_modifiers> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAttributeModifiers.java#L219

Name<EntityTag.attribute_value[<attribute>]>
ReturnsElementTag(Decimal)
MechanismEntityTag.attribute_base_values
DescriptionReturns the final calculated value of the named attribute for the entity.
See also Tag:EntityTag.has_attribute.
Valid attribute names are listed at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/attribute/Attribute.html
See also Language:attribute modifiers.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAttributeBaseValues.java#L90

Name<EntityTag.base_plate>
ReturnsElementTag(Boolean)
MechanismEntityTag.base_plate
DescriptionIf the entity is an armor stand, returns whether the armor stand has a base plate.
Generated Example
- if <player.base_plate>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityBasePlate.java#L53

Name<EntityTag.base_potion>
ReturnsElementTag
MechanismEntityTag.base_potion
DescriptionReturns the Area Effect Cloud's base potion data.
In the format Type,Upgraded,Extended
Generated Example
- narrate <player.base_potion>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L72

Name<EntityTag.base_potion.is_extended>
ReturnsElementTag(Boolean)
DescriptionReturns whether the Area Effect Cloud's base potion is extended.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L108

Name<EntityTag.base_potion.is_upgraded>
ReturnsElementTag(Boolean)
DescriptionReturns whether the Area Effect Cloud's base potion is upgraded.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L96

Name<EntityTag.base_potion.type>
ReturnsElementTag
DescriptionReturns the Area Effect Cloud's base potion type.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L84

Name<EntityTag.beam_target>
ReturnsLocationTag
MechanismEntityTag.beam_target
DescriptionReturns the target location of the ender crystal's beam, if any.
Generated Example
- teleport <player> <player.beam_target>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityBeamTarget.java#L55

Name<EntityTag.boat_type>
ReturnsElementTag
MechanismEntityTag.boat_type
DescriptionReturns the wood type of the boat.
Valid wood types: GENERIC, REDWOOD, BIRCH, JUNGLE, ACACIA, DARK_OAK.
Generated Example
- narrate <player.boat_type>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityBoatType.java#L54

Name<EntityTag.body_arrows>
ReturnsElementTag(Number)
MechanismEntityTag.body_arrows
DescriptionReturns the number of arrows stuck in the entity's body.
Note: Body arrows will only be visible for players or player-type npcs.
Generated Example
- narrate "the number value is <player.body_arrows>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityBodyArrows.java#L58

Name<EntityTag.bounding_box>
ReturnsListTag(LocationTag)
MechanismEntityTag.bounding_box
DescriptionReturns the collision bounding box of the entity in the format "<low>|<high>", essentially a cuboid with decimals.
Generated Example
- foreach <player.bounding_box> as:entry:
    - narrate "found <[entry]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityBoundingBox.java#L75

Name<EntityTag.can_join_raid>
ReturnsElementTag(Boolean)
MechanismEntityTag.can_join_raid
DescriptionIf the entity is raider mob (like a pillager), returns whether the entity is allowed to join active raids.
Generated Example
- if <player.can_join_raid>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityCanJoinRaid.java#L53

Name<EntityTag.cannot_enter_hive>
ReturnsDurationTag
MechanismEntityTag.cannot_enter_hive
DescriptionReturns the minimum duration until a Bee entity is allowed to enter a hive.
Generated Example
- ratelimit <player> <player.cannot_enter_hive>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityCannotEnterHive.java#L66

Name<EntityTag.carries_chest>
ReturnsElementTag(Boolean)
MechanismEntityTag.carries_chest
DescriptionReturns whether a horse-like entity is carrying a chest.
Generated Example
- if <player.carries_chest>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityChestCarrier.java#L53

Name<EntityTag.charged>
ReturnsElementTag(Boolean)
MechanismEntityTag.charged
DescriptionIf the entity is wither_skull, returns whether the skull is charged. Charged skulls are blue.
If the entity is a vex, returns whether the vex is charging. Charging vexes have red lines.
Generated Example
- if <player.charged>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityCharged.java#L51

Name<EntityTag.color>
ReturnsElementTag
MechanismEntityTag.color
DescriptionIf the entity can have a color, returns the entity's color.
For the available color options, refer to Language:Entity Color Types.
Generated Example
- narrate <player.color>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityColor.java#L237

Name<EntityTag.colorable>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity can be colored.
If this returns true, it will enable access to:
Mechanism:EntityTag.color and Tag:EntityTag.color
Generated Example
- if <player.colorable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2411

Name<EntityTag.conversion_duration>
ReturnsDurationTag
MechanismEntityTag.conversion_duration
DescriptionReturns the duration of time until an entity completes a conversion. See Tag:EntityTag.is_converting for examples of conversions.
When this value hits 0, the conversion completes.
See also Tag:EntityTag.in_water_duration
Generated Example
- ratelimit <player> <player.conversion_duration>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityConversionTime.java#L57

Name<EntityTag.critical>
ReturnsElementTag(Boolean)
MechanismEntityTag.critical
DescriptionIf the entity is an arrow or trident, returns whether the arrow/trident is critical.
Generated Example
- if <player.critical>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityCritical.java#L53

Name<EntityTag.custom_effects>
ReturnsListTag
MechanismEntityTag.custom_effects
DescriptionReturns a ListTag of the Area Effect Cloud's custom effects
In the form Type,Amplifier,Duration,Ambient,Particles|...
Generated Example
- foreach <player.custom_effects> as:entry:
    - narrate "found <[entry]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L283

Name<EntityTag.custom_effects[<#>].amplifier>
ReturnsElementTag(Number)
DescriptionReturns the specified Area Effect Cloud potion effect amplifier.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L324

Name<EntityTag.custom_effects[<#>].duration>
ReturnsDurationTag
DescriptionReturns the specified Area Effect Cloud potion effect duration.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L336

Name<EntityTag.custom_effects[<#>].has_particles>
ReturnsElementTag(Boolean)
DescriptionReturns whether the specified Area Effect Cloud potion effect has particles.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L348

Name<EntityTag.custom_effects[<#>].is_ambient>
ReturnsElementTag(Boolean)
DescriptionReturns whether the specified Area Effect Cloud potion effect is ambient.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L360

Name<EntityTag.custom_effects[<#>].type>
ReturnsElementTag
DescriptionReturns the specified Area Effect Cloud potion effect type.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L312

Name<EntityTag.damage>
ReturnsElementTag(Decimal)
MechanismEntityTag.damage
DescriptionReturns the damage that the arrow/trident will inflict.
NOTE: The actual damage dealt by the arrow/trident may be different depending on the projectile's flight speed.
Generated Example
- narrate "the decimal value is <player.damage>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityArrowDamage.java#L53

Name<EntityTag.describe>
ReturnsEntityTag
DescriptionReturns the entity's full description, including all properties.
Generated Example
- remove <player.describe>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2606

Name<EntityTag.disabled_slots>
ReturnsListTag
MechanismEntityTag.disabled_slots
DescriptionDeprecated in favor of Tag:EntityTag.disabled_slots_data.
Generated Example
- foreach <player.disabled_slots> as:entry:
    - narrate "found <[entry]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityDisabledSlots.java#L97

Name<EntityTag.disabled_slots_data>
ReturnsMapTag
MechanismEntityTag.disabled_slots
DescriptionIf the entity is an armor stand, returns its disabled slots as a map of slot names to list of actions.
Generated Example
- foreach <player.disabled_slots_data> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityDisabledSlots.java#L127

Name<EntityTag.disabled_slots.raw>
ReturnsElementTag(Number)
MechanismEntityTag.disabled_slots_raw
DescriptionDeprecated in favor of Tag:EntityTag.disabled_slots_data.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityDisabledSlots.java#L108

Name<EntityTag.disguise_to_others[(<player>)]>
ReturnsEntityTag
DescriptionReturns the fake entity used to disguise the entity in other's views, either globally (if no context input given), or to the specified player.
Relates to Command:disguise.
Generated Example
- remove <player.disguise_to_others>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2569

Name<EntityTag.disguised_type[(<player>)]>
ReturnsEntityTag
DescriptionReturns the entity type the entity is disguised as, either globally (if no context input given), or to the specified player.
Relates to Command:disguise.
Generated Example
- kill <player.disguised_type>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2535

Name<EntityTag.dragon_phase>
ReturnsElementTag
MechanismEntityTag.dragon_phase
DescriptionReturns the phase an EnderDragon is currently in.
Valid phases: 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/EnderDragon.Phase.html
Generated Example
- narrate <player.dragon_phase>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2454

Name<EntityTag.duration>
ReturnsDurationTag
MechanismEntityTag.duration
DescriptionReturns the Area Effect Cloud's duration.
Generated Example
- ratelimit <player> <player.duration>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L149

Name<EntityTag.duration.on_use>
ReturnsDurationTag
DescriptionReturns the duration the Area Effect Cloud
will increase by when it applies an effect to an entity.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L160

Name<EntityTag.ender_eye_target_location>
ReturnsLocationTag
MechanismEntityTag.ender_eye_target_location
DescriptionReturns a thrown eye of ender's target location - the location it's moving towards, which in vanilla is a stronghold location.
Generated Example
- teleport <player> <player.ender_eye_target_location>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityEyeTargetLocation.java#L39

Name<EntityTag.experience>
ReturnsElementTag(Number)
MechanismEntityTag.experience
DescriptionReturns the experience value of this experience orb entity.
Generated Example
- narrate "the number value is <player.experience>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2424

Name<EntityTag.explosion_fire>
ReturnsElementTag(Boolean)
MechanismEntityTag.explosion_fire
DescriptionIf this entity is explosive, returns whether its explosion creates fire.
Generated Example
- if <player.explosion_fire>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityExplosionFire.java#L57

Name<EntityTag.explosion_radius>
ReturnsElementTag(Decimal)
MechanismEntityTag.explosion_radius
DescriptionIf this entity can explode, returns its explosion radius.
Generated Example
- narrate "the decimal value is <player.explosion_radius>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityExplosionRadius.java#L62

Name<EntityTag.firework_item>
ReturnsItemTag
MechanismEntityTag.firework_item
DescriptionIf the entity is a firework, returns the firework item used to launch it.
Generated Example
- give <player.firework_item>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityFirework.java#L63

Name<EntityTag.firework_lifetime>
ReturnsDurationTag
MechanismEntityTag.firework_lifetime
DescriptionReturns the duration that a firework will live for (before detonating).
Generated Example
- ratelimit <player> <player.firework_lifetime>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityFireworkLifetime.java#L53

Name<EntityTag.flower>
ReturnsLocationTag
MechanismEntityTag.flower
DescriptionReturns the location of a bee's flower (if any).
Generated Example
- teleport <player> <player.flower>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityFlower.java#L69

Name<EntityTag.framed_item>
ReturnsItemTag
MechanismEntityTag.framed
DescriptionIf the entity is an item frame, returns the item currently framed.
Generated Example
- give <player.framed_item>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityFramed.java#L100

Name<EntityTag.framed_item_rotation>
ReturnsElementTag
MechanismEntityTag.framed
DescriptionIf the entity is an item frame, returns the rotation of the item currently framed.
Generated Example
- narrate <player.framed_item_rotation>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityFramed.java#L87

Name<EntityTag.fuse_ticks>
ReturnsElementTag(Number)
MechanismEntityTag.fuse_ticks
DescriptionReturns the number of ticks until the explosion of the primed TNT.
Generated Example
- narrate "the number value is <player.fuse_ticks>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2439

Name<EntityTag.gravity>
ReturnsElementTag(Boolean)
MechanismEntityTag.gravity
DescriptionReturns whether the entity has gravity.
Generated Example
- if <player.gravity>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityGravity.java#L62

Name<EntityTag.has_attribute[<attribute>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity has the named attribute.
Valid attribute names are listed at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/attribute/Attribute.html
See also Language:attribute modifiers.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAttributeBaseValues.java#L72

Name<EntityTag.has_custom_effect[(<effect>)]>
ReturnsElementTag(Boolean)
MechanismEntityTag.custom_effects
DescriptionReturns whether the Area Effect Cloud has a specified effect.
If no effect is specified, returns whether it has any custom effect.
Generated Example
- if <player.has_custom_effect>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L244

Name<EntityTag.has_framed_item>
ReturnsElementTag(Boolean)
MechanismEntityTag.framed
DescriptionIf the entity is an item frame, returns whether the frame has an item in it.
Generated Example
- if <player.has_framed_item>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityFramed.java#L113

Name<EntityTag.has_nectar>
ReturnsElementTag(Boolean)
MechanismEntityTag.has_nectar
DescriptionReturns whether a bee entity has nectar on it.
Generated Example
- if <player.has_nectar>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityHasNectar.java#L66

Name<EntityTag.has_pumpkin_head>
ReturnsElementTag(Boolean)
MechanismEntityTag.has_pumpkin_head
DescriptionIf the entity is a snowman, returns whether the snowman has a pumpkin on its head.
Generated Example
- if <player.has_pumpkin_head>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPumpkinHead.java#L58

Name<EntityTag.has_stung>
ReturnsElementTag(Boolean)
MechanismEntityTag.has_stung
DescriptionReturns whether a bee entity has already used its stinger.
Generated Example
- if <player.has_stung>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityHasStung.java#L66

Name<EntityTag.hive>
ReturnsLocationTag
MechanismEntityTag.hive
DescriptionReturns the location of a bee's hive (if any).
Generated Example
- teleport <player> <player.hive>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityHive.java#L69

Name<EntityTag.immune>
ReturnsElementTag(Boolean)
MechanismEntityTag.immune
DescriptionReturns whether this piglin or hoglin entity is immune to zombification.
Generated Example
- if <player.immune>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityImmune.java#L79

Name<EntityTag.in_water_duration>
ReturnsElementTag(Boolean)
MechanismEntityTag.in_water_duration
DescriptionIf the entity is a zombie mob, returns the duration of time the zombie has been in water for.
If this value exceeds 600 ticks, the zombie will begin converted to a Drowned mob.
See also Tag:EntityTag.conversion_duration
Generated Example
- if <player.in_water_duration>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityInWaterTime.java#L49

Name<EntityTag.invulnerable>
ReturnsElementTag(Boolean)
MechanismEntityTag.invulnerable
DescriptionReturns whether the entity is invulnerable (cannot be damaged).
Generated Example
- if <player.invulnerable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityInvulnerable.java#L61

Name<EntityTag.is_age_locked>
ReturnsElementTag(Boolean)
MechanismEntityTag.age_lock
DescriptionIf the entity is ageable, returns whether the entity is age locked.
Generated Example
- if <player.is_age_locked>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAge.java#L100

Name<EntityTag.is_baby>
ReturnsElementTag(Boolean)
MechanismEntityTag.age
DescriptionIf the entity is ageable, returns whether the entity is a baby.
Generated Example
- if <player.is_baby>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAge.java#L112

Name<EntityTag.is_converting>
ReturnsElementTag(Boolean)
DescriptionReturns whether an entity is currently underoing a conversion process. This can be:
A zombie villager being cured,
A zombie becoming a drowned (See also Tag:EntityTag.in_water_duration),
A husk becoming a zombie, or
A skeleton becoming a stray.
Generated Example
- if <player.is_converting>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityConversionTime.java#L75

Name<EntityTag.is_disguised[(<player>)]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity is currently disguised, either globally (if no context input given), or to the specified player.
Relates to Command:disguise.
Generated Example
- if <player.is_disguised>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2509

Name<EntityTag.is_patrol_leader>
ReturnsElementTag(Boolean)
MechanismEntityTag.is_patrol_leader
DescriptionIf the entity is raider mob (like a pillager), returns whether the entity is a patrol leader.
Generated Example
- if <player.is_patrol_leader>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPatrolLeader.java#L48

Name<EntityTag.is_showing_bottom>
ReturnsElementTag(Boolean)
MechanismEntityTag.is_showing_bottom
DescriptionIf the entity is an ender crystal, returns whether the ender crystal has its bottom showing.
Generated Example
- if <player.is_showing_bottom>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityIsShowingBottom.java#L63

Name<EntityTag.is_small>
ReturnsElementTag(Boolean)
MechanismEntityTag.is_small
DescriptionReturns whether the armor stand is small.
Generated Example
- if <player.is_small>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntitySmall.java#L61

Name<EntityTag.is_tamed>
ReturnsElementTag(Boolean)
MechanismEntityTag.tame
DescriptionReturns whether the entity has been tamed.
Generated Example
- if <player.is_tamed>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityTame.java#L72

Name<EntityTag.is_using_riptide>
ReturnsElementTag(Boolean)
MechanismEntityTag.is_using_riptide
DescriptionReturns whether this entity is using the Riptide enchantment.
Generated Example
- if <player.is_using_riptide>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityRiptide.java#L56

Name<EntityTag.item>
ReturnsItemTag
MechanismEntityTag.item
DescriptionIf the entity is a dropped item, returns the item represented by the entity.
If the entity is a trident, returns the trident item represented by the entity.
If the entity is a throwable projectile, returns the display item for that projectile.
If the entity is an eye-of-ender, returns the item to be displayed and dropped by it.
If the entity is a fireball, returns the fireball's display item.
Generated Example
- give <player.item>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityItem.java#L130

Name<EntityTag.jump_strength>
ReturnsElementTag(Number)
MechanismEntityTag.jump_strength
DescriptionReturns the power of a horse's jump.
Also applies to horse-like mobs, such as donkeys and mules.
Generated Example
- narrate "the number value is <player.jump_strength>"
Synonyms (Search Aid)entitytag.horse_jump_height
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityJumpStrength.java#L58

Name<EntityTag.knockback>
ReturnsElementTag(Number)
MechanismEntityTag.knockback
DescriptionIf the entity is an arrow or trident, returns the knockback strength of the arrow/trident.
Generated Example
- narrate "the number value is <player.knockback>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityKnockback.java#L57

Name<EntityTag.marker>
ReturnsElementTag(Boolean)
MechanismEntityTag.marker
DescriptionIf the entity is an armor stand, returns whether the armor stand is a marker.
Marker armor stands have a tiny hitbox.
Generated Example
- if <player.marker>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityMarker.java#L63

Name<EntityTag.material>
ReturnsMaterialTag
MechanismEntityTag.material
DescriptionReturns the block material associated with the entity.
For endermen, returns the material the enderman is holding.
For minecarts, returns the material the minecart is carrying.
Generated Example
- foreach <player.location.find_blocks[<player.material>].within[5]> as:loc:
    - modifyblock <[loc]> air
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityMaterial.java#L47

Name<EntityTag.max_fuse_ticks>
ReturnsElementTag(Number)
MechanismEntityTag.max_fuse_ticks
DescriptionReturns the default number of ticks until the creeper explodes when primed (NOT the time remaining if already primed).
Generated Example
- narrate "the number value is <player.max_fuse_ticks>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityMaxFuseTicks.java#L58

Name<EntityTag.owner>
ReturnsPlayerTag
MechanismEntityTag.owner
DescriptionReturns the owner of a tamed entity.
Generated Example
- heal <player.owner>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityTame.java#L85

Name<EntityTag.painting>
ReturnsElementTag
MechanismEntityTag.painting
DescriptionIf the entity is a painting, returns what art it shows.
See also Tag:server.art_types.
Generated Example
- narrate <player.painting>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPainting.java#L85

Name<EntityTag.painting_height>
ReturnsElementTag(Number)
MechanismEntityTag.painting
DescriptionIf the entity is a painting, returns its height.
Generated Example
- narrate "the number value is <player.painting_height>