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

Categories:

Base | AreaObject | BiomeTag | ChunkTag | ColorTag | CuboidTag | DurationTag | EllipsoidTag | EnchantmentTag | EntityTag | FlaggableObject | InventoryTag | ItemTag | ListTag | LocationTag | MapTag | MaterialTag | NPCTag | ObjectTag | PlayerTag | PluginTag | PolygonTag | proc | QueueTag | schematic | ScriptTag | server | tern | TimeTag | TradeTag | util | WorldTag | yaml | ElementTag | PropertyHolderObject | AreaShopTag | BigDoorsDoorTag | bungee | crackshot | DiscordBotTag | DiscordButtonTag | DiscordChannelTag | DiscordCommandTag | DiscordEmbedTag | DiscordGroupTag | DiscordInteractionTag | DiscordMessageTag | DiscordReactionTag | DiscordRoleTag | DiscordSelectionTag | 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'.
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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L513

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L457

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

Name<&dq>
ReturnsElementTag
DescriptionReturns a double-quote symbol: "
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L143

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

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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L333

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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L344

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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L355

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L434

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

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

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

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

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

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

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

Name<biome[<biome>]>
ReturnsBiomeTag
DescriptionReturns a biome object constructed from the input value.
Refer to Language:BiomeTag.
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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L667

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

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

Name<chunk[<chunk>]>
ReturnsChunkTag
DescriptionReturns a chunk object constructed from the input value.
Refer to Language:ChunkTag.
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 Language:ColorTag.
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 Language:CuboidTag.
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 Language:CustomObjectTag.
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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L688

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

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

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

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

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

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]>".
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 Language:DurationTag.
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 Language:ElementTag.
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 Language:EllipsoidTag.
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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L79

Name<enchantment[<enchantment>]>
ReturnsEnchantmentTag
DescriptionReturns an enchantment object constructed from the input value.
Refer to Language:EnchantmentTag.
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 Language:EntityTag.
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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L709

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

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

Name<inventory[<inventory>]>
ReturnsInventoryTag
DescriptionReturns an inventory object constructed from the input value.
Refer to Language:InventoryTag.
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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L807

Name<item[<item>]>
ReturnsItemTag
DescriptionReturns an item object constructed from the input value.
Refer to Language:ItemTag.
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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L758

Name<list[(<list>)]>
ReturnsListTag
DescriptionReturns a list object constructed from the input value.
Give no input to create an empty list.
Refer to Language:ListTag.
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 Language:LocationTag.
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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L779

Name<map[(<map>)]>
ReturnsMapTag
DescriptionReturns a map object constructed from the input value.
Give no input to create an empty map.
Refer to Language:MapTag.
For example: <map[a=1;b=2;c=3]>
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 Language:MaterialTag.
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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L231

Name<npc[(<npc>)]>
ReturnsNPCTag
DescriptionReturns an npc object constructed from the input value.
Refer to Language:NPCTag.
If no input value is specified, returns the linked 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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L239

Name<player[(<player>)]>
ReturnsPlayerTag
DescriptionReturns a player object constructed from the input value.
Refer to Language:PlayerTag.
If no input value is specified, returns the linked 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 Language:PluginTag.
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 Language:PolygonTag.
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 Language:QueueTag.
If no input is given, returns the current 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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L751

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

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 Language:ScriptTag.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/ScriptTagBase.java#L10

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

Name<time[<time>]>
ReturnsTimeTag
DescriptionReturns a time object constructed from the input value.
Refer to Language:TimeTag.
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 Language:TradeTag.
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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L800

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

Name<world[<world>]>
ReturnsWorldTag
DescriptionReturns a world object constructed from the input value.
Refer to Language:WorldTag.
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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L765

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

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

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 Language:DiscordButtonTag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L88

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

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

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 Language:DiscordEmbedTag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L133

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

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

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

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

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

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 Language:DiscordSelectionTag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L223

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

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.
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 Language:MythicMobsMobTag.
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 Language:MythicSpawnerTag.
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#L121

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

Name<placeholder[<name>]>
ReturnsElementTag
DescriptionReturns the value of the placeholder.
RequiresDepenizen, PlaceholderAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/PlaceholderAPIBridge.java#L48

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

Name<region[<region>]>
ReturnsWorldGuardRegionTag
DescriptionReturns a WorldGuard region object constructed from the input value.
Refer to Language:WorldGuardRegionTag.
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#L93



Category: AreaObject


Name<AreaObject.blocks[(<matcher>)]>
ReturnsListTag(LocationTag)
DescriptionReturns each block location within the area.
Optionally, specify a material match to only return locations with that block type.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L189

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

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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L78

Name<AreaObject.contains[<location>]>
ReturnsElementTag(Boolean)
DescriptionReturns a boolean indicating whether the specified location is inside this area.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L172

Name<AreaObject.entities[(<matcher>)]>
ReturnsListTag(EntityTag)
DescriptionGets a list of all entities currently within the area, with an optional search parameter for the entity.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L135

Name<AreaObject.is_within[<cuboid>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this area is fully inside another cuboid.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L257

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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L155

Name<AreaObject.npcs>
ReturnsListTag(NPCTag)
DescriptionGets a list of all NPCs currently within the area.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L116

Name<AreaObject.players>
ReturnsListTag(PlayerTag)
DescriptionGets a list of all players currently within the area.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L100

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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L247

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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L211

Name<AreaObject.with_world[<world>]>
ReturnsAreaObject
DescriptionReturns a copy of the area, with the specified world.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L300

Name<AreaObject.world>
ReturnsWorldTag
DescriptionReturns the area's world.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L90



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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L176

Name<BiomeTag.humidity>
ReturnsElementTag(Decimal)
MechanismBiomeTag.humidity
DescriptionReturns the humidity of this biome.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L198

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

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

Name<BiomeTag.temperature>
ReturnsElementTag(Decimal)
MechanismBiomeTag.temperature
DescriptionReturns the temperature of this biome.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L208



Category: ChunkTag


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

Name<ChunkTag.average_height>
ReturnsElementTag(Decimal)
DescriptionReturns the average height of the blocks in the chunk.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L541

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

Name<ChunkTag.cuboid>
ReturnsCuboidTag
DescriptionReturns a cuboid of this chunk.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L403

Name<ChunkTag.entities[(<entity>|...)]>
ReturnsListTag(EntityTag)
DescriptionReturns a list of entities in the chunk.
Optionally specify entity types to filter down to.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L438

Name<ChunkTag.force_loaded>
ReturnsElementTag(Boolean)
DescriptionReturns whether the chunk is forced to stay loaded at all times.
This is related to the Command:chunkload command.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L358

Name<ChunkTag.height_map>
ReturnsListTag
DescriptionReturns a list of the height of each block in the chunk.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L522

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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L647

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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L560

Name<ChunkTag.is_generated>
ReturnsElementTag(Boolean)
DescriptionReturns true if the chunk has already been generated.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L338

Name<ChunkTag.is_loaded>
ReturnsElementTag(Boolean)
DescriptionReturns true if the chunk is currently loaded into memory.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L348

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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L475

Name<ChunkTag.players>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of players in the chunk.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L502

Name<ChunkTag.spawn_slimes>
ReturnsElementTag(Boolean)
DescriptionReturns whether the chunk is a specially located 'slime spawner' chunk.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L633

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

Name<ChunkTag.surface_blocks>
ReturnsListTag(LocationTag)
DescriptionReturns a list of the highest non-air surface blocks in the chunk.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L588

Name<ChunkTag.tile_entities>
ReturnsListTag(LocationTag)
DescriptionReturns a list of tile entity locations in the chunk.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L414

Name<ChunkTag.world>
ReturnsWorldTag
DescriptionReturns the world associated with the chunk.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L393

Name<ChunkTag.x>
ReturnsElementTag(Number)
DescriptionReturns the x coordinate of the chunk.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L373

Name<ChunkTag.z>
ReturnsElementTag(Number)
DescriptionReturns the z coordinate of the chunk.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L383



Category: ColorTag


Name<ColorTag.blue>
ReturnsElementTag(Number)
DescriptionReturns the blue value of this color (0 to 255).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L229

Name<ColorTag.brightness>
ReturnsElementTag(Number)
DescriptionReturns the brightness value of this color (0 to 255).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L271

Name<ColorTag.green>
ReturnsElementTag(Number)
DescriptionReturns the green value of this color (0 to 255).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L219

Name<ColorTag.hex>
ReturnsElementTag
DescriptionReturns a hex code formatting of this color, like '#ff00ff'.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L199

Name<ColorTag.hsv>
ReturnsElementTag
DescriptionReturns the HSV value of this color.
EG, 100,100,255
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L281

Name<ColorTag.hue>
ReturnsElementTag(Number)
DescriptionReturns the hue value of this color (0 to 255).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L251

Name<ColorTag.mix[<color>]>
ReturnsColorTag
DescriptionReturns the color that results if you mix this color with another.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L369

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

Name<ColorTag.red>
ReturnsElementTag(Number)
DescriptionReturns the red value of this color (0 to 255).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L209

Name<ColorTag.rgb>
ReturnsElementTag
DescriptionReturns the RGB value of this color.
EG, 255,0,255
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L239

Name<ColorTag.saturation>
ReturnsElementTag(Number)
DescriptionReturns the saturation value of this color (0 to 255).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L261

Name<ColorTag.to_particle_offset>
ReturnsLocationTag
DescriptionReturns the color as a particle offset, for use with Command:playeffect.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java#L390

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

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

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

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

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

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



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

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

Name<CuboidTag.center>
ReturnsLocationTag
DescriptionReturns the location of the exact center of the cuboid.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L985

Name<CuboidTag.chunks>
ReturnsListTag(ChunkTag)
DescriptionGets a list of all chunks entirely within the CuboidTag (ignoring the Y axis).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1265

Name<CuboidTag.expand[<location>]>
ReturnsCuboidTag
DescriptionChanges the first member of the CuboidTag to be expanded 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).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1239

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

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

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

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

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

Name<CuboidTag.intersects[<cuboid>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this cuboid and another intersect.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L797

Name<CuboidTag.list_members>
ReturnsListTag(CuboidTag)
DescriptionReturns a list of all sub-cuboids in this CuboidTag (for cuboids that contain multiple sub-cuboids).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L833

Name<CuboidTag.max>
ReturnsLocationTag
DescriptionReturns the highest-numbered (maximum) corner location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1052

Name<CuboidTag.members_size>
ReturnsElementTag(Number)
DescriptionReturns the number of cuboids defined in the CuboidTag.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L762

Name<CuboidTag.min>
ReturnsLocationTag
DescriptionReturns the lowest-numbered (minimum) corner location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1074

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

Name<CuboidTag.outline>
ReturnsListTag(LocationTag)
DescriptionReturns each block location on the outline of the CuboidTag.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L772

Name<CuboidTag.outline_2d[<#.#>]>
ReturnsListTag(LocationTag)
DescriptionReturns a list of block locations along the 2D outline of this CuboidTag, at the specified Y level.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L782

Name<CuboidTag.partial_chunks>
ReturnsListTag(ChunkTag)
DescriptionGets a list of all chunks partially or entirely within the CuboidTag.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1298

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

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

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

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

Name<CuboidTag.size>
ReturnsLocationTag
DescriptionReturns the size of the cuboid.
Effectively equivalent to: (max - min) + (1,1,1)
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1026

Name<CuboidTag.volume>
ReturnsElementTag(Number)
DescriptionReturns the volume of the cuboid.
Effectively equivalent to: (size.x * size.y * size.z).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1013

Name<CuboidTag.with_max[<location>]>
ReturnsCuboidTag
DescriptionChanges the first member of the CuboidTag 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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1221

Name<CuboidTag.with_min[<location>]>
ReturnsCuboidTag
DescriptionChanges the first member of the CuboidTag 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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1203

Name<CuboidTag.has_region>
ReturnsElementTag(Boolean)
DescriptionReturns whether the cuboid contains any region.
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.
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.
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.
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.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L426

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

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

Name<DurationTag.in_days>
ReturnsElementTag(Decimal)
Descriptionreturns the number of days in the duration.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L352

Name<DurationTag.in_hours>
ReturnsElementTag(Decimal)
Descriptionreturns the number of hours in the duration.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L362

Name<DurationTag.in_milliseconds>
ReturnsElementTag(Decimal)
Descriptionreturns the number of milliseconds in the duration.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L392

Name<DurationTag.in_minutes>
ReturnsElementTag(Decimal)
Descriptionreturns the number of minutes in the duration.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L372

Name<DurationTag.in_seconds>
ReturnsElementTag(Decimal)
Descriptionreturns the number of seconds in the duration.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L382

Name<DurationTag.in_ticks>
ReturnsElementTag(Number)
Descriptionreturns the number of ticks in the duration. (20t/second)
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L402

Name<DurationTag.in_weeks>
ReturnsElementTag(Decimal)
Descriptionreturns the number of weeks in the duration.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L342

Name<DurationTag.in_years>
ReturnsElementTag(Decimal)
Descriptionreturns the number of years in the duration.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L332

Name<DurationTag.sub[<duration>]>
ReturnsDurationTag
Descriptionreturns this duration minus another.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L412

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

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

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

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



Category: EllipsoidTag


Name<EllipsoidTag.add[<location>]>
ReturnsEllipsoidTag
DescriptionReturns a copy of this ellipsoid, shifted by the input location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L455

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).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L547

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

Name<EllipsoidTag.location>
ReturnsLocationTag
DescriptionReturns the location of the ellipsoid.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L435

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

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

Name<EllipsoidTag.size>
ReturnsLocationTag
DescriptionReturns the size of the ellipsoid.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L445

Name<EllipsoidTag.with_location[<location>]>
ReturnsEllipsoidTag
DescriptionReturns a copy of this ellipsoid, set to the specified location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L519

Name<EllipsoidTag.with_size[<location>]>
ReturnsEllipsoidTag
DescriptionReturns a copy of this ellipsoid, set to the specified size.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L533



Category: EnchantmentTag


Name<EnchantmentTag.can_enchant[<item>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this enchantment can enchant the given ItemTag (based on material mainly).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L292

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
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L271

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

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]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L370

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

Name<EnchantmentTag.is_compatible[<enchantment>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this enchantment is compatible with another given enchantment.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L305

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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L261

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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L250

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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L240

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

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

Name<EnchantmentTag.max_level>
ReturnsElementTag(Number)
DescriptionReturns the minimum level of this enchantment. Usually between 1 and 5.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L220

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

Name<EnchantmentTag.min_level>
ReturnsElementTag(Number)
DescriptionReturns the minimum level of this enchantment. Usually '1'.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L210

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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L157

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

Name<EnchantmentTag.script>
ReturnsScriptTag
DescriptionReturns the script that created this enchantment type, if any.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L193

Name<EnchantmentTag.treasure_only>
ReturnsElementTag(Boolean)
DescriptionReturns whether this enchantment is only for spawning as treasure.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L230



Category: EntityTag


Name<EntityTag.absorption_health>
ReturnsElementTag(Decimal)
MechanismEntityTag.absorption_health
DescriptionReturns the living entity's absorption health.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1994

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

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

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

Name<EntityTag.attack_cooldown_duration>
ReturnsDurationTag
MechanismEntityTag.attack_cooldown
DescriptionReturns the amount of time that passed since the start of the attack cooldown.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2781

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

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

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

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

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 URL:https://minecraft.fandom.com/wiki/Fishing for more info.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2704

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

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

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

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

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

Name<EntityTag.is_sleeping>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player, NPC, or villager is currently sleeping.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1914

Name<EntityTag.is_trading>
ReturnsElementTag(Boolean)
DescriptionReturns whether the villager entity is trading.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1380

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

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

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

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

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

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

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

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

Name<EntityTag.trades>
ReturnsListTag(TradeTag)
MechanismEntityTag.trades
DescriptionReturns a list of the Villager's trade recipes.
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.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1393

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

Name<EntityTag.list_effects>
ReturnsListTag
MechanismEntityTag.potion_effects
DescriptionReturns the list of active potion effects on the entity, in the format: TYPE,AMPLIFIER,DURATION,IS_AMBIENT,HAS_PARTICLES,HAS_ICON|...
Note that AMPLIFIER is a number representing the level, and DURATION is a number representing the time, in ticks, it will last for.
IS_AMBIENT, HAS_PARTICLES, and HAS_ICON are booleans.
The effect type will be from URL:https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionEffectType.html.
Groupattribute
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPotionEffects.java#L83

Name<EntityTag.armor_bonus>
ReturnsElementTag(Decimal)
MechanismEntityTag.armor_bonus
DescriptionReturns the entity's base armor bonus.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityArmorBonus.java#L64

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

Name<EntityTag.armor_pose_list>
ReturnsListTag
MechanismEntityTag.armor_pose
DescriptionDeprecated in favor of Tag:EntityTag.armor_pose_map
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityArmorPose.java#L92

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!
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityArmorPose.java#L78

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

Name<EntityTag.breeding>
ReturnsElementTag(Boolean)
MechanismEntityTag.breed
DescriptionReturns whether the animal entity is trying to with another of its kind.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1791

Name<EntityTag.can_breed>
ReturnsElementTag(Boolean)
MechanismEntityTag.can_breed
DescriptionReturns whether the animal entity is capable of mating with another of its kind.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1776

Name<EntityTag.can_pickup_items>
ReturnsElementTag(Boolean)
MechanismEntityTag.can_pickup_items
DescriptionReturns whether the entity can pick up items.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1600

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

Name<EntityTag.custom_name_visible>
ReturnsElementTag(Boolean)
MechanismEntityTag.custom_name_visible
DescriptionReturns true if the entity's custom name is visible.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityCustomNameVisible.java#L54

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

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

Name<EntityTag.fall_distance>
ReturnsElementTag(Decimal)
MechanismEntityTag.fall_distance
DescriptionReturns how far the entity has fallen.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1630

Name<EntityTag.fallingblock_material>
ReturnsMaterialTag
MechanismEntityTag.fallingblock_type
DescriptionReturns the material of a fallingblock-type entity.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1615

Name<EntityTag.fire_time>
ReturnsDurationTag
MechanismEntityTag.fire_time
DescriptionReturns the duration for which the entity will remain on fire
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1642

Name<EntityTag.fixed>
ReturnsElementTag(Boolean)
MechanismEntityTag.fixed
DescriptionReturns whether the item frame is fixed. (Meaning, it can't be altered by players).
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'.
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).
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.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2198

Name<EntityTag.glowing>
ReturnsElementTag(Boolean)
MechanismEntityTag.glowing
DescriptionReturns whether this entity is glowing.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2223

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.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAI.java#L57

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 URL: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#L102

Name<EntityTag.has_passenger>
ReturnsElementTag(Boolean)
MechanismEntityTag.passenger
DescriptionReturns whether the entity has a passenger.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1806

Name<EntityTag.health>
ReturnsElementTag(Decimal)
MechanismEntityTag.health
DescriptionReturns the current health of the entity.
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.
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.
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.
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.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAware.java#L46

Name<EntityTag.is_collidable>
ReturnsElementTag(Boolean)
MechanismEntityTag.collidable
DescriptionReturns whether the entity is collidable.
Returns the persistent collidable value for NPCs.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1898

Name<EntityTag.is_empty>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity does not have a passenger.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1818

Name<EntityTag.is_in_block>
ReturnsElementTag(Boolean)
DescriptionReturns whether or not the arrow/trident entity is in a block.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2163

Name<EntityTag.is_inside_vehicle>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity is inside a vehicle.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1829

Name<EntityTag.is_leashed>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity is leashed.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1840

Name<EntityTag.is_on_ground>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity is supported by a block.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1865

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).
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1876

Name<EntityTag.is_sheared>
ReturnsElementTag(Boolean)
DescriptionReturns whether a sheep is sheared.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1851

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

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

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

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

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

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

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).
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.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2005

Name<EntityTag.on_fire>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity is currently ablaze or not.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1654

Name<EntityTag.oxygen>
ReturnsDurationTag
MechanismEntityTag.oxygen
DescriptionReturns the duration of oxygen the entity has left.
Works with offline players.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2017

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

Name<EntityTag.passengers>
ReturnsListTag(EntityTag)
MechanismEntityTag.passengers
DescriptionReturns a list of the entity's passengers, if any.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1680

Name<EntityTag.persistent>
ReturnsElementTag(Boolean)
MechanismEntityTag.persistent
DescriptionOutdated form of Tag:EntityTag.is_persistent
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1885

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

Name<EntityTag.scoreboard_tags>
ReturnsListTag
MechanismEntityTag.scoreboard_tags
DescriptionReturns a list of the scoreboard tags on the entity.
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, if any.
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#L1711

Name<EntityTag.silent>
ReturnsElementTag(Boolean)
MechanismEntityTag.silent
DescriptionReturns whether the entity is silent. (Plays no sounds)
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.
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.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2210

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

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

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

Name<EntityTag.visible>
ReturnsElementTag(Boolean)
MechanismEntityTag.visible
DescriptionReturns whether the armor stand or item frame is visible.
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityVisible.java#L77

Name<EntityTag.eid>
ReturnsElementTag(Number)
DescriptionReturns the entity's temporary server entity ID.
Groupdata
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1238

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

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

Name<EntityTag.is_mob>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity type is a mob (Not a player or NPC).
Groupdata
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2268

Name<EntityTag.is_monster>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity type is a hostile monster.
Groupdata
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2254

Name<EntityTag.is_npc>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity is a Citizens NPC.
Groupdata
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2283

Name<EntityTag.is_player>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity is a player.
Works with offline players.
Groupdata
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2294

Name<EntityTag.is_projectile>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity type is a projectile.
Groupdata
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2306

Name<EntityTag.is_spawned>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity is spawned.
Groupdata
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1227

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

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

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

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

Name<EntityTag.advanced_matches[<matcher>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity matches some matcher text, using the system behind Language:Advanced Script Event Matching.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2559

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 Script Event 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#L2573

Name<EntityTag.equipment>
ReturnsListTag(ItemTag)
MechanismEntityTag.equipment
DescriptionReturns a ListTag containing the entity's equipment.
Output list is boots|leggings|chestplate|helmet
Groupinventory
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityEquipment.java#L115

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.
Groupinventory
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityEquipment.java#L128

Name<EntityTag.has_saddle>
ReturnsElementTag(Boolean)
DescriptionIf the entity is a pig or horse, returns whether it has a saddle equipped.
Groupinventory
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1360

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

Name<EntityTag.inventory>
ReturnsInventoryTag
DescriptionReturns the entity's inventory, if it has one.
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.
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.
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.
Groupinventory
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1326

Name<EntityTag.body_yaw>
ReturnsElementTag(Decimal)
DescriptionReturns the entity's body yaw (separate from head yaw).
Grouplocation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1561

Name<EntityTag.can_see[<entity>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity can see the specified other entity (has an uninterrupted line-of-sight).
Grouplocation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1444

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 include passable blocks.
Grouplocation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1509

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).
This uses logic equivalent to Tag:LocationTag.precise_cursor_on_block[(range)].
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.
Grouplocation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1486

Name<EntityTag.eye_height>
ReturnsElementTag(Number)
DescriptionReturns the height of the entity's eyes above its location.
Grouplocation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1472

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

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

Name<EntityTag.map_trace>
ReturnsLocationTag
DescriptionReturns a 2D location indicating where on the map the entity's looking at.
Each coordinate is in the range of 0 to 128.
Grouplocation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1410

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).
Grouplocation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1546

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

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

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.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAge.java#L129

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

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.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityColor.java#L244

Name<EntityTag.anger>
ReturnsDurationTag
MechanismEntityTag.anger
DescriptionReturns the remaining anger time of a PigZombie or Bee.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAnger.java#L75

Name<EntityTag.angry>
ReturnsElementTag(Boolean)
MechanismEntityTag.angry
DescriptionIf the entity is a wolf or PigZombie, returns whether the entity is angry.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAngry.java#L75

Name<EntityTag.arms>
ReturnsElementTag(Boolean)
MechanismEntityTag.arms
DescriptionIf the entity is an armor stand, returns whether the armor stand has arms.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityArms.java#L63

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

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 URL: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#L135

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.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAttributeModifiers.java#L235

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 URL: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#L93

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.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityBasePlate.java#L63

Name<EntityTag.base_potion>
ReturnsElementTag
MechanismEntityTag.base_potion
DescriptionReturns the Area Effect Cloud's base potion data.
In the format Type,Upgraded,Extended
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.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityBeamTarget.java#L59

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.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityBoatType.java#L58

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.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityBodyArrows.java#L65

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.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityBoundingBox.java#L83

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.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityCanJoinRaid.java#L48

Name<EntityTag.cannot_enter_hive>
ReturnsDurationTag
MechanismEntityTag.cannot_enter_hive
DescriptionReturns the minimum duration until a Bee entity is allowed to enter a 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
DescriptionIf the entity is a horse, returns whether it is carrying a chest.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityChestCarrier.java#L58

Name<EntityTag.charged>
ReturnsElementTag(Boolean)
MechanismEntityTag.charged
DescriptionIf the entity is wither_skull, returns whether the skull is charged. Charged skulls are blue.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityCharged.java#L48

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.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityColor.java#L262

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

Name<EntityTag.critical>
ReturnsElementTag(Boolean)
MechanismEntityTag.critical
DescriptionIf the entity is an arrow or trident, returns whether the arrow/trident is critical.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityCritical.java#L62

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|...
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.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityArrowDamage.java#L56

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

Name<EntityTag.disabled_slots>
ReturnsListTag
MechanismEntityTag.disabled_slots
DescriptionIf the entity is an armor stand, returns a list of its disabled slots in the form slot/action|...
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityDisabledSlots.java#L103

Name<EntityTag.disabled_slots.raw>
ReturnsElementTag(Number)
MechanismEntityTag.disabled_slots_raw
DescriptionIf the entity is an armor stand, returns its raw disabled slots value.
See URL:https://minecraft.fandom.com/wiki/Armor_Stand/ED
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityDisabledSlots.java#L89

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

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

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

Name<EntityTag.duration>
ReturnsDurationTag
MechanismEntityTag.duration
DescriptionReturns the Area Effect Cloud's 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.experience>
ReturnsElementTag(Number)
MechanismEntityTag.experience
DescriptionReturns the experience value of this experience orb entity.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2366

Name<EntityTag.explosion_fire>
ReturnsElementTag(Boolean)
MechanismEntityTag.explosion_fire
DescriptionIf this entity is explosive, returns whether its explosion creates fire.
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.
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.
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).
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).
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.
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.
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.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2381

Name<EntityTag.gravity>
ReturnsElementTag(Boolean)
MechanismEntityTag.gravity
DescriptionReturns whether the entity has gravity.
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 URL: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#L78

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.
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.
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.
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.
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.
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).
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.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityImmune.java#L79

Name<EntityTag.invulnerable>
ReturnsElementTag(Boolean)
MechanismEntityTag.invulnerable
DescriptionReturns whether the entity is invulnerable (cannot be damaged).
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.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAge.java#L146

Name<EntityTag.is_baby>
ReturnsElementTag(Boolean)
MechanismEntityTag.age
DescriptionIf the entity is ageable, returns whether the entity is a baby.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAge.java#L159

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

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.
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.
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.
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.
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.
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 an enderman, returns the item that the enderman is holding.
If the entity is a trident, returns the trident item represented by the entity.
If the item is a throwable projectile, returns the item that was thrown.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityItem.java#L105

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.
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.
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.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityMarker.java#L63

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).
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.
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.
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.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPainting.java#L72

Name<EntityTag.painting_width>
ReturnsElementTag(Number)
MechanismEntityTag.painting
DescriptionIf the entity is a painting, returns its width.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPainting.java#L59

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

Name<EntityTag.particle.color>
ReturnsColorTag
DescriptionReturns the Area Effect Cloud's particle color.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L134

Name<EntityTag.patrol_target>
ReturnsLocationTag
MechanismEntityTag.patrol_target
DescriptionIf the entity is raider mob (like a pillager), returns whether the entity is allowed to join active raids.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPatrolTarget.java#L53

Name<EntityTag.pickup_status>
ReturnsElementTag
MechanismEntityTag.pickup_status
DescriptionIf the entity is an arrow or trident, returns the pickup status of the arrow/trident.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPickupStatus.java#L56

Name<EntityTag.player_created>
ReturnsElementTag(Boolean)
MechanismEntityTag.player_created
DescriptionReturns whether this Iron_Golem was created by a player.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPlayerCreated.java#L62

Name<EntityTag.potion>
ReturnsItemTag
MechanismEntityTag.potion
DescriptionIf the entity is a Tipped Arrow, returns an ItemTag of a potion with the base potion data of the arrow.
If the entity is a Splash Potion, returns an ItemTag of the splash potion's full potion data.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPotion.java#L86

Name<EntityTag.powered>
ReturnsElementTag(Boolean)
MechanismEntityTag.powered
DescriptionIf the entity is a creeper, returns whether the creeper is powered.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPowered.java#L75

Name<EntityTag.profession>
ReturnsElementTag
MechanismEntityTag.profession
DescriptionIf the entity can have professions, returns the entity's profession.
Currently, only Villager-type and infected zombie entities can have professions.
For the list of possible professions, refer to URL:https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/Villager.Profession.html
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityProfession.java#L80

Name<EntityTag.radius>
ReturnsElementTag(Decimal)
MechanismEntityTag.radius
DescriptionReturns the Area Effect Cloud's radius.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L176

Name<EntityTag.radius.on_use>
ReturnsElementTag(Decimal)
DescriptionReturns the amount the Area Effect Cloud's radius
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#L187

Name<EntityTag.radius.per_tick>
ReturnsElementTag(Decimal)
DescriptionReturns the amount the Area Effect Cloud's radius
will increase by every tick.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L200

Name<EntityTag.reapplication_delay>
ReturnsDurationTag
MechanismEntityTag.reapplication_delay
DescriptionReturns the duration an entity will be immune
from the Area Effect Cloud's subsequent exposure.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L216

Name<EntityTag.rotation>
ReturnsElementTag
MechanismEntityTag.rotation
DescriptionIf the entity can have a rotation, returns the entity's rotation.
Currently, only Hanging-type entities can have rotations.
Value is from URL:https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/BlockFace.html.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityRotation.java#L87

Name<EntityTag.rotation_vector>
ReturnsLocationTag
MechanismEntityTag.rotation
DescriptionIf the entity can have a rotation, returns the entity's rotation as a direction vector.
Currently, only Hanging-type entities can have rotations.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityRotation.java#L73

Name<EntityTag.shulker_peek>
ReturnsElementTag(Number)
MechanismEntityTag.shulker_peek
DescriptionReturns the peek value of a shulker box (where 0 is fully closed, 100 is fully open).
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityShulkerPeek.java#L59

Name<EntityTag.sitting>
ReturnsElementTag(Boolean)
MechanismEntityTag.sitting
DescriptionIf the entity is a wolf, cat, or parrot, returns whether the animal is sitting.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntitySitting.java#L61

Name<EntityTag.size>
ReturnsElementTag(Number)
MechanismEntityTag.size
DescriptionReturns the size of a slime-type entity or a Phantom (1-120).
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntitySize.java#L63

Name<EntityTag.source>
ReturnsEntityTag
MechanismEntityTag.source
DescriptionReturns the source of the Area Effect Cloud.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L267

Name<EntityTag.spell>
ReturnsElementTag
MechanismEntityTag.spell
DescriptionReturns the spell the entity is currently casting.
Can be: URL:https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/Spellcaster.Spell.html
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntitySpell.java#L57

Name<EntityTag.strength>
ReturnsElementTag
MechanismEntityTag.strength
DescriptionReturns the strength of a Llama. A llama's inventory contains (strength times three) slots.
Can be from 1 to 5 (inclusive).
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityStrength.java#L52

Name<EntityTag.tameable>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity is tameable.
If this returns true, it will enable access to:
Mechanism:EntityTag.tame, Mechanism:EntityTag.owner,
Tag:EntityTag.is_tamed, and Tag:EntityTag.owner
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2324

Name<EntityTag.villager_experience>
ReturnsElementTag(Number)
MechanismEntityTag.villager_experience
DescriptionReturns the experience amount of a villager.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityVillagerExperience.java#L58

Name<EntityTag.villager_level>
ReturnsElementTag(Number)
MechanismEntityTag.villager_level
DescriptionReturns the level of a villager.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityVillagerLevel.java#L58

Name<EntityTag.wait_time>
ReturnsDurationTag
MechanismEntityTag.wait_time
DescriptionReturns the duration an entity must be exposed to
the Area Effect Cloud before its effect is applied.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L230

Name<EntityTag.weapon_damage[(<entity>)]>
ReturnsElementTag(Number)
DescriptionReturns the amount of damage the entity will do based on its held item.
Optionally, specify a target entity to test how much damage will be done to that specific target
(modified based on enchantments and that entity's armor/status/etc).
Note that the result will not always be completely exact, as it doesn't take into account some specific factors
(eg sweeping vs single-hit, etc).
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2412

Name<EntityTag.crackshot_weapon>
ReturnsElementTag
DescriptionReturns the CrackShot weapon name that the projectile was shot from.
RequiresDepenizen, CrackShot
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/crackshot/CrackShotEntityProperties.java#L58

Name<EntityTag.is_mythicmob>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity is a MythicMob.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mythicmobs/MythicMobsEntityProperties.java#L53

Name<EntityTag.is_shopkeeper>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity is a Shopkeeper.
RequiresDepenizen, ShopKeepers
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/shopkeepers/ShopKeepersEntityProperties.java#L62

Name<EntityTag.libsdisguise_disguise>
ReturnsLibsDisguiseTag
DescriptionReturns the disguise of the entity.
RequiresDepenizen, LibsDisguises
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/libsdisguise/LibsDisguiseEntityProperties.java#L71

Name<EntityTag.libsdisguise_is_disguised>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity is in a disguise.
RequiresDepenizen, LibsDisguises
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/libsdisguise/LibsDisguiseEntityProperties.java#L60

Name<EntityTag.mcmmo.is_spawned_mob>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity is tracked by McMMO as a 'spawned' mob (one from a spawner block or spawn egg).
RequiresDepenizen, mcMMO
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mcmmo/McMMOEntityProperties.java#L62

Name<EntityTag.mythicmob>
ReturnsMythicMobsMobTag
DescriptionReturns the MythicMob for this entity.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mythicmobs/MythicMobsEntityProperties.java#L64

Name<EntityTag.shopkeeper>
ReturnsShopKeeperTag
DescriptionReturns the ShopKeeper for this entity.
RequiresDepenizen, ShopKeepers
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/shopkeepers/ShopKeepersEntityProperties.java#L74

Name<EntityTag.can_tick>
ReturnsElementTag(Boolean)
MechanismEntityTag.can_tick
DescriptionIf the entity is an armor stand, returns whether the armor stand can tick.
Groupproperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityCanTick.java#L47

Name<EntityTag.from_spawner>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity was spawned from a spawner.
Groupproperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperEntityProperties.java#L143

Name<EntityTag.spawn_location>
ReturnsLocationTag
DescriptionReturns the initial spawn location of this entity.
Groupproperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperEntityProperties.java#L130

Name<EntityTag.spawn_reason>
ReturnsElementTag
DescriptionReturns the entity's spawn reason.
Valid spawn reasons can be found at URL:https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/CreatureSpawnEvent.SpawnReason.html
Groupproperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperEntityProperties.java#L50

Name<EntityTag.xp_source>
ReturnsEntityTag
DescriptionIf the entity is an experience orb, returns the entity that it was created from (if any).
For example, if the xp orb was spawned from breeding this would return the baby.
Groupproperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperEntityProperties.java#L105

Name<EntityTag.xp_spawn_reason>
ReturnsElementTag
DescriptionIf the entity is an experience orb, returns its spawn reason.
Valid spawn reasons can be found at URL:https://papermc.io/javadocs/paper/1.17/org/bukkit/entity/ExperienceOrb.SpawnReason.html
Groupproperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperEntityProperties.java#L63

Name<EntityTag.xp_trigger>
ReturnsEntityTag
DescriptionIf the entity is an experience orb, returns the entity that triggered it spawning (if any).
For example, if a player killed an entity this would return the player.
Groupproperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperEntityProperties.java#L80



Category: FlaggableObject


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

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

Name<FlaggableObject.flag_map>
ReturnsMapTag
DescriptionReturns a raw map of the objects internal flag data.
Note that this is exclusively for debug/testing reasons, and should never be used in a real script.
See Language:flag system.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L96

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

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



Category: InventoryTag


Name<InventoryTag.anvil_max_repair_cost>
ReturnsElementTag(Number)
MechanismInventoryTag.anvil_max_repair_cost
DescriptionReturns the maximum repair cost on an anvil.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2220

Name<InventoryTag.anvil_rename_text>
ReturnsElementTag
DescriptionReturns the current entered renaming text on an anvil.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2234

Name<InventoryTag.anvil_repair_cost>
ReturnsElementTag(Number)
MechanismInventoryTag.anvil_repair_cost
DescriptionReturns the current repair cost on an anvil.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2206

Name<InventoryTag.can_fit[<item>|...]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the inventory can fit an item.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1158

Name<InventoryTag.can_fit[<item>].count>
ReturnsElementTag(Number)
DescriptionReturns the total count of how many times an item can fit into an inventory.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1184

Name<InventoryTag.can_fit[<item>].quantity[<#>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the inventory can fit a certain quantity of an item.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1203

Name<InventoryTag.contains_item[<matcher>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the inventory contains any item that matches the specified item matcher.
Uses the system behind Language:Advanced Script Event Matching.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1396

Name<InventoryTag.contains_item[<matcher>].quantity[<#>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the inventory contains a certain number of items that match the specified item matcher.
Uses the system behind Language:Advanced Script Event Matching.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1410

Name<InventoryTag.contains.display[(strict:)<element>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the inventory contains an item with the specified display name.
Use 'strict:' in front of the search element to ensure the display name is EXACTLY the search element,
otherwise the searching will only check if the search element is contained in the display name.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1436

Name<InventoryTag.contains.display[(strict:)<element>].quantity[<#>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the inventory contains a certain quantity of an item with the specified display name.
Use 'strict:' in front of the search element to ensure the display name is EXACTLY the search element,
otherwise the searching will only check if the search element is contained in the display name.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1459

Name<InventoryTag.contains.lore[(strict:)<element>|...]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the inventory contains an item with the specified lore.
Use 'strict:' in front of the search elements to ensure all lore lines are EXACTLY the search elements,
otherwise the searching will only check if the search elements are contained in the lore.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1518

Name<InventoryTag.contains.lore[(strict:)<element>|...].quantity[<#>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the inventory contains a certain quantity of an item with the specified lore.
Use 'strict:' in front of the search elements to ensure all lore lines are EXACTLY the search elements,
otherwise the searching will only check if the search elements are contained in the lore.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1542

Name<InventoryTag.craftable_quantity>
ReturnsElementTag(Number)
DescriptionReturns the quantity of items that would be received if this crafting inventory were fully crafted (eg via a shift click).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2162

Name<InventoryTag.empty_slots>
ReturnsElementTag(Number)
DescriptionReturns the number of empty slots in an inventory.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1135

Name<InventoryTag.equipment>
ReturnsListTag(ItemTag)
DescriptionReturns the equipment of an inventory as a list of items.
For players, the order is boots|leggings|chestplate|helmet.
For horses, the order is saddle|armor.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2106

Name<InventoryTag.equipment_map>
ReturnsMapTag
DescriptionReturns a MapTag containing the inventory's equipment.
Output keys for players are boots, leggings, chestplate, helmet.
Output keys for horses are saddle, armor.
Air items will be left out of the map.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2093

Name<InventoryTag.exclude_item[<item_matcher>]>
ReturnsInventoryTag
DescriptionReturns a copy of the InventoryTag with all matching items excluded.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1274

Name<InventoryTag.exclude_item[<item_matcher>].quantity[<#>]>
ReturnsInventoryTag
DescriptionReturns the InventoryTag with a certain quantity of matching items excluded.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1297

Name<InventoryTag.find_all_items[<matcher>]>
ReturnsListTag
DescriptionReturns a list of the location of all slots that contains an item that matches the given item matcher.
Returns an empty list if there's no match.
Uses the system behind Language:Advanced Script Event Matching.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1830

Name<InventoryTag.find_item[<matcher>]>
ReturnsElementTag(Number)
DescriptionReturns the location of the first slot that contains an item that matches the given item matcher.
Returns -1 if there's no match.
Uses the system behind Language:Advanced Script Event Matching.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1806

Name<InventoryTag.first_empty>
ReturnsElementTag(Number)
DescriptionReturns the location of the first empty slot.
Returns -1 if the inventory is full.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1794

Name<InventoryTag.fuel>
ReturnsItemTag
MechanismInventoryTag.fuel
DescriptionReturns the item currently in the fuel section of a furnace or brewing stand inventory.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2247

Name<InventoryTag.id_type>
ReturnsElementTag
DescriptionReturns Denizen's type ID for this inventory (player, location, etc.).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1934

Name<InventoryTag.include[<item>|...]>
ReturnsInventoryTag
DescriptionReturns a copy of the InventoryTag with items added.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1230

Name<InventoryTag.include[<item>].quantity[<#>]>
ReturnsInventoryTag
DescriptionReturns the InventoryTag with a certain quantity of an item added.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1252

Name<InventoryTag.input>
ReturnsItemTag
MechanismInventoryTag.input
DescriptionReturns the item currently in the smelting slot of a furnace inventory, or the ingredient slot of a brewing stand inventory.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2264

Name<InventoryTag.inventory_type>
ReturnsElementTag
DescriptionReturns the type of the inventory (e.g. "PLAYER", "CRAFTING", "HORSE").
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2083

Name<InventoryTag.is_empty>
ReturnsElementTag(Boolean)
DescriptionReturns whether the inventory is empty.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1359

Name<InventoryTag.is_full>
ReturnsElementTag(Boolean)
DescriptionReturns whether the inventory is completely full.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1376

Name<InventoryTag.location>
ReturnsLocationTag
DescriptionReturns the location of this inventory's holder.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1958

Name<InventoryTag.matrix>
ReturnsListTag(ItemTag)
MechanismInventoryTag.matrix
DescriptionReturns the items currently in a crafting inventory's matrix.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2118

Name<InventoryTag.note_name>
ReturnsElementTag
DescriptionGets the name of a noted InventoryTag. If the inventory isn't noted, this is null.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1944

Name<InventoryTag.quantity_item[(<matcher>)]>
ReturnsElementTag(Number)
DescriptionReturns the combined quantity of itemstacks that match an item matcher if one is specified,
or the combined quantity of all itemstacks if one is not.
Uses the system behind Language:Advanced Script Event Matching.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1968

Name<InventoryTag.recipe>
ReturnsElementTag
DescriptionReturns the recipe ID for the recipe currently formed in a crafting inventory.
Returns a list in the Namespace:Key format, for example "minecraft:stick".
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2141

Name<InventoryTag.result>
ReturnsItemTag
MechanismInventoryTag.result
DescriptionReturns the item currently in the result section of a crafting inventory or furnace inventory.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2182

Name<InventoryTag.slot[<#>|...]>
ReturnsObjectTag
DescriptionIf one slot is specified, returns the ItemTag in the specified slot.
If more than one slot is specified, returns a ListTag(ItemTag) of the item in each given slot.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2039

Name<InventoryTag.stacks[(<item>)]>
ReturnsElementTag(Number)
DescriptionReturns the number of itemstacks that match an item if one is specified, or the number of all itemstacks if one is not.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2024

Name<InventoryTag.advanced_matches[<matcher>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the inventory matches some matcher text, using the system behind Language:Advanced Script Event Matching.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2282

Name<InventoryTag.id_holder>
ReturnsObjectTag
DescriptionReturns Denizen's holder ID for this inventory. (player object, location object, etc.)
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventoryHolder.java#L52

Name<InventoryTag.list_contents>
ReturnsListTag(ItemTag)
MechanismInventoryTag.contents
DescriptionReturns a list of all items in the inventory.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventoryContents.java#L134

Name<InventoryTag.list_contents.simple>
ReturnsListTag(ItemTag)
MechanismInventoryTag.contents
DescriptionReturns a list of all items in the inventory, without item properties.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventoryContents.java#L144

Name<InventoryTag.list_contents.with_lore[<element>]>
ReturnsListTag(ItemTag)
MechanismInventoryTag.contents
DescriptionReturns a list of all items in the inventory with the specified
lore. Color codes are ignored.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventoryContents.java#L157

Name<InventoryTag.list_contents.with_lore[<element>].simple>
ReturnsListTag(ItemTag)
MechanismInventoryTag.contents
DescriptionReturns a list of all items in the inventory with the specified
lore, without item properties. Color codes are ignored.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventoryContents.java#L175

Name<InventoryTag.map_slots>
ReturnsMapTag
DescriptionReturns a map of inventory slots to the items in those slots (excludes air).
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventoryContents.java#L115

Name<InventoryTag.script>
ReturnsScriptTag
DescriptionReturns the script that this inventory came from (if any).
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventoryHolder.java#L63

Name<InventoryTag.size>
ReturnsElementTag(Number)
MechanismInventoryTag.size
DescriptionReturn the number of slots in the inventory.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventorySize.java#L63

Name<InventoryTag.title>
ReturnsElementTag
MechanismInventoryTag.title
DescriptionReturns the title of the inventory.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventoryTitle.java#L67

Name<InventoryTag.trades>
ReturnsListTag(TradeTag)
MechanismInventoryTag.trades
DescriptionReturn the list of recipes from a merchant inventory.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventoryTrades.java#L61

Name<InventoryTag.is_bossshop>
ReturnsElementTag(Boolean)
DescriptionReturns whether the inventory is a BossShop.
RequiresDepenizen, BossShopPro
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/bossshop/BossShopInventoryProperties.java#L60



Category: ItemTag


Name<ItemTag.has_potion_effect>
ReturnsElementTag(Boolean)
MechanismItemTag.potion_effects
DescriptionReturns whether the potion has a potion effect.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L182

Name<ItemTag.recipe_ids[(<type>)]>
ReturnsListTag
DescriptionIf the item is a scripted item, returns a list of all recipe IDs created by the item script.
Others, returns a list of all recipe IDs that the server lists as capable of crafting the item.
Returns a list in the Namespace:Key format, for example "minecraft:gold_nugget".
Optionally, specify a recipe type (CRAFTING, FURNACE, COOKING, BLASTING, SHAPED, SHAPELESS, SMOKING, STONECUTTING)
to limit to just recipes of that type.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L640

Name<ItemTag.bukkit_serial>
ReturnsElementTag
DescriptionReturns a YAML text section representing the Bukkit serialization of the item, under subkey "item".
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L616

Name<ItemTag.json>
ReturnsElementTag
DescriptionReturns the item converted to a raw JSON object with one layer of escaping for network transmission.
EG, via /tellraw.
Generally, prefer tags like Tag:ElementTag.on_hover.type with type 'show_item'.
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L591

Name<ItemTag.material>
ReturnsMaterialTag
MechanismItemTag.material
DescriptionReturns the MaterialTag that is the basis of the item.
EG, a stone with lore and a display name, etc. will return only "[email protected]".
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L567

Name<ItemTag.meta_type>
ReturnsElementTag
DescriptionReturns the name of the Bukkit item meta type that applies to this item.
This is for debugging purposes.
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L604

Name<ItemTag.simple>
ReturnsElementTag
DescriptionReturns a simple reusable item identification for this item, with minimal extra data.
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L629

Name<ItemTag.scriptname>
ReturnsElementTag
DescriptionUse ".script.name" instead.
Groupdata
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemScript.java#L57

Name<ItemTag.advanced_matches[<matcher>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the item matches some matcher text, using the system behind Language:Advanced Script Event Matching.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L686

Name<ItemTag.formatted>
ReturnsElementTag
DescriptionReturns the formatted material name of the item to be used in a sentence.
Correctly uses singular and plural forms of item names, among other things.
Groupformatting
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L674

Name<ItemTag.all_raw_nbt>
ReturnsMapTag
MechanismItemTag.raw_nbt
DescriptionReturns a map of all raw NBT on this item, including default values.
Refer to format details at Language:Raw NBT Encoding.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemRawNBT.java#L317

Name<ItemTag.armor_pose>
ReturnsMapTag
MechanismItemTag.armor_pose
DescriptionReturns the pose of this armor stand item, if any.
Map has keys: head, body, left_arm, right_arm, left_leg, right_leg
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemArmorPose.java#L84

Name<ItemTag.attribute_modifiers>
ReturnsMapTag
MechanismItemTag.attribute_modifiers
DescriptionReturns a map of all attribute modifiers on the item, 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.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemAttributeModifiers.java#L84

Name<ItemTag.base_color>
ReturnsElementTag
MechanismItemTag.base_color
DescriptionGets the base color of a shield.
For the list of possible colors, see URL:https://hub.spigotmc.org/javadocs/spigot/org/bukkit/DyeColor.html.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemBaseColor.java#L85

Name<ItemTag.block_material>
ReturnsMaterialTag
MechanismItemTag.block_material
DescriptionReturns the material for an item with complex-block-data attached.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemBlockMaterial.java#L48

Name<ItemTag.book_author>
ReturnsElementTag
MechanismItemTag.book_author
DescriptionReturns the author of the book.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemBook.java#L64

Name<ItemTag.book_generation>
ReturnsListTag
MechanismItemTag.book_generation
DescriptionReturns the generation of the book (if any), as ORIGINAL, COPY_OF_ORIGINAL, COPY_OF_COPY, or TATTERED.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemBookGeneration.java#L48

Name<ItemTag.book_map>
ReturnsMapTag
MechanismItemTag.book
DescriptionReturns a MapTag of data about the book, with keys "pages" (a ListTag), and when available, "author" and "title".
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemBook.java#L106

Name<ItemTag.book_pages>
ReturnsListTag
MechanismItemTag.book_pages
DescriptionReturns the plain-text pages of the book as a ListTag.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemBook.java#L90

Name<ItemTag.book_title>
ReturnsElementTag
MechanismItemTag.book_title
DescriptionReturns the title of the book.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemBook.java#L77

Name<ItemTag.can_destroy>
ReturnsListTag(MaterialTag)
MechanismItemTag.can_destroy
DescriptionReturns a list of materials this item can destroy while in adventure mode, if any.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemCanDestroy.java#L66

Name<ItemTag.can_place_on>
ReturnsListTag(MaterialTag)
MechanismItemTag.can_place_on
DescriptionReturns a list of materials this item can be placed on while in adventure mode, if any.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemCanPlaceOn.java#L66

Name<ItemTag.charged_projectiles>
ReturnsListTag(ItemTag)
MechanismItemTag.charged_projectiles
DescriptionReturns a list of charged projectile items on this crossbow.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemChargedProjectile.java#L50

Name<ItemTag.color>
ReturnsColorTag
MechanismItemTag.color
DescriptionReturns the color of the leather armor item or potion item.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemColor.java#L64

Name<ItemTag.custom_model_data>
ReturnsElementTag(Number)
MechanismItemTag.custom_model_data
DescriptionReturns the custom model data ID number of the item.
This tag is invalid for items that do not have a custom model data ID.
Also see Tag:ItemTag.has_custom_model_data.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemCustomModel.java#L61

Name<ItemTag.display>
ReturnsElementTag
MechanismItemTag.display
DescriptionReturns the display name of the item, as set by plugin or an anvil.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemDisplayname.java#L56

Name<ItemTag.durability>
ReturnsElementTag(Number)
MechanismItemTag.durability
DescriptionReturns the current durability (number of uses) on the item.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemDurability.java#L48

Name<ItemTag.enchantment_map>
ReturnsMapTag
MechanismItemTag.enchantments
DescriptionReturns a map of enchantments on the item.
Map keys are enchantment names (like "sharpness"), and values are the level (as a number).
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemEnchantments.java#L141

Name<ItemTag.enchantment_types>
ReturnsListTag(EnchantmentTag)
MechanismItemTag.enchantments
DescriptionReturns a list of the types of enchantments on the item.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemEnchantments.java#L105

Name<ItemTag.enchantments>
ReturnsListTag
MechanismItemTag.enchantments
DescriptionDeprecated in favor of Tag:ItemTag.enchantment_types or Tag:ItemTag.enchantment_map
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemEnchantments.java#L122

Name<ItemTag.firework>
ReturnsListTag
MechanismItemTag.firework
DescriptionReturns the firework's property value as a list, matching the format of the mechanism.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemFirework.java#L85

Name<ItemTag.has_custom_model_data>
ReturnsElementTag(Boolean)
MechanismItemTag.custom_model_data
DescriptionReturns whether the item has a custom model data ID number set on it.
Also see Tag:ItemTag.custom_model_data.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemCustomModel.java#L47

Name<ItemTag.has_display>
ReturnsElementTag(Boolean)
MechanismItemTag.display
DescriptionReturns whether the item has a custom set display name.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemDisplayname.java#L71

Name<ItemTag.has_inventory>
ReturnsElementTag(Boolean)
DescriptionReturns whether the item has an inventory.
If this returns true, it will enable access to:
Mechanism:ItemTag.inventory_contents, and Tag:ItemTag.inventory_contents.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L541

Name<ItemTag.has_lore>
ReturnsElementTag(Boolean)
MechanismItemTag.lore
DescriptionReturns whether the item has lore set on it.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemLore.java#L71

Name<ItemTag.has_skin>
ReturnsElementTag(Boolean)
MechanismItemTag.skull_skin
DescriptionReturns whether the item has a custom skin set.
(Only for 'player_head's)
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSkullskin.java#L101

Name<ItemTag.hides>
ReturnsListTag
MechanismItemTag.hides
DescriptionReturns a list of item data types to be hidden from view on this item.
Valid hide types include: ATTRIBUTES, DESTROYS, ENCHANTS, PLACED_ON, ITEM_DATA, UNBREAKABLE, and DYE
ITEM_DATA hides potion effects, banner patterns, etc.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemHidden.java#L76

Name<ItemTag.inventory_contents>
ReturnsListTag(ItemTag)
MechanismItemTag.inventory_contents
DescriptionReturns a list of the contents of the inventory of a container item.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemInventory.java#L93

Name<ItemTag.invisible>
ReturnsElementTag(Boolean)
MechanismItemTag.invisible
DescriptionReturns whether an Item_Frame item will be invisible when placed.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemFrameInvisible.java#L67

Name<ItemTag.is_book>
ReturnsElementTag(Boolean)
DescriptionReturns whether the item is considered an editable book.
If this returns true, it will enable access to:
Mechanism:ItemTag.book,
Tag:ItemTag.book_author, Tag:ItemTag.book_title, and Tag:ItemTag.book_pages.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L497

Name<ItemTag.is_charged>
ReturnsElementTag(Boolean)
MechanismItemTag.charged_projectiles
DescriptionReturns whether this crossbow is charged.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemChargedProjectile.java#L63

Name<ItemTag.is_colorable>
ReturnsElementTag(Boolean)
DescriptionReturns whether the item can have a custom color.
If this returns true, it will enable access to:
Mechanism:ItemTag.color, and Tag:ItemTag.color.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L511

Name<ItemTag.is_enchanted>
ReturnsElementTag(Boolean)
MechanismItemTag.enchantments
DescriptionReturns whether the item has any enchantments.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemEnchantments.java#L58

Name<ItemTag.is_firework>
ReturnsElementTag(Boolean)
DescriptionReturns whether the item is a firework.
If this returns true, it will enable access to:
Mechanism:ItemTag.firework, and Tag:ItemTag.firework.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L528

Name<ItemTag.is_lockable>
ReturnsElementTag(Boolean)
DescriptionReturns whether the item is lockable.
If this returns true, it will enable access to:
Mechanism:ItemTag.lock, and Tag:ItemTag.lock.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L554

Name<ItemTag.is_locked>
ReturnsElementTag(Boolean)
MechanismItemTag.lock
DescriptionReturns whether this item has a lock password.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemLock.java#L74

Name<ItemTag.knowledge_book_recipes>
ReturnsListTag
MechanismItemTag.knowledge_book_recipes
DescriptionReturns a recipes unlocked by this knowledge book. Recipes are in the Namespace:Key format, for example "minecraft:gold_nugget".
These keys are not necessarily 1:1 with material names, as seen in the example "minecraft:gold_ingot_from_nuggets".
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemKnowledgeBookRecipes.java#L63

Name<ItemTag.lock>
ReturnsElementTag
MechanismItemTag.lock
DescriptionReturns the lock password of this item.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemLock.java#L59

Name<ItemTag.lodestone_location>
ReturnsLocationTag
MechanismItemTag.lodestone_location
DescriptionReturns the lodestone location this compass is pointing at (if any).
See also Tag:ItemTag.lodestone_tracked
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemLodestoneLocation.java#L49

Name<ItemTag.lodestone_tracked>
ReturnsElementTag(Boolean)
MechanismItemTag.lodestone_tracked
DescriptionReturns whether the compass will track a lodestone. If "true", the compass will only work if there's a lodestone at the target location.
See also Tag:ItemTag.lodestone_location
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemLodestoneTracked.java#L49

Name<ItemTag.lore>
ReturnsListTag
MechanismItemTag.lore
DescriptionReturns lore as a ListTag.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemLore.java#L57

Name<ItemTag.map>
ReturnsElementTag(Number)
MechanismItemTag.map
DescriptionReturns the ID number of the map item's map.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemMap.java#L56

Name<ItemTag.map_locked>
ReturnsElementTag(Boolean)
MechanismItemTag.map_locked
DescriptionReturns whether maps with the same ID as this map are locked.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemMap.java#L90

Name<ItemTag.map_scale>
ReturnsElementTag(Number)
MechanismItemTag.map
DescriptionReturns the scale of the map, from 0 (smallest) to 4 (largest).
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemMap.java#L71

Name<ItemTag.max_durability>
ReturnsElementTag(Number)
DescriptionReturns the maximum durability (number of uses) of this item.
For use with Tag:ItemTag.durability and Mechanism:ItemTag.durability.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemDurability.java#L61

Name<ItemTag.max_stack>
ReturnsElementTag(Number)
DescriptionReturns the max number of this item possible in a single stack of this type.
For use with Tag:ItemTag.quantity and Mechanism:ItemTag.quantity.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemQuantity.java#L66

Name<ItemTag.patterns>
ReturnsListTag
MechanismItemTag.patterns
DescriptionLists a banner's patterns in the form "COLOR/PATTERN|COLOR/PATTERN" etc.
For the list of possible colors, see URL:https://hub.spigotmc.org/javadocs/spigot/org/bukkit/DyeColor.html.
For the list of possible patterns, see URL:https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/banner/PatternType.html.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPatterns.java#L109

Name<ItemTag.potion_base>
ReturnsElementTag
MechanismItemTag.potion_effects
DescriptionReturns the potion type details for this potion item.
In the format Type,Level,Extended,Splash,Color
The type will be from URL:https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionType.html.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L146

Name<ItemTag.potion_base_type>
ReturnsElementTag
MechanismItemTag.potion_effects
DescriptionReturns the base potion type name for this potion item.
The type will be from URL:https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionType.html.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L132

Name<ItemTag.potion_effect[<#>].amplifier>
ReturnsElementTag(Number)
MechanismItemTag.potion_effects
DescriptionReturns the amplifier level of the potion effect.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L296

Name<ItemTag.potion_effect[<#>].duration>
ReturnsElementTag(Number)
MechanismItemTag.potion_effects
DescriptionReturns the duration in ticks of the potion.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L283

Name<ItemTag.potion_effect[<#>].has_particles>
ReturnsElementTag(Boolean)
MechanismItemTag.potion_effects
DescriptionReturns whether the potion effect has particles.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L270

Name<ItemTag.potion_effect[<#>].icon>
ReturnsElementTag(Boolean)
MechanismItemTag.potion_effects
DescriptionReturns whether the potion effect shows an icon.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L258

Name<ItemTag.potion_effect[<#>].is_ambient>
ReturnsElementTag(Boolean)
MechanismItemTag.potion_effects
DescriptionReturns whether the potion effect is ambient.
"Ambient" effects in vanilla came from a beacon, while non-ambient came from a potion.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L244

Name<ItemTag.potion_effect[<#>].is_extended>
ReturnsElementTag(Boolean)
MechanismItemTag.potion_effects
DescriptionReturns whether the potion effect is extended.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L218

Name<ItemTag.potion_effect[<#>].is_splash>
ReturnsElementTag(Boolean)
MechanismItemTag.potion_effects
DescriptionReturns whether the potion is a splash potion.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L205

Name<ItemTag.potion_effect[<#>].level>
ReturnsElementTag(Number)
MechanismItemTag.potion_effects
DescriptionReturns the potion effect's level.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L231

Name<ItemTag.potion_effect[<#>].type>
ReturnsElementTag
MechanismItemTag.potion_effects
DescriptionReturns the type of the potion effect.
The effect type will be from URL:https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionEffectType.html.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L309

Name<ItemTag.potion_effects>
ReturnsListTag
MechanismItemTag.potion_effects
DescriptionReturns the list of potion effects on this item.
The effect type will be from URL:https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionEffectType.html.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L164

Name<ItemTag.quantity>
ReturnsElementTag(Number)
MechanismItemTag.quantity
DescriptionReturns the number of items in the ItemTag's itemstack.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemQuantity.java#L48

Name<ItemTag.raw_nbt>
ReturnsMapTag
MechanismItemTag.raw_nbt
DescriptionReturns a map of all non-default raw NBT on this item.
Refer to format details at Language:Raw NBT Encoding.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemRawNBT.java#L304

Name<ItemTag.repair_cost>
ReturnsElementTag(Number)
MechanismItemTag.repair_cost
DescriptionReturns the current repair cost (on an anvil) for this item.
Note that zero indicates no repair cost.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemRepairCost.java#L49

Name<ItemTag.repairable>
ReturnsElementTag(Boolean)
DescriptionReturns whether the item can be repaired.
If this returns true, it will enable access to:
Mechanism:ItemTag.durability,
Tag:ItemTag.max_durability, and Tag:ItemTag.durability.
Note that due to odd design choices in Spigot, this is effectively true for all items, even though the durability value of most items is locked at zero.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L482

Name<ItemTag.sign_contents>
ReturnsListTag
MechanismItemTag.sign_contents
DescriptionReturns a list of lines on a sign item.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSignContents.java#L59

Name<ItemTag.skin>
ReturnsElementTag
MechanismItemTag.skull_skin
DescriptionReturns the UUID of the player whose skin a skull item uses.
Note: Item must be a 'player_head' with a skin.
In format: UUID|Texture|Name.
See also Language:Player Entity Skins (Skin Blobs).
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSkullskin.java#L74

Name<ItemTag.skull_skin>
ReturnsElementTag
MechanismItemTag.skull_skin
DescriptionReturns the UUID of the player whose skin a skull item uses.
Note: Item must be a 'player_head' with a skin.
In format: UUID|Texture|Name.
See also Language:Player Entity Skins (Skin Blobs).
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSkullskin.java#L55

Name<ItemTag.spawner_count>
ReturnsElementTag(Number)
MechanismItemTag.spawner_count
DescriptionReturns the spawn count for a spawner block item.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSpawnerCount.java#L50

Name<ItemTag.spawner_max_nearby_entities>
ReturnsElementTag(Number)
MechanismItemTag.spawner_max_nearby_entities
DescriptionReturns the maximum nearby entities for a spawner block item.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSpawnerMaxNearbyEntities.java#L50

Name<ItemTag.spawner_maximum_spawn_delay>
ReturnsElementTag(Number)
MechanismItemTag.spawner_delay_data
DescriptionReturns the maximum spawn delay for a spawner block item.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSpawnerDelay.java#L82

Name<ItemTag.spawner_minimum_spawn_delay>
ReturnsElementTag(Number)
MechanismItemTag.spawner_delay_data
DescriptionReturns the minimum spawn delay for a spawner block item.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSpawnerDelay.java#L67

Name<ItemTag.spawner_player_range>
ReturnsElementTag(Number)
MechanismItemTag.spawner_player_range
DescriptionReturns the maximum player range for a spawner block item (ie how close a player must be for this spawner to be active).
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSpawnerPlayerRange.java#L50

Name<ItemTag.spawner_range>
ReturnsElementTag(Number)
MechanismItemTag.spawner_range
DescriptionReturns the spawn range for a spawner block item (the radius mobs will spawn in).
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSpawnerRange.java#L50

Name<ItemTag.spawner_spawn_delay>
ReturnsElementTag(Number)
MechanismItemTag.spawner_delay_data
DescriptionReturns the current spawn delay for a spawner block item.
This changes over time between Tag:ItemTag.spawner_minimum_spawn_delay and Tag:ItemTag.spawner_maximum_spawn_delay.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSpawnerDelay.java#L51

Name<ItemTag.spawner_type>
ReturnsEntityTag
MechanismItemTag.spawner_type
DescriptionReturns the spawn type for a spawner block item.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSpawnerType.java#L50

Name<ItemTag.unbreakable>
ReturnsElementTag(Boolean)
MechanismItemTag.unbreakable
DescriptionReturns whether an item has the unbreakable flag.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemUnbreakable.java#L44

Name<ItemTag.with_flag[<flag_set_action>]>
ReturnsItemTag
MechanismItemTag.flag
DescriptionReturns a copy of the item with the specified flag data action applied to it.
For example: <[item].with_flag[myflagname]>, or <[item].with_flag[myflag:myvalue]>, or <[item].with_flag[mycounter:+:<[amount]>]>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemFlags.java#L53

Name<ItemTag.with_flag[<flag_set_action>].duration[<expire_duration>]>
ReturnsItemTag
MechanismItemTag.flag
DescriptionReturns a copy of the item with the specified flag data action (and the specified expiration duration) applied to it.
For example: <[item].with_flag[myflagname].duration[5m]>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemFlags.java#L68

Name<ItemTag.script>
ReturnsScriptTag
DescriptionReturns the script of the item if it was created by an item script.
Groupscripts
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemScript.java#L73

Name<ItemTag.potion_effect[<#>]>
ReturnsElementTag
MechanismItemTag.potion_effects
DescriptionReturns the potion effect on this item.
In the format Effect,Level,Extended,Splash
Groupproperties
Warning(s)Don't use this directly, use its sub-tags!
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L328

Name<ItemTag.crackshot_weapon>
ReturnsElementTag
DescriptionReturns the CrackShot weapon name for the item.
RequiresDepenizen, CrackShot
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/crackshot/CrackShotItemProperties.java#L55

Name<ItemTag.worth>
ReturnsElementTag(Decimal)
MechanismItemTag.worth
DescriptionReturns the amount of money one of this item is worth in Essentials.
RequiresDepenizen, Essentials
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsItemProperties.java#L60

Name<ItemTag.worth.quantity[<#>]>
ReturnsElementTag(Decimal)
DescriptionReturns the amount of money the quantity specified of this item is worth in Essentials.
RequiresDepenizen, Essentials
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsItemProperties.java#L79

Name<ItemTag.armor_stand_data>
ReturnsMapTag
MechanismItemTag.armor_stand_data
DescriptionReturns a map of basic armor stand data, with keys matching EntityTag property names.
Keys: base_plate, visible, marker, is_small, arms
Groupproperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/ItemArmorStand.java#L67

Name<ItemTag.rarity>
ReturnsElementTag
DescriptionReturns the rarity of an item, as "common", "uncommon", "rare", or "epic".
Groupproperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperItemTagProperties.java#L43



Category: ListTag


Name<ListTag.alphabetical>
ReturnsListTag
Descriptionreturns the list sorted to be in alphabetical order.
For example: a list of "c|d|q|a|g" will return "a|c|d|g|q".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1883

Name<ListTag.alphanumeric>
ReturnsListTag
Descriptionreturns the list sorted to be in alphabetical/numerical order.
For example: a list of "b|c|a10|a1" will return "a1|a10|b|c".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1870

Name<ListTag.any>
ReturnsElementTag(Boolean)
Descriptionreturns whether the list is not empty.
For example: a list of "" returns false, while "one" returns true.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L989

Name<ListTag.average>
ReturnsElementTag(Decimal)
Descriptionreturns the mean average of all numbers in the list. Ignores non-numerical values.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1611

Name<ListTag.closest_to[<text>]>
ReturnsElementTag
DescriptionReturns the raw text of the item in the list that seems closest to the given value.
Particularly useful for command handlers, "<list[c1|c2|c3|...].closest_to[<argument>]>" to get the best option as "did you mean" suggestion.
For example, "<list[dance|quit|spawn].closest_to[spwn]>" returns "spawn".
Be warned that this will always return /something/, excluding the case of an empty list, which will return an empty element.
Uses the logic of tag "ElementTag.difference"!
You can use that tag to add an upper limit on how different the text can be.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2420

Name<ListTag.combine>
ReturnsListTag
Descriptionreturns a list containing the contents of all sublists within this list.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L693

Name<ListTag.comma_separated>
ReturnsElementTag
Descriptionreturns the list in a cleaner format, separated by commas.
For example: a list of "one|two|three" will return "one, two, three".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L764

Name<ListTag.contains[<element>|...]>
ReturnsElementTag(Boolean)
Descriptionreturns whether the list contains all of the given elements.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2364

Name<ListTag.contains_any[<element>|...]>
ReturnsElementTag(Boolean)
Descriptionreturns whether the list contains any of a list of given elements.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2320

Name<ListTag.contains_any_case_sensitive[<element>|...]>
ReturnsElementTag(Boolean)
Descriptionreturns whether the list contains any of a list of given elements, case-sensitive.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2296

Name<ListTag.contains_case_sensitive[<element>]>
ReturnsElementTag(Boolean)
Descriptionreturns whether the list contains a given element, case-sensitive.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2344

Name<ListTag.count[<element>]>
ReturnsElementTag(Number)
Descriptionreturns how many times in the sub-list occurs.
For example: a list of "one|two|two|three" .count[two] returns 2.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1573

Name<ListTag.deduplicate>
ReturnsListTag
Descriptionreturns a copy of the list with any duplicate items removed.
For example: a list of "one|one|two|three" will become "one|two|three".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1385

Name<ListTag.exclude[...|...]>
ReturnsListTag
Descriptionreturns a new ListTag excluding the items specified.
For example: .exclude[two|four] on a list of "one|two|three|four" will return "one|three".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1186

Name<ListTag.exclude[...|...].max[<#>]>
ReturnsListTag
Descriptionreturns a new ListTag excluding the items specified. Specify a maximum number of items to remove from the list.
Max must be an integer >= 1.
For example: .exclude[potato].max[2] on a list of "taco|potato|taco|potato|taco|potato" will return "taco|taco|taco|potato".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1200

Name<ListTag.filter[<tag>]>
ReturnsListTag
Descriptionreturns a copy of the list with all its contents parsed through the given tag and only including ones that returned 'true'.
For example: a list of '1|2|3|4|5' .filter[is[or_more].than[3]] returns a list of '3|4|5'.
One should generally prefer Tag:ListTag.filter_tag.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2062

Name<ListTag.filter_tag[<dynamic-boolean>]>
ReturnsListTag
Descriptionreturns a copy of the list with all its contents parsed through the given input tag and only including ones that returned 'true'.
This requires a fully formed tag as input, making use of the 'filter_value' definition.
For example: a list of '1|2|3|4|5' .filter_tag[<[filter_value].is[or_more].than[3]>] returns a list of '3|4|5'.
For example: a list of '1|2|3|4|5' .filter_tag[<list[4|5].contains[<[filter_value]>]>] returns a list of '4|5'.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2158

Name<ListTag.find[<element>]>
ReturnsElementTag(Number)
Descriptionreturns the numbered location of an element within a list,
or -1 if the list does not contain that item.
For example: .find[two] on a list of "one|two|three" will return "2".
TODO: Take multiple inputs? Or a matcher?
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1544

Name<ListTag.find_all[<element>]>
ReturnsListTag
Descriptionreturns all the numbered locations of elements that match the text within a list,
or an empty list if the list does not contain that item.
For example: .find_all[two] on a list of "one|two|three|two" will return "2|4".
TODO: Take multiple inputs? Or a matcher?
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1498

Name<ListTag.find_all_partial[<element>]>
ReturnsListTag
Descriptionreturns all the numbered locations of elements that contain the text within a list,
or an empty list if the list does not contain that item.
For example: .find_all_partial[tw] on a list of "one|two|three|two" will return "2|4".
TODO: Take multiple inputs? Or a matcher?
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1474

Name<ListTag.find_partial[<element>]>
ReturnsElementTag(Number)
Descriptionreturns the numbered location of the first partially matching element within a list,
or -1 if the list does not contain that item.
For example: .find_partial[tw] on a list of "one|two|three" will return "2".
TODO: Take multiple inputs? Or a matcher?
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1521

Name<ListTag.first>
ReturnsObjectTag
Descriptionreturns the first element in the list.
If the list is empty, returns null instead.
For example: a list of "one|two|three" will return "one".
Effectively equivalent to .get[1]
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1635

Name<ListTag.formatted>
ReturnsElementTag
DescriptionReturns the list in a human-readable format.
EG, a list of "<npc>|<player>|potato" will return "GuardNPC, bob, and potato".
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitListProperties.java#L41

Name<ListTag.get[<#>|...]>
ReturnsObjectTag
Descriptionreturns an element of the value specified by the supplied context.
For example: .get[1] on a list of "one|two" will return "one", and .get[2] will return "two"
Specify more than one index to get a list of results.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1396

Name<ListTag.get_sub_items[<#>]>
ReturnsListTag
Descriptionreturns a list of the specified sub items in the list, as split by the
forward-slash character (/).
For example: .get_sub_items[1] on a list of "one/alpha|two/beta" will return "one|two".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L792

Name<ListTag.get_sub_items[<#>].split_by[<element>]>
ReturnsListTag
Descriptionreturns a list of the specified sub item in the list, allowing you to specify a
character in which to split the sub items by. WARNING: When setting your own split
character, make note that it is CASE SENSITIVE.
For example: .get_sub_items[1].split_by[-] on a list of "one-alpha|two-beta" will return "one|two".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L806

Name<ListTag.get[<#>].to[<#>]>
ReturnsListTag
Descriptionreturns all elements in the range from the first index to the second.
For example: .get[1].to[3] on a list of "one|two|three|four" will return "one|two|three".
Use "last" as the 'to' index to automatically get all of the list starting at the first index.
For example: .get[3].to[last] on a list of "one|two|three|four" will return "three|four".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1435

Name<ListTag.highest[(<tag>)]>
ReturnsObjectTag
Descriptionreturns the highest value in a list of decimal numbers.
For example: a list of "3|2|1|10" will return "10".
Optionally specify a tag to run on each list entry that returns the numeric value for that entry.
For example, <server.players.highest[money]> returns the player with the most money.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1760

Name<ListTag.highest[(<tag>)].count[<#>]>
ReturnsListTag
Descriptionreturns a list of the highest values in a list of decimal numbers.
For example: a list of "3|5|2|1|10" with .highest.count[2] will return "10|5".
Optionally specify a tag to run on each list entry that returns the numeric value for that entry.
For example, <server.players.highest[money].count[5]> returns the 5 players with the most money.
Note: if you want to sort the entire list, rather than just getting a few values, use a sort tag like Tag:listtag.sort_by_number
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1783

Name<ListTag.include[...|...]>
ReturnsListTag
Descriptionreturns a new ListTag including the items specified.
For example: .include[three|four] on a list of "one|two" will return "one|two|three|four".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1169

Name<ListTag.include_single[<value>]>
ReturnsListTag
Descriptionreturns a new ListTag including the value specified as a new entry.
If the value input is a list, that list becomes a list-within-a-list, still only occupying one space in the outer list.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1152

Name<ListTag.insert[...|...].at[<#>]>
ReturnsListTag
Descriptionreturns a new ListTag with the items specified inserted to the specified location.
For example: .insert[two|three].at[2] on a list of "one|four" will return "one|two|three|four".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1000

Name<ListTag.is_empty>
ReturnsElementTag(Boolean)
Descriptionreturns whether the list is empty.
For example: a list of "" returns true, while "one" returns false.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L978

Name<ListTag.last>
ReturnsObjectTag
Descriptionreturns the last element in the list.
If the list is empty, returns null instead.
For example: a list of "one|two|three" will return "three".
Effectively equivalent to .get[<list.size>]
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1653

Name<ListTag.lowest[(<tag>)]>
ReturnsObjectTag
Descriptionreturns the smallest value in a list of decimal numbers.
For example: a list of "3|2|1|10" will return "1".
Optionally specify a tag to run on each list entry that returns the numeric value for that entry.
For example, <server.online_players.lowest[money]> returns the player with the least money currently online.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1671

Name<ListTag.lowest[(<tag>)].count[<#>]>
ReturnsListTag
Descriptionreturns a list of the smallest values in a list of decimal numbers.
For example: a list of "3|5|2|1|10" with .count[2] will return "1|2".
Optionally specify a tag to run on each list entry that returns the numeric value for that entry.
For example, <server.online_players.lowest[money].count[5]> returns the 5 players with the least money currently online.
Note: if you want to sort the entire list, rather than just getting a few values, use a sort tag link Tag:listtag.sort_by_number
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1694

Name<ListTag.map_with[<value>|...]>
ReturnsMapTag
DescriptionInterprets this list as a list of keys, and the input as a list of values,
and forms a mapping from keys to values based on list index.
Both lists must have the same size.
For example, on a list of "a|b|c|", using ".map_with[1|2|3|]" will return a MapTag of [a=1;b=2;c=3]
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L945

Name<ListTag.merge_maps>
ReturnsMapTag
DescriptionIf this list is a list of MapTags, returns a single MapTag of all the maps combined together.
So a list that contains map of [a=1;b=2] and a map of [x=3;y=4] will return a single map of [a=1;b;=2;x=3;y=4]
Duplicate keys will have the the last value that appears in the list.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L899

Name<ListTag.numerical>
ReturnsListTag
Descriptionreturns the list sorted to be in numerical order.
For example: a list of "3|2|1|10" will return "1|2|3|10".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1846

Name<ListTag.overwrite[...|...].at[<#>]>
ReturnsListTag
Descriptionreturns a new ListTag with the index specified and beyond replaced with the input list.
The result list will be the same size as the original list, unless (input_list.size + at_index) is greater than the original list size.
For example: .overwrite[potato|taco].at[2] on a list of "one|two|three|four" will return "one|potato|taco|four".
For example: .overwrite[potato|taco|hotdog|cheeseburger].at[2] on a list of "one|two|three" will return "one|potato|taco|hotdog|cheeseburger".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1108

Name<ListTag.pad_left[<#>]>
ReturnsListTag
DescriptionReturns a ListTag extended to reach a minimum specified length
by adding entries to the left side.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2214

Name<ListTag.pad_left[<#>].with[<element>]>
ReturnsListTag
DescriptionReturns a ListTag extended to reach a minimum specified length
by adding a specific entry to the left side.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2228

Name<ListTag.pad_right[<#>]>
ReturnsListTag
DescriptionReturns a ListTag extended to reach a minimum specified length
by adding entries to the right side.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2246

Name<ListTag.pad_right[<#>].with[<element>]>
ReturnsListTag
DescriptionReturns a ListTag extended to reach a minimum specified length
by adding a specific entry to the right side.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2260

Name<ListTag.parse[<tag>]>
ReturnsListTag
Descriptionreturns a copy of the list with all its contents parsed through the given tag.
For example: a list of 'one|two' .parse[to_uppercase] returns a list of 'ONE|TWO'.
One should generally prefer Tag:ListTag.parse_tag.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2101

Name<ListTag.parse_tag[<parseable-value>]>
ReturnsListTag
Descriptionreturns a copy of the list with all its contents parsed through the given tag.
This requires a fully formed tag as input, making use of the 'parse_value' definition.
For example: a list of 'one|two' .parse_tag[<[parse_value].to_uppercase>] returns a list of 'ONE|TWO'.
For example: a list of '3|1|2' .parse_tag[<list[alpha|bravo|charlie].get[<[parse_value]>]>] returns a list of 'charlie|alpha|bravo'.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2187

Name<ListTag.random[(<#>)]>
ReturnsObjectTag
DescriptionGets a random item in the list and returns it as an Element.
Optionally, add [<#>] to get a list of multiple randomly chosen elements.
For example: .random on a list of "one|two" could return EITHER "one" or "two" - different each time!
For example: .random[2] on a list of "one|two|three" could return "one|two", "two|three", OR "one|three" - different each time!
For example: .random[9999] on a list of "one|two|three" could return "one|two|three", "one|three|two", "two|one|three",
"two|three|one", "three|two|one", OR "three|one|two" - different each time!
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2387

Name<ListTag.remove[<#>|...]>
ReturnsListTag
Descriptionreturns a new ListTag excluding the items at the specified index.
For example: .remove[2] on a list of "one|two|three|four" will return "one|three|four".
Also supports [first] and [last] values.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1231

Name<ListTag.remove[<#>].to[<#>]>
ReturnsListTag
Descriptionreturns a new ListTag excluding the items in the specified index range.
For example: .remove[2].to[4] on a list of "one|two|three|four|five" will return "one|five".
Also supports [first] and [last] values.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1247

Name<ListTag.replace[(regex:)<element>]>
ReturnsListTag
DescriptionReturns the list with all instances of an element removed.
Specify regex: at the start of the replace element to replace elements that match the Regex.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1307

Name<ListTag.replace[(regex:)<element>].with[<element>]>
ReturnsListTag
DescriptionReturns the list with all instances of an element replaced with another.
Specify regex: at the start of the replace element to replace elements that match the Regex.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1315

Name<ListTag.reverse>
ReturnsListTag
Descriptionreturns a copy of the list, with all items placed in opposite order.
For example: a list of "one|two|three" will become "three|two|one".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1372

Name<ListTag.separated_by[<text>]>
ReturnsElementTag
Descriptionreturns the list formatted, with each item separated by the defined text.
For example: <list[bob|joe|john].separated_by[ and ]> will return "bob and joe and john".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L749

Name<ListTag.set_single[<value>].at[<#>]>
ReturnsListTag
Descriptionreturns a new ListTag with the single item specified inserted to the specified location, replacing the element already at that location.
For example: .set_single[potato].at[2] on a list of "one|two|three" will return "one|potato|three".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1073

Name<ListTag.set[...|...].at[<#>]>
ReturnsListTag
Descriptionreturns a new ListTag with the items specified inserted to the specified location,
replacing the element already at that location.
For example: .set[potato].at[2] on a list of "one|two|three" will return "one|potato|three".
For example: .set[potato|taco|hotdog].at[2] on a list of "one|two|three" will return "one|potato|taco|hotdog|three".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1034

Name<ListTag.shared_contents[...|...]>
ReturnsListTag
Descriptionreturns a list of only items that appear in both this list and the input one.
For example: .shared_contents[two|four|five|six] on a list of "one|two|three|four" will return "two|four".
This will also inherently deduplicate the output as part of processing.
This will retain the list order of the list object the tag is on (so, for example "a|b|c" .shared_contents[c|b] returns "b|c").
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1283

Name<ListTag.size>
ReturnsElementTag(Number)
Descriptionreturns the size of the list.
For example: a list of "one|two|three" will return "3".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L967

Name<ListTag.sort[<procedure>]>
ReturnsListTag
Descriptionreturns a list sorted according to the return values of a procedure.
The <procedure> should link a procedure script that takes two definitions each of which will be an item
in the list, and returns -1, 0, or 1 based on whether the second item should be added. EG, if a procedure
with definitions "one" and "two" returned -1, it would place "two" after "one". Note that this
uses some complex internal sorting code that could potentially throw errors if the procedure does not return
consistently - EG, if "one" and "two" returned 1, but "two" and "one" returned 1 as well - obviously,
"two" can not be both before AND after "one"!
Note that the script should ALWAYS return -1, 0, or 1, or glitches could happen!
Note that if two inputs are exactly equal, the procedure should always return 0.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1987

Name<ListTag.sort_by_number[<tag>]>
ReturnsListTag
Descriptionreturns a copy of the list, sorted such that the lower numbers appear first, and the higher numbers appear last.
Rather than sorting based on the item itself, it sorts based on a tag attribute read from within the object being read.
For example, you might sort a list of players based on the amount of money they have, via .sort_by_number[money] on the list of valid players.
Non-numerical input is considered an error, and the result is not guaranteed.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1933

Name<ListTag.sort_by_value[<tag>]>
ReturnsListTag
Descriptionreturns a copy of the list, sorted alphanumerically.
Rather than sorting based on the item itself, it sorts based on a tag attribute read from within the object being read.
For example, you might sort a list of players based on their names, via .sort_by_value[name] on the list of valid players.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1896

Name<ListTag.sort[<procedure>].context[<context>]>
ReturnsListTag
DescriptionSort a list, with context. See Tag:ListTag.sort[<procedure>] for general sort details.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2009

Name<ListTag.space_separated>
ReturnsElementTag
Descriptionreturns the list in a cleaner format, separated by spaces.
For example: a list of "one|two|three" will return "one two three".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L735

Name<ListTag.sub_lists[<#>]>
ReturnsListTag(ListTag)
Descriptionreturns a list containing sublists of this list capped to a specific length.
For example, a list of a|b|c|d|e|f .sub_lists[2] will return a list containing lists "a|b", "c|d", and "e|f".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L707

Name<ListTag.sum>
ReturnsElementTag(Decimal)
Descriptionreturns the sum of all numbers in the list. Ignores non-numerical values.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1595

Name<ListTag.to_map[(<separator>)]>
ReturnsMapTag
DescriptionInterprets a list of "key/value" pairs as a map, and returns the resulting MapTag.
Optionally specify the map separator symbol, by default '/'.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L920

Name<ListTag.to_polygon>
ReturnsPolygonTag
DescriptionConverts a list of locations to a PolygonTag.
The Y-Min and Y-Max values will be assigned based the range of Y values in the locations given.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitListProperties.java#L104

Name<ListTag.unseparated>
ReturnsElementTag
Descriptionreturns the list in a less clean format, separated by nothing.
For example: a list of "one|two|three" will return "onetwothree".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L778



Category: LocationTag


Name<LocationTag.above[(<#.#>)]>
ReturnsLocationTag
DescriptionReturns the location above this location. Optionally specify a number of blocks to go up.
This just moves straight along the Y axis, equivalent to Tag:LocationTag.add with input 0,1,0 (or the input value instead of '1').
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L934

Name<LocationTag.add[<location>]>
ReturnsLocationTag
DescriptionReturns the location with the specified coordinates added to it.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2924

Name<LocationTag.age>
ReturnsDurationTag
MechanismLocationTag.age
DescriptionReturns the age of an end gateway.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3678

Name<LocationTag.attached_to>
ReturnsLocationTag
DescriptionReturns the block this block is attached to.
(For buttons, levers, signs, torches, etc).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3561

Name<LocationTag.backward[(<#.#>)]>
ReturnsLocationTag
DescriptionReturns the location behind this location based on pitch and yaw. Optionally specify a number of blocks to go backward.
This is equivalent to Tag:LocationTag.forward in the opposite direction.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L994

Name<LocationTag.backward_flat[(<#.#>)]>
ReturnsLocationTag
DescriptionReturns the location behind this location based on yaw but not pitch. Optionally specify a number of blocks to go backward.
This is equivalent to Tag:LocationTag.forward_flat in the opposite direction.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L969

Name<LocationTag.beacon_primary_effect>
ReturnsElementTag
MechanismLocationTag.beacon_primary_effect
DescriptionReturns the primary effect of the beacon. The return is simply a potion effect type name.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3531

Name<LocationTag.beacon_secondary_effect>
ReturnsElementTag
MechanismLocationTag.beacon_secondary_effect
DescriptionReturns the secondary effect of the beacon. The return is simply a potion effect type name.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3546

Name<LocationTag.beacon_tier>
ReturnsElementTag(Number)
DescriptionReturns the tier level of a beacon pyramid (0-4).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3521

Name<LocationTag.below[(<#.#>)]>
ReturnsLocationTag
DescriptionReturns the location below this location. Optionally specify a number of blocks to go down.
This just moves straight along the Y axis, equivalent to Tag:LocationTag.sub with input 0,1,0 (or the input value instead of '1').
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L945

Name<LocationTag.biome>
ReturnsBiomeTag
MechanismLocationTag.biome
DescriptionReturns the biome at the location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3217

Name<LocationTag.block>
ReturnsLocationTag
DescriptionReturns the location of the block this location is on,
i.e. returns a location without decimals or direction.
Note that you almost never actually need this tag. This does not "get the block", this just rounds coordinates down.
If you have this in a script, it is more likely to be a mistake than actually needed.
Consider using Tag:LocationTag.round_down instead.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1091

Name<LocationTag.block_facing>
ReturnsLocationTag
MechanismLocationTag.block_facing
DescriptionReturns the relative location vector of where this block is facing.
Only works for block types that have directionality (such as signs, chests, stairs, etc.).
This can return for example "1,0,0" to mean the block is facing towards the positive X axis.
You can use <some_block_location.add[<some_block_location.block_facing>]> to get the block directly in front of this block (based on its facing direction).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L888

Name<LocationTag.brewing_fuel_level>
ReturnsElementTag(Number)
MechanismLocationTag.brewing_fuel_level
DescriptionReturns the level of fuel a brewing stand has. Each unit of fuel can power one brewing operation.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3465

Name<LocationTag.brewing_time>
ReturnsDurationTag
MechanismLocationTag.brewing_time
DescriptionReturns the brewing time a brewing stand has left.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3454

Name<LocationTag.campfire_items>
ReturnsListTag(ItemTag)
MechanismLocationTag.campfire_items
DescriptionReturns a list of items currently in this campfire.
This list has air items in empty slots, and is always sized exactly the same as the number of spaces a campfire has.
(A standard campfire has exactly 4 slots).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3746

Name<LocationTag.center>
ReturnsLocationTag
DescriptionReturns the location at the center of the block this location is on.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1105

Name<LocationTag.chunk>
ReturnsChunkTag
DescriptionReturns the chunk that this location belongs to.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2741

Name<LocationTag.command_block>
ReturnsElementTag
MechanismLocationTag.command_block
DescriptionReturns the command a command block is set to.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3440

Name<LocationTag.command_block_name>
ReturnsElementTag
MechanismLocationTag.command_block_name
DescriptionReturns the name a command block is set to.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3426

Name<LocationTag.cuboids>
ReturnsListTag(CuboidTag)
DescriptionReturns a ListTag of all noted CuboidTags that include this location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3233

Name<LocationTag.custom_name>
ReturnsElementTag
MechanismLocationTag.custom_name
DescriptionReturns the custom name of this block.
Only works for nameable blocks, such as chests and dispensers.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3617

Name<LocationTag.direction[(<location>)]>
ReturnsElementTag
DescriptionReturns the compass direction between two locations.
If no second location is specified, returns the direction of the location.
Example returns include "north", "southwest", ...
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1927

Name<LocationTag.direction.vector>
ReturnsLocationTag
DescriptionReturns the location's direction as a one-length vector.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1936

Name<LocationTag.direction[<location>].yaw>
ReturnsElementTag(Decimal)
DescriptionReturns the yaw direction between two locations.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1953

Name<LocationTag.distance[<location>]>
ReturnsElementTag(Decimal)
DescriptionReturns the distance between 2 locations.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3067

Name<LocationTag.distance_squared[<location>]>
ReturnsElementTag(Decimal)
DescriptionReturns the distance between 2 locations, squared.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3044

Name<LocationTag.distance[<location>].horizontal>
ReturnsElementTag(Decimal)
DescriptionReturns the horizontal distance between 2 locations.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3080

Name<LocationTag.distance[<location>].horizontal.multiworld>
ReturnsElementTag(Decimal)
DescriptionReturns the horizontal distance between 2 multiworld locations.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3088

Name<LocationTag.distance[<location>].vertical>
ReturnsElementTag(Decimal)
DescriptionReturns the vertical distance between 2 locations.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3106

Name<LocationTag.distance[<location>].vertical.multiworld>
ReturnsElementTag(Decimal)
DescriptionReturns the vertical distance between 2 multiworld locations.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3114

Name<LocationTag.div[<length>]>
ReturnsLocationTag
DescriptionReturns the location divided by the specified length.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2989

Name<LocationTag.down[(<#.#>)]>
ReturnsLocationTag
DescriptionReturns the location below this location based on pitch and yaw. Optionally specify a number of blocks to go down.
This is equivalent to Tag:LocationTag.forward with a -90 degree rotation to the pitch.
To just get the location above this location, use Tag:LocationTag.below instead.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1049

Name<LocationTag.drops[(<item>)]>
ReturnsListTag(ItemTag)
DescriptionReturns what items the block at the location would drop if broken naturally.
Optionally specifier a breaker item.
Not guaranteed to contain exactly correct or contain all possible drops (for things like plants that drop only when grown, ores that drop random amounts, etc).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1423

Name<LocationTag.ellipsoids>
ReturnsListTag(EllipsoidTag)
DescriptionReturns a ListTag of all noted EllipsoidTags that include this location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3248

Name<LocationTag.exit_location>
ReturnsLocationTag
MechanismLocationTag.exit_location
DescriptionReturns the exit location of an end gateway block.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3712

Name<LocationTag.face[<location>]>
ReturnsLocationTag
DescriptionReturns a location containing a yaw/pitch that point from the current location
to the target location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2001

Name<LocationTag.facing[<entity>/<location>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the location's yaw is facing another entity or location, within a limit of 45 degrees of yaw.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2016

Name<LocationTag.facing_blocks[(<#>)]>
ReturnsListTag(LocationTag)
DescriptionFinds all block locations in the direction this location is facing,
optionally with a custom range (default is 100).
For example a location at 0,0,0 facing straight up
will include 0,1,0 0,2,0 and so on.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1875

Name<LocationTag.facing[<entity>/<location>].degrees[<#>(,<#>)]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the location's yaw is facing another
entity or location, within a specified degree range.
Optionally specify a pitch limit as well.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2041

Name<LocationTag.find_blocks_flagged[<flag_name>].within[<#>]>
ReturnsListTag(LocationTag)
DescriptionReturns a list of blocks that have the specified flag within a radius.
Note: current implementation measures the center of nearby block's distance from the exact given location.
Result list is sorted by closeness (1 = closest, 2 = next closest, ... last = farthest).
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/LocationTag.java#L2314

Name<LocationTag.find_blocks[(<matcher>)].within[<#.#>]>
ReturnsListTag(LocationTag)
DescriptionReturns a list of blocks within a radius, with an optional search parameter for the block material.
Note: current implementation measures the center of nearby block's distance from the exact given location.
Result list is sorted by closeness (1 = closest, 2 = next closest, ... last = farthest).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2394

Name<LocationTag.find_entities[(<matcher>)].within[<#.#>]>
ReturnsListTag(EntityTag)
DescriptionReturns a list of entities within a radius, with an optional search parameter for the entity type.
Result list is sorted by closeness (1 = closest, 2 = next closest, ... last = farthest).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2366

Name<LocationTag.find_nearest_biome[<biome>]>
ReturnsLocationTag
DescriptionReturns the location of the nearest block of the given biome type (or null).
Warning: may be extremely slow to process. Use with caution.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2291

Name<LocationTag.find_path[<location>]>
ReturnsListTag(LocationTag)
DescriptionReturns a full list of points along the path from this location to the given location.
Uses a max range of 100 blocks from the start.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2687

Name<LocationTag.find.living_entities.within[<#.#>]>
ReturnsListTag(EntityTag)
DescriptionReturns a list of living entities within a radius.
This includes Players, mobs, NPCs, etc., but excludes dropped items, experience orbs, etc.
Result list is sorted by closeness (1 = closest, 2 = next closest, ... last = farthest).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2617

Name<LocationTag.find.npcs.within[<#.#>]>
ReturnsListTag(NPCTag)
DescriptionReturns a list of NPCs within a radius.
Result list is sorted by closeness (1 = closest, 2 = next closest, ... last = farthest).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2573

Name<LocationTag.find.players.within[<#.#>]>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of players within a radius.
Result list is sorted by closeness (1 = closest, 2 = next closest, ... last = farthest).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2554

Name<LocationTag.find.structure[<type>].within[<#.#>]>
ReturnsLocationTag
DescriptionReturns the location of the nearest structure of the given type, within a maximum radius.
To get a list of valid structure types, use Tag:server.structure_types.
Note that structure type names are case sensitive, and likely to be all-lowercase in most cases.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2639

Name<LocationTag.find.surface_blocks[(<material>|...)].within[<#.#>]>
ReturnsListTag(LocationTag)
DescriptionReturns a list of matching surface blocks within a radius.
Result list is sorted by closeness (1 = closest, 2 = next closest, ... last = farthest).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2495

Name<LocationTag.find.unexplored_structure[<type>].within[<#.#>]>
ReturnsLocationTag
DescriptionReturns the location of the nearest unexplored structure of the given type, within a maximum radius.
To get a list of valid structure types, use Tag:server.structure_types.
Note that structure type names are case sensitive, and likely to be all-lowercase in most cases.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2662

Name<LocationTag.flood_fill[<limit>]>
ReturnsListTag(LocationTag)
DescriptionReturns the set of all blocks, starting at the given location,
that can be directly reached in a way that only travels through blocks of the same type as the starting block.
For example, if starting at an air block inside an enclosed building, this will return all air blocks inside the building (but none outside, and no non-air blocks).
As another example, if starting on a block of iron_ore in the ground, this will find all other blocks of iron ore that are part of the same vein.
This will not travel diagonally, only the 6 cardinal directions (N/E/S/W/Up/Down).
As this is potentially infinite should there be any opening however small, a limit must be given.
The limit value can be: a CuboidTag, an EllipsoidTag, or an ElementTag(Decimal) to use as a radius.
Note that the returned list will not be in any particular order.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2223

Name<LocationTag.flood_fill[<limit>].types[<matcher>]>
ReturnsListTag(LocationTag)
DescriptionReturns the set of all blocks, starting at the given location,
that can be directly reached in a way that only travels through blocks that match the given LocationTag matcher.
This will not travel diagonally, only the 6 cardinal directions (N/E/S/W/Up/Down).
As this is potentially infinite for some block types (like air, stone, etc.) should there be any opening however small, a limit must be given.
The limit value can be: a CuboidTag, an EllipsoidTag, or an ElementTag(Decimal) to use as a radius.
Note that the returned list will not be in any particular order.
The result will be an empty list if the block at the start location is not one of the input materials.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2263

Name<LocationTag.formatted>
ReturnsElementTag
DescriptionReturns the formatted version of the LocationTag.
In the format: X 'x.x', Y 'y.y', Z 'z.z', in world 'world'
For example: X '1.0', Y '2.0', Z '3.0', in world 'world_nether'
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2714

Name<LocationTag.formatted.citizens>
ReturnsElementTag
DescriptionReturns the location formatted for a Citizens command.
In the format: x.x:y.y:z.z:world
For example: 1.0:2.0:3.0:world_nether
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2723

Name<LocationTag.forward[(<#.#>)]>
ReturnsLocationTag
DescriptionReturns the location in front of this location based on pitch and yaw. Optionally specify a number of blocks to go forward.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L983

Name<LocationTag.forward_flat[(<#.#>)]>
ReturnsLocationTag
DescriptionReturns the location in front of this location based on yaw but not pitch. Optionally specify a number of blocks to go forward.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L956

Name<LocationTag.furnace_burn_duration>
ReturnsDurationTag
MechanismLocationTag.furnace_burn_duration
DescriptionReturns the burn time a furnace has left.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3476

Name<LocationTag.furnace_cook_duration>
ReturnsDurationTag
MechanismLocationTag.furnace_cook_duration
DescriptionReturns the cook time a furnace has been cooking its current item for.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3491

Name<LocationTag.furnace_cook_duration_total>
ReturnsDurationTag
MechanismLocationTag.furnace_cook_duration_total
DescriptionReturns the total cook time a furnace has left.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3506

Name<LocationTag.has_inventory>
ReturnsElementTag(Boolean)
DescriptionReturns whether the block at the location has an inventory.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1162

Name<LocationTag.has_loot_table>
ReturnsElementTag(Boolean)
MechanismLocationTag.clear_loot_table
DescriptionReturns an element indicating whether the chest at this location has a loot-table set.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3377

Name<LocationTag.head_rotation>
ReturnsElementTag(Number)
MechanismLocationTag.head_rotation
DescriptionGets the rotation of the head at this location. Can be 1-16.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1218

Name<LocationTag.highest>
ReturnsLocationTag
DescriptionReturns the location of the highest solid block at the location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1148

Name<LocationTag.hive_bee_count>
ReturnsElementTag(Number)
DescriptionReturns the number of bees inside a hive.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1443

Name<LocationTag.hive_max_bees>
ReturnsElementTag(Number)
MechanismLocationTag.hive_max_bees
DescriptionReturns the maximum number of bees allowed inside a hive.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1453

Name<LocationTag.inventory>
ReturnsInventoryTag
DescriptionReturns the InventoryTag of the block at the location. If the
block is not a container, returns null.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1172

Name<LocationTag.is_exact_teleport>
ReturnsElementTag(Boolean)
MechanismLocationTag.is_exact_teleport
DescriptionReturns whether an end gateway is 'exact teleport' - if false, the destination will be randomly chosen *near* the destination.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3695

Name<LocationTag.is_in[<matcher>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the location is in an area, using the same logic as an event "in" switch.
Invalid input may produce odd error messages, as this is passed through the event system as a fake event.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3732

Name<LocationTag.is_liquid>
ReturnsElementTag(Boolean)
DescriptionReturns whether the block at the location is a liquid.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3278

Name<LocationTag.is_lockable>
ReturnsElementTag(Boolean)
MechanismLocationTag.lock
DescriptionReturns whether the container is lockable.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1412

Name<LocationTag.is_locked>
ReturnsElementTag(Boolean)
MechanismLocationTag.lock
DescriptionReturns whether the container is locked.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1398

Name<LocationTag.is_within[<area>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the location is within the specified area (cuboid, ellipsoid, polygon, ...).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3153

Name<LocationTag.is_within_border>
ReturnsElementTag(Boolean)
DescriptionReturns whether the location is within the world border.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3143

Name<LocationTag.jukebox_is_playing>
ReturnsElementTag
MechanismLocationTag.jukebox_play
DescriptionReturns whether the jukebox is currently playing a song.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3661

Name<LocationTag.jukebox_record>
ReturnsItemTag
MechanismLocationTag.jukebox_record
DescriptionReturns the record item currently inside the jukebox.
If there's no record, will return air.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3643

Name<LocationTag.lectern_page>
ReturnsElementTag(Number)
MechanismLocationTag.lectern_page
DescriptionReturns the current page on display in the book on this Lectern block.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3362

Name<LocationTag.left[(<#.#>)]>
ReturnsLocationTag
DescriptionReturns the location to the left of this location based on pitch and yaw. Optionally specify a number of blocks to go left.
This is equivalent to Tag:LocationTag.forward with a +90 degree rotation to the yaw and the pitch set to 0.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1006

Name<LocationTag.light>
ReturnsElementTag(Number)
DescriptionReturns the total amount of light on the location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3298

Name<LocationTag.light.blocks>
ReturnsElementTag(Number)
DescriptionReturns the amount of light from light blocks that is
on the location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3310

Name<LocationTag.light.sky>
ReturnsElementTag(Number)
DescriptionReturns the amount of light from the sky that is
on the location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3322

Name<LocationTag.line_of_sight[<location>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the specified location is within this location's
line of sight.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1903

Name<LocationTag.local_difficulty>
ReturnsElementTag(Decimal)
DescriptionReturns the local difficulty (damage scaler) at the location.
This is based internally on multiple factors, including Tag:ChunkTag.inhabited_time and Tag:WorldTag.difficulty.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3632

Name<LocationTag.lock>
ReturnsElementTag
MechanismLocationTag.lock
DescriptionReturns the password to a locked container.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1383

Name<LocationTag.loot_table_id>
ReturnsElementTag
MechanismLocationTag.clear_loot_table
DescriptionReturns an element indicating the minecraft key for the loot-table for the chest at this location (if any).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3392

Name<LocationTag.material>
ReturnsMaterialTag
DescriptionReturns the material of the block at the location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1186

Name<LocationTag.mul[<length>]>
ReturnsLocationTag
DescriptionReturns the location multiplied by the specified length.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2976

Name<LocationTag.normalize>
ReturnsLocationTag
DescriptionReturns a 1-length vector in the same direction as this vector location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3002

Name<LocationTag.note_name>
ReturnsElementTag
DescriptionGets the name of a noted LocationTag. If the location isn't noted, this is null.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2906

Name<LocationTag.other_block>
ReturnsLocationTag
DescriptionIf the location is part of a double-block structure (double chests, double plants, doors, beds, etc),
returns the location of the other block in the double-block structure.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3595

Name<LocationTag.pitch>
ReturnsElementTag(Decimal)
DescriptionReturns the pitch of the object at the location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2069

Name<LocationTag.points_between[<location>]>
ReturnsListTag(LocationTag)
DescriptionFinds all locations between this location and another, separated by 1 block-width each.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1839

Name<LocationTag.points_between[<location>].distance[<#.#>]>
ReturnsListTag(LocationTag)
DescriptionFinds all locations between this location and another, separated by the specified distance each.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1851

Name<LocationTag.polygons>
ReturnsListTag(PolygonTag)
DescriptionReturns a ListTag of all noted PolygonTags that include this location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3263

Name<LocationTag.power>
ReturnsElementTag(Number)
DescriptionReturns the current redstone power level of a block.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3342

Name<LocationTag.precise_cursor_on[(<range>)]>
ReturnsLocationTag
DescriptionReturns the exact location this location is pointing at.
Optionally, specify a maximum range to find the location from (defaults to 200).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1719

Name<LocationTag.precise_cursor_on_block[(<range>)]>
ReturnsLocationTag
DescriptionReturns the block location this location is pointing at.
Optionally, specify a maximum range to find the location from (defaults to 200).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1700

Name<LocationTag.precise_impact_normal[(<range>)]>
ReturnsLocationTag
DescriptionReturns the exact impact normal at the location this location is pointing at.
In minecraft, the impact normal is generally the side of the block that the location is facing.
Optionally, specify a maximum range to find the location from (defaults to 200).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1680

Name<LocationTag.precise_target[(<range>)]>
ReturnsEntityTag
DescriptionReturns the entity this location is pointing at, using precise ray trace logic.
Optionally, specify a maximum range to find the entity from (defaults to 100).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1763

Name<LocationTag.precise_target_list[<range>]>
ReturnsListTag(EntityTag)
DescriptionReturns a list of all entities this location is pointing directly at (using precise ray trace logic), up to a given range limit.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1738

Name<LocationTag.precise_target_position[(<range>)]>
ReturnsLocationTag
DescriptionReturns the precise location this location is pointing at, when tracing against entities.
Optionally, specify a maximum range to find the entity from (defaults to 100).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1801

Name<LocationTag.precise_target_position[(<range>)].type[<entity_type>|...]>
ReturnsLocationTag
DescriptionReturns the precise location this location is pointing at, when tracing against entities.
Optionally, specify a maximum range to find the entity from (defaults to 100).
Accepts a list of types to trace against (types not listed will be ignored).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1814

Name<LocationTag.precise_target[(<range>)].type[<entity_type>|...]>
ReturnsEntityTag
DescriptionReturns the entity this location is pointing at, using precise ray trace logic.
Optionally, specify a maximum range to find the entity from (defaults to 100).
Accepts a list of types to trace against (types not listed will be ignored).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1776

Name<LocationTag.random_offset[<limit>]>
ReturnsLocationTag
DescriptionReturns a copy of this location, with the X/Y/Z offset by a random decimal value up to a given limit.
The limit can either be an X,Y,Z location vector like [3,1,3] or a single value like [3] (which is equivalent to [3,3,3]).
For example, for a location at 0,100,0, ".random_offset[1,2,3]" can return any decimal location within the cuboid from -1,98,-3 to 1,102,3.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1115

Name<LocationTag.raw>
ReturnsLocationTag
DescriptionReturns the raw representation of this location, without any note name.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2751

Name<LocationTag.relative[<location>]>
ReturnsLocationTag
DescriptionReturns the location relative to this location. Input is a vector location of the form left,up,forward.
For example, input -1,1,1 will return a location 1 block to the right, 1 block up, and 1 block forward.
To just get the location relative to this without rotation math, use Tag:LocationTag.add instead.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1064

Name<LocationTag.right[(<#.#>)]>
ReturnsLocationTag
DescriptionReturns the location to the right of this location based on pitch and yaw. Optionally specify a number of blocks to go right.
This is equivalent to Tag:LocationTag.forward with a -90 degree rotation to the yaw and the pitch set to 0.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1020

Name<LocationTag.rotate_around_x[<#.#>]>
ReturnsLocationTag
DescriptionReturns the location-vector rotated around the x axis by a specified angle in radians.
Generally used in a format like <player.location.add[<location[0,1,0].rotate_around_x[<[some_angle]>]>]>.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2153

Name<LocationTag.rotate_around_y[<#.#>]>
ReturnsLocationTag
DescriptionReturns the location-vector rotated around the y axis by a specified angle in radians.
Generally used in a format like <player.location.add[<location[1,0,0].rotate_around_y[<[some_angle]>]>]>.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2175

Name<LocationTag.rotate_around_z[<#.#>]>
ReturnsLocationTag
DescriptionReturns the location-vector rotated around the z axis by a specified angle in radians.
Generally used in a format like <player.location.add[<location[1,0,0].rotate_around_z[<[some_angle]>]>]>.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2197

Name<LocationTag.rotate_pitch[<#.#>]>
ReturnsLocationTag
DescriptionReturns the location with the pitch rotated the specified amount. Note that this is capped to +/- 90.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1989

Name<LocationTag.rotate_yaw[<#.#>]>
ReturnsLocationTag
DescriptionReturns the location with the yaw rotated the specified amount (eg 180 to face the location backwards).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1977

Name<LocationTag.round>
ReturnsLocationTag
DescriptionReturns a rounded version of the LocationTag's coordinates.
That is, each component (X, Y, Z, Yaw, Pitch) is rounded
(eg, 0.1 becomes 0.0, 0.5 becomes 1.0, 0.9 becomes 1.0).
This is NOT equivalent to the block coordinates. For that, use Tag:LocationTag.round_down.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1541

Name<LocationTag.round_down>
ReturnsLocationTag
DescriptionReturns a rounded-downward version of the LocationTag's coordinates.
That is, each component (X, Y, Z, Yaw, Pitch) is rounded downward
(eg, 0.1 becomes 0.0, 0.5 becomes 0.0, 0.9 becomes 0.0).
This is equivalent to the block coordinates of the location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1578

Name<LocationTag.round_to[<#>]>
ReturnsLocationTag
DescriptionReturns a rounded-to-precision version of the LocationTag's coordinates.
That is, each component (X, Y, Z, Yaw, Pitch) is rounded to the specified decimal place
(eg, 0.12345 .round_to[3] returns "0.123").
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1597

Name<LocationTag.round_to_precision[<#.#>]>
ReturnsLocationTag
DescriptionReturns a rounded-to-precision version of the LocationTag's coordinates.
That is, each component (X, Y, Z, Yaw, Pitch) is rounded to the specified precision value
(0.12345 .round_to_precision[0.005] returns "0.125").
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1620

Name<LocationTag.round_up>
ReturnsLocationTag
DescriptionReturns a rounded-upward version of the LocationTag's coordinates.
That is, each component (X, Y, Z, Yaw, Pitch) is rounded upward
(eg, 0.1 becomes 1.0, 0.5 becomes 1.0, 0.9 becomes 1.0).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1560

Name<LocationTag.sign_contents>
ReturnsListTag
MechanismLocationTag.sign_contents
DescriptionReturns a list of lines on a sign.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1241

Name<LocationTag.simple>
ReturnsElementTag
DescriptionReturns a simple version of the LocationTag's block coordinates.
In the format: x,y,z,world
For example: 1,2,3,world_nether
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1643

Name<LocationTag.simple.formatted>
ReturnsElementTag
DescriptionReturns the formatted simple version of the LocationTag's block coordinates.
In the format: X 'x', Y 'y', Z 'z', in world 'world'
For example, X '1', Y '2', Z '3', in world 'world_nether'
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1652

Name<LocationTag.skull_name>
ReturnsElementTag
MechanismLocationTag.skull_skin
DescriptionReturns the name of the skin the skull is displaying.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1479

Name<LocationTag.skull_skin>
ReturnsElementTag
MechanismLocationTag.skull_skin
DescriptionReturns the skin the skull is displaying - just the name or UUID as text, not a player object.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1502

Name<LocationTag.skull_skin.full>
ReturnsElementTag
MechanismLocationTag.skull_skin
DescriptionReturns the skin the skull item is displaying - just the name or UUID as text, not a player object,
along with the permanently cached texture property.
In format "uuid|texture" - separated by a pipe, but not a ListTag.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1520

Name<LocationTag.skull_type>
ReturnsElementTag
DescriptionReturns the type of the skull.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1464

Name<LocationTag.spawner_count>
ReturnsElementTag(Number)
MechanismLocationTag.spawner_count
DescriptionReturns the spawn count for the spawner.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1369

Name<LocationTag.spawner_display_entity>
ReturnsEntityTag
DescriptionReturns the full "display entity" for the spawner. This can contain more data than just a type.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1271

Name<LocationTag.spawner_max_nearby_entities>
ReturnsElementTag(Number)
MechanismLocationTag.spawner_max_nearby_entities
DescriptionReturns the maximum nearby entities for the spawner (the radius mobs will spawn in).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1355

Name<LocationTag.spawner_maximum_spawn_delay>
ReturnsElementTag(Number)
MechanismLocationTag.spawner_delay_data
DescriptionReturns the maximum spawn delay for the mob spawner.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1313

Name<LocationTag.spawner_minimum_spawn_delay>
ReturnsElementTag(Number)
MechanismLocationTag.spawner_delay_data
DescriptionReturns the minimum spawn delay for the mob spawner.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1299

Name<LocationTag.spawner_player_range>
ReturnsElementTag(Number)
MechanismLocationTag.spawner_player_range
DescriptionReturns the maximum player range for the spawner (ie how close a player must be for this spawner to be active).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1327

Name<LocationTag.spawner_range>
ReturnsElementTag(Number)
MechanismLocationTag.spawner_range
DescriptionReturns the spawn range for the spawner (the radius mobs will spawn in).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1341

Name<LocationTag.spawner_spawn_delay>
ReturnsElementTag(Number)
MechanismLocationTag.spawner_delay_data
DescriptionReturns the current spawn delay for the spawner.
This changes over time between Tag:LocationTag.spawner_minimum_spawn_delay and Tag:LocationTag.spawner_maximum_spawn_delay.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1284

Name<LocationTag.spawner_type>
ReturnsEntityTag
MechanismLocationTag.spawner_type
DescriptionReturns the type of entity spawned by a mob spawner.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1257

Name<LocationTag.sub[<location>]>
ReturnsLocationTag
DescriptionReturns the location with the specified coordinates subtracted from it.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2950

Name<LocationTag.switched>
ReturnsElementTag(Boolean)
DescriptionReturns whether the block at the location is considered to be switched on.
(For buttons, levers, etc.)
To change this, see Command:Switch
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1229

Name<LocationTag.to_cuboid[<location>]>
ReturnsCuboidTag
DescriptionReturns a cuboid from this location to the specified location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3199

Name<LocationTag.to_ellipsoid[<size>]>
ReturnsEllipsoidTag
DescriptionReturns an ellipsoid centered at this location with the specified size.
Size input is a vector of x,y,z size.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3184

Name<LocationTag.up[(<#.#>)]>
ReturnsLocationTag
DescriptionReturns the location above this location based on pitch and yaw. Optionally specify a number of blocks to go up.
This is equivalent to Tag:LocationTag.forward with a +90 degree rotation to the pitch.
To just get the location above this location, use Tag:LocationTag.above instead.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1034

Name<LocationTag.vector_length>
ReturnsElementTag(Decimal)
DescriptionReturns the 3D length of the vector/location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3016

Name<LocationTag.vector_to_face>
ReturnsElementTag
DescriptionReturns the name of the BlockFace represented by a normal vector.
Result can be any of the following:
NORTH, EAST, SOUTH, WEST, UP, DOWN, NORTH_EAST, NORTH_WEST, SOUTH_EAST, SOUTH_WEST,
WEST_NORTH_WEST, NORTH_NORTH_WEST, NORTH_NORTH_EAST, EAST_NORTH_EAST, EAST_SOUTH_EAST,
SOUTH_SOUTH_EAST, SOUTH_SOUTH_WEST, WEST_SOUTH_WEST, SELF
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3026

Name<LocationTag.with_facing_direction>
ReturnsLocationTag
DescriptionReturns the location with its direction set to the block's facing direction.
Only works for block types that have directionality (such as signs, chests, stairs, etc.).
You can use <some_block_location.with_facing_direction.forward[1]> to get the block directly in front of this block (based on its facing direction).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L911

Name<LocationTag.with_pitch[<number>]>
ReturnsLocationTag
DescriptionReturns a copy of the location with a changed pitch value.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2875

Name<LocationTag.with_pose[<entity>/<pitch>,<yaw>]>
ReturnsLocationTag
DescriptionReturns the location with pitch and yaw.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2079

Name<LocationTag.with_world[<world>]>
ReturnsLocationTag
DescriptionReturns a copy of the location with a changed world value.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2890

Name<LocationTag.with_x[<number>]>
ReturnsLocationTag
DescriptionReturns a copy of the location with a changed X value.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2815

Name<LocationTag.with_y[<number>]>
ReturnsLocationTag
DescriptionReturns a copy of the location with a changed Y value.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2830

Name<LocationTag.with_yaw[<number>]>
ReturnsLocationTag
DescriptionReturns a copy of the location with a changed yaw value.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2860

Name<LocationTag.with_z[<number>]>
ReturnsLocationTag
DescriptionReturns a copy of the location with a changed Z value.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2845

Name<LocationTag.world>
ReturnsWorldTag
DescriptionReturns the world that the location is in.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2763

Name<LocationTag.x>
ReturnsElementTag(Decimal)
DescriptionReturns the X coordinate of the location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2773

Name<LocationTag.xyz>
ReturnsElementTag
DescriptionReturns the location in "x,y,z" format.
For example: 1,2,3
World, yaw, and pitch will be excluded from this output.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2803

Name<LocationTag.y>
ReturnsElementTag(Decimal)
DescriptionReturns the Y coordinate of the location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2783

Name<LocationTag.yaw>
ReturnsElementTag(Decimal)
DescriptionReturns the normalized yaw of the object at the location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2107

Name<LocationTag.yaw.raw>
ReturnsElementTag(Decimal)
DescriptionReturns the raw yaw of the object at the location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2140

Name<LocationTag.yaw.simple>
ReturnsElementTag
DescriptionReturns the yaw as 'North', 'South', 'East', or 'West'.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2114

Name<LocationTag.z>
ReturnsElementTag(Decimal)
DescriptionReturns the Z coordinate of the location.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2793

Name<LocationTag.patterns>
ReturnsListTag
MechanismLocationTag.patterns
DescriptionLists the patterns of the banner at this location in the form "COLOR/PATTERN|COLOR/PATTERN" etc.
For the list of possible colors, see URL:https://hub.spigotmc.org/javadocs/spigot/org/bukkit/DyeColor.html.
For the list of possible patterns, see URL:https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/banner/PatternType.html.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1200

Name<LocationTag.tree_distance>
ReturnsElementTag(Number)
DescriptionReturns a number of how many blocks away from a connected tree leaves are.
Defaults to 7 if not connected to a tree.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3410

Name<LocationTag.faction>
ReturnsFactionTag
DescriptionReturns the faction at the location. (Can also be SafeZone, WarZone, or Wilderness)
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/factions/FactionsLocationProperties.java#L58

Name<LocationTag.griefprevention.claim>
ReturnsGriefPreventionClaimTag
DescriptionReturns the GriefPreventionClaim at this location.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/griefprevention/GriefPreventionLocationProperties.java#L84

Name<LocationTag.griefprevention.has_claim[(<ignore_height>)]>
ReturnsElementTag(Boolean)
DescriptionReturns whether there is a GriefPreventionClaim at this location.
Optionally specify an ElementTag(Boolean) for whether to ignore Y axis.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/griefprevention/GriefPreventionLocationProperties.java#L65

Name<LocationTag.has_residence>
ReturnsElementTag(Boolean)
DescriptionReturns if the location has a residence.
RequiresDepenizen, Residence
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/residence/ResidenceLocationProperties.java#L53

Name<LocationTag.has_town>
ReturnsElementTag(Boolean)
DescriptionReturns whether the location is within a town.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L114

Name<LocationTag.in_region[(<name>|...)]>
ReturnsElementTag(Boolean)
DescriptionIf a region name or list of names is specified, returns whether the
location is in one of the listed regions, otherwise returns whether
the location is in any region.
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardLocationProperties.java#L89

Name<LocationTag.is_wilderness>
ReturnsElementTag(Boolean)
DescriptionReturns whether the location is wilderness.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L146

Name<LocationTag.mcmmo.is_placed>
ReturnsElementTag(Boolean)
DescriptionReturns whether the location is tracked by McMMO as a player-placed block (might only apply to certain block types).
RequiresDepenizen, mcMMO
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mcmmo/McMMOLocationProperties.java#L61

Name<LocationTag.plotsquared_plot>
ReturnsPlotSquaredPlotTag
DescriptionReturns the plot contained by this location.
RequiresDepenizen, PlotSquared
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/plotsquared/PlotSquaredLocationProperties.java#L57

Name<LocationTag.regions>
ReturnsListTag(WorldGuardRegionTag)
DescriptionReturns a list of regions that the location is in.
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardLocationProperties.java#L116

Name<LocationTag.residence>
ReturnsResidenceTag
DescriptionReturns the residence contained by this location.
RequiresDepenizen, Residence
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/residence/ResidenceLocationProperties.java#L65

Name<LocationTag.skyblock.has_skyblock>
ReturnsElementTag(Boolean)
DescriptionReturns whether the location has a skyblock.
RequiresDepenizen, A SkyBlock
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/askyblock/ASkyBlockLocationProperties.java#L64

Name<LocationTag.skyblock.owner>
ReturnsPlayerTag
DescriptionReturns the owner of the skyblock at the location.
RequiresDepenizen, A SkyBlock
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/askyblock/ASkyBlockLocationProperties.java#L75

Name<LocationTag.tc_biome.name>
ReturnsElementTag
DescriptionReturns the TerrainControl biome name at this location, if any.
RequiresDepenizen, TerrainControl
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/terraincontrol/TCLocationProperties.java#L63

Name<LocationTag.tc_biome.temperature>
ReturnsElementTag
DescriptionReturns the TerrainControl biome temperature at this location, if any.
RequiresDepenizen, TerrainControl
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/terraincontrol/TCLocationProperties.java#L75

Name<LocationTag.town>
ReturnsTownTag
DescriptionReturns the town at the specified location.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L130

Name<LocationTag.towny_type>
ReturnsElementTag
DescriptionReturns the type of the Towny area this location is in.
Can be RESIDENTIAL, COMMERCIAL, ARENA, EMBASSY, WILDS, SPLEEF, INN, JAIL, FARM, or BANK.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L98

Name<LocationTag.towny.resident>
ReturnsPlayerTag
DescriptionReturns the resident of a Towny plot at the location, if any.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L73



Category: MapTag


Name<MapTag.contains[<key>|...]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the map contains the specified key.
If a list is given as input, returns whether the map contains all of the specified keys.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L385

Name<MapTag.deep_exclude[<key>|...]>
ReturnsMapTag
DescriptionReturns a copy of the map with the specified deep key(s) excluded.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L598

Name<MapTag.deep_get[<key>|...]>
ReturnsObjectTag
DescriptionReturns the object value at the specified key, using deep key paths separated by the '.' symbol.
This means if you have a MapTag with key 'root' set to the value of a second MapTag (with key 'leaf' as "myvalue"),
then ".deep_get[root.leaf]" will return "myvalue".
If a list is given as input, returns a list of values.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L436

Name<MapTag.deep_keys>
ReturnsListTag
DescriptionReturns a list of all keys in this map, including keys in any sub-maps (map values that are in turn MapTags), using deep key paths separated by the '.' symbol.
No returned key value will refer to a MapTag instance.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L653

Name<MapTag.deep_with[<key>].as[<value>]>
ReturnsMapTag
DescriptionReturns a copy of the map, with the specified key set to the specified value, using deep key paths separated by the '.' symbol.
This means for example if you use "deep_with[root.leaf].as[myvalue]", you will have the key 'root' set to the value of a second MapTag (with key 'leaf' as "myvalue").
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L522

Name<MapTag.default[<key>].as[<value>]>
ReturnsMapTag
DescriptionReturns a copy of the map, with the specified key defaulted to the specified value.
If the map does not already have the specified key, this is equivalent to the 'with[key].as[value]' tag.
If the map already has the specified key, this will return the original map, unmodified.
For example, on a map of [a=1;b=2;c=3], using ".default[d].as[4]" will return [a=1;b=2;c=3;d=4].
For example, on a map of [a=1;b=2;c=3], using ".default[c].as[4]" will return [a=1;b=2;c=3].
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L488

Name<MapTag.exclude[<key>|...]>
ReturnsMapTag
DescriptionReturns a copy of the map with the specified key(s) excluded.
For example, on a map of [a=1;b=2;c=3], using ".exclude[b]" will return [a=1;c=3].
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L616

Name<MapTag.filter_tag[<parseable-boolean>]>
ReturnsMapTag
Descriptionreturns a copy of the map with all its contents parsed through the given input tag and only including ones that returned 'true'.
This requires a fully formed tag as input, making use of the 'filter_key' and 'filter_value' definition.
For example: a map of [a=1;b=2;c=3;d=4;e=5] .filter_tag[<[filter_value].is[or_more].than[3]>] returns a list of [c=3;d=4;e=5].
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L327

Name<MapTag.get[<key>|...]>
ReturnsObjectTag
DescriptionReturns the object value at the specified key.
If a list is given as input, returns a list of values.
For example, on a map of [a=1;b=2;c=3], using ".get[b]" will return "2".
For example, on a map of [a=1;b=2;c=3], using ".get[b|c]" will return a list of "2|3".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L411

Name<MapTag.get_subset[<key>|...]>
ReturnsMapTag
DescriptionReturns the subset of the map represented by the given keys, ordered based on the input list.
For example, on a map of [a=1;b=2;c=3], using ".get_subset[b|a]" will return [b=2;a=1].
Keys that aren't present in the original map will be ignored.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L463

Name<MapTag.include[<map>]>
ReturnsMapTag
DescriptionReturns a copy of the map with the specified map's contents copied in.
For example, on a map of [a=1;b=2;c=3], using ".include[d=4;e=5]" will return [a=1;b=2;c=3;d=4;e=5].
Matching keys will be overridden. For example, on a map of [a=1;b=2;c=3], using ".include[b=4;c=5]" will return [a=1;b=4;c=5].
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L635

Name<MapTag.invert>
ReturnsMapTag
DescriptionReturns an inverted copy of the map. That is, keys become values and values become keys.
For example, on a map of [a=1;b=2;c=3], using "invert" will return [1=a;2=b;3=c].
All values in the result will be ElementTags.
Note that the size of the result is not guaranteed to be the same as the input (as duplicate keys are not allowed, but duplicate values are).
In the case of duplicate new-keys, the last instance of the new-key will be preserved.
For example, on a map of [a=1;b=2;c=2], using "invert" will return [1=a;2=c].
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L579

Name<MapTag.is_empty>
ReturnsElementTag(Boolean)
DescriptionReturns "true" if the map is empty (contains no keys), otherwise "false".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L274

Name<MapTag.keys>
ReturnsListTag
DescriptionReturns a list of all keys in this map.
For example, on a map of [a=1;b=2;c=3], using "keys" will return "a|b|c|".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L673

Name<MapTag.parse_value_tag[<parseable-value>]>
ReturnsMapTag
Descriptionreturns a copy of the map with all its values updated through the given tag.
This requires a fully formed tag as input, making use of the 'parse_key' and 'parse_value' definition.
For example: a map of [alpha=one;bravo=two] .parse_value_tag[<[parse_value].to_uppercase>] returns a map of [alpha=ONE;bravo=TWO].
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L357

Name<MapTag.size>
ReturnsElementTag(Number)
DescriptionReturns the size of the map - that is, how many key/value pairs are within it.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L264

Name<MapTag.sort_by_value[(<tag>)]>
ReturnsMapTag
Descriptionreturns a copy of the map, sorted alphanumerically by the value under each key.
Optionally, specify a tag to apply to the value.
To sort by key, use Tag:MapTag.get_subset with list sort tags, like 'map.get_subset[map.keys.sort_by_value[...]]'.
This also lets you apply list filters or similar to the keyset.
To apply a '.parse' to the values, use Tag:ListTag.map_with, like 'map.keys.map_with[map.values.parse[...]]'
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L284

Name<MapTag.to_json>
ReturnsElementTag
DescriptionReturns a JSON encoding of this map.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L731

Name<MapTag.to_list>
ReturnsListTag
DescriptionReturns a list of all key/value pairs in this map, separated by the slash '/' symbol.
Note that there is no slash ('/') escaping, so maps that have slashes in their keys will not be possible to convert back to a map.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L716

Name<MapTag.to_pair_lists>
ReturnsListTag
DescriptionReturns a list of all key/value pairs in this map, where each entry in the list is itself a list with 2 entries: the key, then the value.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L699

Name<MapTag.to_yaml>
ReturnsElementTag
DescriptionReturns a YAML encoding of this map.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L741

Name<MapTag.values>
ReturnsListTag
DescriptionReturns a list of all values in this map.
For example, on a map of [a=1;b=2;c=3], using "values" will return "1|2|3|".
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L684

Name<MapTag.with[<key>].as[<value>]>
ReturnsMapTag
DescriptionReturns a copy of the map, with the specified key set to the specified value.
For example, on a map of [a=1;b=2;c=3], using ".with[d].as[4]" will return [a=1;b=2;c=3;d=4].
Matching keys will be overridden. For example, on a map of [a=1;b=2;c=3], using ".with[c].as[4]" will return [a=1;b=2;c=4].
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L550



Category: MaterialTag


Name<MaterialTag.advanced_matches[<matcher>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material matches some matcher text, using the system behind Language:Advanced Script Event Matching.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L566

Name<MaterialTag.block_resistance>
ReturnsElementTag(Decimal)
MechanismMaterialTag.block_resistance
DescriptionReturns the explosion resistance for all blocks of this material type.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L452

Name<MaterialTag.block_strength>
ReturnsElementTag(Decimal)
MechanismMaterialTag.block_strength
DescriptionReturns the material's strength level. (Only for block materials).
This is a representation of how much time mining is needed to break a block.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L541

Name<MaterialTag.fuel_burn_time>
ReturnsDurationTag
DescriptionReturns the duration that a burnable fuel block will burn in a furnace for.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L388

Name<MaterialTag.hardness>
ReturnsElementTag(Decimal)
DescriptionReturns the value representing how hard a material, used as a basis for calculating the time it takes to break.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L467

Name<MaterialTag.has_gravity>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is affected by gravity.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L316

Name<MaterialTag.is_block>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is a placeable block.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L326

Name<MaterialTag.is_burnable>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is a block that can burn away.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L348

Name<MaterialTag.is_edible>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is edible.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L358

Name<MaterialTag.is_flammable>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is a block that can catch fire.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L368

Name<MaterialTag.is_fuel>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is a block that can be burned in a furnace as fuel.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L378

Name<MaterialTag.is_item>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is a holdable item.
Note that most blocks are valid items as well.
This only returns "false" for certain non-holdable "special" blocks, like Fire.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L336

Name<MaterialTag.is_occluding>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is a block that completely blocks vision.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L402

Name<MaterialTag.is_record>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is a playable music disc.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L412

Name<MaterialTag.is_solid>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is a block that is solid (can be built upon).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L422

Name<MaterialTag.is_transparent>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is a block that does not block any light.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L432

Name<MaterialTag.item>
ReturnsItemTag
DescriptionReturns an item of the material.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L516

Name<MaterialTag.max_durability>
ReturnsElementTag(Number)
DescriptionReturns the maximum durability of this material.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L442

Name<MaterialTag.max_stack_size>
ReturnsElementTag(Number)
MechanismMaterialTag.max_stack_size
DescriptionReturns the maximum amount of this material that can be held in a stack.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L481

Name<MaterialTag.name>
ReturnsElementTag
DescriptionReturns the name of the material.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L506

Name<MaterialTag.piston_reaction>
ReturnsElementTag
MechanismMaterialTag.piston_reaction
DescriptionReturns the material's piston reaction. (Only for block materials).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L526

Name<MaterialTag.produced_instrument>
ReturnsElementTag
DescriptionReturns the name of the instrument that would be used by a note block placed above a block of this material.
See list at URL:https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Instrument.html.
For the current instrument of a note block material refer to Tag:MaterialTag.instrument.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L593

Name<MaterialTag.translated_name>
ReturnsElementTag
DescriptionReturns the localized name of the material.
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/objects/MaterialTag.java#L492

Name<MaterialTag.vanilla_tags>
ReturnsListTag
DescriptionReturns a list of vanilla tags that apply to this material. See also URL:https://minecraft.fandom.com/wiki/Tag.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L579

Name<MaterialTag.age>
ReturnsElementTag(Number)
MechanismMaterialTag.age
DescriptionReturns the current age for an ageable material. This includes plant growth.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialAge.java#L57

Name<MaterialTag.count>
ReturnsElementTag(Number)
MechanismMaterialTag.count
DescriptionReturns the amount of pickles in a Sea Pickle material, eggs in a Turtle Egg material, charges in a Respawn Anchor material, or candles in a Candle material.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialCount.java#L55

Name<MaterialTag.count_max>
ReturnsElementTag(Number)
MechanismMaterialTag.count
DescriptionReturns the maximum amount of pickles allowed in a Sea Pickle material, eggs in a Turtle Egg material, charges in a Respawn Anchor material, or candles in a Candle material.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialCount.java#L67

Name<MaterialTag.count_min>
ReturnsElementTag(Number)
MechanismMaterialTag.count
DescriptionReturns the minimum amount of pickles allowed in a Sea Pickle material, eggs in a Turtle Egg material, charges in a Respawn Anchor material, or candles in a Candle material.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialCount.java#L79

Name<MaterialTag.delay>
ReturnsElementTag(Number)
MechanismMaterialTag.delay
DescriptionReturns the current delay of a redstone repeater material.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialDelay.java#L40

Name<MaterialTag.direction>
ReturnsElementTag
MechanismMaterialTag.direction
DescriptionReturns the current facing direction for a directional material (like a door or a bed).
Output is a direction name like "NORTH", or an axis like "X", or a rail direction like "ASCENDING_NORTH".
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialDirectional.java#L95

Name<MaterialTag.faces>
ReturnsListTag
Mechanism