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

Categories:

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



Category: Base


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name<&translate[key=<key>;(fallback=<fallback>);(with=<text>|...)]>
ReturnsElementTag
DescriptionReturns a special chat code that is read by the client to display an auto-translated message.
"key" is the translation key.
Optionally specify "fallback" as text to display when the client can't find a translation for the key.
Optionally specify "with" as a list of input data for the translatable message (parts of the message that are dynamic).
Be warned that language keys can change between Minecraft versions.
Note that this is a magic Denizen tool - refer to Language:Denizen Text Formatting.
You can use Tag:ElementTag.strip_color to convert the translated output to plain text (pre-translated).
Example
Narrates a translatable of a diamond sword's name.
- narrate "Reward: <&translate[key=item.minecraft.diamond_sword]>"
Example
Narrates a translatable with some input data.
- narrate <&translate[key=commands.give.success.single;with=32|<&translate[key=item.minecraft.diamond_sword]>|<player.name>]>
Example
Narrates a custom translatable (from something like a resource pack), with a fallback in case it can't be translated.
- narrate <&translate[key=my.custom.translation;fallback=Please use the resource pack!]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L183

Name<&translate[<key>].with[<text>|...]>
ReturnsElementTag
DescriptionDeprecated in favor of Tag:&translate.
DeprecatedUse '<&translate[key=<key>;with=<text>|...]>'.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L211

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

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

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

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

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

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

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

Name<color[<color>]>
ReturnsColorTag
DescriptionReturns a color object constructed from the input value.
Refer to ObjectType:ColorTag.
Generated Example
- inventory adjust slot:hand color:<color[red]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L83

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name<image[<image>]>
ReturnsImageTag
DescriptionReturns an ImageTag constructed from the input value.
Refer to ObjectType:ImageTag.
Generated Example
- draw id:artwork image:<image[loaded_image_id]> x:5 y:5
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L121

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



Category: AreaObject


Name<AreaObject.approximate_overlap_areas>
ReturnsListTag(AreaObject)
DescriptionReturns a list of all noted areas that approximately overlap this area.
May be inaccurate for objects with complex shapes.
Errs on the side of over-inclusion (ie areas that don't overlap may be in the list, but areas that do overlap will never be excluded).
Generated Example
- foreach <cuboid[my_noted_cuboid].approximate_overlap_areas> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L348

Name<AreaObject.blocks[(<matcher>)]>
ReturnsListTag(LocationTag)
DescriptionReturns each block location within the area.
Optionally, specify a material matcher to only return locations with that block type.
Example
# Spawns a debugblock to highlight every plank-type block in the area.
- debugblock <cuboid[my_cuboid].blocks[*planks]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L214

Name<AreaObject.blocks_flagged[<flag_name>]>
ReturnsListTag(LocationTag)
DescriptionGets a list of all block locations with a specified flag within the area.
Searches the internal flag lists, rather than through all possible blocks.
Example
# Spawns a debugblock to highlight every block in the cuboid that has the location flag 'my_flag'.
- debugblock <cuboid[my_cuboid].blocks_flagged[my_flag]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L265

Name<AreaObject.bounding_box>
ReturnsCuboidTag
DescriptionReturns a cuboid approximately representing the maximal bounding box of the area (anything this cuboid does not contain, is also not contained by the area, but not vice versa).
For single-member CuboidTags, this tag returns a copy of the cuboid.
Example
# Notes the polygon's bounding box to efficiently check when things are near the polygon, even if not exactly inside.
- note <polygon[my_poly].bounding_box> my_bound_box
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L93

Name<AreaObject.contains[<location>]>
ReturnsElementTag(Boolean)
DescriptionReturns a boolean indicating whether the specified location is inside this area.
Example
# Checks to see if "my_cuboid" contains the player's location.
- if <cuboid[my_cuboid].contains[<player.location>]>:
     - narrate "You are within 'my_cuboid'!"
- else:
     - narrate "You are NOT within 'my_cuboid'!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L198

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

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

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

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

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

Name<AreaObject.shell>
ReturnsListTag(LocationTag)
DescriptionReturns each block location on the 3D outer shell of the area.
This tag is useful for displaying particles or blocks to mark the boundary of the area.
Example
# Spawns a hollow sphere of fire around the player.
- playeffect effect:flame at:<player.location.to_ellipsoid[5,5,5].shell> offset:0
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L279

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

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

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



Category: BinaryTag


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

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

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

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

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

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

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

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

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

Name<BinaryTag.to_image>
ReturnsImageTag
DescriptionReturns an ImageTag of the image represented by the binary data, or null if the binary data doesn't represent an image.
Example
Converts a base64 encoded string into an ImageTag, commonly used in web APIs.
- define image <[base64].base64_to_binary.to_image>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L394

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

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

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

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



Category: BiomeTag


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

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

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

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

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

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

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

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

Name<BiomeTag.spawnable_entities[(<type>)]>
ReturnsListTag
DescriptionReturns all entities that spawn naturally in this biome.
Optionally specify a type as: AMBIENT, CREATURES, MONSTERS, WATER, or ALL.
(By default, will be "ALL").
Example
# Narrates the types of entities of type MONSTERS that can spawn in the player's biome.
# For example, in a plains biome this could contain "SPIDER", "ZOMBIE", "CREEPER", etc.
- narrate <player.location.biome.spawnable_entities[MONSTERS].formatted>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L234

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

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



Category: ChunkTag


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

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

Name<ChunkTag.blocks_flagged[<flag_name>]>
ReturnsListTag(LocationTag)
DescriptionGets a list of all block locations with a specified flag within the CuboidTag.
Searches the internal flag lists, rather than through all possible blocks.
Example
# Spawns a debugblock to highlight every block in the chunk flagged "my_flag"
- debugblock <player.location.chunk.blocks_flagged[my_flag]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L688

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

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

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

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

Name<ChunkTag.inhabited_time>
ReturnsDurationTag
MechanismChunkTag.inhabited_time
DescriptionReturns the total time the chunk has been inhabited for.
This is a primary deciding factor in the "local difficulty" setting.
Example
# Narrates the time inhabited in the chunk by the player formatted into words.
# For example: "You have been in this chunk for a total of 2 hours 26 minutes!"
- narrate "You have been in this chunk for a total of <player.location.chunk.inhabited_time.formatted_words>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L730

Name<ChunkTag.is_flat[(<#>)]>
ReturnsElementTag(Boolean)
DescriptionScans the heights of the blocks to check variance between them.
If no number is supplied, is_flat will return true if all the blocks are less than 2 blocks apart in height.
Specifying a number will modify the number criteria for determining if it is flat.
Example
- if <player.location.chunk.is_flat>:
    - narrate "Wow! That is a flat chunk!"
- else:
    - narrate "Watch out! This chunk has a more rugged terrain!"
Example
- if <player.location.chunk.is_flat[4]>:
    - narrate "Wow! This chunk's blocks are all less than 4 blocks apart in height!"
- else:
    - narrate "This chunk's blocks do not meet the criteria of being flat."
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L625

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

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

Name<ChunkTag.living_entities>
ReturnsListTag(EntityTag)
DescriptionReturns a list of living entities in the chunk.
This includes Players, mobs, NPCs, etc., but excludes dropped items, experience orbs, etc.
Example
# Loops though the living entities found in the player's chunk and narrates the name and location of it.
- foreach <player.location.chunk.living_entities> as:entity:
    - narrate "Found a <[entity].name> at <[entity].location.simple>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L526

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

Name<ChunkTag.plugin_tickets>
ReturnsListTag(PluginTag)
MechanismChunkTag.clear_plugin_tickets
DescriptionReturns a list of plugins that are keeping this chunk loaded.
This is related to the Command:chunkload command.
Example
# Narrates the list of plugin names keeping the player's chunk loaded formatted into readable format.
# Example: "Plugins keeping your chunk loaded: Denizen and Citizens".
- narrate "Plugins keeping your chunk loaded: <player.location.chunk.plugin_tickets.formatted>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L368

Name<ChunkTag.spawn_slimes>
ReturnsElementTag(Boolean)
DescriptionReturns whether the chunk is a specially located 'slime spawner' chunk.
Example
- if <player.location.chunk.spawn_slimes>:
    - narrate "Watch out! Slimes can spawn here!"
- else:
    - narrate "No slimes can spawn here! You are safe for now!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L711

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

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

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

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

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

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



Category: ColorTag


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



Category: CuboidTag


Name<CuboidTag.add_member[<cuboid>|...]>
ReturnsCuboidTag
MechanismCuboidTag.add_member
DescriptionReturns a modified copy of this cuboid, with the input cuboid(s) added at the end.
Example
# Creates a new cuboid named "my_third_cuboid" and adds "my_cuboid" and "my_second_cuboid" as members.
# You can also use the "add_member" mechanism.
- note <cuboid[my_cuboid].add_member[my_second_cuboid]> as:my_third_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L954

Name<CuboidTag.add_member[<cuboid>|...].at[<index>]>
ReturnsCuboidTag
MechanismCuboidTag.add_member
DescriptionReturns a modified copy of this cuboid, with the input cuboid(s) added at the specified index.
Example
# Adds "my_second_cuboid" as a member of "my_cuboid" at an index of 3.
# You can also use the "add_member" mechanism.
- note <cuboid[my_cuboid].add_member[my_second_cuboid].at[3]> as:my_third_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L974

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

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

Name<CuboidTag.contained_cuboids>
ReturnsListTag(CuboidTag)
DescriptionReturns a list of all noted cuboid areas that this cuboid fully contains.
Generated Example
- foreach <cuboid[my_noted_cuboid].contained_cuboids> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1608

Name<CuboidTag.contains_cuboid[<cuboid>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this cuboid fully contains another cuboid.
Example
# Checks if the cuboid, "my_cuboid", contains "my_second_cuboid".
- if <cuboid[my_cuboid].contains_cuboid[my_second_cuboid]>:
    - narrate "My_Cuboid contains Second!"
- else:
    - narrate "Second is NOT contained!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L808

Name<CuboidTag.corners>
ReturnsListTag(LocationTag)
DescriptionReturns all 8 corners of the cuboid.
The 4 low corners, then the 4 high corners.
In order X-Z-, X+Z-, X-Z+, X+Z+
If the object is a multi-member cuboid, returns corners for all members in sequence.
Example
# Displays a glowstone block marker effect at each corner of the cuboid.
- playeffect effect:block_marker special_data:glowstone at:<cuboid[my_cuboid].corners> offset:0.0
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1176

Name<CuboidTag.expand[<location>]>
ReturnsCuboidTag
DescriptionExpands the cuboid by the given amount, and returns the changed cuboid.
This will decrease the min coordinates by the given vector location, and increase the max coordinates by it.
Supplying a negative input will therefore contract the cuboid.
Note that you can also specify a single number to expand all coordinates by the same amount (equivalent to specifying a location that is that value on X, Y, and Z).
Not valid for multi-member CuboidTags.
Example
# If "my_cuboid" spans from 10,10,10 to 5,5,5 and gets expanded by 15 (15,15,15),
# then "my_expanded_cuboid" will span -10,-10,-10 (min) to 25,25,25 (max).
- note <cuboid[my_cuboid].expand[15]> as:my_expanded_cuboid
Example
# If "my_cuboid" spans from 10,10,10 to 5,5,5 and gets expanded by 15,20,25,
# then "my_expanded_cuboid" will span -10,-15,-20 (min) to 25,30,35 (max).
- note <cuboid[my_cuboid].expand[15,20,25]> as:my_expanded_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1376

Name<CuboidTag.expand_one_side[<location>]>
ReturnsCuboidTag
DescriptionExpands the cuboid by the given amount in just one direction, and returns the changed cuboid.
If a coordinate is positive, it will expand the high value. If it is negative, it will expand the low value.
Note that you can also specify a single number to expand all coordinates by the same amount (equivalent to specifying a location that is that value on X, Y, and Z).
Inverted by Tag:CuboidTag.shrink_one_side
Not valid for multi-member CuboidTags.
Example
# Expands the high value of the cuboid "my_cuboid" by 15,16,17 on one side and notes it as "my_expanded_cuboid".
# If "my_cuboid" spans from 10,10,10 (max) to 5,5,5 (min), then expanding it by 15,16,17 will make "my_expanded_cuboid"
# span from 25,26,27 (max) to 5,5,5 (min).
- note <cuboid[my_cuboid].expand_one_side[15,16,17]> as:my_expanded_cuboid
Example
# Expands the low value of the cuboid "my_cuboid" by -15 (-15,-15,-15) on one side and notes it as "my_expanded_cuboid".
# If "my_cuboid" spans from 10,10,10 (max) to 5,5,5 (min), then shrinking it by -15 will make "my_expanded_cuboid"
# span from 10,10,10 (max) to -10,-10,-10 (min).
- note <cuboid[my_cuboid].expand_one_side[-15]> as:my_expanded_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1411

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

Name<CuboidTag.include[<location>/<cuboid>]>
ReturnsCuboidTag
DescriptionExpands the first member of the CuboidTag to contain the given location (or entire cuboid), and returns the expanded cuboid.
Example
# Expands the cuboid to contain the player's location and notes it as "my_new_cuboid".
- note <cuboid[my_cuboid].include[<player.location>]> as:my_new_cuboid
Example
# Expands the cuboid to contain the cuboid "my_second_cuboid" and notes it as "my_new_cuboid".
- note <cuboid[my_cuboid].include[my_second_cuboid]> as:my_new_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1225

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

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

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

Name<CuboidTag.intersecting_cuboids>
ReturnsListTag(CuboidTag)
DescriptionReturns a list of all noted cuboid areas that this cuboid intersects with.
Generated Example
- foreach <cuboid[my_noted_cuboid].intersecting_cuboids> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1627

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name<CuboidTag.shrink_one_side[<location>]>
ReturnsCuboidTag
DescriptionShrinks the cuboid by the given amount in just one direction, and returns the changed cuboid.
If a coordinate is positive, it will shrink the high value. If it is negative, it will shrink the low value.
Note that you can also specify a single number to expand all coordinates by the same amount (equivalent to specifying a location that is that value on X, Y, and Z).
Inverted by Tag:CuboidTag.expand_one_side
Not valid for multi-member CuboidTags.
If you shrink past the limits of the cuboid's size, the cuboid will flip and start expanding the opposite direction.
Example
# Shrinks the high value of the cuboid "my_cuboid" by 15,16,17 on one side and notes it as "my_smaller_cuboid".
# If "my_cuboid" spans from 10,10,10 (max) to 5,5,5 (min), then shrinking it by 15,16,17 will make "my_smaller_cuboid"
# span from 5,5,5 (max) to -5,-6,-7 (min).
- note <cuboid[my_cuboid].shrink_one_side[15,16,17]> as:my_smaller_cuboid
Example
# Shrinks the low value of the cuboid "my_cuboid" by -15 (-15,-15,-15) on one side and notes it as "my_smaller_cuboid".
# If "my_cuboid" spans from 10,10,10 (max) to 5,5,5 (min), then shrinking it by -15 will make "my_smaller_cuboid"
# span from 20,20,20 (max) to 10,10,10 (min).
- note <cuboid[my_cuboid].shrink_one_side[-15]> as:my_smaller_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1468

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

Name<CuboidTag.volume>
ReturnsElementTag(Number)
DescriptionReturns the volume of the cuboid.
Effectively equivalent to: (size.x * size.y * size.z).
Not valid for multi-member CuboidTags.
Example
# For example, a cuboid with a size of "6,7,8" will have a volume of "336". 6 * 7 * 8 = 336.
- narrate "The volume of the cuboid 'my_cuboid' is: <cuboid[my_cuboid].volume>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1077

Name<CuboidTag.walls>
ReturnsListTag(LocationTag)
DescriptionReturns each block location on the walls of the CuboidTag - that is, the shell minus top and bottom.
Example
# Plays the "flame" effect at the walls of the cuboid.
- playeffect effect:flame at:<cuboid[my_cuboid].walls> offset:0.0
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L795

Name<CuboidTag.with_max[<location>]>
ReturnsCuboidTag
DescriptionChanges the cuboid to have the given maximum location, and returns the changed cuboid.
If values in the new max are lower than the existing min, the output min will contain the new max values,
and the output max will contain the old min values.
Note that this is equivalent to constructing a cuboid with the input value and the original cuboids min value.
Not valid for multi-member CuboidTags.
Example
# Notes a new cuboid with the player's location as the new maximum location of the cuboid.
# For example: if "my_cuboid" spans from 10,10,10 (max) to 5,5,5 (min) and the player had a location of 15,10,15,
# then "my_new_cuboid" will span from 15,10,15 (max) to 5,5,5 (min).
- note <cuboid[my_cuboid].with_max[<player.location>]> as:my_new_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1352

Name<CuboidTag.with_min[<location>]>
ReturnsCuboidTag
DescriptionChanges the cuboid to have the given minimum location, and returns the changed cuboid.
If values in the new min are higher than the existing max, the output max will contain the new min values,
and the output min will contain the old max values.
Note that this is equivalent to constructing a cuboid with the input value and the original cuboids max value.
Not valid for multi-member CuboidTags.
Example
# Notes a new cuboid with the player's location as the new minimum location of the cuboid.
# For example: if "my_cuboid" spans from 10,10,10 (max) to 5,5,5 (min) and the player had a location of -5,5,-5,
# then "my_new_cuboid" will have a minimum location of -5,5,-5.
- note <cuboid[my_cuboid].with_min[<player.location>]> as:my_new_cuboid
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1328

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

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

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

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



Category: DurationTag


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



Category: ElementTag


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

Name<ElementTag.snbt_to_map>
ReturnsMapTag
DescriptionParses a raw SNBT string into an NBT MapTag.
See Language:Raw NBT Encoding for more information on the returned MapTag.
See 🔗https://minecraft.wiki/w/NBT_format#SNBT_format for more information on SNBT.
Example
Use to set certain SNBT data onto an entity.
- adjust <[entity]> raw_nbt:<[snbt].snbt_to_map>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L914

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name<ElementTag.strip_color>
ReturnsElementTag
DescriptionReturns the element with all color encoding stripped.
This will remove any/all colors, formats (bold/italic/etc), advanced formats (fonts/clickables/etc), and translate any translatables (&translate, &score, etc).
This will automatically translate translatable sections
Generated Example
- narrate <element[hello_world].strip_color>
Grouptext manipulation
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L346

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

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

Name<ElementTag.discord_id_to_time>
ReturnsTimeTag
DescriptionReturns the TimeTag converted from the given discord ID.
Discord IDs internally are just timestamps in a Discord-specific numeric format.
Example
# Find out when a message was sent.
- narrate "You wrote <[message].text> at <[message].id.discord_id_to_time.format>"
Groupextensions
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/properties/DiscordElementTagExtensions.java#L11

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

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



Category: EllipsoidTag


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

Name<EllipsoidTag.chunks>
ReturnsListTag(ChunkTag)
DescriptionReturns a list of all chunks that this ellipsoid touches at all (note that no valid ellipsoid tag can ever totally contain a chunk, due to vertical limits and roundness).
Example
# Loads the chunks that touch the ellipsoid "my_ellipsoid".
# For example, if "my_ellipsoid" had a size of "9,4,6" and a location of "-10,70,-9",
# this will return a list containing chunks -2,-1 and -1,-1.
- chunkload <ellipsoid[my_ellipsoid].chunks>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L571

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

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

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

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

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

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

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



Category: EnchantmentTag


Name<EnchantmentTag.can_enchant[<item>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether this enchantment can enchant the given ItemTag (based on material mainly).
This is internally based on multiple factors, such as the enchantment's category and its own specific compatibility checks.
Example
# In the case of the "knockback" enchantment, this narrates
# "You can apply the knockback enchantment in a diamond sword!"
- if <enchantment[knockback].can_enchant[diamond_sword]>:
    - narrate "You can apply the knockback enchantment in a diamond sword!"
- else:
    - narrate "You cannot apply the knockback enchantment in a diamond sword!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L352

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

Name<EnchantmentTag.damage_bonus[level=<level>;type=<type>]>
ReturnsElementTag(Decimal)
DescriptionReturns the damage bonus this enchantment applies against the given monster type.
The input is a MapTag with a level value and a monster type specified, where the type can be any of: ARTHROPOD, ILLAGER, WATER, UNDEAD, or UNDEFINED
See also Tag:EntityTag.monster_type for getting the category of another mob.
Example
# Narrates "With Bane of Arthropods 2, you get a damage bonus of 5 on arthropods!"
- narrate "With Bane of Arthropods 2, you get a damage bonus of <enchantment[bane_of_arthropods].damage_bonus[level=2;type=arthropod]> on arthropods!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L425

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

Name<EnchantmentTag.full_name[<level>]>
ReturnsElementTag
DescriptionReturns the full name for this enchantment for a given level, like "Sharpness V".
For vanilla enchantments, uses language translation keys.
Example
# Narrates "You don your Thorns III armor."
# Note: vanilla enchantments have a color applied to them, such as grey or red.
- narrate "You don your <enchantment[thorns].full_name[3]><reset> armor."
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L191

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

Name<EnchantmentTag.is_curse>
ReturnsElementTag(Boolean)
DescriptionReturns whether this enchantment is only considered to be a curse. Curses are removed at grindstones, and spread from crafting table repairs.
Example
# In the case of the "vanishing_curse" enchantment, this will narrate:
# "Watch out! This enchantment is a curse!"
- if <enchantment[vanishing_curse].is_curse>:
    - narrate "Watch out! This enchantment is a curse!"
- else:
    - narrate "Phew, this enchantment is not a curse!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L308

Name<EnchantmentTag.is_discoverable>
ReturnsElementTag(Boolean)
DescriptionReturns whether this enchantment is only considered to be discoverable.
If true, this will spawn from vanilla sources like the enchanting table. If false, it can only be given directly by script.
Example
# In the case of the "loyalty" enchantment, this will narrate:
# "Time to do some discovering!"
- if <enchantment[loyalty].is_discoverable>:
    - narrate "Time to do some discovering!"
- else:
    - narrate "You'll have to be given this enchantment through a script!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L290

Name<EnchantmentTag.is_tradable>
ReturnsElementTag(Boolean)
DescriptionReturns whether this enchantment is only considered to be tradable. Villagers won't trade this enchantment if set to false.
Example
# In the case of the "loyalty" enchantment, this will narrate:
# "Let's do some haggling to get this enchantment!"
- if <enchantment[loyalty].is_tradable>:
    - narrate "Let's do some haggling to get this enchantment!"
- else:
    - narrate "Villagers don't seem to want to trade this enchantment!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L273

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

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

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

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

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

Name<EnchantmentTag.name>
ReturnsElementTag
DescriptionGets the name of this enchantment. For vanilla enchantments, uses the vanilla name like 'sharpness'.
For Denizen custom enchantments, returns the 'id' specified in the script.
For any other enchantments, returns the full key.
Example
# This can narrate something like this:
# "The item in your hand's first enchantment is sharpness!"
- narrate "The item in your hand's first enchantment is <player.item_in_hand.enchantment_types.get[1].name||nothing>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L158

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

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

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



Category: EntityTag


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

Name<EntityTag.all_raw_nbt>
ReturnsMapTag
MechanismEntityTag.raw_nbt
DescriptionReturns the entity's entire raw NBT data as a MapTag.
See Language:Raw NBT Encoding for more information.
Generated Example
- foreach <player.all_raw_nbt> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L3072

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

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

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

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

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

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

Name<EntityTag.bookshelf_slot>
ReturnsElementTag(Number)
DescriptionReturns the Chiseled Bookshelf slot that the entity is looking at, if any.
See also Tag:LocationTag.slot
Generated Example
- narrate "the number value is <player.bookshelf_slot>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L3054

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name<EntityTag.force_no_persist>
ReturnsElementTag(Boolean)
MechanismEntityTag.force_no_persist
DescriptionReturns 'true' if the entity is forced to not save to file when chunks unload.
Returns 'false' if not forced to not-save. May return 'false' even for entities that don't save for other reasons.
This is a custom value added in Bukkit to block saving, which is not the same as Mojang's similar option under Tag:EntityTag.is_persistent.
Generated Example
- if <player.force_no_persist>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1955

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name<EntityTag.is_persistent>
ReturnsElementTag(Boolean)
MechanismEntityTag.persistent
DescriptionReturns whether the mob-entity will not be removed completely when far away from players.
This is Bukkit's "getRemoveWhenFarAway" which is Mojang's "isPersistenceRequired".
In many cases, Tag:EntityTag.force_no_persist may be preferred.
Generated Example
- if <player.is_persistent>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupattributes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1941

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name<EntityTag.monster_type>
ReturnsElementTag
DescriptionReturns the entity's monster type, if it is a monster.
This is sometimes called 'mob type' or 'entity category', but it is only applicable to enemy monsters - this is used for enchanted damage bonuses, see Tag:EnchantmentTag.damage_bonus.
This can be any of undead/water/illager/arthropod, see 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/EntityCategory.html.
Generated Example
- narrate <player.monster_type>
Groupdata
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1368

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name<EntityTag.conversion_player>
ReturnsPlayerTag
MechanismEntityTag.conversion_player
DescriptionReturns the player that caused a zombie villager to start converting back to a villager, if any.
Generated Example
- narrate "hello there!" targets:<player.conversion_player>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityConversionPlayer.java#L58

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name<EntityTag.horns>
ReturnsListTag
MechanismEntityTag.horns
DescriptionReturns a ListTag of a goat's horns. can include "left" and "right", for the left and right horns.
Generated Example
- foreach <player.horns> as:entry:
    - narrate "found <[entry]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityHorns.java#L57

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

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

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

Name<EntityTag.is_age_locked>
ReturnsElementTag(Boolean)
DescriptionDeprecated in favor of Tag:EntityTag.age_locked.
Generated Example
- if <player.is_age_locked>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Deprecateduse 'age_locked'.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAgeLocked.java#L53

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name<EntityTag.painting_height>
ReturnsElementTag(Number)
MechanismEntityTag.painting
DescriptionIf the entity is a painting, returns its height.
Generated Example
- narrate "the number value is <player.painting_height>"
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.
Generated Example
- narrate "the number value is <player.painting_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.
Generated Example
- narrate <player.particle>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L124

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

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.
Generated Example
- teleport <player> <player.patrol_target>
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.
Generated Example
- narrate <player.pickup_status>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPickupStatus.java#L55

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

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

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.
Generated Example
- give <player.potion>
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.
Generated Example
- if <player.powered>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/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 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/Villager.Profession.html
Generated Example
- narrate <player.profession>
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.
Generated Example
- narrate "the decimal value is <player.radius>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L177

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

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

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

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 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/BlockFace.html.
Generated Example
- narrate <player.rotation>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityRotation.java#L85

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.
Generated Example
- teleport <player> <player.rotation_vector>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityRotation.java#L71

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

Name<EntityTag.shot_at_angle>
ReturnsElementTag(Boolean)
MechanismEntityTag.shot_at_angle
DescriptionReturns true if the Firework entity is 'shot at angle', meaning it should render facing the direction it's moving. If false, will be angled straight up.
Generated Example
- if <player.shot_at_angle>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityShotAtAngle.java#L52

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).
Generated Example
- narrate "the number value is <player.shulker_peek>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityShulkerPeek.java#L62

Name<EntityTag.sitting>
ReturnsElementTag(Boolean)
MechanismEntityTag.sitting
DescriptionIf the entity is a wolf, cat, or parrot, returns whether the animal is sitting.
Generated Example
- if <player.sitting>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntitySitting.java#L61

Name<EntityTag.size>
ReturnsElementTag(Number)
MechanismEntityTag.size
DescriptionReturns the size of a slime-type entity or a Phantom (1-120).
If the entity is a PufferFish it returns the puff state (0-3).
Generated Example
- narrate "the number value is <player.size>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntitySize.java#L60

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

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).
Generated Example
- narrate <player.strength>
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
Generated Example
- if <player.tameable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2394

Name<EntityTag.trap_time>
ReturnsDurationTag
MechanismEntityTag.trap_time
DescriptionReturns the skeleton horse's trap time in ticks.
Trap time will go up every tick for as long as the horse is trapped (see Tag:EntityTag.trapped).
A trapped horse will despawn after it reaches 18000 ticks (15 minutes).
Generated Example
- flag server myflag expire:<player.trap_time>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityTrapTime.java#L44

Name<EntityTag.trapped>
ReturnsElementTag(Boolean)
MechanismEntityTag.trapped
DescriptionReturns whether the skeleton horse is trapped.
A trapped skeleton horse will trigger the skeleton horse trap when the player is within 10 blocks of it.
Generated Example
- if <player.trapped>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityTrapped.java#L44

Name<EntityTag.villager_experience>
ReturnsElementTag(Number)
MechanismEntityTag.villager_experience
DescriptionReturns the experience amount of a villager.
Generated Example
- narrate "the number value is <player.villager_experience>"
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.
Generated Example
- narrate "the number value is <player.villager_level>"
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 before the Area Effect Cloud starts applying potion effects.
Generated Example
- flag server myflag expire:<player.wait_time>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L231

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).
Generated Example
- narrate "the number value is <player.weapon_damage>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2481

Name<EntityTag.age>
ReturnsElementTag
MechanismEntityTag.age
Description(Property) Controls the entity's age.
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.
For the mechanism, inputs can be 'baby', 'adult', or a valid age number.
Also available: Mechanism:EntityTag.age_locked and Tag:EntityTag.is_baby
Generated Example
- narrate <player.age>
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAge.java#L17

Name<EntityTag.age_locked>
ReturnsElementTag(Boolean)
MechanismEntityTag.age_locked
Description(Property) Controls whether the entity is locked into its current age.
Generated Example
- if <player.age_locked>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAgeLocked.java#L11

Name<EntityTag.aggressive>
ReturnsElementTag(Boolean)
MechanismEntityTag.aggressive
Description(Property) Controls whether the entity is currently aggressive.
Generated Example
- if <player.aggressive>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAggressive.java#L11

Name<EntityTag.background_color>
ReturnsColorTag
MechanismEntityTag.background_color
Description(Property) A text display entity's background color.
Note that this is based on experimental API; while unlikely, breaking changes aren't impossible.
Generated Example
- inventory adjust slot:hand color:<player.background_color>
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityBackgroundColor.java#L12

Name<EntityTag.boat_type>
ReturnsElementTag
MechanismEntityTag.boat_type
Description(Property) Controls the wood type of the boat.
Valid wood types can be found here: 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/TreeSpecies.html
Deprecated in versions 1.19 and above. Use Property:EntityTag.color.
Generated Example
- narrate <player.boat_type>
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityBoatType.java#L15

Name<EntityTag.brightness>
ReturnsMapTag
MechanismEntityTag.brightness
Description(Property) A map of the display entity's brightness override (if any), containing "block" and "sky" keys, each with a brightness level between 0 and 15.
For the mechanism: provide no input to remove the brightness override.
Example
# Sets the brightness of the display entity to be as if the block was well lit by a torch in a cave (no sky light).
- adjust <[some_entity]> brightness:[sky=0;block=15]
Example
# Spawns a block_display entity of a stone that is middle brightness from both the sky and block sources.
- spawn block_display[material=stone;brightness=[sky=7;block=7]] <player.location>
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityBrightness.java#L11

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

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

Name<EntityTag.default_background>
ReturnsElementTag(Boolean)
MechanismEntityTag.default_background
Description(Property) Whether a text display entity's background is default (same as the chat window), or custom set (see Property:EntityTag.background_color).
Generated Example
- if <player.default_background>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityDefaultBackground.java#L10

Name<EntityTag.display>
ReturnsElementTag
MechanismEntityTag.display
Description(Property) For an item display entity this is the model transform it will display, can be any of 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/ItemDisplay.ItemDisplayTransform.html.
For a text display entity this is its text alignment, can be any of 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/TextDisplay.html.
Generated Example
- narrate <player.display>
Synonyms (Search Aid)entitytag.display_transform, entitytag.text_alignment
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityDisplay.java#L11

Name<EntityTag.glow_color>
ReturnsColorTag
MechanismEntityTag.glow_color
Description(Property) A display entity's glow color override, if any.
For the mechanism: provide no input to remove the override.
Generated Example
- inventory adjust slot:hand color:<player.glow_color>
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityGlowColor.java#L12

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

Name<EntityTag.height>
ReturnsElementTag(Decimal)
MechanismEntityTag.height
Description(Property) For a display entity, this is the height of it's culling box. The box will span from the entity's y to the entity's y + the height.
The default value for these is 0, which disables culling entirely.
For an interaction entity, this is the height of it's bounding box (the area that can be interacted with).
Generated Example
- narrate "the decimal value is <player.height>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityHeight.java#L11

Name<EntityTag.interpolation_duration>
ReturnsDurationTag
MechanismEntityTag.interpolation_duration
Description(Property) The duration a display entity will spend interpolating between interpolated value(s).
See also Language:Display entity interpolation.
Generated Example
- ratelimit <player> <player.interpolation_duration>
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityInterpolationDuration.java#L10

Name<EntityTag.interpolation_start>
ReturnsDurationTag
MechanismEntityTag.interpolation_start
Description(Property) The delay between a display entity receiving an update to an interpolated value(s) to it starting its interpolation.
Interpolation is started whenever this value is set. If no changes were made to the entity in the same tick, it will (visually) redo its last interpolation.
See also Language:Display entity interpolation.
Generated Example
- flag server myflag expire:<player.interpolation_start>
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityInterpolationStart.java#L19

Name<EntityTag.is_aware>
ReturnsElementTag(Boolean)
MechanismEntityTag.is_aware
Description(Property) For mobs (Tag:EntityTag.is_mob), this is 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 Property:EntityTag.has_ai, except allows the entity to be moved by gravity, being pushed or attacked, etc.
For interaction entities, this is whether interacting with them should trigger a response (arm swings, sounds, etc.).
Generated Example
- if <player.is_aware>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAware.java#L13

Name<EntityTag.left_rotation>
ReturnsQuaternionTag
MechanismEntityTag.left_rotation
Description(Property) A display entity's "left" rotation.
Note that Mechanism:EntityTag.right_rotation is also available, but should normally use this instead.
Generated Example
- narrate "TODO: Placeholder: quaternion is <player.left_rotation>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityLeftRotation.java#L12

Name<EntityTag.line_width>
ReturnsElementTag(Number)
MechanismEntityTag.line_width
Description(Property) A text display entity's line width, used to split lines (note that newlines can still be added as normal).
Generated Example
- narrate "the number value is <player.line_width>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityLineWidth.java#L10

Name<EntityTag.material>
ReturnsMaterialTag
MechanismEntityTag.material
Description(Property) An entity's associated block material.
For endermen, this is the block being held.
For minecarts, this is the block being carried.
For block displays, this is the block being displayed.
Generated Example
- modifyblock <player.location.below> <player.material>
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityMaterial.java#L16

Name<EntityTag.opacity>
ReturnsElementTag(Number)
MechanismEntityTag.opacity
Description(Property) A text display entity's text opacity, from 0 to 255.
Can be interpolated, see Language:Display entity interpolation.
Note that there's currently an edge-case/bug where 0-3 are completely opaque, and it only becomes transparent at 4.
Generated Example
- narrate "the number value is <player.opacity>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityOpacity.java#L10

Name<EntityTag.pierce_level>
ReturnsElementTag(Number)
MechanismEntityTag.pierce_level
Description(Property) The number of entities an arrow will pierce through while flying. Must be between 0 and 127.
Generated Example
- narrate "the number value is <player.pierce_level>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityArrowPierceLevel.java#L10

Name<EntityTag.pivot>
ReturnsElementTag
MechanismEntityTag.pivot
Description(Property) A display entity's pivot point/axes, can be any of 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/Display.Billboard.html.
Generated Example
- narrate <player.pivot>
Synonyms (Search Aid)entitytag.billboard
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPivot.java#L10

Name<EntityTag.right_rotation>
ReturnsQuaternionTag
MechanismEntityTag.right_rotation
Description(Property) A display entity's "right" rotation.
Should usually use Mechanism:EntityTag.left_rotation instead.
Generated Example
- narrate "TODO: Placeholder: quaternion is <player.right_rotation>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityRightRotation.java#L12

Name<EntityTag.scale>
ReturnsLocationTag
MechanismEntityTag.scale
Description(Property) A display entity's scale, represented as a ObjectType:LocationTag vector.
Can be interpolated, see Language:Display entity interpolation.
Generated Example
- teleport <player> <player.scale>
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityScale.java#L12

Name<EntityTag.see_through>
ReturnsElementTag(Boolean)
MechanismEntityTag.see_through
Description(Property) Whether a text display entity can be seen through blocks.
Generated Example
- if <player.see_through>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntitySeeThrough.java#L10

Name<EntityTag.shadow_radius>
ReturnsElementTag(Decimal)
MechanismEntityTag.shadow_radius
Description(Property) The radius of a display entity's shadow.
Can be interpolated, see Language:Display entity interpolation.
Generated Example
- narrate "the decimal value is <player.shadow_radius>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityShadowRadius.java#L10

Name<EntityTag.shadow_strength>
ReturnsElementTag(Decimal)
MechanismEntityTag.shadow_strength
Description(Property) The strength of a display entity's shadow.
Note that the final opacity will change based on the entity's distance to the block the shadow is on.
Can be interpolated, see Language:Display entity interpolation.
Generated Example
- narrate "the decimal value is <player.shadow_strength>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityShadowStrength.java#L10

Name<EntityTag.spell>
ReturnsElementTag
MechanismEntityTag.spell
Description(Property) Controls the spell that an Illager entity (such as an Evoker or Illusioner) should cast.
Valid spells are: 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/Spellcaster.Spell.html
Generated Example
- narrate <player.spell>
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntitySpell.java#L11

Name<EntityTag.step_height>
ReturnsElementTag(Decimal)
MechanismEntityTag.step_height
Description(Property) Sets the entity's step height, which controls how many blocks can it walk over.
As this is based on an internal value, it has some edge-cases, for example:
- most (but not all) living entities can still step over 1 block tall things as usual, even if this is set to 0.
- this doesn't apply to vehicles when the player is controlling them.
Note that this also applies to things like getting pushed.
Generated Example
- narrate "the decimal value is <player.step_height>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityStepHeight.java#L10

Name<EntityTag.teleport_duration>
ReturnsDurationTag
MechanismEntityTag.teleport_duration
Description(Property) The duration a display entity will spend teleporting between positions.
See also Language:Display entity interpolation.
Generated Example
- ratelimit <player> <player.teleport_duration>
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityTeleportDuration.java#L10

Name<EntityTag.text>
ReturnsElementTag
MechanismEntityTag.text
Description(Property) A text display entity's text, supports new lines.
Generated Example
- narrate <player.text>
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityText.java#L11

Name<EntityTag.text_shadowed>
ReturnsElementTag(Boolean)
MechanismEntityTag.text_shadowed
Description(Property) Whether a text display entity's text has a shadow.
Generated Example
- if <player.text_shadowed>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityTextShadowed.java#L10

Name<EntityTag.translation>
ReturnsLocationTag
MechanismEntityTag.translation
Description(Property) A display entity's translation, represented as a ObjectType:LocationTag vector.
Can be interpolated, see Language:Display entity interpolation.
Generated Example
- teleport <player> <player.translation>
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityTranslation.java#L12

Name<EntityTag.view_range>
ReturnsElementTag(Decimal)
MechanismEntityTag.view_range
Description(Property) A display entity's view range, how far away from a player will it still be visible to them.
Note that the final value used depends on client settings such as entity distance scaling, and is multiplied by 64 client-side.
Generated Example
- narrate "the decimal value is <player.view_range>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityViewRange.java#L10

Name<EntityTag.visual_fire>
ReturnsElementTag(Boolean)
MechanismEntityTag.visual_fire
Description(Property) Whether an entity has a fake fire effect. For actual fire, see Command:burn and Tag:EntityTag.on_fire.
Generated Example
- if <player.visual_fire>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityVisualFire.java#L9

Name<EntityTag.width>
ReturnsElementTag(Decimal)
MechanismEntityTag.width
Description(Property) For a display entity, this is the width of it's culling box. The box will span half the width in every direction from the entity's position.
The default value for these is 0, which disables culling entirely.
For an interaction entity, this is the width of it's bounding box (the area that can be interacted with).
Generated Example
- narrate "the decimal value is <player.width>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityWidth.java#L11

Name<EntityTag.crackshot_weapon>
ReturnsElementTag
DescriptionReturns the CrackShot weapon name that the projectile was shot from.
Generated Example
- narrate <player.crackshot_weapon>
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.
Generated Example
- if <player.is_mythicmob>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
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.
Generated Example
- if <player.is_shopkeeper>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, ShopKeepers
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/shopkeepers/ShopKeepersEntityExtensions.java#L11

Name<EntityTag.libsdisguise_disguise>
ReturnsLibsDisguiseTag
DescriptionReturns the disguise of the entity.
Generated Example
- narrate <player.libsdisguise_disguise>
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.
Generated Example
- if <player.libsdisguise_is_disguised>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
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.
Generated Example
- narrate <player.mythicmob>
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, if it is one (see also Tag:EntityTag.is_shopkeeper).
Generated Example
- narrate <player.shopkeeper>
RequiresDepenizen, ShopKeepers
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/shopkeepers/ShopKeepersEntityExtensions.java#L22

Name<EntityTag.collides_at[<location>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity's bounding box would collide if the entity was moved to the given location.
This checks for any colliding entities (like boats and shulkers), the world border and regular blocks.
(Note that this won't load chunks at the location.)
Generated Example
- if <player.collides_at[<player.location>]>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Grouppaper
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperEntityExtensions.java#L144

Name<EntityTag.from_spawner>
ReturnsElementTag(Boolean)
DescriptionReturns whether the entity was spawned from a spawner.
Generated Example
- if <player.from_spawner>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Grouppaper
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperEntityExtensions.java#L115

Name<EntityTag.spawn_location>
ReturnsLocationTag
DescriptionReturns the initial spawn location of this entity.
Generated Example
- teleport <player> <player.spawn_location>
Grouppaper
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperEntityExtensions.java#L102

Name<EntityTag.spawn_reason>
ReturnsElementTag
DescriptionReturns the entity's spawn reason.
Valid spawn reasons can be found at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/CreatureSpawnEvent.SpawnReason.html
Generated Example
- narrate <player.spawn_reason>
Grouppaper
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperEntityExtensions.java#L22

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.
Generated Example
- remove <player.xp_source>
Grouppaper
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperEntityExtensions.java#L77

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

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.
Generated Example
- kill <player.xp_trigger>
Grouppaper
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperEntityExtensions.java#L52

Name<EntityTag.arms_raised>
ReturnsElementTag(Boolean)
MechanismEntityTag.arms_raised
DescriptionDeprecated in favor of Tag:EntityTag.aggressive.
Generated Example
- if <player.arms_raised>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
RequiresPaper
Deprecateduse 'aggressive'
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityArmsRaised.java#L46

Name<EntityTag.auto_expire>
ReturnsElementTag(Boolean)
MechanismEntityTag.auto_expire
DescriptionReturns whether a falling_block will auto-expire (after 30 seconds, or 5 when outside the world).
See also Tag:EntityTag.time_lived
Generated Example
- if <player.auto_expire>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityAutoExpire.java#L39

Name<EntityTag.can_tick>
ReturnsElementTag(Boolean)
MechanismEntityTag.can_tick
DescriptionIf the entity is an armor stand, returns whether the armor stand can tick.
Generated Example
- if <player.can_tick>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityCanTick.java#L47

Name<EntityTag.carrying_egg>
ReturnsElementTag(Boolean)
MechanismEntityTag.carrying_egg
DescriptionIf the entity is a turtle, returns whether it is carrying an egg. A turtle that is carrying an egg isn't visually different, but can't breed and will eventually lay the egg.
Generated Example
- if <player.carrying_egg>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityCarryingEgg.java#L39

Name<EntityTag.drinking_potion>
ReturnsItemTag
MechanismEntityTag.drinking_potion
DescriptionReturns the potion item a witch is drinking, or air if none.
Generated Example
- give <player.drinking_potion>
Groupproperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityDrinkingPotion.java#L41

Name<EntityTag.has_friction>
ReturnsElementTag(Boolean)
MechanismEntityTag.has_friction
DescriptionReturns an entity's friction state if one has been set.
Generated Example
- if <player.has_friction>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityFriction.java#L50

Name<EntityTag.invulnerable_duration>
ReturnsDurationTag
MechanismEntityTag.invulnerable_duration
DescriptionReturns the duration remaining until the wither becomes vulnerable.
Generated Example
- flag server myflag expire:<player.invulnerable_duration>
Groupproperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityWitherInvulnerable.java#L39

Name<EntityTag.potion_drink_duration>
ReturnsDurationTag
MechanismEntityTag.potion_drink_duration
DescriptionReturns the duration remaining until a witch is done drinking a potion.
Generated Example
- ratelimit <player> <player.potion_drink_duration>
Groupproperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityDrinkingPotion.java#L54

Name<EntityTag.reputation>
ReturnsMapTag
MechanismEntityTag.reputation
DescriptionReturns a villager's reputations as a map of player UUIDs to reputation maps.
Reputation maps are maps of reputation types to integer values, a full list of all valid reputation types can be found at 🔗https://jd.papermc.io/paper/1.19/com/destroystokyo/paper/entity/villager/ReputationType.html.
Generated Example
- foreach <player.reputation> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Groupproperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityReputation.java#L51

Name<EntityTag.egg_lay_time>
ReturnsDurationTag
MechanismEntityTag.egg_lay_time
Description(Property) If the entity is a chicken, controls the duration of time until it next lays an egg.
Generated Example
- ratelimit <player> <player.egg_lay_time>
GroupProperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityEggLayTime.java#L11

Name<EntityTag.is_sneaking>
ReturnsElementTag(Boolean)
MechanismEntityTag.is_sneaking
Description(Property) Whether an entity is sneaking.
For most entities this just makes the name tag less visible, and doesn't actually update the pose.
Note that Command:sneak is also available.
Generated Example
- if <player.is_sneaking>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
GroupProperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntitySneaking.java#L12

Name<EntityTag.left_handed>
ReturnsElementTag(Boolean)
MechanismEntityTag.left_handed
Description(Property) Whether a mob is left-handed. Mobs have a rare chance of spawning left-handed.
Generated Example
- if <player.left_handed>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
GroupProperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityLeftHanded.java#L11

Name<EntityTag.should_burn>
ReturnsElementTag(Boolean)
MechanismEntityTag.should_burn
Description(Property) If the entity is a Zombie, Skeleton, or Phantom, controls whether it should burn in daylight.
Generated Example
- if <player.should_burn>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
GroupProperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityShouldBurn.java#L13



Category: FlaggableObject


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

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

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

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

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



Category: ImageTag


Name<ImageTag.copy>
ReturnsImageTag
DescriptionReturns a copy of the image, useful for getting normal images from id-based ones (see Command:Image).
Example
Gets a normal image object from an id-based one.
- define image <image[drawing].copy>
# The "image" definition won't change.
- draw id:drawing pixel x:0 y:0 color:red
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ImageTag.java#L204

Name<ImageTag.height>
ReturnsElementTag(Number)
MechanismImageTag.scale
DescriptionReturns the image's height (in pixels).
Example
Narrates an image's height.
- narrate "The image is <[image].height> tall."
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ImageTag.java#L172

Name<ImageTag.pixel_at[x=<x>;y=<y>]>
ReturnsColorTag
DescriptionReturns the color of a specific pixel in an image.
"x" and "y" are the position of the pixel, see Language:Image positions.
Example
Gets the color of the pixel at 43,21
- narrate "The color is: <[image].pixel_at[x=43;y=21]>."
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ImageTag.java#L135

Name<ImageTag.sub_image[x=<x>;y=<y>;width=<width>;height=<height>]>
ReturnsImageTag
DescriptionReturns a part of the image.
"x" and "y" are the position of the upper left corner of the image part, see Language:Image positions.
"width" and "height" are the size of the image part.
Example
Gets the top right corner of a 100x100 image.
- define corner <[image].sub_image[x=50;y=0;with=50;height=50]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ImageTag.java#L219

Name<ImageTag.to_binary[<image_format>]>
ReturnsBinaryTag
DescriptionReturns a BinaryTag of the image's raw binary data, in the specified image format.
Example
Gets a base64 encoded string of the image, commonly used in web APIs.
- define base64 <[image].to_binary[png].to_base64>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ImageTag.java#L186

Name<ImageTag.width>
ReturnsElementTag(Number)
MechanismImageTag.scale
DescriptionReturns the image's width (in pixels).
Example
Narrates an image's width.
- narrate "The image is <[image].width> wide."
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ImageTag.java#L158



Category: InventoryTag


Name<InventoryTag.anvil_max_repair_cost>
ReturnsElementTag(Number)
MechanismInventoryTag.anvil_max_repair_cost
DescriptionReturns the maximum repair cost on an anvil.
Generated Example
- narrate "the number value is <player.inventory.anvil_max_repair_cost>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2282

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

Name<InventoryTag.anvil_repair_cost>
ReturnsElementTag(Number)
MechanismInventoryTag.anvil_repair_cost
DescriptionReturns the current repair cost on an anvil.
Generated Example
- narrate "the number value is <player.inventory.anvil_repair_cost>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2268

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

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

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

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

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

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

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

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

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

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).
Generated Example
- narrate "the number value is <player.inventory.craftable_quantity>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2224

Name<InventoryTag.empty_slots>
ReturnsElementTag(Number)
DescriptionReturns the number of empty slots in an inventory.
Generated Example
- narrate "the number value is <player.inventory.empty_slots>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1186

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.
Generated Example
- foreach <player.inventory.equipment> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2165

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.
Generated Example
- foreach <player.inventory.equipment_map> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2152

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

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

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

Name<InventoryTag.find_empty_slots>
ReturnsListTag
DescriptionReturns the index of all the empty slots in an inventory.
Generated Example
- foreach <player.inventory.find_empty_slots> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2360

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

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

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

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

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

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

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.
Generated Example
- give <player.inventory.input>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2326

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

Name<InventoryTag.is_empty>
ReturnsElementTag(Boolean)
DescriptionReturns whether the inventory is empty.
Generated Example
- if <player.inventory.is_empty>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1410

Name<InventoryTag.is_full>
ReturnsElementTag(Boolean)
DescriptionReturns whether the inventory is completely full.
Generated Example
- if <player.inventory.is_full>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1427

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

Name<InventoryTag.matrix>
ReturnsListTag(ItemTag)
MechanismInventoryTag.matrix
DescriptionReturns the items currently in a crafting inventory's matrix.
Generated Example
- foreach <player.inventory.matrix> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2177

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

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 Object Matching.
Generated Example
- narrate "the number value is <player.inventory.quantity_item>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2019

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".
Generated Example
- narrate <player.inventory.recipe>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2200

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

Name<InventoryTag.slot[<#>|...]>
ReturnsObjectTag
DescriptionIf just a single slot is specified, returns the ItemTag in the specified slot.
If a list 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#L2090

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.
Generated Example
- narrate "the number value is <player.inventory.stacks>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2075

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

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

Name<InventoryTag.list_contents>
ReturnsListTag(ItemTag)
MechanismInventoryTag.contents
DescriptionReturns a list of all items in the inventory.
Generated Example
- foreach <player.inventory.list_contents> as:entry:
    - narrate "found <[entry]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventoryContents.java#L124

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

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

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

Name<InventoryTag.map_slots>
ReturnsMapTag
DescriptionReturns a map of inventory slots to the items in those slots (excludes air).
Generated Example
- foreach <player.inventory.map_slots> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventoryContents.java#L105

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

Name<InventoryTag.size>
ReturnsElementTag(Number)
MechanismInventoryTag.size
Description(Property) Controls the size of the inventory.
Note that the mechanism can only be set for "generic" chest inventories.
Generated Example
- narrate "the number value is <player.inventory.size>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventorySize.java#L12

Name<InventoryTag.title>
ReturnsElementTag
MechanismInventoryTag.title
Description(Property) Controls the title of the inventory.
Note that the mechanism can only be set for "generic" inventories.
Generated Example
- narrate <player.inventory.title>
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventoryTitle.java#L14

Name<InventoryTag.trades>
ReturnsListTag(TradeTag)
MechanismInventoryTag.trades
Description(Property) Controls the trade recipe list for a merchant inventory.
Generated Example
- foreach <player.inventory.trades> as:entry:
    - narrate "found <[entry]>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventoryTrades.java#L15

Name<InventoryTag.is_bossshop>
ReturnsElementTag(Boolean)
DescriptionReturns whether the inventory is a BossShop.
Generated Example
- if <player.inventory.is_bossshop>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
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 item (potion, tipped arrow, or suspicious stew) has a potion effect.
Generated Example
- if <player.item_in_hand.has_potion_effect>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L268

Name<ItemTag.map_to_image[<player>]>
ReturnsImageTag
DescriptionReturns an image of a filled map item's contents.
Must specify a player for the map to render for, as if that player is holding the map.
Note that this does not include cursors, as their rendering is entirely client-side.
Generated Example
- draw id:artwork image:<player.item_in_hand.map_to_image[<player>]> x:5 y:5
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L756

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, BREWING)
to limit to just recipes of that type.
Brewing recipes are only supported on Paper, and only custom ones are available.
Generated Example
- foreach <player.item_in_hand.recipe_ids> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L683

Name<ItemTag.potion_base>
ReturnsElementTag
MechanismItemTag.potion_effects
DescriptionDeprecated in favor of Tag:ItemTag.effects_data
Generated Example
- narrate <player.item_in_hand.potion_base>
Groupattribute
Deprecateduse 'effects_data' instead
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L303

Name<ItemTag.potion_effect[<#>]>
ReturnsElementTag
MechanismItemTag.potion_effects
DescriptionDeprecated in favor of Tag:ItemTag.effects_data
Generated Example
- narrate <player.item_in_hand.potion_effect[2]>
Groupattribute
Deprecateduse 'effects_data' instead
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L340

Name<ItemTag.potion_effects>
ReturnsListTag
MechanismItemTag.potion_effects
DescriptionDeprecated in favor of Tag:ItemTag.effects_data
Generated Example
- foreach <player.item_in_hand.potion_effects> as:entry:
    - narrate "found <[entry]>"
Groupattribute
Deprecateduse 'effects_data' instead
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L323

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

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'.
Generated Example
- narrate <player.item_in_hand.json>
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L634

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 "m@stone".
Generated Example
- foreach <player.location.find_blocks[<player.item_in_hand.material>].within[5]> as:loc:
    - modifyblock <[loc]> air
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L593

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

Name<ItemTag.placed_material>
ReturnsMaterialTag
DescriptionReturns the MaterialTag that this item would place as a block, if it is a block-like item.
For example, the "redstone" item will return a "redstone_wire" block.
Returns null if the item doesn't place as a block.
Generated Example
- modifyblock <player.location.below> <player.item_in_hand.placed_material>
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L617

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

Name<ItemTag.scriptname>
ReturnsElementTag
DescriptionUse ".script.name" instead.
This deprecated tag may be useful for debugging items when item scripts may have been deleted.
Generated Example
- narrate <player.item_in_hand.scriptname>
Groupdata
Deprecateduse ".script.name" instead.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemScript.java#L57

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.
Generated Example
- narrate <player.item_in_hand.formatted>
Groupformatting
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L727

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.
Generated Example
- foreach <player.item_in_hand.all_raw_nbt> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemRawNBT.java#L316

Name<ItemTag.block_material>
ReturnsMaterialTag
MechanismItemTag.block_material
DescriptionReturns the material for an item with complex-block-data attached.
Generated Example
- modifyblock <player.location.below> <player.item_in_hand.block_material>
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.
Generated Example
- narrate <player.item_in_hand.book_author>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemBook.java#L58

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.
Generated Example
- foreach <player.item_in_hand.book_generation> as:entry:
    - narrate "found <[entry]>"
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".
Generated Example
- foreach <player.item_in_hand.book_map> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemBook.java#L101

Name<ItemTag.book_pages>
ReturnsListTag
MechanismItemTag.book_pages
DescriptionReturns the plain-text pages of the book as a ListTag.
Generated Example
- foreach <player.item_in_hand.book_pages> as:entry:
    - narrate "found <[entry]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemBook.java#L84

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

Name<ItemTag.can_destroy>
ReturnsListTag(MaterialTag)
MechanismItemTag.can_destroy
DescriptionReturns a list of materials this item can destroy while in adventure mode, if any.
Generated Example
- foreach <player.item_in_hand.can_destroy> as:entry:
    - narrate "found <[entry]>"
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.
Generated Example
- foreach <player.item_in_hand.can_place_on> as:entry:
    - narrate "found <[entry]>"
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.
Generated Example
- foreach <player.item_in_hand.charged_projectiles> as:entry:
    - narrate "found <[entry]>"
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, potion item, or filled map item.
Generated Example
- inventory adjust slot:hand color:<player.item_in_hand.color>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemColor.java#L65

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.
Generated Example
- narrate "the number value is <player.item_in_hand.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.default_attribute_modifiers[<slot>]>
ReturnsMapTag
DescriptionReturns a map of all default attribute modifiers on the item based purely on its material type, for the given slot,
in the same format as Tag:ItemTag.attribute_modifiers
Slot must be one of: HAND, OFF_HAND, FEET, LEGS, CHEST, or HEAD
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemAttributeModifiers.java#L99

Name<ItemTag.display>
ReturnsElementTag
MechanismItemTag.display
DescriptionReturns the display name of the item, as set by plugin or an anvil.
Generated Example
- narrate <player.item_in_hand.display>
Synonyms (Search Aid)itemtag.display_name
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemDisplayname.java#L57

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

Name<ItemTag.effects_data>
ReturnsListTag(MapTag)
MechanismItemTag.potion_effects
DescriptionReturns a list of all potion effects on this item, in the same format as the MapTag input to the mechanism.
This applies to Potion items, Tipped Arrow items, and Suspicious Stews.
Note that for potions or tipped arrows (not suspicious stew) the first value in the list is the potion's base type.
All subsequent entries are effect data.
Generated Example
- foreach <player.item_in_hand.effects_data> as:entry:
    - narrate "found <[entry]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L217

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).
Generated Example
- foreach <player.item_in_hand.enchantment_map> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemEnchantments.java#L142

Name<ItemTag.enchantment_types>
ReturnsListTag(EnchantmentTag)
MechanismItemTag.enchantments
DescriptionReturns a list of the types of enchantments on the item.
Generated Example
- foreach <player.item_in_hand.enchantment_types> as:entry:
    - narrate "found <[entry]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemEnchantments.java#L106

Name<ItemTag.enchantments>
ReturnsListTag
MechanismItemTag.enchantments
DescriptionDeprecated in favor of Tag:ItemTag.enchantment_types or Tag:ItemTag.enchantment_map
Generated Example
- foreach <player.item_in_hand.enchantments> as:entry:
    - narrate "found <[entry]>"
Groupproperties
DeprecatedUse 'enchantment_types' or 'enchantment_map'
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemEnchantments.java#L123

Name<ItemTag.firework>
ReturnsListTag
MechanismItemTag.firework
DescriptionReturns the firework's property value as a list, matching the non-MapTag format of the mechanism.
Consider instead using Tag:ItemTag.firework_data
Generated Example
- foreach <player.item_in_hand.firework> as:entry:
    - narrate "found <[entry]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemFirework.java#L120

Name<ItemTag.firework_data>
ReturnsListTag
MechanismItemTag.firework
DescriptionReturns the firework's property value as a ListTag of MapTags, matching the MapTag format of the mechanism.
Generated Example
- foreach <player.item_in_hand.firework_data> as:entry:
    - narrate "found <[entry]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemFirework.java#L133

Name<ItemTag.firework_power>
ReturnsElementTag(Number)
MechanismItemTag.firework_power
DescriptionReturns the firework's power.
Power primarily affects how high the firework flies, with each level of power corresponding to approximately half a second of additional flight them.
Generated Example
- narrate "the number value is <player.item_in_hand.firework_power>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemFirework.java#L145

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.
Generated Example
- if <player.item_in_hand.has_custom_model_data>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemCustomModel.java#L47

Name<ItemTag.has_display>
ReturnsElementTag(Boolean)
MechanismItemTag.display
DescriptionReturns whether the item has a custom set display name.
Generated Example
- if <player.item_in_hand.has_display>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemDisplayname.java#L73

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.
Generated Example
- if <player.item_in_hand.has_inventory>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L567

Name<ItemTag.has_lore>
ReturnsElementTag(Boolean)
MechanismItemTag.lore
DescriptionReturns whether the item has lore set on it.
Generated Example
- if <player.item_in_hand.has_lore>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/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)
Generated Example
- if <player.item_in_hand.has_skin>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSkullskin.java#L102

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.
Generated Example
- foreach <player.item_in_hand.hides> as:entry:
    - narrate "found <[entry]>"
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.
Generated Example
- foreach <player.item_in_hand.inventory_contents> as:entry:
    - narrate "found <[entry]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemInventory.java#L91

Name<ItemTag.invisible>
ReturnsElementTag(Boolean)
MechanismItemTag.invisible
DescriptionReturns whether an Item_Frame item will be invisible when placed.
Generated Example
- if <player.item_in_hand.invisible>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemFrameInvisible.java#L66

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.
Generated Example
- if <player.item_in_hand.is_book>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L523

Name<ItemTag.is_charged>
ReturnsElementTag(Boolean)
MechanismItemTag.charged_projectiles
DescriptionReturns whether this crossbow is charged.
Generated Example
- if <player.item_in_hand.is_charged>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/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.
Generated Example
- if <player.item_in_hand.is_colorable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L537

Name<ItemTag.is_enchanted>
ReturnsElementTag(Boolean)
MechanismItemTag.enchantments
DescriptionReturns whether the item has any enchantments.
Generated Example
- if <player.item_in_hand.is_enchanted>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemEnchantments.java#L59

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.
Generated Example
- if <player.item_in_hand.is_firework>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L554

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.
Generated Example
- if <player.item_in_hand.is_lockable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L580

Name<ItemTag.is_locked>
ReturnsElementTag(Boolean)
MechanismItemTag.lock
DescriptionReturns whether this item has a lock password.
Generated Example
- if <player.item_in_hand.is_locked>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/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".
Generated Example
- foreach <player.item_in_hand.knowledge_book_recipes> as:entry:
    - narrate "found <[entry]>"
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.
Generated Example
- narrate <player.item_in_hand.lock>
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
Generated Example
- teleport <player> <player.item_in_hand.lodestone_location>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemLodestoneLocation.java#L50

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
Generated Example
- if <player.item_in_hand.lodestone_tracked>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemLodestoneTracked.java#L49

Name<ItemTag.lore>
ReturnsListTag
MechanismItemTag.lore
DescriptionReturns lore as a ListTag.
Generated Example
- foreach <player.item_in_hand.lore> as:entry:
    - narrate "found <[entry]>"
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.
Generated Example
- narrate "the number value is <player.item_in_hand.map>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemMap.java#L46

Name<ItemTag.map_center>
ReturnsLocationTag
MechanismItemTag.map_center
DescriptionReturns the center location on the map's display.
Note that there is no Y value (it's always 0), only X, Z, and a World.
Generated Example
- teleport <player> <player.item_in_hand.map_center>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemMap.java#L99

Name<ItemTag.map_locked>
ReturnsElementTag(Boolean)
MechanismItemTag.map_locked
DescriptionReturns whether maps with the same ID as this map are locked.
Generated Example
- if <player.item_in_hand.map_locked>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemMap.java#L80

Name<ItemTag.map_scale>
ReturnsElementTag(Number)
MechanismItemTag.map
DescriptionReturns the scale of the map, from 0 (smallest) to 4 (largest).
Generated Example
- narrate "the number value is <player.item_in_hand.map_scale>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemMap.java#L61

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.
Generated Example
- narrate "the number value is <player.item_in_hand.max_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.
Generated Example
- narrate "the number value is <player.item_in_hand.max_stack>"
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 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/DyeColor.html.
For the list of possible patterns, see 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/banner/PatternType.html.
Generated Example
- foreach <player.item_in_hand.patterns> as:entry:
    - narrate "found <[entry]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPatterns.java#L112

Name<ItemTag.potion_base_type>
ReturnsElementTag
MechanismItemTag.potion_effects
DescriptionDeprecated in favor of Tag:ItemTag.effects_data
Generated Example
- narrate <player.item_in_hand.potion_base_type>
Groupproperties
Deprecateduse 'effects_data.first.get[base_type]' instead
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L285

Name<ItemTag.quantity>
ReturnsElementTag(Number)
MechanismItemTag.quantity
DescriptionReturns the number of items in the ItemTag's itemstack.
Generated Example
- narrate "the number value is <player.item_in_hand.quantity>"
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.
Generated Example
- foreach <player.item_in_hand.raw_nbt> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemRawNBT.java#L303

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.
Generated Example
- narrate "the number value is <player.item_in_hand.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.
Generated Example
- if <player.item_in_hand.repairable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L508

Name<ItemTag.sign_contents>
ReturnsListTag
MechanismItemTag.sign_contents
DescriptionReturns a list of lines on a sign item.
Generated Example
- foreach <player.item_in_hand.sign_contents> as:entry:
    - narrate "found <[entry]>"
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).
Generated Example
- narrate <player.item_in_hand.skin>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSkullskin.java#L75

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).
Generated Example
- narrate <player.item_in_hand.skull_skin>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSkullskin.java#L56

Name<ItemTag.spawner_count>
ReturnsElementTag(Number)
MechanismItemTag.spawner_count
DescriptionReturns the spawn count for a spawner block item.
Generated Example
- narrate "the number value is <player.item_in_hand.spawner_count>"
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.
Generated Example
- narrate "the number value is <player.item_in_hand.spawner_max_nearby_entities>"
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.
Generated Example
- narrate "the number value is <player.item_in_hand.spawner_maximum_spawn_delay>"
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.
Generated Example
- narrate "the number value is <player.item_in_hand.spawner_minimum_spawn_delay>"
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).
Generated Example
- narrate "the number value is <player.item_in_hand.spawner_player_range>"
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).
Generated Example
- narrate "the number value is <player.item_in_hand.spawner_range>"
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.
Generated Example
- narrate "the number value is <player.item_in_hand.spawner_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.unbreakable>
ReturnsElementTag(Boolean)
MechanismItemTag.unbreakable
DescriptionReturns whether an item has the unbreakable flag.
Generated Example
- if <player.item_in_hand.unbreakable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/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.armor_pose>
ReturnsMapTag
MechanismItemTag.armor_pose
Description(Property) Controls the pose of this armor stand item.
Allowed keys: head, body, left_arm, right_arm, left_leg, right_leg
Generated Example
- foreach <player.item_in_hand.armor_pose> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemArmorPose.java#L19

Name<ItemTag.attribute_modifiers>
ReturnsMapTag
MechanismItemTag.attribute_modifiers
Description(Property) Controls the attribute modifiers of an 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'.
For use as a mechanism, this is a SET operation, meaning pre-existing modifiers are removed.
For format details, refer to Language:attribute modifiers.
Generated Example
- foreach <player.item_in_hand.attribute_modifiers> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemAttributeModifiers.java#L28

Name<ItemTag.base_color>
ReturnsElementTag
MechanismItemTag.base_color
Description(Property) Controls the base color of a shield.
For the list of possible colors, see 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/DyeColor.html.
Give no input with a shield to remove the base color (and any patterns).
Tag returns null if there is no base color or patterns.
Generated Example
- narrate <player.item_in_hand.base_color>
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemBaseColor.java#L17

Name<ItemTag.instrument>
ReturnsElementTag
MechanismItemTag.instrument
Description(Property) A goat horn's instrument, if any.
Goat horns will default to playing "ponder_goat_horn" when the instrument is unset, although this is effectively random and shouldn't be relied on.
Valid instruments are: admire_goat_horn, call_goat_horn, dream_goat_horn, feel_goat_horn, ponder_goat_horn, seek_goat_horn, sing_goat_horn, yearn_goat_horn.
For the mechanism: provide no input to unset the instrument.
Example
# This can narrate: "This horn has the ponder_goat_horn instrument!"
- narrate "This horn has the <player.item_in_hand.instrument> instrument!"
Example
# Forces the player's held item to play seek_goat_horn instead of whatever it played before.
# Would break if the player isn't holding a goat horn.
- inventory adjust slot:hand instrument:seek_goat_horn
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemInstrument.java#L12

Name<ItemTag.spawner_type>
ReturnsEntityTag
MechanismItemTag.spawner_type
Description(Property) The entity type a spawner item will spawn, if any.
For the mechanism: provide no input to unset the type.
Note that the type can only be unset on 1.20 and above.
Generated Example
- kill <player.item_in_hand.spawner_type>
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSpawnerType.java#L14

Name<ItemTag.trim>
ReturnsMapTag
MechanismItemTag.trim
Description(Property) An armor item's trim.
Allowed keys: material, pattern.
Valid material values can be found here: 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/inventory/meta/trim/TrimMaterial.html
Valid pattern values can be found here: 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/inventory/meta/trim/TrimPattern.html
Valid values also include ones added by datapacks, plugins, etc. as a namespaced key.
For the mechanism, if an item already has a trim, you can omit either material or pattern to keep the original data while also changing the other option.
For example, if you only want to change the pattern and not the material, you can omit the material, and it will use the already existing material.
Generated Example
- foreach <player.item_in_hand.trim> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemTrim.java#L16

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

Name<ItemTag.crackshot_weapon>
ReturnsElementTag
DescriptionReturns the CrackShot weapon name for the item.
Generated Example
- narrate <player.item_in_hand.crackshot_weapon>
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.
Generated Example
- narrate "the decimal value is <player.item_in_hand.worth>"
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.rarity>
ReturnsElementTag
DescriptionReturns the rarity of an item, as "common", "uncommon", "rare", or "epic".
Generated Example
- narrate <player.item_in_hand.rarity>
Grouppaper
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperItemExtensions.java#L10

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
Generated Example
- foreach <player.item_in_hand.armor_stand_data> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Groupproperties
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/ItemArmorStand.java#L67



Category: JavaReflectedObjectTag


Name<JavaReflectedObjectTag.field_class_type[<name>]>
ReturnsElementTag
DescriptionReturns the full class name of the field of the given name on this object.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L368

Name<JavaReflectedObjectTag.field_is_final[<name>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the field for the given name on this object is a final field.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L351

Name<JavaReflectedObjectTag.field_is_private[<name>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the field for the given name on this object is a private field.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L300

Name<JavaReflectedObjectTag.field_is_protected[<name>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the field for the given name on this object is a protected field.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L317

Name<JavaReflectedObjectTag.field_is_public[<name>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the field for the given name on this object is a public field.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L283

Name<JavaReflectedObjectTag.field_is_static[<name>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the field for the given name on this object is a static field.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L334

Name<JavaReflectedObjectTag.field_names>
ReturnsListTag
DescriptionReturns a list of all field names on the object (in its current class or any super classes).
Generated Example
- foreach <reflected[some_reflected_obj].field_names> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L263

Name<JavaReflectedObjectTag.full_class_name>
ReturnsElementTag
DescriptionReturns the full class name of the reflected object with package info included, such as "com.denizenscript.denizencore.objects.core.JavaReflectedObjectTag"
Generated Example
- narrate <reflected[some_reflected_obj].full_class_name>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L183

Name<JavaReflectedObjectTag.hash_code>
ReturnsElementTag(Number)
DescriptionReturns the result of the Java hashCode() call on the object.
Generated Example
- narrate "the number value is <reflected[some_reflected_obj].hash_code>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L221

Name<JavaReflectedObjectTag.interpret>
ReturnsObjectTag
DescriptionInterprets the object to Denizen object format.
Generated Example
- narrate "debug - the object is: <reflected[some_reflected_obj].interpret>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L193

Name<JavaReflectedObjectTag.java_equals[<reflected_object>]>
ReturnsElementTag(Boolean)
DescriptionReturns the result of the Java equals(<object>) call on the object with another JavaReflectedObjectTag.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L235

Name<JavaReflectedObjectTag.memory_equals[<reflected_object>]>
ReturnsElementTag(Boolean)
DescriptionReturns the result of the Java "==" exact memory equality call on the object with another JavaReflectedObjectTag.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L249

Name<JavaReflectedObjectTag.read_field[<name>]>
ReturnsObjectTag
DescriptionReads the field of the given name on the object and returns the value in its Denizen-valid format.
See also Tag:JavaReflectedObjectTag.reflect_field
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L385

Name<JavaReflectedObjectTag.reflect_field[<name>]>
ReturnsJavaReflectedObjectTag
DescriptionReads the field of the given name on the object and returns the value as another reflected tag.
See also Tag:JavaReflectedObjectTag.read_field
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L403

Name<JavaReflectedObjectTag.simple_class_name>
ReturnsElementTag
DescriptionReturns the simple/short class name of the reflected object, such as "JavaReflectedObjectTag".
Generated Example
- narrate <reflected[some_reflected_obj].simple_class_name>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L157

Name<JavaReflectedObjectTag.super_classes>
ReturnsListTag
DescriptionReturns the list of super classes of this object, in order, starting with its primary class's super, down to Object, as a ListTag of full class names.
Generated Example
- foreach <reflected[some_reflected_obj].super_classes> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L167

Name<JavaReflectedObjectTag.to_string>
ReturnsElementTag
DescriptionReturns the result of the Java toString() call on the object.
Generated Example
- narrate <reflected[some_reflected_obj].to_string>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L207



Category: ListTag


Name<ListTag.alphabetical>
ReturnsListTag
DescriptionReturns the list sorted to be in alphabetical order.
Example
# Narrates a list of 'a|c|d|g|q'
- narrate "<list[c|d|q|a|g].alphabetical>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2146

Name<ListTag.alphanumeric>
ReturnsListTag
DescriptionReturns the list sorted to be in alphabetical/numerical order.
Example
# Narrates a list of 'a1|a10|b|c'
- narrate "<list[b|c|a10|a1].alphanumeric>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2131

Name<ListTag.any>
ReturnsElementTag(Boolean)
DescriptionReturns whether the list is not empty.
Example
- if <list.any>:
    - narrate "never shows"
- else:
    - narrate "ain't got any"
Example
- if <list[something].any>:
    - narrate "something's here!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1060

Name<ListTag.average>
ReturnsElementTag(Decimal)
DescriptionReturns the mean average of all numbers in the list. Ignores non-numerical values.
Example
# Narrates "3"
- narrate <list[1|2|4|5].average>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1798

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.
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.
Example
# Narrates "spawn"
- narrate "<list[dance|quit|spawn].closest_to[spwn]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2718

Name<ListTag.combine>
ReturnsListTag
DescriptionReturns a list containing the contents of all sublists within this list.
Generated Example
- foreach <list[one|two].combine> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L743

Name<ListTag.comma_separated>
ReturnsElementTag
DescriptionReturns the list in a cleaner format, separated by commas.
Example
# Narrates "one, two, three"
- narrate <list[one|two|three].comma_separated>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L816

Name<ListTag.contains[<element>|...]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the list contains all of the given elements.
See also Tag:ListTag.contains_single for safer single-value checks.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2639

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

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

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

Name<ListTag.contains_match[<matcher>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the list contains an object that matches the specified matcher,
using the system behind Language:Advanced Object Matching.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2659

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

Name<ListTag.count[<element>]>
ReturnsElementTag(Number)
DescriptionReturns how many times a value in the list occurs.
Example
# Narrates "2"
- narrate <list[one|two|two|three].count[two]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1738

Name<ListTag.count_matches[<matcher>]>
ReturnsElementTag(Number)
DescriptionReturns how many times a value in the list matches the matcher,
using the system behind Language:Advanced Object Matching,
For example: a list of "one|two|three" .count[t*] returns 2.
Example
# Narrates "2"
- narrate <list[one|two|two|three].count_matches[t*]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1758

Name<ListTag.deduplicate>
ReturnsListTag
DescriptionReturns a copy of the list with any duplicate items removed.
Example
# Narrates a list of "one|two|three"
- narrate <list[one|one|two|three].deduplicate>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1515

Name<ListTag.exclude[...|...]>
ReturnsListTag
DescriptionReturns a new ListTag excluding the items specified.
Example
# Narrates a list of "one|three"
- narrate <list[one|two|three|four|two].exclude[two|four]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1313

Name<ListTag.exclude_single[<value>]>
ReturnsListTag
DescriptionReturns a new ListTag excluding the items specified.
If your list contains sub-lists, this tag can cleanly remove them.
Note that the "_single" refers to not taking a list of removables, it does still remove more than once instance of the value if present in the list.
Example
# Narrates a list of "one|two|three|four", note how it does not remove anything here, as "two|three" does not appear as a *single* value in the list.
- narrate <list[one|two|three|four].exclude_single[two|three]>
Example
# Narrates a list of "three|four", with the single-entry "one|two" value removed.
- narrate <list_single[one|two].include[three|four].exclude_single[one|two]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1288

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.
Example
# Narrates a list of "taco|taco|taco|potato"
- narrate <list[taco|potato|taco|potato|taco|potato].exclude[potato].max[2]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1328

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'.
One should generally prefer Tag:ListTag.filter_tag.
Example
# Narrates a list of '3|4|5'
- narrate <list[1|2|3|4|5].filter[is_more_than[3]]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2330

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.
Example
# Narrates a list of '3|4|5'
- narrate <list[1|2|3|4|5].filter_tag[<[filter_value].is_more_than[3]>]>
Example
# Narrates a list of '4|5'
- narrate <list[1|2|3|4|5].filter_tag[<list[4|5].contains[<[filter_value]>]>]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2430

Name<ListTag.find[<element>]>
ReturnsElementTag(Number)
DescriptionReturns the numbered index of an entry within a list,
or -1 if the list does not contain that item.
Example
# Narrates "2"
- narrate <list[one|two|three].find[two]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1718

Name<ListTag.find_all[<element>]>
ReturnsListTag
DescriptionReturns all the numbered indices of all entries that match the text within a list,
or an empty list if the list does not contain that item.
Example
# Narrates a list of "2|4"
- narrate <list[one|two|three|two].find_all[two]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1656

Name<ListTag.find_all_matches[<matcher>]>
ReturnsListTag
DescriptionReturns all the numbered indices of elements that match within a list,
using the system behind Language:Advanced Object Matching,
or an empty list if the list does not contain that item.
Example
# Narrates a list of "2|3"
- narrate <list[one|two|three].find_all_matches[t*]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1633

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.
Example
# Narrates a list of "2|4"
- narrate <list[one|two|three|two].find_all_partial[tw]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1612

Name<ListTag.find_match[<matcher>]>
ReturnsElementTag(Number)
DescriptionReturns the numbered index of the first match within a list,
using the system behind Language:Advanced Object Matching,
or -1 if the list does not contain that item.
Example
# Narrates "2"
- narrate <list[one|two|three].find_match[t*]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1697

Name<ListTag.find_partial[<element>]>
ReturnsElementTag(Number)
DescriptionReturns the numbered index of the first partially matching entry within a list,
or -1 if the list does not contain that item.
Example
# Narrates "2"
- narrate <list[one|two|three].find_partial[tw]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1677

Name<ListTag.first[(<#>)]>
ReturnsObjectTag
DescriptionReturns the first element in the list.
If the list is empty, returns null instead.
Effectively equivalent to .get[1]
Optionally, specify a number of entries to get, which will return the # first entries, equivalent to .get[1].to[#]
Example
# Narrates "one"
- narrate <list[one|two|three].first>
Example
# Narrates a list of "one" and "two"
- narrate <list[one|two|three].first[2]>
Example
# Narrates a list of "one", "two", and "three"
- narrate <list[one|two|three].first[5]>
Example
# Causes an error, as the list is empty.
- narrate <list.first>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1825

Name<ListTag.formatted>
ReturnsElementTag
DescriptionReturns the list in a human-readable format.
Note that this will parse the values within the list to be human-readable as well when possible.
EG, a list of "<npc>|<player>|potato" will return "GuardNPC, bob, and potato".
The exact formatting rules that will be followed are not guaranteed, other than that it will be a semi-clean human-readable format.
Generated Example
- narrate <list[one|two].formatted>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitListExtensions.java#L20

Name<ListTag.get[<#>|...]>
ReturnsObjectTag
DescriptionReturns an element of the value specified by the supplied context.
Specify more than one index to get a list of results.
Note the index input options described at ObjectType:listtag
Example
# Narrates "one"
- narrate <list[one|two|three].get[1]>
Example
# Narrates a list of "one|three"
- narrate <list[one|two|three].get[1|3]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1528

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

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.
Example
# Narrates a list of "one|two"
- narrate <list[one-alpha|two-beta].get_sub_items[1].split_by[-]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L864

Name<ListTag.get[<#>].to[<#>]>
ReturnsListTag
DescriptionReturns all elements in the range from the first index to the second.
Note the index input options described at ObjectType:listtag
Example
# Narrates a list of "one|two|three"
- narrate <list[one|two|three|four].get[1].to[3]>
Example
# Narrates a list of "three|four"
- narrate <list[one|two|three|four].get[3].to[last]>
Example
# Narrates a list of "three|four"
- narrate <list[one|two|three|four].get[-2].to[-1]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1568

Name<ListTag.highest[(<tag>)]>
ReturnsObjectTag
DescriptionReturns the highest value in a list of decimal numbers.
Optionally specify a tag to run on each list entry that returns the numeric value for that entry.
Example
# Narrates '10'
- narrate "<list[3|2|1|10].highest>
Example
# Narrates the name of the player with the most money currently online
- narrate <server.online_players.highest[money].name>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2007

Name<ListTag.highest[(<tag>)].count[<#>]>
ReturnsListTag
DescriptionReturns a list of the highest values in a list of decimal numbers.
Optionally specify a tag to run on each list entry that returns the numeric value for that entry.
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
Example
# Narrates a list of '10|3'
- narrate "<list[3|2|1|10].highest.count[2]>
Example
# Narrates the names of the 5 players with the most money currently online
- narrate <server.online_players.highest[money].count[5].parse[name].formatted>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2034

Name<ListTag.include[...|...]>
ReturnsListTag
DescriptionReturns a new ListTag including the items specified.
Example
# Narrates a list of "one|two|three|four"
- narrate <list[one|two].include[three|four]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1273

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

Name<ListTag.insert_single[...|...].at[<#>]>
ReturnsListTag
DescriptionReturns a new ListTag with the single item specified inserted to the specified location.
Note the index input options described at ObjectType:listtag
Example
# Narrates a list with 3 values: "one", "two|alsotwo", "three"
- narrate <list[one|three].insert_single[two|alsotwo].at[2]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1111

Name<ListTag.insert[...|...].at[<#>]>
ReturnsListTag
DescriptionReturns a new ListTag with the items specified inserted to the specified location.
Note the index input options described at ObjectType:listtag
Example
# Narrates a list of "one|two|three|four"
- narrate <list[one|four].insert[two|three].at[2]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1078

Name<ListTag.is_empty>
ReturnsElementTag(Boolean)
DescriptionReturns whether the list is empty.
Example
- if <list[something].is_empty>:
    - narrate "never shows"
- else:
    - narrate "it ain't empty!"
Example
- if <list.is_empty>:
    - narrate "it empty!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1042

Name<ListTag.last[(<#>)]>
ReturnsObjectTag
DescriptionReturns the last element in the list.
If the list is empty, returns null instead.
Effectively equivalent to .get[<[list].size>]
Optionally, specify a number of entries to get, which will return the # first entries, equivalent to .get[<[size].sub[#]>].to[last]
Example
# Narrates "three"
- narrate <list[one|two|three].last>
Example
# Narrates a list of "two" and "three"
- narrate <list[one|two|three].last[2]>
Example
# Narrates a list of "one", "two", and "three"
- narrate <list[one|two|three].last[5]>
Example
# Causes an error, as the list is empty.
- narrate <list.last>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1866

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

Name<ListTag.lowest[(<tag>)].count[<#>]>
ReturnsListTag
DescriptionReturns a list of the smallest values in a list of decimal numbers.
Optionally specify a tag to run on each list entry that returns the numeric value for that entry.
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
Example
# Narrates a list of '1|2'
- narrate "<list[3|2|1|10].lowest.count[2]>
Example
# Narrates the names of the 5 players with the least money currently online
- narrate <server.online_players.lowest[money].count[5].parse[name].formatted>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1933

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.
Example
# Narrates a map of "[a=1;b=2;c=3]"
- narrate <list[a|b|c].map_with[1|2|3|]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1006

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.
Generated Example
- foreach <list[one|two].merge_maps> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L959

Name<ListTag.numerical>
ReturnsListTag
DescriptionReturns the list sorted to be in numerical order.
Example
# Narrates a list of '1|2|3|10'
- narrate "<list[3|2|1|10].numerical>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2105

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.
Note the index input options described at ObjectType:listtag
Example
# Narrates a list of "one|potato|taco|four"
- narrate <list[one|two|three|four].overwrite[potato|taco].at[2]>
Example
# Narrates a list of "one|potato|taco|hotdog|cheeseburger"
- narrate <list[one|two|three].overwrite[potato|taco|hotdog|cheeseburger].at[2]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1215

Name<ListTag.pad_left[<#>]>
ReturnsListTag
DescriptionReturns a ListTag extended to reach a minimum specified length by adding entries to the left side.
Generated Example
- foreach <list[one|two].pad_left[4]> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2494

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

Name<ListTag.pad_right[<#>]>
ReturnsListTag
DescriptionReturns a ListTag extended to reach a minimum specified length by adding entries to the right side.
Generated Example
- foreach <list[one|two].pad_right[2]> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2521

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

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

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.
Example
# Narrates a list of 'ONE|TWO'
- narrate <list[one|two].parse_tag[<[parse_value].to_uppercase>]>
Example
# Narrates a list of 'charlie|alpha|bravo'
- narrate <list[3|1|2].parse_tag[<list[alpha|bravo|charlie].get[<[parse_value]>]>]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2463

Name<ListTag.random[(<#>)]>
ReturnsObjectTag
DescriptionGets a random item in the list and returns it.
Optionally, add [<#>] to instead get a list of multiple randomly chosen list entries.
Example
# Narrates EITHER "one" OR "two" - different each time!
- narrate "<list[one|two].random>
Example
# Could narrate "one|two", "two|three", OR "one|three" - different each time!
- narrate "<list[one|two|three].random[2]>
Example
# Could narrate "one|two|three", "one|three|two", "two|one|three", "two|three|one", "three|two|one", OR "three|one|two" - different each time!
- narrate "<list[one|two|three].random[9999]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2676

Name<ListTag.remove[<#>|...]>
ReturnsListTag
DescriptionReturns a new ListTag excluding the items at the specified index.
Note the index input options described at ObjectType:listtag
Example
# Narrates a list of "one|three|four"
- narrate <list[one|two|three|four].remove[2]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1358

Name<ListTag.remove[<#>].to[<#>]>
ReturnsListTag
DescriptionReturns a new ListTag excluding the items in the specified index range.
Note the index input options described at ObjectType:listtag
Example
# Narrates a list of "one|five"
- narrate <list[one|two|three|four|five].remove[2].to[4]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1371

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

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

Name<ListTag.reverse>
ReturnsListTag
DescriptionReturns a copy of the list, with all items placed in opposite order.
Example
# Narrates a list of "three|two|one"
- narrate <list[one|two|three].reverse>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1500

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

Name<ListTag.set_single[<value>].at[<#>]>
ReturnsListTag
DescriptionReturns a new ListTag with the single item specified inserted to the specified location, replacing the object already at that location.
Note the index input options described at ObjectType:listtag
Example
# Narrates a list with 3 values: "one", "potato|taco", "three"
- narrate <list[one|two|three].set_single[potato|taco].at[2]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1181

Name<ListTag.set[...|...].at[<#>]>
ReturnsListTag
DescriptionReturns a new ListTag with the items specified inserted to the specified location, replacing the object already at that location.
Note the index input options described at ObjectType:listtag
Example
# Narrates a list of "one|potato|three"
- narrate <list[one|two|three].set[potato].at[2]>
Example
# Narrates a list of "one|potato|taco|hotdog|three"
- narrate <list[one|two|three].set[potato|taco|hotdog].at[2]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1142

Name<ListTag.shared_contents[...|...]>
ReturnsListTag
DescriptionReturns a list of only items that appear in both this list and the input one.
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").
Example
# Narrates a list of "two|four"
- narrate <list[one|two|three|four].shared_contents[two|four|five|six]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1415

Name<ListTag.size>
ReturnsElementTag(Number)
DescriptionReturns the size of the list.
Example
# Narrates '3'
- narrate <list[one|two|three].size>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1029

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

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

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

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

Name<ListTag.space_separated>
ReturnsElementTag
DescriptionReturns the list in a cleaner format, separated by spaces.
Example
# Narrates "one two three"
- narrate <list[one|two|three].space_separated>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L784

Name<ListTag.sub_lists[<#>]>
ReturnsListTag(ListTag)
DescriptionReturns a list containing sublists of this list capped to a specific length.
Example
# Narrates "a|b", then "c|d", then "e|f"
- foreach <list[a|b|c|d|e|f].sub_lists[2]> as:sublist:
    - narrate <[sublist]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L757

Name<ListTag.sum>
ReturnsElementTag(Decimal)
DescriptionReturns the sum of all numbers in the list. Ignores non-numerical values.
Example
# Narrates "6"
- narrate <list[1|2|3].sum>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1779

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 '/'.
Inverted by Tag:MapTag.to_list
Generated Example
- foreach <list[one|two].to_map> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L980

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.
Generated Example
- note <list[one|two].to_polygon> as:my_new_polygon
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitListExtensions.java#L89

Name<ListTag.unseparated>
ReturnsElementTag
DescriptionReturns the list in a less clean format, separated by nothing.
Example
# Narrates "onetwothree"
- narrate <list[one|two|three].unseparated>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L832



Category: LocationTag


Name<LocationTag.buried_item>
ReturnsItemTag
MechanismLocationTag.buried_item
DescriptionReturns the item buried in a brushable block (also referred to as "suspicious blocks"). Returns air if there is no item buried.
Generated Example
- give <player.location.buried_item>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4338

Name<LocationTag.downfall_type>
ReturnsElementTag
DescriptionReturns a location's downfall type (for when a world has weather), based on the biome it's in.
This can be RAIN, SNOW, or NONE.
See also Tag:BiomeTag.downfall_at.
Example
# Tells the linked player what the downfall type at their location is.
- narrate "The downfall type at your location is: <player.location.downfall_type>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4239

Name<LocationTag.last_interacted_slot>
ReturnsElementTag(Number)
MechanismLocationTag.last_interacted_slot
DescriptionReturns the last interacted slot of a Chiseled Bookshelf inventory.
Generated Example
- narrate "the number value is <player.location.last_interacted_slot>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4255

Name<LocationTag.sherds>
ReturnsMapTag
MechanismLocationTag.sherds
DescriptionReturns a decorated pot's sherds as a map of sides to ObjectType:MaterialTags of the sherds.
The map will always contain every side, with a brick being the default value for when a side has no sherd.
Valid sides are: 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/DecoratedPot.Side.html.
Valid sherd materials are either a brick or any pottery sherd.
Example
# Tells the player if they're looking at a pot that has any sherds.
- if <player.cursor_on.sherds.values.contains_match[!brick].if_null[false]>:
  - narrate "That pot has sherds in it! You should check!"
- else:
  - narrate "Try looking somewhere else."
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4272

Name<LocationTag.slot[<vector>]>
ReturnsElementTag(Number)
DescriptionReturns the appropriate slot based on a given point along the bookshelves' surface relative to its position.
It will return 0 if the given vector is not within the bounds of any slot.
See also Tag:EntityTag.bookshelf_slot
Example
# Obtain and narrate the slot that the player right-clicked.
on player right clicks chiseled_bookshelf:
- define slot <player.eye_location.ray_trace.sub[<context.location>]>
- narrate <context.location.slot[<[slot]>]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4407

Name<LocationTag.temperature>
ReturnsElementTag(Decimal)
DescriptionReturns a location's temperature, based on the biome it's in.
If this is less than 0.15, snow will form on the ground when weather occurs in the world and a layer of ice will form over water.
See also Tag:BiomeTag.temperature_at.
Example
# Gives the player water if they are standing in a warm location.
- if <player.location.temperature> > 0.5:
  - give water_bucket
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4222

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
Generated Example
- narrate <player.location.vector_to_face>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3292

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

Name<LocationTag.areas[(<matcher>)]>
ReturnsListTag(AreaObject)
DescriptionReturns a ListTag of all noted areas that include this location.
Optionally, specify a matcher to only include areas that match the given AreaObject matcher text.
Example
# This example shows all areas at the player's location.
- narrate "You are inside: <player.location.areas.parse[note_name].formatted>"
Example
# This example finds which "Town" area the player is in.
- narrate "You are inside the town of <player.location.areas[town_*].first.flag[town_name].if_null[Nowhere!]>"
Groupareas
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3500

Name<LocationTag.cuboids[(<matcher>)]>
ReturnsListTag(CuboidTag)
DescriptionReturns a ListTag of all noted CuboidTags that include this location.
Optionally, specify a matcher to only include areas that match the given AreaObject matcher text.
Generated Example
- foreach <player.location.cuboids> as:entry:
    - narrate "found <[entry]>"
Groupareas
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3525

Name<LocationTag.ellipsoids[(<matcher>)]>
ReturnsListTag(EllipsoidTag)
DescriptionReturns a ListTag of all noted EllipsoidTags that include this location.
Optionally, specify a matcher to only include areas that match the given AreaObject matcher text.
Generated Example
- foreach <player.location.ellipsoids> as:entry:
    - narrate "found <[entry]>"
Groupareas
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3546

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

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

Name<LocationTag.polygons[(<matcher>)]>
ReturnsListTag(PolygonTag)
DescriptionReturns a ListTag of all noted PolygonTags that include this location.
Optionally, specify a matcher to only include areas that match the given AreaObject matcher text.
Generated Example
- foreach <player.location.polygons> as:entry:
    - narrate "found <[entry]>"
Groupareas
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3567

Name<LocationTag.to_cuboid[<location>]>
ReturnsCuboidTag
DescriptionReturns a cuboid from this location to the specified location.
Generated Example
- note <player.location.to_cuboid[<npc.location>]> as:my_new_cuboid
Groupareas
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3473

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

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

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

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

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.
Generated Example
- teleport <player> <player.location.find_nearest_biome[desert]>
Groupfinding
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2574

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).
Generated Example
- foreach <player.location.find_npcs_within[0]> as:entry:
    - narrate "found <[entry]>"
Groupfinding
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2852

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.
Generated Example
- foreach <player.location.find_path[<npc.location>]> as:entry:
    - narrate "found <[entry]>"
Groupfinding
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3115

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).
Generated Example
- foreach <player.location.find_players_within[0]> as:entry:
    - narrate "found <[entry]>"
Groupfinding
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2829

Name<LocationTag.find_spawnable_blocks_within[<#.#>]>
ReturnsListTag(LocationTag)
DescriptionReturns a list of blocks within a radius, that are safe for spawning, with the same logic as Tag:LocationTag.is_spawnable.
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).
Generated Example
- foreach <player.location.find_spawnable_blocks_within[2]> as:entry:
    - narrate "found <[entry]>"
Groupfinding
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2786

Name<LocationTag.find_tile_entities[(<matcher>)].within[<#.#>]>
ReturnsListTag(LocationTag)
DescriptionReturns a list of tile-entity blocks within a radius, with an optional search parameter for the block material.
This can be more efficient that Tag:LocationTag.find_blocks.within when only tile-entity blocks are relevant.
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).
Groupfinding
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2726

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

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

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

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

Name<LocationTag.chunk>
ReturnsChunkTag
DescriptionReturns the chunk that this location belongs to.
Generated Example
- adjust <player.location.chunk> set_all_biomes:desert
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3195

Name<LocationTag.format[<format>]>
ReturnsElementTag
DescriptionFormats a LocationTag according to a specified format input.
You can request x, y, z, yaw, or pitch as full "f", short "s", or block "b" format.
eg "fx" for "full X coordinate" (like 1.051234), "syaw" for "short yaw" (like 1.03), or "bz" for "block Z coordinate" (like 1).
"world" is also available to get the world name.
If "$" is in the format, only codes prefixed with "$" will be replaced, eg "$bx but not bx" will become "5 but not bx" (allowing the safe use of unpredictable text inside the format block).
Example
# This example does a simple format, like "1, 2, 3".
- narrate "You are at <player.location.format[bx, by, bz]>"
Example
# This example adds colors, uses the "$" prefix to be safe from bugs, and formats like "You are at y = 32 in Space".
- narrate "<&[base]>You are at <player.location.format[y = <&[emphasis]>$by <&[base]>in <&[emphasis]>$world]>"
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3139

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'
Generated Example
- narrate <player.location.formatted>
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3166

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

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

Name<LocationTag.pitch>
ReturnsElementTag(Decimal)
DescriptionReturns the pitch of the object at the location.
Generated Example
- narrate "the decimal value is <player.location.pitch>"
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2293

Name<LocationTag.raw>
ReturnsElementTag
DescriptionReturns the raw representation of this location, without any note name.
Generated Example
- narrate <player.location.raw>
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3206

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
Generated Example
- narrate <player.location.simple>
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1683

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

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

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

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

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

Name<LocationTag.world>
ReturnsWorldTag
DescriptionReturns the world that the location is in.
Generated Example
- adjust <player.location.world> full_time:0
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3217

Name<LocationTag.yaw>
ReturnsElementTag(Decimal)
DescriptionReturns the normalized yaw of the object at the location.
Generated Example
- narrate "the decimal value is <player.location.yaw>"
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2333

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

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:VectorObject.add with input 0,1,0 (or the input value instead of '1').
Generated Example
- teleport <player> <player.location.above>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L883

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.
Generated Example
- teleport <player> <player.location.backward>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L948

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.
Generated Example
- teleport <player> <player.location.backward_flat>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L921

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:VectorObject.sub with input 0,1,0 (or the input value instead of '1').
Generated Example
- teleport <player> <player.location.below>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L895

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.
Generated Example
- teleport <player> <player.location.block>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1051

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

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", ...
Generated Example
- narrate <player.location.direction>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2146

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

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

Name<LocationTag.distance[<location>]>
ReturnsElementTag(Decimal)
DescriptionReturns the distance between 2 locations.
Generated Example
- narrate "the decimal value is <player.location.distance[<player.location>]>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3335

Name<LocationTag.distance_squared[<location>]>
ReturnsElementTag(Decimal)
DescriptionReturns the distance between 2 locations, squared.
Generated Example
- narrate "the decimal value is <player.location.distance_squared[<npc.location>]>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3310

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

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

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

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

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.
Generated Example
- teleport <player> <player.location.down>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1007

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

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

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

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.
Generated Example
- teleport <player> <player.location.forward>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L936

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.
Generated Example
- teleport <player> <player.location.forward_flat>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L907

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.
Generated Example
- teleport <player> <player.location.left>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L961

Name<LocationTag.line_of_sight[<location>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the specified location is within this location's line of sight.
Generated Example
- if <player.location.line_of_sight[<player.location>]>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2122

Name<LocationTag.points_around_x[radius=<#.#>;points=<#>]>
ReturnsListTag(LocationTag)
DescriptionReturns a list of points in a circle around a location's x axis with the specified radius and number of points.
For example: <player.location.points_around_x[radius=10;points=16]>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2438

Name<LocationTag.points_around_y[radius=<#.#>;points=<#>]>
ReturnsListTag(LocationTag)
DescriptionReturns a list of points in a circle around a location's y axis with the specified radius and number of points.
For example: <player.location.points_around_y[radius=10;points=16]>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2460

Name<LocationTag.points_around_z[radius=<#.#>;points=<#>]>
ReturnsListTag(LocationTag)
DescriptionReturns a list of points in a circle around a location's z axis with the specified radius and number of points.
For example: <player.location.points_around_z[radius=10;points=16]>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2482

Name<LocationTag.points_between[<location>]>
ReturnsListTag(LocationTag)
DescriptionFinds all locations between this location and another, separated by 1 block-width each.
Generated Example
- foreach <player.location.points_between[<player.location>]> as:entry:
    - narrate "found <[entry]>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2047

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

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

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:VectorObject.add instead.
Generated Example
- teleport <player> <player.location.relative[<player.location>]>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1023

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.
Generated Example
- teleport <player> <player.location.right>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L976

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]>]>]>.
Generated Example
- teleport <player> <player.location.rotate_around_x[2]>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2381

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]>]>]>.
Generated Example
- teleport <player> <player.location.rotate_around_y[1]>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2400

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]>]>]>.
Generated Example
- teleport <player> <player.location.rotate_around_z[1]>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2419

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

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

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.
Generated Example
- teleport <player> <player.location.round>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1576

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.
Generated Example
- teleport <player> <player.location.round_down>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1615

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").
Generated Example
- teleport <player> <player.location.round_to[3]>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1635

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").
Generated Example
- teleport <player> <player.location.round_to_precision[1.5]>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1659

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).
Generated Example
- teleport <player> <player.location.round_up>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1596

Name<LocationTag.simplex_3d>
ReturnsElementTag(Decimal)
DescriptionReturns the 3D simplex noise value (from -1 to 1) for this location's X/Y/Z.
See also Tag:util.random_simplex
Generated Example
- narrate "the decimal value is <player.location.simplex_3d>"
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1077

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.
Generated Example
- teleport <player> <player.location.up>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L991

Name<LocationTag.age>
ReturnsDurationTag
MechanismLocationTag.age
DescriptionReturns the age of an end gateway.
Generated Example
- ratelimit <player> <player.location.age>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4012

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

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.
Generated Example
- narrate <player.location.beacon_primary_effect>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3859

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.
Generated Example
- narrate <player.location.beacon_secondary_effect>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3875

Name<LocationTag.beacon_tier>
ReturnsElementTag(Number)
DescriptionReturns the tier level of a beacon pyramid (0-4).
Generated Example
- narrate "the number value is <player.location.beacon_tier>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3848

Name<LocationTag.biome>
ReturnsBiomeTag
MechanismLocationTag.biome
DescriptionReturns the biome at the location.
Generated Example
- adjust <player.location.chunk> set_all_biomes:<player.location.biome>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3488

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).
Generated Example
- teleport <player> <player.location.block_facing>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L835

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.
Generated Example
- narrate "the number value is <player.location.brewing_fuel_level>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3788

Name<LocationTag.brewing_time>
ReturnsDurationTag
MechanismLocationTag.brewing_time
DescriptionReturns the brewing time a brewing stand has left.
Generated Example
- flag server myflag expire:<player.location.brewing_time>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3776

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).
Generated Example
- foreach <player.location.campfire_items> as:entry:
    - narrate "found <[entry]>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4084

Name<LocationTag.command_block>
ReturnsElementTag
MechanismLocationTag.command_block
DescriptionReturns the command a command block is set to.
Generated Example
- narrate <player.location.command_block>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3761

Name<LocationTag.command_block_name>
ReturnsElementTag
MechanismLocationTag.command_block_name
DescriptionReturns the name a command block is set to.
Generated Example
- narrate <player.location.command_block_name>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3746

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.
Generated Example
- narrate <player.location.custom_name>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3947

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).
Generated Example
- foreach <player.location.drops> as:entry:
    - narrate "found <[entry]>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1433

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

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.
This is an imperfect block line tracer.
Generated Example
- foreach <player.location.facing_blocks> as:entry:
    - narrate "found <[entry]>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2092

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

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

Name<LocationTag.furnace_burn_duration>
ReturnsDurationTag
MechanismLocationTag.furnace_burn_duration
DescriptionReturns the burn time a furnace has left.
Generated Example
- ratelimit <player> <player.location.furnace_burn_duration>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3800

Name<LocationTag.furnace_cook_duration>
ReturnsDurationTag
MechanismLocationTag.furnace_cook_duration
DescriptionReturns the cook time a furnace has been cooking its current item for.
Generated Example
- flag server myflag expire:<player.location.furnace_cook_duration>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3816

Name<LocationTag.furnace_cook_duration_total>
ReturnsDurationTag
MechanismLocationTag.furnace_cook_duration_total
DescriptionReturns the total cook time a furnace has left.
Generated Example
- flag server myflag expire:<player.location.furnace_cook_duration_total>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3832

Name<LocationTag.has_inventory>
ReturnsElementTag(Boolean)
DescriptionReturns whether the block at the location has an inventory.
Generated Example
- if <player.location.has_inventory>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1135

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.
Generated Example
- if <player.location.has_loot_table>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3693

Name<LocationTag.head_rotation>
ReturnsElementTag(Number)
MechanismLocationTag.head_rotation
DescriptionGets the rotation of the head at this location. Can be 1-16.
Generated Example
- narrate "the number value is <player.location.head_rotation>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1210

Name<LocationTag.highest>
ReturnsLocationTag
DescriptionReturns the location of the highest solid block at the location.
Generated Example
- teleport <player> <player.location.highest>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1123

Name<LocationTag.hive_bee_count>
ReturnsElementTag(Number)
DescriptionReturns the number of bees inside a hive.
Generated Example
- narrate "the number value is <player.location.hive_bee_count>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1472

Name<LocationTag.hive_max_bees>
ReturnsElementTag(Number)
MechanismLocationTag.hive_max_bees
DescriptionReturns the maximum number of bees allowed inside a hive.
Generated Example
- narrate "the number value is <player.location.hive_max_bees>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1483

Name<LocationTag.inventory>
ReturnsInventoryTag
DescriptionReturns the InventoryTag of the block at the location. If the
block is not a container, returns null.
Generated Example
- note <player.location.inventory> as:my_new_inventory
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1146

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.
Generated Example
- if <player.location.is_exact_teleport>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4030

Name<LocationTag.is_liquid>
ReturnsElementTag(Boolean)
DescriptionReturns whether the block at the location is a liquid.
Generated Example
- if <player.location.is_liquid>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3588

Name<LocationTag.is_lockable>
ReturnsElementTag(Boolean)
MechanismLocationTag.lock
DescriptionReturns whether the container is lockable.
Generated Example
- if <player.location.is_lockable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1421

Name<LocationTag.is_locked>
ReturnsElementTag(Boolean)
MechanismLocationTag.lock
DescriptionReturns whether the container is locked.
Generated Example
- if <player.location.is_locked>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1406

Name<LocationTag.is_passable>
ReturnsElementTag(Boolean)
DescriptionReturns whether the block at this location is non-solid and can be walked through.
Note that for example an open door is still solid, and thus will return false.
Generated Example
- if <player.location.is_passable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1176

Name<LocationTag.is_spawnable>
ReturnsElementTag(Boolean)
DescriptionReturns whether the location is safe to spawn at, for a player or player-like entity.
Specifically this verifies that:
- The block above this location is air.
- The block at this location is non-solid.
- The block below this location is solid.
- All relevant blocks are not dangerous (like fire, lava, etc.), or unstable/small/awkward (like fences, doors, etc.) or otherwise likely to go wrong (like pressure plates).
Generated Example
- if <player.location.is_spawnable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4107

Name<LocationTag.is_within_border>
ReturnsElementTag(Boolean)
DescriptionReturns whether the location is within the world border.
Generated Example
- if <player.location.is_within_border>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3414

Name<LocationTag.jukebox_is_playing>
ReturnsElementTag(Boolean)
MechanismLocationTag.jukebox_play
DescriptionReturns whether the jukebox is currently playing a song.
Generated Example
- if <player.location.jukebox_is_playing>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3994

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

Name<LocationTag.lectern_page>
ReturnsElementTag(Number)
MechanismLocationTag.lectern_page
DescriptionReturns the current page on display in the book on this Lectern block.
Generated Example
- narrate "the number value is <player.location.lectern_page>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3677

Name<LocationTag.light>
ReturnsElementTag(Number)
DescriptionReturns the total amount of light on the location.
Generated Example
- narrate "the number value is <player.location.light>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3609

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

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

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.
Generated Example
- narrate "the decimal value is <player.location.local_difficulty>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3963

Name<LocationTag.lock>
ReturnsElementTag
MechanismLocationTag.lock
DescriptionReturns the password to a locked container.
Generated Example
- narrate <player.location.lock>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1390

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

Name<LocationTag.map_color>
ReturnsColorTag
DescriptionReturns the color of the block at the location, as seen in a map.
Generated Example
- narrate "<&color[<player.location.map_color>]>hello there!"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4158

Name<LocationTag.material>
ReturnsMaterialTag
DescriptionReturns the material of the block at the location.
Generated Example
- foreach <player.location.find_blocks[<player.location.material>].within[5]> as:loc:
    - modifyblock <[loc]> air
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1161

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.
Generated Example
- teleport <player> <player.location.other_block>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3926

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 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/DyeColor.html.
For the list of possible patterns, see 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/banner/PatternType.html.
Generated Example
- foreach <player.location.patterns> as:entry:
    - narrate "found <[entry]>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1192

Name<LocationTag.power>
ReturnsElementTag(Number)
DescriptionReturns the current redstone power level of a block.
Generated Example
- narrate "the number value is <player.location.power>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3656

Name<LocationTag.precise_cursor_on[(<range>)]>
ReturnsLocationTag
DescriptionDeprecated in favor of Tag:LocationTag.ray_trace with all default settings (no input other than optionally the range).
Generated Example
- teleport <player> <player.location.precise_cursor_on>
Groupworld
Deprecateduse "ray_trace" instead.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1920

Name<LocationTag.precise_cursor_on_block[(<range>)]>
ReturnsLocationTag
DescriptionDeprecated in favor of Tag:LocationTag.ray_trace with input setting [return=block].
Generated Example
- teleport <player> <player.location.precise_cursor_on_block>
Groupworld
Deprecateduse "ray_trace[return=block]" instead.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1899

Name<LocationTag.precise_impact_normal[(<range>)]>
ReturnsLocationTag
DescriptionDeprecated in favor of Tag:LocationTag.ray_trace with input setting [return=normal].
Generated Example
- teleport <player> <player.location.precise_impact_normal>
Groupworld
Deprecateduse "ray_trace[return=normal]" instead.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1878

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).
Generated Example
- heal <player.location.precise_target>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1967

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

Name<LocationTag.precise_target_position[(<range>)]>
ReturnsLocationTag
DescriptionDeprecated in favor of Tag:LocationTag.ray_trace with input of [entities=*]
Generated Example
- teleport <player> <player.location.precise_target_position>
Groupworld
Deprecateduse "ray_trace[entities=*]" instead.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2007

Name<LocationTag.precise_target_position[(<range>)].type[<entity_type>|...]>
ReturnsLocationTag
DescriptionDeprecated in favor of Tag:LocationTag.ray_trace with "entities=" set to your input types as a matcher.
Groupworld
Deprecateduse "ray_trace[entities=(your_types)]" instead.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2022

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

Name<LocationTag.ray_trace[(range=<#.#>/{200});(return=<{precise}/block/normal>);(default=<{null}/air>);(fluids=<true/{false}>);(nonsolids=<true/{false}>);(entities=<matcher>);(ignore=<entity>|...);(raysize=<#.#>/{0})]>
ReturnsLocationTag
DescriptionTraces a line from this location towards the direction it's facing, returning the location of the first hit block or (optionally) entity.
This tag has also been referred to as 'cursor_on' or 'precise_cursor_on' in the past.
For ray tracing entities, see Tag:LocationTag.ray_trace_target.
Using 'return=normal' instead replaces the old 'precise_impact_normal' tag.
Optionally specify:
range: (defaults to 200) a maximum distance (in blocks) to trace before giving up.
return: (defaults to precise)
specify "precise" to return the exact location of the hit (if it hits a block, returns a location along the edge of the block -- but if it hits an entity, returns a location along the body of the entity)
"normal" to return the normal vector of the impact location,
or "block" to return the location of the block hit (if it hits an entity, returns equivalent to 'precise')
For "precise" and "block", the location's direction is set to the direction of the block face hit (or entity bounding box face), pointing exactly away from whatever was hit (the 'normal' direction).
default: (defaults to "null")
specify "null" to return null when nothing is hit,
or "air" to return the location of the air at the end of the trace (NOTE: can potentially be in water or other ignored block type, not just literal air).
fluids: (defaults to false) specify "true" to count fluids like water as solid, or "false" to ignore them.
nonsolids: (defaults to false) specify "true" to count passable blocks (like tallgrass) as solid, or false to ignore them.
entities: (defaults to none) specify an entity matcher for entities to count as blocking the trace, "*" for any entity counts, or leave off (or empty) to ignore entities.
ignore: (defaults to none) optional list of EntityTags to ignore even if they match the matcher.
raysize: (defaults to 0) sets the radius of the ray being used to trace entities (and NOT for blocks!).
Example
# Destroys whatever solid block the player is looking at.
- define target <player.eye_location.ray_trace[return=block]||null>
- if <[target]> != null:
    - modifyblock <[target]> air
Example
# Spawns a heart wherever the player is looking, no more than 5 blocks away.
- playeffect effect:heart offset:0 at:<player.eye_location.ray_trace[range=5;entities=*;ignore=<player>;fluids=true;nonsolids=true;default=air]>
Example
# Spawns a line of fire starting at the player's target location and spewing out in the direction of the blockface or entity hit, demonstrating the concept of a normal vector.
- define hit <player.eye_location.ray_trace[entities=*;ignore=<player>;fluids=true;nonsolids=true]||null>
- if <[hit]> != null:
    - playeffect effect:flame offset:0 at:<[hit].points_between[<[hit].forward[2]>].distance[0.2]>
Synonyms (Search Aid)locationtag.raycast, locationtag.raytrace, locationtag.ray_cast
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1718

Name<LocationTag.ray_trace_target[(range=<#.#>/{200});(blocks=<{true}/false>);(fluids=<true/{false}>);(nonsolids=<true/{false}>);(entities=<matcher>);(ignore=<entity>|...);(raysize=<#.#>/{0})]>
ReturnsEntityTag
DescriptionTraces a line from this location towards the direction it's facing, returning the first hit entity (if any).
This is similar to Tag:LocationTag.precise_target and Tag:PlayerTag.target, except offering more options for how the ray trace is performed.
For ray tracing locations, see Tag:LocationTag.ray_trace.
Optionally specify:
range: (defaults to 200) a maximum distance (in blocks) to trace before giving up.
blocks: (defaults to true) specify "false" to ignore all blocks, solid or nonsolid or fluid, between this location and the target entity.
fluids: (defaults to false) specify "true" to count fluids like water as solid, or "false" to ignore them.
nonsolids: (defaults to false) specify "true" to count passable blocks (like tall_grass) as solid, or "false" to ignore them.
entities: (defaults to none) specify an entity matcher for entities to ray trace for. Any non-matching entities along the way are ignored. Leave blank to match any entity.
ignore: (defaults to none) optional list of EntityTags to ignore even if they match the matcher.
raysize: (defaults to 0) sets the radius of the ray being used to trace entities.
Example
# Removes the entity a player is looking at.
- define target <player.eye_location.ray_trace_target[ignore=<player>]||null>
- if <[target]> != null:
    - remove <[target]>
Example
# Returns any player within the view of an NPC.
- define target <npc.eye_location.ray_trace_target[entities=player;raysize=2]||null>
Example
# Highlights an entity through any number or types of blocks.
- define target <player.eye_location.ray_trace_target[ignore=<player>;blocks=false]||null>
- if <[target]> != null:
    - adjust <[target]> glowing:true
Synonyms (Search Aid)locationtag.raycast_target, locationtag.raytrace_target, locationtag.ray_cast_target
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1814

Name<LocationTag.sign_contents>
ReturnsListTag
MechanismLocationTag.sign_contents
DescriptionReturns a list of lines on a sign.
Generated Example
- foreach <player.location.sign_contents> as:entry:
    - narrate "found <[entry]>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1235

Name<LocationTag.sign_glow_color>
ReturnsElementTag
MechanismLocationTag.sign_glow_color
DescriptionReturns the name of the glow-color of the sign at the location.
See also Tag:LocationTag.sign_glowing
Generated Example
- narrate <player.location.sign_glow_color>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4140

Name<LocationTag.sign_glowing>
ReturnsElementTag(Boolean)
MechanismLocationTag.sign_glowing
DescriptionReturns whether the location is a Sign block that is glowing.
Generated Example
- if <player.location.sign_glowing>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4123

Name<LocationTag.skull_name>
ReturnsElementTag
MechanismLocationTag.skull_skin
DescriptionReturns the name of the skin the skull is displaying.
Generated Example
- narrate <player.location.skull_name>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1511

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.
Generated Example
- narrate <player.location.skull_skin>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1535

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

Name<LocationTag.skull_type>
ReturnsElementTag
DescriptionReturns the type of the skull.
Generated Example
- narrate <player.location.skull_type>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1495

Name<LocationTag.spawner_count>
ReturnsElementTag(Number)
MechanismLocationTag.spawner_count
DescriptionReturns the spawn count for the spawner.
Generated Example
- narrate "the number value is <player.location.spawner_count>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1375

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

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).
Generated Example
- narrate "the number value is <player.location.spawner_max_nearby_entities>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1360

Name<LocationTag.spawner_maximum_spawn_delay>
ReturnsElementTag(Number)
MechanismLocationTag.spawner_delay_data
DescriptionReturns the maximum spawn delay for the mob spawner.
Generated Example
- narrate "the number value is <player.location.spawner_maximum_spawn_delay>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1315

Name<LocationTag.spawner_minimum_spawn_delay>
ReturnsElementTag(Number)
MechanismLocationTag.spawner_delay_data
DescriptionReturns the minimum spawn delay for the mob spawner.
Generated Example
- narrate "the number value is <player.location.spawner_minimum_spawn_delay>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1300

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).
Generated Example
- narrate "the number value is <player.location.spawner_player_range>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1330

Name<LocationTag.spawner_range>
ReturnsElementTag(Number)
MechanismLocationTag.spawner_range
DescriptionReturns the spawn range for the spawner (the radius mobs will spawn in).
Generated Example
- narrate "the number value is <player.location.spawner_range>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1345

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.
Generated Example
- narrate "the number value is <player.location.spawner_spawn_delay>"
Groupworld
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, if any.
Generated Example
- kill <player.location.spawner_type>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1252

Name<LocationTag.structure_block_data>
ReturnsMapTag
MechanismLocationTag.structure_block_data
DescriptionReturns the structure block data of the structure block at the location as a map with the following keys:
- author: ElementTag: The name of the structure's creator. set to "?" for most vanilla structures.
- integrity: ElementTag(Decimal): The integrity of the structure (0-1). Lower integrity values will result in more blocks being removed when loading a structure.
used with the seed to determine which blocks are randomly removed to mimic "decay".
- metadata: ElementTag: Only applies in DATA mode, sets specific functions that can be applied to the structure,
check the Minecraft wiki (🔗https://minecraft.wiki/w/Structure_Block#Data) for more information.
- mirror: ElementTag: How the structure is mirrored; "NONE", "LEFT_RIGHT", or "FRONT_BACK".
- box_position: LocationTag: The position of the structure's bounding box, relative to the position of the structure block. Maximum allowed distance is 48 blocks in any direction.
- rotation: ElementTag: The rotation of the structure; "NONE", "CLOCKWISE_90", "CLOCKWISE_180", or "COUNTERCLOCKWISE_90".
- seed: ElementTag(Number): The seed used to determine how many blocks are removed upon loading of this structure (see "integrity" for more information).
- structure_name: ElementTag: The name of the structure.
- size: LocationTag: The size of the structure's bounding box, The maximum structure size is 48,48,48.
- mode: ElementTag: The structure block's mode; "CORNER", "DATA", "LOAD", or "SAVE". See also Mechanism:MaterialTag.mode.
- box_visible: ElementTag(Boolean): Whether the structure's bounding box is visible, only applies in LOAD mode.
- ignore_entities: ElementTag(Boolean): Whether entities in the structure are ignored, only applies in SAVE mode.
- show_invisible: ElementTag(Boolean): Whether invisible blocks in the structure are shown.
Generated Example
- foreach <player.location.structure_block_data> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4173

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
Generated Example
- if <player.location.switched>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1222

Name<LocationTag.tree_distance>
ReturnsElementTag(Number)
DescriptionDeprecated in favor of Tag:MaterialTag.distance
Used like <[location].material.distance>
Generated Example
- narrate "the number value is <player.location.tree_distance>"
Groupworld
DeprecatedUse MaterialTag.distance
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3728

Name<LocationTag.waxed>
ReturnsElementTag(Boolean)
MechanismLocationTag.waxed
DescriptionIf the location is a sign block, returns whether it is waxed (locked to prevent players editing the text).
Generated Example
- if <player.location.waxed>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4370

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).
Generated Example
- teleport <player> <player.location.with_facing_direction>
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L859

Name<LocationTag.xp_drop[(<item>)]>
ReturnsElementTag(Number)
DescriptionReturns how much experience, if any, the block at the location would drop if broken naturally.
Returns 0 if a block wouldn't drop xp.
Optionally specifier a breaker item.
Not guaranteed to contain exactly the amount that actual drops if then broken later, as the value is usually randomized.
Generated Example
- narrate "the number value is <player.location.xp_drop>"
Groupworld
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1454

Name<LocationTag.coreprotect_logs[<duration>]>
ReturnsListTag(MapTag)
DescriptionReturns a list changes to the given block within the given duration.
Each Map has keys:
"action" ("removal", "placement", or "interaction"),
"is_rolled_back" (true/false),
"material" (MaterialTag),
"player_name" (player username, not a PlayerTag instance),
"time" (TimeTag)
Generated Example
- foreach <player.location.coreprotect_logs[1s]> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, CoreProtect
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/coreprotect/CoreProtectLocationProperties.java#L50

Name<LocationTag.faction>
ReturnsFactionTag
DescriptionReturns the faction at the location. (Can also be SafeZone, WarZone, or Wilderness)
Generated Example
- narrate <player.location.faction>
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 whether the location has a Residence.
Generated Example
- if <player.location.has_residence>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, Residence
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/residence/ResidenceLocationExtensions.java#L13

Name<LocationTag.has_town>
ReturnsElementTag(Boolean)
DescriptionReturns whether the location is within a town.
Generated Example
- if <player.location.has_town>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L88

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.
Generated Example
- if <player.location.in_region>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardLocationProperties.java#L89

Name<LocationTag.is_nation_zone>
ReturnsElementTag(Boolean)
DescriptionReturns whether the location is a nation zone.
Generated Example
- if <player.location.is_nation_zone>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L114

Name<LocationTag.is_wilderness>
ReturnsElementTag(Boolean)
DescriptionReturns whether the location is wilderness.
Generated Example
- if <player.location.is_wilderness>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L125

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.
Generated Example
- narrate <player.location.plotsquared_plot>
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.
Generated Example
- foreach <player.location.regions> as:entry:
    - narrate "found <[entry]>"
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.
Generated Example
- narrate <player.location.residence>
RequiresDepenizen, Residence
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/residence/ResidenceLocationExtensions.java#L25

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.
Generated Example
- narrate <player.location.town>
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L99

Name<LocationTag.towny_allows_pvp>
ReturnsElementTag(Boolean)
DescriptionReturns whether Towny would allow PVP here.
Generated Example
- if <player.location.towny_allows_pvp>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L18

Name<LocationTag.towny_resident>
ReturnsPlayerTag
DescriptionReturns the resident of a Towny plot at the location, if any.
Generated Example
- narrate "hello there!" targets:<player.location.towny_resident>
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L29

Name<LocationTag.towny_type>
ReturnsElementTag
DescriptionReturns the type of the Towny area this location is in.
Can be Default, Shop, Arena, Embassy, Wilds, Inn, Jail, Farm, Bank
Generated Example
- narrate <player.location.towny_type>
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L72

Name<LocationTag.towny.resident>
ReturnsPlayerTag
DescriptionReturns the resident of a Towny plot at the location, if any.
Deprecated in favor of Tag:LocationTag.towny_resident.
RequiresDepenizen, Towny
Deprecateduse 'towny_resident'
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L50



Category: MapTag


Name<MapTag.any>
ReturnsElementTag(Boolean)
DescriptionReturns "true" if the map contains any keys, or "false" if it is empty.
Example
- if <map[a=1;b=2].any>:
    - narrate "This will show! The map has stuff in it!"
- else:
    - narrate "This won't show"
Example
- if <map.any>:
    - narrate "This won't show"
- else:
    - narrate "This will show! That map is empty!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L408

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.
Example
- if <map[a=1;b=2].contains[a]>:
    - narrate "Yep it sure does have 'a' as a key!"
Example
- if <map[a=1;b=2].contains[c]>:
    - narrate "This won't show"
- else:
    - narrate "No it doesn't have 'c'"
Example
# Narrates 'true'
- narrate <map[a=1;b=2].contains[a|b]>
Example
# Narrates 'false'
- narrate <map[a=1;b=2].contains[a|b|c]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L539

Name<MapTag.deep_exclude[<key>|...]>
ReturnsMapTag
DescriptionReturns a copy of the map with the specified deep key(s) excluded.
Example
- definemap mymap:
    root:
        first: kept
        second: lost
# Will narrate the initial map of '[root=[first=kept;second=lost]]'
- narrate <[mymap]>
# Demonstrates deep_exclude of 'second', narrating a new map of '[root=[first=kept]]' without 'second' in it
- narrate <[mymap].deep_exclude[root.second]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L802

Name<MapTag.deep_get[<key>|...]>
ReturnsObjectTag
DescriptionReturns the object value at the specified key, using deep key paths separated by the '.' symbol.
If a list is given as input, returns a list of values.
Example
# Narrates 'myvalue'
- narrate <map.with[root].as[<map[leaf=myvalue]>].deep_get[root.leaf]>
Example
# Narrates 'myvalue'
- definemap mymap:
    root:
        leaf: myvalue
- narrate <[mymap].deep_get[root.leaf]>
# The below will also get the same result ('myvalue') using the definition tag's special automatic deep get syntax:
- narrate <[mymap.root.leaf]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L604

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.
Example
- definemap mymap:
    root:
        first: 1
        second: 2
# Will narrate a list of 'root.first' and 'root.second'
# Note that 'root' itself is not in the output list, as it is a map, not a leaf value.
- narrate <[mymap].deep_keys>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L861

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.
Example
# Narrates a map of '[root=[leaf=myvalue]]', such that <[that].get[root]> itself returns a map of '[leaf=myvalue]'
- narrate <map.deep_with[root.leaf].as[myvalue]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L695

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.
Example
# Narrates a map of '[a=1;b=2;c=3;d=4]'
- narrate <map[a=1;b=2;c=3].default[d].as[4]>
Example
# Demonstrates matching keys not being replaced - narrates a map of '[a=1;b=2;c=3]'
- narrate <map[a=1;b=2;c=3].default[c].as[4]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L657

Name<MapTag.exclude[<key>|...]>
ReturnsMapTag
DescriptionReturns a copy of the map with the specified key(s) excluded.
Example
# Narrates a map of '[a=1;c=3]'
- narrate <map[a=1;b=2;c=3].exclude[b]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L825

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.
Example
# Narrates a map of '[c=3;d=4;e=5]'
- narrate <map[a=1;b=2;c=3;d=4;e=5].filter_tag[<[filter_value].is[or_more].than[3]>]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L477

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.
Example
# Narrates '2'
- narrate <map[a=1;b=2;c=3].get[b]>
Example
# Demonstrates that list input gives list output - narrates '2' then '3'
- foreach <map[a=1;b=2;c=3].get[b|c]> as:value:
    - narrate "One of the values is <[value]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L579

Name<MapTag.get_subset[<key>|...]>
ReturnsMapTag
DescriptionReturns the subset of the map represented by the given keys, ordered based on the input list.
Keys that aren't present in the original map will be ignored.
Example
# Narrates a map of '[b=2;a=1]'
- narrate <map[a=1;b=2;c=3].get_subset[b|a]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L635

Name<MapTag.include[<map>]>
ReturnsMapTag
DescriptionReturns a copy of the map with the specified map's contents copied in.
Matching keys will be overridden.
Example
# Narrates a map of '[a=1;b=2;c=3;d=4;e=5]'
- narrate <map[a=1;b=2;c=3].include[d=4;e=5]>
Example
# Demonstrates matching keys overriding - Narrates a map of '[a=1;b=4;c=5]'
- narrate <map[a=1;b=2;c=3].include[b=4;c=5]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L842

Name<MapTag.invert>
ReturnsMapTag
DescriptionReturns an inverted copy of the map. That is, keys become values and values become keys.
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.
Example
# Narrates a map of '[1=a;2=b;3=c]'
- narrate <map[a=1;b=2;c=3].invert>
Example
# Demonstrates how duplicate values in the input become a single key in the output - narrates a map of '[1=a;2=c]'
- narrate <map[a=1;b=2;c=2].invert>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L759

Name<MapTag.is_empty>
ReturnsElementTag(Boolean)
DescriptionReturns "true" if the map is empty (contains no keys), otherwise "false".
Example
- if <map[a=1;b=2].is_empty>:
    - narrate "This won't show"
- else:
    - narrate "This will show! The map has stuff in it!"
Example
- if <map.is_empty>:
    - narrate "This will show! That map is empty!"
- else:
    - narrate "This won't show"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L388

Name<MapTag.keys>
ReturnsListTag
DescriptionReturns a list of all keys in this map.
Example
# Narrates a list of 'a|b|c|'
- narrate <map[a=1;b=2;c=3].key>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L889

Name<MapTag.parse_value[<tag>]>
ReturnsMapTag
DescriptionReturns a copy of the map with all its values updated through the given tag.
One should generally prefer Tag:MapTag.parse_value_tag.
Example
# Narrates a map of '[alpha=ONE;beta=TWO]'
- narrate <map[alpha=one;bravo=two].parse_value[to_uppercase]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L987

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.
Example
# Narrates a map of '[alpha=ONE;bravo=TWO]'
- narrate <map[alpha=one;bravo=two].parse_value_tag[<[parse_value].to_uppercase>]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L509

Name<MapTag.reverse>
ReturnsMapTag
DescriptionReturns a reversed copy of the map. That is, the last key becomes the first key and vice-versa, akin to Tag:ListTag.reverse
Not to be confused with Tag:MapTag.invert
Example
# Narrates a map of '[c=3;b=2;a=1]'
- narrate <map[a=1;b=2;c=3].reverse>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L782

Name<MapTag.size>
ReturnsElementTag(Number)
DescriptionReturns the size of the map - that is, how many key/value pairs are within it.
Example
# Narrates '2'
- narrate <map[a=1;b=2].size>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L375

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[...]]'
Example
# Narrates a map of [a=1;b=2;c=3]
- narrate <map[c=3;a=1;b=2].sort_by_value>
Example
# Narrates a map of [c=3;b=2;a=1]
- narrate <map[c=3;a=1;b=2].sort_by_value[mul[-1]]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L428

Name<MapTag.to_json[(native_types=<true/false>);(indent=<#>)]>
ReturnsElementTag
DescriptionReturns a JSON encoding of this map. Primarily useful with interop with other software, such as when use Command:webget or Command:webserver.
Optionally specify configuration input with:
'native_types' (defaults to false) if 'true' will attempt to convert 'true' or 'false' to booleans, and numbers to raw numbers.
'indent' (defaults to 0) to specify the indentation level of the JSON text output. 0 means no spacing or newlines at all.
Example
# Narrates {"a":"1","b":"2"}
- narrate <map[a=1;b=2].to_json>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L951

Name<MapTag.to_list[(<separator>)]>
ReturnsListTag
DescriptionReturns a list of all key/value pairs in this map, separated by the specified separator symbol. If none is given, uses the slash '/' symbol.
Note that there is no escaping of the separator, so maps that have the separator in their keys will not be possible to convert back to a map.
Inverted by Tag:ListTag.to_map
Example
# Narrates "a/1", then "b/2", then "c/3"
- foreach <map[a=1;b=2;c=3].to_list> as:slashed:
    - narrate "<[slashed]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L934

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.
Example
# Narrates "a is set to 1", then "b is set to 2", then "c is set to 3"
- foreach <map[a=1;b=2;c=3].to_pair_lists> as:pair:
    - narrate "<[pair].get[1]> is set to <[pair].get[2]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L915

Name<MapTag.to_yaml>
ReturnsElementTag
DescriptionReturns a YAML encoding of this map. Sometimes useful for debugging or for interop with other software.
Example
# Narrates multiple lines, as follows:
# a: '1'
# b: '2'
- narrate <map[a=1;b=2].to_yaml>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L970

Name<MapTag.values>
ReturnsListTag
DescriptionReturns a list of all values in this map.
Example
# Narrates a list of '1|2|3|'
- narrate <map[a=1;b=2;c=3].values>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L902

Name<MapTag.with[<key>].as[<value>]>
ReturnsMapTag
DescriptionReturns a copy of the map, with the specified key set to the specified value.
Matching keys will be overridden.
Example
# Narrates a map of '[a=1;b=2;c=3;d=4]'
- narrate <map[a=1;b=2;c=3].with[d].as[4]>
Example
# Demonstrates matching key overriding - narrates a map of '[a=1;b=2;c=4]'
- narrate <map[a=1;b=2;c=3].with[c].as[4]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L725

Name<MapTag.map_to_nbt>
ReturnsBinaryTag
DescriptionConverts the NBT-formatted MapTag to raw binary NBT.
Refer to Language:Raw NBT Encoding
Example
# Stores a player ".dat" file's NBT data
# NOTE: replace 'something' with your map data
- define playerdata something
- define data <[playerdata].map_to_nbt.gzip_compress>
- ~filewrite path:data/<player.uuid>.dat data:<[data]>
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitMapExtensions.java#L16



Category: MaterialTag


Name<MaterialTag.block_resistance>
ReturnsElementTag(Decimal)
MechanismMaterialTag.block_resistance
DescriptionReturns the explosion resistance for all blocks of this material type.
Generated Example
- narrate "the decimal value is <material[stone].block_resistance>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L477

Name<MaterialTag.block_sound_data>
ReturnsMapTag
DescriptionIf the material is a block, returns the sound data for that block.
The returned map has the following keys:
volume, pitch: a decimal number
break_sound, step_sound, place_sound, hit_sound, fall_sound: Bukkit name of the sound effect
Generated Example
- foreach <material[stone].block_sound_data> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L633

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.
Generated Example
- narrate "the decimal value is <material[stone].block_strength>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L582

Name<MaterialTag.fuel_burn_time>
ReturnsDurationTag
DescriptionReturns the duration that a burnable fuel block will burn in a furnace for.
Generated Example
- ratelimit <player> <material[stone].fuel_burn_time>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L413

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.
Generated Example
- narrate "the decimal value is <material[stone].hardness>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L492

Name<MaterialTag.has_gravity>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is affected by gravity.
Generated Example
- if <material[stone].has_gravity>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L329

Name<MaterialTag.is_block>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is a placeable block.
Generated Example
- if <material[stone].is_block>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L339

Name<MaterialTag.is_burnable>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is a block that can burn away.
Generated Example
- if <material[stone].is_burnable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L373

Name<MaterialTag.is_edible>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is edible.
Generated Example
- if <material[stone].is_edible>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L383

Name<MaterialTag.is_flammable>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is a block that can catch fire.
Generated Example
- if <material[stone].is_flammable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L393

Name<MaterialTag.is_fuel>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is a block that can be burned in a furnace as fuel.
Generated Example
- if <material[stone].is_fuel>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L403

Name<MaterialTag.is_interactable>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material can be interacted with.
Some blocks such as piston heads and stairs are considered interactable.
Note that this will return true if at least one state of a material has interaction handling.
Generated Example
- if <material[stone].is_interactable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L361

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.
Generated Example
- if <material[stone].is_item>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L349

Name<MaterialTag.is_occluding>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is a block that completely blocks vision.
Generated Example
- if <material[stone].is_occluding>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L427

Name<MaterialTag.is_record>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is a playable music disc.
Generated Example
- if <material[stone].is_record>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L437

Name<MaterialTag.is_solid>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is a block that is solid (can be built upon).
Generated Example
- if <material[stone].is_solid>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L447

Name<MaterialTag.is_transparent>
ReturnsElementTag(Boolean)
DescriptionReturns whether the material is a block that does not block any light.
Generated Example
- if <material[stone].is_transparent>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L457

Name<MaterialTag.item>
ReturnsItemTag
DescriptionReturns an item of the material.
Generated Example
- give <material[stone].item>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L541

Name<MaterialTag.max_durability>
ReturnsElementTag(Number)
DescriptionReturns the maximum durability of this material.
Generated Example
- narrate "the number value is <material[stone].max_durability>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L467

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.
Generated Example
- narrate "the number value is <material[stone].max_stack_size>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L506

Name<MaterialTag.name>
ReturnsElementTag
DescriptionReturns the name of the material.
Generated Example
- narrate <material[stone].name>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L531

Name<MaterialTag.piston_reaction>
ReturnsElementTag
MechanismMaterialTag.piston_reaction
DescriptionReturns the material's piston reaction. (Only for block materials).
Generated Example
- narrate <material[stone].piston_reaction>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L551

Name<MaterialTag.produced_instrument>
ReturnsElementTag
DescriptionReturns the name of the instrument that would be used by a note block placed above or below (depending on the material type) a block of this material.
See list at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Instrument.html.
For the current instrument of a note block material refer to Tag:MaterialTag.instrument.
Generated Example
- narrate <material[stone].produced_instrument>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L621

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.
Generated Example
- narrate <material[stone].translated_name>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L517

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

Name<MaterialTag.bottles>
ReturnsListTag
MechanismMaterialTag.bottles
DescriptionReturns a list of booleans that represent whether a slot in a brewing stand has a bottle.
Under current implementation this always returns exactly 3 values, like "true|false|true".
Generated Example
- foreach <material[stone].bottles> as:entry:
    - narrate "found <[entry]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialBrewingStand.java#L41

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.
Generated Example
- narrate "the number value is <material[stone].count>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialCount.java#L53

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.
Generated Example
- narrate "the number value is <material[stone].count_max>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialCount.java#L65

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.
Generated Example
- narrate "the number value is <material[stone].count_min>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialCount.java#L77

Name<MaterialTag.delay>
ReturnsElementTag(Number)
MechanismMaterialTag.delay
DescriptionReturns the current delay of a redstone repeater material.
Generated Example
- narrate "the number value is <material[stone].delay>"
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).
This includes materials that Spigot classifies as "directional", "orientable", or "rotatable", as well as rails, dripstone, and jigsaw blocks.
Output is a direction name like "NORTH", or an axis like "X", or a rail direction like "ASCENDING_NORTH".
Generated Example
- narrate <material[stone].direction>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialDirectional.java#L111

Name<MaterialTag.distance>
ReturnsElementTag(Number)
MechanismMaterialTag.distance
DescriptionReturns the horizontal distance between a scaffolding block and the nearest scaffolding block placed above a 'bottom' scaffold,
or between a leaves block and the nearest log (a distance of 7 will cause a leaf to decay if 'persistent' is also false, less than 7 will prevent decay).
Generated Example
- narrate "the number value is <material[stone].distance>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialDistance.java#L42

Name<MaterialTag.faces>
ReturnsListTag
MechanismMaterialTag.faces
DescriptionReturns a list of the current faces for a material that has multiple faces (like a mushroom block).
Output is a direction name like "NORTH".
Generated Example
- foreach <material[stone].faces> as:entry:
    - narrate "found <[entry]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialFaces.java#L58

Name<MaterialTag.half>
ReturnsElementTag
MechanismMaterialTag.half
DescriptionReturns the current half for a bisected material (like a door, double-plant, chest, or a bed).
Output for "Bisected" blocks (doors/double plants/...) is "BOTTOM" or "TOP".
Output for beds is "HEAD" or "FOOT".
Output for chests is "LEFT" or "RIGHT".
Generated Example
- narrate <material[stone].half>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialHalf.java#L54

Name<MaterialTag.heights>
ReturnsListTag
MechanismMaterialTag.heights
DescriptionDeprecated in favor of Tag:MaterialTag.sides
Generated Example
- foreach <material[stone].heights> as:entry:
    - narrate "found <[entry]>"
Groupproperties
DeprecatedUse 'sides'
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialSides.java#L53

Name<MaterialTag.hinge>
ReturnsElementTag
MechanismMaterialTag.hinge
DescriptionReturns a door's hinge side.
Output is LEFT or RIGHT.
Generated Example
- narrate <material[stone].hinge>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialHinge.java#L40

Name<MaterialTag.instrument>
ReturnsElementTag
MechanismMaterialTag.instrument
DescriptionReturns the name of the instrument played from this note block,
see list at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Instrument.html.
For the instrument that a material *would* produce if below a noteblock Tag:MaterialTag.produced_instrument.
Generated Example
- narrate <material[stone].instrument>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialInstrument.java#L41

Name<MaterialTag.is_locked>
ReturnsElementTag(Boolean)
MechanismMaterialTag.is_locked
DescriptionReturns whether this redstone repeater material is locked.
Generated Example
- if <material[stone].is_locked>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialLocked.java#L40

Name<MaterialTag.leaf_size>
ReturnsElementTag
MechanismMaterialTag.leaf_size
DescriptionReturns the size of the leaves for this bamboo block.
Output is SMALL, LARGE, or NONE.
Generated Example
- narrate <material[stone].leaf_size>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialLeafSize.java#L40

Name<MaterialTag.max_delay>
ReturnsElementTag(Number)
MechanismMaterialTag.delay
DescriptionReturns the maximum delay allowed for the redstone repeater material.
Generated Example
- narrate "the number value is <material[stone].max_delay>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialDelay.java#L52

Name<MaterialTag.max_power>
ReturnsElementTag(Number)
MechanismMaterialTag.power
DescriptionReturns the maximum redstone power an analogue-powerable block can have.
Generated Example
- narrate "the number value is <material[stone].max_power>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialPower.java#L52

Name<MaterialTag.maximum_age>
ReturnsElementTag(Number)
DescriptionReturns the maximum age for an ageable material. This includes plant growth.
Generated Example
- narrate "the number value is <material[stone].maximum_age>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialAge.java#L67

Name<MaterialTag.maximum_level>
ReturnsElementTag(Number)
DescriptionReturns the maximum level for a Levelled material (like water, lava, and cauldrons), cake, beehives, snow, or farmland.
Generated Example
- narrate "the number value is <material[stone].maximum_level>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialLevel.java#L73

Name<MaterialTag.min_delay>
ReturnsElementTag(Number)
MechanismMaterialTag.delay
DescriptionReturns the minimum delay allowed for the redstone repeater material.
Generated Example
- narrate "the number value is <material[stone].min_delay>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialDelay.java#L64

Name<MaterialTag.minimum_level>
ReturnsElementTag(Number)
DescriptionReturns the minimum level for a Levelled material (like water, lava, and cauldrons), cake, beehives, snow, or farmland.
This will return 0 for all valid materials aside from snow.
Generated Example
- narrate "the number value is <material[stone].minimum_level>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialLevel.java#L84

Name<MaterialTag.mode>
ReturnsElementTag
MechanismMaterialTag.mode
DescriptionReturns a block's mode.
For comparators, output is COMPARE or SUBTRACT.
For piston_heads, output is NORMAL or SHORT.
For bubble_columns, output is NORMAL or DRAG.
For structure_blocks, output is CORNER, DATA, LOAD, or SAVE.
For sculk_sensors, output is ACTIVE, COOLDOWN, or INACTIVE.
For daylight_detectors, output is INVERTED or NORMAL.
For command_blocks, output is CONDITIONAL or NORMAL.
For big_dripleafs, output is FULL, NONE, PARTIAL, or UNSTABLE.
For sculk_catalysts, output is BLOOM or NORMAL.
For sculk_shriekers, output is SHRIEKING or NORMAL.
For tripwires, output is ARMED or DISARMED.
Generated Example
- narrate <material[stone].mode>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialMode.java#L60

Name<MaterialTag.note>
ReturnsElementTag(Number)
MechanismMaterialTag.note
DescriptionReturns the note played from this note block, as an ID number from 0 to 24.
Generated Example
- narrate "the number value is <material[stone].note>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialNote.java#L67

Name<MaterialTag.note_octave>
ReturnsElementTag(Number)
MechanismMaterialTag.note
DescriptionReturns the octave of note played from this note block, as 0, 1, or 2.
Generated Example
- narrate "the number value is <material[stone].note_octave>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialNote.java#L41

Name<MaterialTag.note_tone>
ReturnsElementTag
MechanismMaterialTag.note
DescriptionReturns the tone of note played from this note block, as a letter from A to F, sometimes with a # to indicate sharp.
Like A or A#.
Generated Example
- narrate <material[stone].note_tone>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialNote.java#L53

Name<MaterialTag.persistent>
ReturnsElementTag(Boolean)
MechanismMaterialTag.persistent
DescriptionReturns whether this block will decay from being too far away from a tree.
Generated Example
- if <material[stone].persistent>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialPersistent.java#L40

Name<MaterialTag.power>
ReturnsElementTag(Number)
MechanismMaterialTag.power
DescriptionReturns the redstone power level of an analogue-powerable block.
Generated Example
- narrate "the number value is <material[stone].power>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialPower.java#L40

Name<MaterialTag.relative_vector>
ReturnsLocationTag
MechanismMaterialTag.half
DescriptionReturns a vector location of the other block for a bisected material.
Generated Example
- teleport <player> <material[stone].relative_vector>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialHalf.java#L73

Name<MaterialTag.shape>
ReturnsElementTag
MechanismMaterialTag.shape
DescriptionReturns the shape of a block.
For stairs, output is the corner shape as INNER_LEFT, INNER_RIGHT, OUTER_LEFT, OUTER_RIGHT, or STRAIGHT.
Generated Example
- narrate <material[stone].shape>
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialShape.java#L40

Name<MaterialTag.sides>
ReturnsListTag
MechanismMaterialTag.sides
DescriptionReturns the list of heights for a wall block, or connections for a redstone wire, in order North|East|South|West|Vertical.
For wall blocks: For n/e/s/w, can be "tall", "low", or "none". For vertical, can be "tall" or "none".
For redstone wires: For n/e/s/w, can be "none", "side", or "up". No vertical.
Generated Example
- foreach <material[stone].sides> as:entry:
    - narrate "found <[entry]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialSides.java#L62

Name<MaterialTag.snowy>
ReturnsElementTag(Boolean)
MechanismMaterialTag.snowy
DescriptionReturns whether this material is covered in snow or not.
Generated Example
- if <material[stone].snowy>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialSnowable.java#L40

Name<MaterialTag.switched>
ReturnsElementTag(Boolean)
MechanismMaterialTag.switched
DescriptionReturns whether a material is 'switched on', which has different semantic meaning depending on the material type.
More specifically, this returns whether:
- a Powerable material (like pressure plates) is activated
- an Openable material (like doors) is open
- a dispenser is powered and should dispense its contents
- a daylight sensor is inverted (detects darkness instead of light)
- a lightable block is lit
- a piston block is extended
- an end portal frame has an ender eye in it
- a hopper is NOT being powered by redstone
- a sculk_shrieker can summon a warden
Generated Example
- if <material[stone].switched>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Synonyms (Search Aid)materialtag.lit, materialtag.open, materialtag.active
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialSwitchable.java#L60

Name<MaterialTag.unstable>
ReturnsElementTag(Boolean)
MechanismMaterialTag.unstable
DescriptionReturns whether this TNT block is unstable (explodes when punched).
Generated Example
- if <material[stone].unstable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialUnstable.java#L40

Name<MaterialTag.valid_directions>
ReturnsListTag
MechanismMaterialTag.direction
DescriptionReturns a list of directions that are valid for a directional material.
See also Tag:MaterialTag.direction
Generated Example
- foreach <material[stone].valid_directions> as:entry:
    - narrate "found <[entry]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialDirectional.java#L64

Name<MaterialTag.valid_faces>
ReturnsListTag
MechanismMaterialTag.faces
DescriptionReturns a list of faces that are valid for a material that has multiple faces.
See also Tag:MaterialTag.faces
Generated Example
- foreach <material[stone].valid_faces> as:entry:
    - narrate "found <[entry]>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialFaces.java#L41

Name<MaterialTag.waterlogged>
ReturnsElementTag(Boolean)
MechanismMaterialTag.waterlogged
DescriptionReturns whether this block is waterlogged or not.
Generated Example
- if <material[stone].waterlogged>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialWaterlogged.java#L40

Name<MaterialTag.age>
ReturnsElementTag(Number)
MechanismMaterialTag.age
Description(Property) Controls an ageable material's current age. This includes plant growth.
See also Tag:MaterialTag.maximum_age.
Generated Example
- narrate "the number value is <material[stone].age>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialAge.java#L15

Name<MaterialTag.attached>
ReturnsElementTag(Boolean)
MechanismMaterialTag.attached
Description(Property) Controls whether a material is attached.
For a lantern, this sets whether it is hanging from the ceiling.
For a gate, this sets whether it is lowered to attach to a wall block.
For a mangrove_propagule, this sets whether it is hanging from the block above it.
For a tripwire, this sets whether a tripwire hook or string forms a complete tripwire circuit and is ready to trigger.
Updating the property on a tripwire hook will change the texture to indicate a connected string, but will not have any effect when used on the tripwire string itself.
It may however still be used to check whether the string forms a circuit.
For hanging signs, this affects signs hanging below a block and changes whether the chains are vertical (false) or diagonal (true).
Generated Example
- if <material[stone].attached>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialAttached.java#L17

Name<MaterialTag.attachment_face>
ReturnsElementTag
MechanismMaterialTag.attachment_face
Description(Property) Controls the current attach direction for attachable materials such as switches, grindstones, and bells.
For bell values, see 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/data/type/Bell.Attachment.html
For all other supported type values, see 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/data/FaceAttachable.AttachedFace.html
Generated Example
- narrate <material[stone].attachment_face>
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialAttachmentFace.java#L13

Name<MaterialTag.level>
ReturnsElementTag(Number)
MechanismMaterialTag.level
Description(Property) Controls the current level for a Levelled material, cake, beehives, snow, farmland, or brushable blocks.
"Levelled" materials include: water, lava, cauldrons, composters, light blocks, brushable blocks, and any other future Levelled implementing types.
For light blocks, this is the brightness of the light.
For water/lava this is the height of the liquid block.
For cauldrons, this is the amount of liquid contained.
For cake, this is the number of bites left.
For beehives/bee nests, this is the amount of honey contained.
For snow, this is the number of partial layers, or the height, of a snow block.
For farmland, this is the moisture level.
For composters, this is the amount of compost.
For brushable blocks (also referred to as "suspicious blocks"), this is the level of dusting. 1.20+ only.
See also Tag:MaterialTag.maximum_level and Tag:MaterialTag.minimum_level.
Generated Example
- narrate "the number value is <material[stone].level>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialLevel.java#L19

Name<MaterialTag.type>
ReturnsElementTag
MechanismMaterialTag.type
Description(Property) Controls the current type of the block.
For slabs, input is TOP, BOTTOM, or DOUBLE.
For piston_heads, input is NORMAL or STICKY.
For campfires, input is NORMAL or SIGNAL.
For pointed dripstone, input is BASE, FRUSTUM, MIDDLE, TIP, or TIP_MERGE.
For cave vines, input is NORMAL or BERRIES.
For scaffolding, input is NORMAL or BOTTOM.
Generated Example
- narrate <material[stone].type>
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialBlockType.java#L13



Category: NPCTag


Name<NPCTag.anchor[<name>]>
ReturnsLocationTag
DescriptionReturns the location associated with the specified anchor, or null if it doesn't exist.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L599

Name<NPCTag.attack_range>
ReturnsElementTag(Decimal)
MechanismNPCTag.attack_range
DescriptionReturns the NPC's current navigator attack range limit.
Generated Example
- narrate "the decimal value is <npc.attack_range>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1120

Name<NPCTag.attack_strategy>
ReturnsElementTag
DescriptionReturns the NPC's current navigator attack strategy.
Not related to Sentinel combat.
Generated Example
- narrate <npc.attack_strategy>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1131

Name<NPCTag.auto_update_skin>
ReturnsElementTag(Boolean)
MechanismNPCTag.auto_update_skin
DescriptionReturns whether the NPC is set to automatically update skins from name.
Generated Example
- if <npc.auto_update_skin>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L903

Name<NPCTag.avoid_water>
ReturnsElementTag(Boolean)
DescriptionReturns whether the NPC will avoid water.
Generated Example
- if <npc.avoid_water>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1162

Name<NPCTag.base_speed>
ReturnsElementTag(Decimal)
DescriptionReturns the NPC's base navigation speed.
Generated Example
- narrate "the decimal value is <npc.base_speed>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1152

Name<NPCTag.citizens_data[<key>]>
ReturnsElementTag
DescriptionReturns the value of a Citizens NPC metadata key.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1250

Name<NPCTag.citizens_data_keys>
ReturnsListTag
DescriptionReturns a list of Citizens NPC metadata keys.
Generated Example
- foreach <npc.citizens_data_keys> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1267

Name<NPCTag.constant[<constant_name>]>
ReturnsElementTag
DescriptionReturns the specified constant from the NPC.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L632

Name<NPCTag.controllable>
ReturnsElementTag(Boolean)
MechanismNPCTag.controllable
DescriptionReturns whether the NPC has controllable enabled.
Generated Example
- if <npc.controllable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L966

Name<NPCTag.distance_margin>
ReturnsElementTag(Decimal)
MechanismNPCTag.distance_margin
DescriptionReturns the NPC's current pathfinding distance margin. That is, how close it needs to get to its destination (in block-lengths).
Generated Example
- narrate "the decimal value is <npc.distance_margin>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1054

Name<NPCTag.engaged[(<player>)]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the NPC is currently engaged.
See Command:engage
Generated Example
- if <npc.engaged>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L789

Name<NPCTag.has_anchors>
ReturnsElementTag(Boolean)
DescriptionReturns whether the NPC has anchors assigned.
Generated Example
- if <npc.has_anchors>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L575

Name<NPCTag.has_nickname>
ReturnsElementTag(Boolean)
DescriptionReturns true if the NPC has a nickname.
Generated Example
- if <npc.has_nickname>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L463

Name<NPCTag.has_pose[<name>]>
ReturnsElementTag(Boolean)
DescriptionReturns true if the NPC has the specified pose, otherwise returns false.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L652

Name<NPCTag.has_skin>
ReturnsElementTag(Boolean)
MechanismNPCTag.skin
DescriptionReturns whether the NPC has a custom skin.
Generated Example
- if <npc.has_skin>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L840

Name<NPCTag.has_trait[<trait>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the NPC has a specified trait.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L532

Name<NPCTag.has_trigger[<trigger>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the NPC has a specified trigger.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L558

Name<NPCTag.hologram_direction>
ReturnsElementTag
MechanismNPCTag.hologram_direction
DescriptionReturns the direction of an NPC's hologram as "BOTTOM_UP" or "TOP_DOWN".
Generated Example
- narrate <npc.hologram_direction>
DeprecatedThis was removed from Citizens.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L741

Name<NPCTag.hologram_line_height>
ReturnsElementTag(Decimal)
MechanismNPCTag.hologram_line_height
DescriptionReturns the line height for an NPC's hologram. Can be -1, indicating a default value should be used.
Generated Example
- narrate "the decimal value is <npc.hologram_line_height>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L759

Name<NPCTag.hologram_lines>
ReturnsListTag
MechanismNPCTag.hologram_lines
DescriptionReturns the list of hologram lines attached to an NPC.
Generated Example
- foreach <npc.hologram_lines> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L726

Name<NPCTag.hologram_npcs>
ReturnsListTag(NPCTag)
DescriptionReturns the list of hologram NPCs attached to an NPC (if any).
Note that these can regenerate at any time.
Generated Example
- foreach <npc.hologram_npcs> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L703

Name<NPCTag.id>
ReturnsElementTag(Number)
DescriptionReturns the NPC's ID number.
Generated Example
- narrate "the number value is <npc.id>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L811

Name<NPCTag.inventory>
ReturnsInventoryTag
DescriptionReturns the InventoryTag of the NPC.
Generated Example
- inventory set o:<npc.inventory> d:stick slot:5
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L917

Name<NPCTag.invulnerable>
ReturnsElementTag(Boolean)
DescriptionReturns whether the NPC is currently invulnerable.
See Command:vulnerable
Generated Example
- if <npc.invulnerable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L800

Name<NPCTag.is_fighting>
ReturnsElementTag(Boolean)
DescriptionReturns whether the NPC is currently targeting an entity for the Citizens internal punching pathfinder.
Not compatible with Sentinel.
Generated Example
- if <npc.is_fighting>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1203

Name<NPCTag.is_navigating>
ReturnsElementTag(Boolean)
DescriptionReturns whether the NPC is currently navigating.
Generated Example
- if <npc.is_navigating>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1088

Name<NPCTag.is_protected>
ReturnsElementTag(Boolean)
DescriptionReturns whether the NPC is protected.
Generated Example
- if <npc.is_protected>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L937

Name<NPCTag.is_sitting>
ReturnsElementTag(Boolean)
DescriptionReturns true if the NPC is sitting. Relates to Command:sit.
Generated Example
- if <npc.is_sitting>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L474

Name<NPCTag.is_sleeping>
ReturnsElementTag(Boolean)
DescriptionReturns true if the NPC is sleeping. Relates to Command:sleep.
Generated Example
- if <npc.is_sleeping>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L485

Name<NPCTag.is_sneaking>
ReturnsElementTag(Boolean)
DescriptionReturns whether the NPC is currently sneaking. Only works for player-type NPCs.
Generated Example
- if <npc.is_sneaking>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L774

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

Name<NPCTag.list_anchors>
ReturnsListTag
DescriptionReturns a list of anchor names currently assigned to the NPC.
Generated Example
- foreach <npc.list_anchors> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L585

Name<NPCTag.lookclose>
ReturnsElementTag(Boolean)
MechanismNPCTag.lookclose
DescriptionReturns whether the NPC has lookclose enabled.
Generated Example
- if <npc.lookclose>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L947

Name<NPCTag.name_hologram_npc>
ReturnsNPCTag
DescriptionReturns the NPCTag of a hologram attached to this NPC as its nameplate (if any).
Note that this can regenerate at any time.
Generated Example
- kill <npc.name_hologram_npc>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L684

Name<NPCTag.navigator_look_at>
ReturnsLocationTag
MechanismNPCTag.navigator_look_at
DescriptionReturns the location the NPC will currently look at while moving, if any.
Generated Example
- teleport <player> <npc.navigator_look_at>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1185

Name<NPCTag.nickname>
ReturnsElementTag
DescriptionReturns the NPC's display name, as set by the Nickname trait (or the default NPC name).
Generated Example
- narrate <npc.nickname>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L496

Name<NPCTag.owner>
ReturnsPlayerTag
MechanismNPCTag.owner
DescriptionReturns the owner of the NPC as a PlayerTag, if any.
Generated Example
- kill <npc.owner>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L821

Name<NPCTag.path_distance_margin>
ReturnsElementTag(Decimal)
MechanismNPCTag.path_distance_margin
DescriptionReturns the NPC's current pathfinding distance margin. That is, how close it needs to get to individual points along its path.
Generated Example
- narrate "the decimal value is <npc.path_distance_margin>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1065

Name<NPCTag.pose[<name>]>
ReturnsLocationTag
DescriptionReturns the pose as a LocationTag with x, y, and z set to 0, and the world set to the first
possible available world Bukkit knows about.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L667

Name<NPCTag.previous_location>
ReturnsLocationTag
DescriptionReturns the NPC's previous navigated location.
Generated Example
- teleport <player> <npc.previous_location>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L448

Name<NPCTag.pushable>
ReturnsElementTag(Boolean)
DescriptionReturns whether the NPC is pushable.
Generated Example
- if <npc.pushable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L548

Name<NPCTag.range>
ReturnsElementTag(Decimal)
MechanismNPCTag.range
DescriptionReturns the NPC's current maximum pathfinding range.
Generated Example
- narrate "the decimal value is <npc.range>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1109

Name<NPCTag.registry_name>
ReturnsElementTag
DescriptionReturns the name of the registry this NPC came from.
Generated Example
- narrate <npc.registry_name>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1240

Name<NPCTag.script>
ReturnsScriptTag
DescriptionDeprecated variant of Tag:NPCTag.scripts.
Generated Example
- narrate <npc.script>
DeprecatedUse 'NPCTag.scripts' (plural) instead.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1009

Name<NPCTag.scripts>
ReturnsListTag(ScriptTag)
DescriptionReturns a list of all assignment scripts on the NPC. Returns null if none.
Generated Example
- foreach <npc.scripts> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1032

Name<NPCTag.skin>
ReturnsElementTag
MechanismNPCTag.skin
DescriptionReturns the NPC's custom skin, if any.
Generated Example
- narrate <npc.skin>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L889

Name<NPCTag.skin_blob>
ReturnsElementTag
MechanismNPCTag.skin_blob
DescriptionReturns the NPC's custom skin blob, if any.
In the format: "texture;signature" (two values separated by a semicolon).
See also Language:Player Entity Skins (Skin Blobs).
Generated Example
- narrate <npc.skin_blob>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L851

Name<NPCTag.skull_skin>
ReturnsElementTag
DescriptionReturns the NPC's current skin blob, formatted for input to a Player Skull item.
In the format: "UUID|Texture" (two values separated by pipes).
See also Language:Player Entity Skins (Skin Blobs).
Generated Example
- narrate <npc.skull_skin>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L873

Name<NPCTag.speed>
ReturnsElementTag(Decimal)
MechanismNPCTag.speed
DescriptionReturns the current speed of the NPC.
Generated Example
- narrate "the decimal value is <npc.speed>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1098

Name<NPCTag.speed_modifier>
ReturnsElementTag(Decimal)
DescriptionReturns the NPC's current movement speed modifier (a multiplier applied over their base speed).
Generated Example
- narrate "the decimal value is <npc.speed_modifier>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1142

Name<NPCTag.target_entity>
ReturnsEntityTag
DescriptionReturns the entity being targeted by the NPC's current navigation (if any).
Generated Example
- remove <npc.target_entity>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1227

Name<NPCTag.target_location>
ReturnsLocationTag
DescriptionReturns the location the NPC is currently navigating towards (if any).
Generated Example
- teleport <player> <npc.target_location>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1172

Name<NPCTag.target_type>
ReturnsElementTag
DescriptionReturns the entity type of the NPC's current navigation target (if any).
Generated Example
- narrate <npc.target_type>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1214

Name<NPCTag.targetable>
ReturnsElementTag(Boolean)
MechanismNPCTag.targetable
DescriptionReturns whether the NPC is targetable.
Generated Example
- if <npc.targetable>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L980

Name<NPCTag.teleport_on_stuck>
ReturnsElementTag(Boolean)
MechanismNPCTag.teleport_on_stuck
DescriptionReturns whether the NPC teleports when it is stuck.
Generated Example
- if <npc.teleport_on_stuck>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L992

Name<NPCTag.traits>
ReturnsListTag
DescriptionReturns a list of all of the NPC's traits.
Generated Example
- foreach <npc.traits> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L518

Name<NPCTag.use_new_finder>
ReturnsElementTag(Boolean)
MechanismNPCTag.use_new_finder
DescriptionIf output is 'true', the NPC uses the 'new' Citizens A-Star pathfinder.
if 'false', the NPC uses the 'old' minecraft vanilla mob pathfinder.
Generated Example
- if <npc.use_new_finder>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1076

Name<NPCTag.wander_delay>
ReturnsDurationTag
MechanismNPCTag.wander_delay
DescriptionReturns the delay for the NPC's wander Waypoint Provider, if that provider is in use.
Generated Example
- flag server myflag expire:<npc.wander_delay>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1298

Name<NPCTag.wander_xrange>
ReturnsElementTag(Number)
MechanismNPCTag.wander_xrange
DescriptionReturns the xrange for the NPC's wander Waypoint Provider, if that provider is in use.
Generated Example
- narrate "the number value is <npc.wander_xrange>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1313

Name<NPCTag.wander_yrange>
ReturnsElementTag(Number)
MechanismNPCTag.wander_yrange
DescriptionReturns the yrange for the NPC's wander Waypoint Provider, if that provider is in use.
Generated Example
- narrate "the number value is <npc.wander_yrange>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1328

Name<NPCTag.waypoint_provider>
ReturnsElementTag
MechanismNPCTag.waypoint_provider
DescriptionReturns the NPC's current Waypoint Provider type (default types: linear, wander, guided).
Generated Example
- narrate <npc.waypoint_provider>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1283

Name<NPCTag.faction>
ReturnsFactionTag
DescriptionReturns the NPC's faction.
Generated Example
- narrate <npc.faction>
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/factions/FactionsNPCProperties.java#L116

Name<NPCTag.factions.power>
ReturnsElementTag(Decimal)
DescriptionReturns the NPC's power level.
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/factions/FactionsNPCProperties.java#L73

Name<NPCTag.factions.role>
ReturnsElementTag
DescriptionReturns the NPC's role in their faction.
Note: In modern Factions these are called ranks instead of roles.
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/factions/FactionsNPCProperties.java#L86

Name<NPCTag.factions.title>
ReturnsElementTag
DescriptionReturns the NPC's title.
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/factions/FactionsNPCProperties.java#L100

Name<NPCTag.sentinel.accuracy>
ReturnsElementTag(Decimal)
DescriptionReturns the accuracy value of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L519

Name<NPCTag.sentinel.armor>
ReturnsElementTag(Decimal)
DescriptionReturns the current armor value (with calculations if needed) of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L190

Name<NPCTag.sentinel.attack_rate>
ReturnsDurationTag
DescriptionReturns the attack rate of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L267

Name<NPCTag.sentinel.attack_rate_ranged>
ReturnsDurationTag
DescriptionReturns the attack rate (at range) of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L278

Name<NPCTag.sentinel.autoswitch>
ReturnsElementTag(Boolean)
DescriptionReturns whether the Sentinel NPC will automatically switch weapons.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L494

Name<NPCTag.sentinel.avoid_range>
ReturnsElementTag(Decimal)
DescriptionReturns the avoid range of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L135

Name<NPCTag.sentinel.avoid_return_point>
ReturnsLocationTag
DescriptionReturns the avoid return point of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L373

Name<NPCTag.sentinel.avoids>
ReturnsListTag
DescriptionReturns a list of all targets currently avoided by this Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L124

Name<NPCTag.sentinel.chase_range>
ReturnsElementTag(Decimal)
DescriptionReturns the chase range of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L348

Name<NPCTag.sentinel.chasing>
ReturnsEntityTag
DescriptionReturns the entity currently being chased by this Sentinel NPC (if any).
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L88

Name<NPCTag.sentinel.close_chase>
ReturnsElementTag(Boolean)
DescriptionReturns whether the Sentinel NPC will chase with close weapons.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L223

Name<NPCTag.sentinel.damage>
ReturnsElementTag(Decimal)
DescriptionReturns the current damage value (with calculations if needed) of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L168

Name<NPCTag.sentinel.drop_chances>
ReturnsListTag
DescriptionReturns a list of drop chances for items that this Sentinel NPC will drop on death.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L402

Name<NPCTag.sentinel.drops>
ReturnsListTag(ItemTag)
DescriptionReturns a list of items that this Sentinel NPC will drop on death.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L387

Name<NPCTag.sentinel.enemy_drops>
ReturnsElementTag(Boolean)
DescriptionReturns whether the Sentinel NPC has enemy-drops enabled.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L417

Name<NPCTag.sentinel.enemy_target_time>
ReturnsDurationTag
DescriptionReturns how long a Sentinel NPC will wait before abandoning an unseen target.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L428

Name<NPCTag.sentinel.fightback>
ReturnsElementTag(Boolean)
DescriptionReturns whether the Sentinel NPC will fight back.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L245

Name<NPCTag.sentinel.greet_range>
ReturnsElementTag(Decimal)
DescriptionReturns the greeting range of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L472

Name<NPCTag.sentinel.greet_rate>
ReturnsDurationTag
DescriptionReturns the greeting rate of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L483

Name<NPCTag.sentinel.greeting>
ReturnsElementTag
DescriptionReturns the greeting message of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L461

Name<NPCTag.sentinel.guard_distance_minimum>
ReturnsElementTag(Decimal)
DescriptionReturns the minimum-guard-distance value of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L552

Name<NPCTag.sentinel.guard_selection_range>
ReturnsElementTag(Decimal)
DescriptionReturns the guard-selection-range value of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L563

Name<NPCTag.sentinel.guarding>
ReturnsEntityTag
DescriptionReturns the entity currently being guarded by this Sentinel NPC (if any).
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L300

Name<NPCTag.sentinel.heal_rate>
ReturnsDurationTag
DescriptionReturns the heal rate of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L289

Name<NPCTag.sentinel.health>
ReturnsElementTag(Decimal)
DescriptionReturns the max health of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L201

Name<NPCTag.sentinel.ignores>
ReturnsListTag
DescriptionReturns a list of all targets currently ignored by this Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L113

Name<NPCTag.sentinel.invincible>
ReturnsElementTag(Boolean)
DescriptionReturns whether the Sentinel NPC is invincible.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L234

Name<NPCTag.sentinel.needs_ammo>
ReturnsElementTag(Boolean)
DescriptionReturns whether the Sentinel NPC needs ammo.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L315

Name<NPCTag.sentinel.range>
ReturnsElementTag(Decimal)
DescriptionReturns the range of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L146

Name<NPCTag.sentinel.ranged_chase>
ReturnsElementTag(Boolean)
DescriptionReturns whether the Sentinel NPC will chase with ranged weapons.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L212

Name<NPCTag.sentinel.raw_armor>
ReturnsElementTag(Decimal)
DescriptionReturns the raw armor value (no calculating) of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L179

Name<NPCTag.sentinel.raw_damage>
ReturnsElementTag(Decimal)
DescriptionReturns the raw damage value (no calculating) of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L157

Name<NPCTag.sentinel.reach>
ReturnsElementTag(Decimal)
DescriptionReturns the hand reach value of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L541

Name<NPCTag.sentinel.realistic>
ReturnsElementTag(Boolean)
DescriptionReturns whether the Sentinel NPC is set to realistic targeting mode.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L530

Name<NPCTag.sentinel.respawn_time>
ReturnsDurationTag
DescriptionReturns how long a Sentinel NPC will wait after death before respawning.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L337

Name<NPCTag.sentinel.runaway>
ReturnsElementTag(Boolean)
DescriptionReturns whether the Sentinel NPC will run away.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L256

Name<NPCTag.sentinel.safe_shot>
ReturnsElementTag(Boolean)
DescriptionReturns whether the Sentinel NPC has safe-shot enabled.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L326

Name<NPCTag.sentinel.spawn_point>
ReturnsLocationTag
DescriptionReturns the respawn point of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L359

Name<NPCTag.sentinel.speed>
ReturnsElementTag(Decimal)
DescriptionReturns the movement speed of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L439

Name<NPCTag.sentinel.squad>
ReturnsElementTag
DescriptionReturns the name of this Sentinel NPC's squad (if any).
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L505

Name<NPCTag.sentinel.targets>
ReturnsListTag
DescriptionReturns a list of all targets currently targeted by this Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L102

Name<NPCTag.sentinel.warning>
ReturnsElementTag
DescriptionReturns the warning message of a Sentinel NPC.
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L450

Name<NPCTag.sentinel.weapon_damage>
ReturnsListTag
DescriptionReturns a list-mapping of custom weapon damage values of a Sentinel NPC.
For example, "stick/5|stone/3"
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L574

Name<NPCTag.sentinel.weapon_redirects>
ReturnsListTag
DescriptionReturns a list-mapping of custom weapon redirect values of a Sentinel NPC.
For example, "stick/bow|stone/diamond_sword"
RequiresDepenizen, Sentinel
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L590

Name<NPCTag.worldguard_wander_region>
ReturnsWorldGuardRegionTag
MechanismNPCTag.worldguard_wander_region
DescriptionIf the NPC's waypoint provider is set to wander (Tag:NPCTag.waypoint_provider),
returns the current WorldGuard region that wandering is restricted to, if any.
Generated Example
- narrate <npc.worldguard_wander_region>
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardNPCExtensions.java#L13



Category: ObjectTag


Name<ObjectTag.advanced_matches[<matcher>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the object matches some matcher text, using the system described at Language:Advanced Object Matching.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L261

Name<ObjectTag.as[<type>]>
ReturnsObjectTag
DescriptionReturns the object, automatically converted to the named object type.
Type names can be of the long form, like "ListTag", "MapTag", "ElementTag", ... or the short form, like "List", "Map", "Element", ...
Type name input is not case-sensitive, so "List" or "list" are the same.
Example
my_example:
    type: task
    # Some input can be any raw object type, but will be forced to a list using 'as[list]' below
    definitions: some_input
    script:
    - narrate "Input list has size <[some_input].as[list].size>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L295

Name<ObjectTag.exists>
ReturnsElementTag(Boolean)
DescriptionReturns true if the object exists (is non-null). Returns false if the object doesn't exist, is null, or the tag errored.
This functions as a fallback - meaning, if the tag up to this point errors, that error will be hidden.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L116

Name<ObjectTag.if_null[<object>]>
ReturnsObjectTag
DescriptionIf the object is null (or the tag errors), this will return the input object.
If the object isn't null, the input won't be parsed, and the original object will be returned.
For example, "<player.if_null[<npc>]>" will return the player if there is a player, and otherwise will return the NPC.
This functions as a fallback - meaning, if the tag up to this point errors, that error will be hidden.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L100

Name<ObjectTag.is_truthy>
ReturnsElementTag(Boolean)
DescriptionReturns true if the object is 'truthy'. An object is 'truthy' if it exists and is valid, and does not represent a concept like emptiness.
An empty list or an air item will return 'false'. Plaintext "null" or "false", an empty element, or a numeric zero will return 'false' as well.
Some object types may have their own logical implementations, for examples an EntityTag value is 'truthy' only if the entity it represents is spawned.
Errored/broken/invalid tags are also considered 'false' by this logic.
This functions as a fallback - meaning, if the tag up to this point errors, that error will be hidden.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L127

Name<ObjectTag.null_if[<tag>]>
ReturnsObjectTag
DescriptionParses the given tag on the object, expecting a boolean return.
If the return is 'true', the 'null_if' tag returns null.
If the return is 'false', the 'null_if' tag returns the original object.
Consider also Tag:ObjectTag.null_if_tag.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L141

Name<ObjectTag.null_if_tag[<dynamic-boolean>]>
ReturnsObjectTag
DescriptionParses the given tag on the object, expecting a boolean return.
This requires a fully formed tag as input, making use of the 'null_if_value' definition.
If the return is 'true', the 'null_if' tag returns null.
If the return is 'false', the 'null_if' tag returns the original object.
Consider also Tag:ObjectTag.null_if_tag.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L176

Name<ObjectTag.object_type>
ReturnsElementTag
DescriptionReturns the short-form name of the tag type that is processing this tag, like 'List'.
This tag is made available to help you debug script issues, for example if you think an object isn't processing its own type correctly.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L35

Name<ObjectTag.prefix>
ReturnsElementTag
DescriptionReturns the prefix of the tag type that is processing this tag, like 'List'.
Prefixes are generally only used for debugging (for example, command execution reports show them).
This tag should not be relied on or expected to return any specific value. It may change arbitrarily or even be removed at any time.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L23

Name<ObjectTag.proc[<procedure_script_name>]>
ReturnsObjectTag
DescriptionReturns the 'determine' result of a procedure script, passing this object in as the context value.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L46

Name<ObjectTag.proc[<procedure_script_name>].context[<object>|...]>
ReturnsObjectTag
DescriptionReturns the 'determine' result of a procedure script, passing this object in as the first context value, with a list of additional context values.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L77

Name<ObjectTag.reflected_internal_object>
ReturnsJavaReflectedObjectTag
DescriptionReturns the reflected internal Java object for a given ObjectTag.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L274

Name<ObjectTag.repeat_as_list[<#>]>
ReturnsListTag
DescriptionReturns a list contained the input number of entries, each of which is an exact copy of the object.
For example, element[hello].repeat_as_list[3] returns a ListTag of "hello|hello|hello|"
An input value or zero or a negative number will result in an empty list.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L240

Name<ObjectTag.is[<operator>].than[<object>]>
ReturnsElementTag(Boolean)
DescriptionTakes an operator, and compares the first object to the given second object.
Returns the outcome of the comparable, either true or false. For information on operators, see Language:operator.
Equivalent to Tag:ObjectTag.is[<operator>].to[<element>]
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L210

Name<ObjectTag.is[<operator>].to[<object>]>
ReturnsElementTag(Boolean)
DescriptionTakes an operator, and compares the first object to the given second object.
Returns the outcome of the comparable, either true or false. For information on operators, see Language:operator.
Equivalent to Tag:ObjectTag.is[<operator>].than[<element>]
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L200



Category: PlayerTag


Name<PlayerTag.advancements>
ReturnsListTag
DescriptionReturns a list of the names of all advancements the player has completed.
Generated Example
- foreach <player.advancements> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2127

Name<PlayerTag.ban_created_time>
ReturnsTimeTag
DescriptionReturns when the player's ban was created, if they are banned.
Generated Example
- flag server myflag expire:<player.ban_created_time>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1164

Name<PlayerTag.ban_expiration_time>
ReturnsTimeTag
DescriptionReturns the expiration of the player's ban, if they are banned.
Potentially can be null.
Generated Example
- flag server myflag expire:<player.ban_expiration_time>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1118

Name<PlayerTag.ban_reason>
ReturnsElementTag
DescriptionReturns the reason for the player's ban, if they are banned.
Generated Example
- narrate <player.ban_reason>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1147

Name<PlayerTag.ban_source>
ReturnsElementTag
DescriptionReturns the source of the player's ban, if they are banned.
Generated Example
- narrate <player.ban_source>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1192

Name<PlayerTag.bed_spawn>
ReturnsLocationTag
MechanismPlayerTag.bed_spawn_location
DescriptionReturns the location of the player's bed spawn location, or null if it doesn't exist.
Works with offline players.
Generated Example
- teleport <player> <player.bed_spawn>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L817

Name<PlayerTag.bossbar_ids>
ReturnsListTag
DescriptionReturns a list of all bossbars from Command:bossbar that this player can see.
Does not list bossbars created by any other source.
Generated Example
- foreach <player.bossbar_ids> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2509

Name<PlayerTag.calculate_xp>
ReturnsElementTag(Number)
DescriptionReturns the calculated total amount of XP the player has, based on the amount of experience needed per level, for each level the player has.
Works with offline players.
Generated Example
- narrate "the number value is <player.calculate_xp>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2182

Name<PlayerTag.calculated_bed_spawn>
ReturnsLocationTag
DescriptionReturns the player's calculated bed spawn location.
This is a location around their set spawn where they could actually spawn, such as a safe block next to a bed.
See Tag:PlayerTag.bed_spawn for the actual spawn location they have set.
Generated Example
- teleport <player> <player.calculated_bed_spawn>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L830

Name<PlayerTag.can_fly>
ReturnsElementTag(Boolean)
MechanismPlayerTag.can_fly
DescriptionReturns whether the player is allowed to fly.
Works with offline players.
Generated Example
- if <player.can_fly>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1902

Name<PlayerTag.chat_history[(<#>)]>
ReturnsElementTag
DescriptionReturns the last thing the player said.
If a number is specified, returns an earlier thing the player said.
Works with offline players.
Generated Example
- narrate <player.chat_history>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L690

Name<PlayerTag.chat_history_list>
ReturnsListTag
DescriptionReturns a list of the last 10 things the player has said, less if the player hasn't said all that much.
Works with offline players, if the player previously joined and typed in chat since the last server restart.
Generated Example
- foreach <player.chat_history_list> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L678

Name<PlayerTag.chunk_loaded[<chunk>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player has the chunk loaded on their client.
Generated Example
- if <player.chunk_loaded[<player.location.chunk>]>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1881

Name<PlayerTag.client_brand>
ReturnsElementTag
DescriptionReturns the brand of the client, as sent via the "minecraft:brand" packet.
On normal clients, will say "vanilla". On broken clients, will say "unknown". Modded clients will identify themselves (though not guaranteed!).
Generated Example
- narrate <player.client_brand>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1482

Name<PlayerTag.compass_target>
ReturnsLocationTag
DescriptionReturns the location of the player's compass target.
Generated Example
- teleport <player> <player.compass_target>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1867

Name<PlayerTag.discovered_recipes>
ReturnsListTag
DescriptionReturns a list of the recipes the player has discovered, in the Namespace:Key format, for example "minecraft:gold_nugget".
Generated Example
- foreach <player.discovered_recipes> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1544

Name<PlayerTag.display_name>
ReturnsElementTag
MechanismPlayerTag.display_name
DescriptionReturns the display name of the player, which may contain prefixes and suffixes, colors, etc.
Generated Example
- narrate <player.display_name>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1456

Name<PlayerTag.enderchest>
ReturnsInventoryTag
DescriptionGets the player's enderchest inventory.
Works with offline players.
Generated Example
- note <player.enderchest> as:my_new_inventory
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1518

Name<PlayerTag.entity>
ReturnsEntityTag
DescriptionReturns the EntityTag object of the player.
(Note: This should never actually be needed. PlayerTags are considered valid EntityTags.)
Generated Example
- remove <player.entity>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1796

Name<PlayerTag.exhaustion>
ReturnsElementTag(Decimal)
MechanismPlayerTag.exhaustion
DescriptionReturns the player's exhaustion value. Exhaustion is increased in vanilla when a player sprints or jumps, and is used to reduce food saturation over time.
This can reach a maximum value of 40, and decreases by 4 every tick.
Works with offline players.
Generated Example
- narrate "the decimal value is <player.exhaustion>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L904

Name<PlayerTag.fake_block[<location>]>
ReturnsMaterialTag
DescriptionReturns the fake material that the player will see at the input location, as set by Command:showfake or connected commands.
Works best alongside Tag:PlayerTag.fake_block_locations.
Returns null if the player doesn't have a fake block at the location.
Generated Example
- foreach <player.location.find_blocks[<player.fake_block[<npc.location>]>].within[5]> as:loc:
    - modifyblock <[loc]> air
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2319

Name<PlayerTag.fake_block_locations>
ReturnsListTag(LocationTag)
DescriptionReturns a list of locations that the player will see a fake block at, as set by Command:showfake or connected commands.
Generated Example
- foreach <player.fake_block_locations> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2302

Name<PlayerTag.fake_entities>
ReturnsListTag(EntityTag)
DescriptionReturns a list of fake entities the player can see, as set by Command:fakespawn.
Note that these entities are not being tracked by the server, so many operations may not be possible on them.
Generated Example
- foreach <player.fake_entities> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2342

Name<PlayerTag.first_played_time>
ReturnsTimeTag
DescriptionReturns the time of when the player first logged on to this server.
Works with offline players.
Generated Example
- flag server myflag expire:<player.first_played_time>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L878

Name<PlayerTag.fish_hook>
ReturnsEntityTag
DescriptionReturns the fishing hook a player has cast (if any).
Generated Example
- remove <player.fish_hook>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2439

Name<PlayerTag.fly_speed>
ReturnsElementTag(Decimal)
MechanismPlayerTag.fly_speed
DescriptionReturns the speed the player can fly at.
Default value is '0.2'.
Works with offline players.
Generated Example
- narrate "the decimal value is <player.fly_speed>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1919

Name<PlayerTag.food_level>
ReturnsElementTag(Number)
MechanismPlayerTag.food_level
DescriptionReturns the current food level (aka hunger) of the player.
Generated Example
- narrate "the number value is <player.food_level>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2003

Name<PlayerTag.formatted_food_level[(<max>)]>
ReturnsElementTag
MechanismPlayerTag.food_level
DescriptionReturns a 'formatted' value of the player's current food level.
May be 'starving', 'famished', 'parched, 'hungry', or 'healthy'.
Generated Example
- narrate <player.formatted_food_level>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1971

Name<PlayerTag.gamemode>
ReturnsElementTag
MechanismPlayerTag.gamemode
DescriptionReturns the name of the gamemode the player is currently set to.
Works with offline players.
Generated Example
- narrate <player.gamemode>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2038

Name<PlayerTag.groups[(<world>)]>
ReturnsListTag
DescriptionReturns a list of all groups the player is in.
May work with offline players, depending on permission plugin.
Generated Example
- foreach <player.groups> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1087

Name<PlayerTag.has_advancement[<advancement>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player has completed the specified advancement.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2106

Name<PlayerTag.has_permission[permission.node]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player has the specified node.
(May work with offline players, depending on your permissions system.)
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1308

Name<PlayerTag.has_permission[permission.node].global>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player has the specified node, regardless of world.
(Works with offline players)
(Note: this may or may not be functional with your permissions system.)
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1318

Name<PlayerTag.has_permission[permission.node].world[<world>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player has the specified node in regards to the
specified world.
(Works with offline players)
(Note: This may or may not be functional with your permissions system.)
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1340

Name<PlayerTag.has_played_before>
ReturnsElementTag(Boolean)
DescriptionReturns true if the player has played before, or is currently online. Returns false if this PlayerTag refers to a UUID that has never been on the server.
Works with offline players.
Generated Example
- if <player.has_played_before>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L893

Name<PlayerTag.health_is_scaled>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player's health bar is currently being scaled.
Generated Example
- if <player.health_is_scaled>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L936

Name<PlayerTag.health_scale>
ReturnsElementTag(Decimal)
MechanismPlayerTag.health_scale
DescriptionReturns the current scale for the player's health bar.
Generated Example
- narrate "the decimal value is <player.health_scale>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L946

Name<PlayerTag.held_item_slot>
ReturnsElementTag(Number)
DescriptionReturns the slot location of the player's selected item.
Generated Example
- narrate "the number value is <player.held_item_slot>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1599

Name<PlayerTag.in_group[<group_name>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player is in the specified group.
(May work with offline players, depending on your permissions system.)
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1242

Name<PlayerTag.in_group[<group_name>].global>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player has the group with no regard to the
player's current world.
(Works with offline players)
(Note: This may or may not be functional with your permissions system.)
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1259

Name<PlayerTag.in_group[<group_name>].world[<world>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player has the group in regards to a specific world.
(Works with offline players)
(Note: This may or may not be functional with your permissions system.)
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1275

Name<PlayerTag.inventory>
ReturnsInventoryTag
DescriptionReturns a InventoryTag of the player's current inventory.
Works with offline players.
Generated Example
- note <player.inventory> as:my_new_inventory
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1507

Name<PlayerTag.ip>
ReturnsElementTag
DescriptionReturns the player's IP address host name.
Generated Example
- narrate <player.ip>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1821

Name<PlayerTag.ip_address>
ReturnsElementTag
DescriptionReturns the player's IP address, without port or hostname.
Generated Example
- narrate <player.ip_address>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1811

Name<PlayerTag.ip.address>
ReturnsElementTag
DescriptionReturns the player's IP address with port (usually including an rdns host path).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1840

Name<PlayerTag.ip.address_only>
ReturnsElementTag
DescriptionReturns the player's IP address with port (without triggering an rdns lookup).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1828

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

Name<PlayerTag.is_blocking>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player is currently blocking.
Generated Example
- if <player.is_blocking>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2053

Name<PlayerTag.is_flying>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player is currently flying.
Generated Example
- if <player.is_flying>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2073

Name<PlayerTag.is_online>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player is currently online.
Works with offline players (returns false in that case).
Generated Example
- if <player.is_online>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1030

Name<PlayerTag.is_op>
ReturnsElementTag(Boolean)
MechanismPlayerTag.is_op
DescriptionReturns whether the player is a full server operator.
Works with offline players.
Generated Example
- if <player.is_op>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1041

Name<PlayerTag.is_sneaking>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player is currently sneaking.
Generated Example
- if <player.is_sneaking>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2083

Name<PlayerTag.is_sprinting>
ReturnsElementTag(Boolean)
MechanismPlayerTag.sprinting
DescriptionReturns whether the player is currently sprinting.
Generated Example
- if <player.is_sprinting>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2095

Name<PlayerTag.item_cooldown[<material>]>
ReturnsDurationTag
DescriptionReturns the cooldown duration remaining on player's material.
Generated Example
- flag server myflag expire:<player.item_cooldown[iron_sword]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L864

Name<PlayerTag.item_on_cursor>
ReturnsItemTag
MechanismPlayerTag.item_on_cursor
DescriptionReturns the item on the player's cursor, if any. This includes
chest interfaces, inventories, and hotbars, etc.
Generated Example
- give <player.item_on_cursor>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1587

Name<PlayerTag.last_action_time>
ReturnsTimeTag
DescriptionReturns the time of the last direct input from the player. Internally used with Tag:server.idle_timeout.
Generated Example
- flag server myflag expire:<player.last_action_time>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2467

Name<PlayerTag.last_death_location>
ReturnsLocationTag
MechanismPlayerTag.last_death_location
DescriptionReturns the location where the player last died, if any.
Works with offline players.
Generated Example
- teleport <player> <player.last_death_location>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2575

Name<PlayerTag.last_played_time>
ReturnsTimeTag
DescriptionReturns the time of when the player was last seen.
Works with offline players.
Not very useful for online players.
Generated Example
- flag server myflag expire:<player.last_played_time>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1065

Name<PlayerTag.list_name>
ReturnsElementTag
MechanismPlayerTag.player_list_name
DescriptionReturns the name of the player as shown in the player list.
Generated Example
- narrate <player.list_name>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1445

Name<PlayerTag.locale>
ReturnsElementTag
DescriptionReturns the current locale of the player.
Generated Example
- narrate <player.locale>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1493

Name<PlayerTag.main_hand>
ReturnsElementTag
DescriptionReturns the player's main hand, either LEFT or RIGHT.
Generated Example
- narrate <player.main_hand>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1764

Name<PlayerTag.nameplate>
ReturnsElementTag
DescriptionReturns the displayed text in the nameplate of the player.
Generated Example
- narrate <player.nameplate>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1853

Name<PlayerTag.open_inventory>
ReturnsInventoryTag
DescriptionGets the inventory the player currently has open. If the player has no open
inventory, this returns the player's inventory.
Generated Example
- inventory set o:<player.open_inventory> d:stick slot:5
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1533

Name<PlayerTag.packets_received>
ReturnsElementTag(Number)
DescriptionReturns a total count of how many network packets have been received from this player while they have been online.
It may be ideal to change setting "Packets.Auto init" in the Denizen config to "true" to guarantee this tag functions as expected.
Generated Example
- narrate "the number value is <player.packets_received>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2427

Name<PlayerTag.packets_sent>
ReturnsElementTag(Number)
DescriptionReturns a total count of how many network packets have been sent to this player while they have been online.
It may be ideal to change setting "Packets.Auto init" in the Denizen config to "true" to guarantee this tag functions as expected.
Generated Example
- narrate "the number value is <player.packets_sent>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2415

Name<PlayerTag.ping>
ReturnsElementTag(Number)
DescriptionReturns the player's current ping.
Generated Example
- narrate "the number value is <player.ping>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2063

Name<PlayerTag.saturation>
ReturnsElementTag(Decimal)
MechanismPlayerTag.saturation
DescriptionReturns the current food saturation of the player.
Works with offline players.
Generated Example
- narrate "the decimal value is <player.saturation>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1954

Name<PlayerTag.scoreboard_id>
ReturnsElementTag
DescriptionReturns the ID of the scoreboard from Command:scoreboard that a player is currently viewing, if any.
Generated Example
- narrate <player.scoreboard_id>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2479

Name<PlayerTag.scoreboard_team_name[(<board>)]>
ReturnsElementTag
DescriptionReturns the name of the team the player is in for a given scoreboard, if any.
If no scoreboard is specified, uses the default (main) board.
Generated Example
- narrate <player.scoreboard_team_name>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2493

Name<PlayerTag.selected_npc>
ReturnsNPCTag
MechanismPlayerTag.selected_npc
DescriptionReturns the NPCTag that the player currently has selected with '/npc select', null if no NPC selected.
Generated Example
- heal <player.selected_npc>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1778

Name<PlayerTag.selected_trade_index>
ReturnsElementTag(Number)
DescriptionReturns the index of the trade the player is currently viewing, if any.
Generated Example
- narrate "the number value is <player.selected_trade_index>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1558

Name<PlayerTag.sidebar_lines>
ReturnsListTag
DescriptionReturns the current lines set on the player's Sidebar via Command:sidebar.
Generated Example
- foreach <player.sidebar_lines> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1618

Name<PlayerTag.sidebar_scores>
ReturnsListTag
DescriptionReturns the current scores set on the player's Sidebar via Command:sidebar,
in the same order as Tag:PlayerTag.sidebar_lines.
Generated Example
- foreach <player.sidebar_scores> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1646

Name<PlayerTag.sidebar_title>
ReturnsElementTag
DescriptionReturns the current title set on the player's Sidebar via Command:sidebar.
Generated Example
- narrate <player.sidebar_title>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1632

Name<PlayerTag.skin_blob>
ReturnsElementTag
MechanismPlayerTag.skin_blob
DescriptionReturns the player's current skin blob.
In the format: "texture;signature" (two values separated by a semicolon).
See also Language:Player Entity Skins (Skin Blobs).
Generated Example
- narrate <player.skin_blob>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1698

Name<PlayerTag.skin_model>
ReturnsElementTag
DescriptionReturns the player's skin model, either CLASSIC or SLIM.
Generated Example
- narrate <player.skin_model>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2562

Name<PlayerTag.skull_item>
ReturnsItemTag
DescriptionReturns a Player_Head item with the skin of the player.
See also Language:Player Entity Skins (Skin Blobs).
Generated Example
- give <player.skull_item>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1728

Name<PlayerTag.skull_skin>
ReturnsElementTag
DescriptionReturns the player's current skin blob, formatted for input to a Player Skull item.
In the format: "UUID|Texture|Name" (three values separated by pipes).
See also Language:Player Entity Skins (Skin Blobs).
Generated Example
- narrate <player.skull_skin>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1711

Name<PlayerTag.spawn_forced>
ReturnsElementTag(Boolean)
MechanismPlayerTag.spawn_forced
DescriptionReturns whether the player's bed spawn location is forced (ie still valid even if a bed is missing).
Generated Example
- if <player.spawn_forced>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2453

Name<PlayerTag.spectator_target>
ReturnsEntityTag
MechanismPlayerTag.spectator_target
DescriptionReturns the entity that a spectator-mode player is currently spectating, if any.
Generated Example
- heal <player.spectator_target>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2397

Name<PlayerTag.statistic[<statistic>]>
ReturnsElementTag(Number)
DescriptionReturns the player's current value for the specified statistic.
Valid statistics: 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Statistic.html
Works with offline players.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1376

Name<PlayerTag.statistic[<statistic>].qualifier[<material>/<entity>]>
ReturnsElementTag(Number)
DescriptionReturns the player's current value for the specified statistic, with the
specified qualifier, which can be either an entity or material.
Valid statistics: 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Statistic.html
To check a statistic type dynamically, refer to Tag:server.statistic_type.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1397

Name<PlayerTag.tab_completions[<command>]>
ReturnsListTag
DescriptionReturns a list of all tab completions for the given plaintext of a command.
Input is formatted equivalent to if it were typed into a chat bar, minus the '/' slash at the start.
Input must necessarily contain at least one space.
For example: "<player.tab_completions[npc ]>" will return all /NPC sub command names available to the player.
This is only compatible with commands registered in Spigot. Meaning in particular, vanilla commands are not recognized or supported.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2526

Name<PlayerTag.target[(<matcher>)]>
ReturnsEntityTag
DescriptionReturns the entity that the player is looking at, within a maximum range of 50 blocks,
or null if the player is not looking at an entity.
Optionally, specify an entity type matcher to only count matches as possible targets.
Generated Example
- heal <player.target>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L773

Name<PlayerTag.target[(<matcher>)].within[(<#.#>)]>
ReturnsEntityTag
DescriptionReturns the living entity that the player is looking at within the specified range limit,
or null if the player is not looking at an entity.
Optionally, specify an entity type matcher to only count matches as possible targets.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L785

Name<PlayerTag.time>
ReturnsElementTag(Number)
DescriptionReturns the time the player is currently experiencing.
This time could differ from the time that the rest of the world is currently experiencing if Command:time is being used on the player.
Generated Example
- narrate "the number value is <player.time>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2153

Name<PlayerTag.time_asleep>
ReturnsDurationTag
DescriptionReturns the time the player has been asleep.
Generated Example
- flag server myflag expire:<player.time_asleep>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2143

Name<PlayerTag.uuid>
ReturnsElementTag
DescriptionReturns the UUID of the player.
Works with offline players.
Generated Example
- narrate <player.uuid>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1434

Name<PlayerTag.walk_speed>
ReturnsElementTag(Decimal)
MechanismPlayerTag.walk_speed
DescriptionReturns the speed the player can walk at.
Works with offline players.
Generated Example
- narrate "the decimal value is <player.walk_speed>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1937

Name<PlayerTag.weather>
ReturnsElementTag
DescriptionReturns the type of weather the player is experiencing. This will be different
from the weather currently in the world that the player is residing in if
the weather is currently being forced onto the player.
Returns null if the player does not currently have any forced weather.
Generated Example
- narrate <player.weather>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2164

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

Name<PlayerTag.xp>
ReturnsElementTag(Decimal)
DescriptionReturns the percentage of experience points to the next level.
Generated Example
- narrate "the decimal value is <player.xp>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2229

Name<PlayerTag.xp_level>
ReturnsElementTag(Number)
DescriptionReturns the number of XP levels the player has.
Works with offline players.
Generated Example
- narrate "the number value is <player.xp_level>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2194

Name<PlayerTag.xp_to_next_level>
ReturnsElementTag(Number)
DescriptionReturns the amount of XP the player needs to get to the next level.
Works with offline players.
Generated Example
- narrate "the number value is <player.xp_to_next_level>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2205

Name<PlayerTag.xp_total>
ReturnsElementTag(Number)
DescriptionReturns the total amount of experience points the player has.
This is how much XP the player has ever received, not a current value.
To get the current total, use Tag:PlayerTag.calculate_xp.
Works with offline players.
Generated Example
- narrate "the number value is <player.xp_total>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2216

Name<PlayerTag.has_clientizen>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player has Clientizen running on their client.
Generated Example
- if <player.has_clientizen>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
GroupClientizen
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/clientizen/ClientizenBridge.java#L49

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

Name<PlayerTag.areashop.owned>
ReturnsListTag(AreaShopTag)
DescriptionReturns a list of AreaShops the player owns.
RequiresDepenizen, AreaShop
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/areashop/AreaShopPlayerProperties.java#L67

Name<PlayerTag.beton_quest[<package>].variable[<variable>]>
ReturnsElementTag
DescriptionReturns a variable from a BetonQuest package, for the player.
RequiresDepenizen, BetonQuest
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/betonquest/BetonQuestPlayerProperties.java#L38

Name<PlayerTag.bigdoors>
ReturnsListTag(BigDoorsDoorTag)
DescriptionReturns a list of Big Doors the player is an owner of.
Generated Example
- foreach <player.bigdoors> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, Big Doors
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/bigdoors/BigDoorsPlayerProperties.java#L51

Name<PlayerTag.chat_prefix>
ReturnsElementTag
MechanismPlayerTag.chat_prefix
DescriptionReturns the player's chat prefix.
NOTE: May work with offline players.
Requires a Vault-compatible chat plugin.
Generated Example
- narrate <player.chat_prefix>
RequiresVault
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2254

Name<PlayerTag.chat_suffix>
ReturnsElementTag
MechanismPlayerTag.chat_suffix
DescriptionReturns the player's chat suffix.
NOTE: May work with offline players.
Requires a Vault-compatible chat plugin.
Generated Example
- narrate <player.chat_suffix>
RequiresVault
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2278

Name<PlayerTag.combat_damage>
ReturnsElementTag(Decimal)
DescriptionReturns the value of the combat damage factor.
Generated Example
- narrate "the decimal value is <player.combat_damage>"
RequiresDepenizen, Vampire
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/vampire/VampirePlayerProperties.java#L93

Name<PlayerTag.combat_infect>
ReturnsElementTag(Decimal)
DescriptionReturns the value of the combat infection risk.
Generated Example
- narrate "the decimal value is <player.combat_infect>"
RequiresDepenizen, Vampire
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/vampire/VampirePlayerProperties.java#L82

Name<PlayerTag.current_jobs>
ReturnsListTag(JobsJobTag)
DescriptionReturns a list of all jobs that the player is in.
Generated Example
- foreach <player.current_jobs> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, Jobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/jobs/JobsPlayerExtensions.java#L24

Name<PlayerTag.essentials_homes>
ReturnsMapTag
DescriptionReturns a map of the homes of the player, with keys as the home name and values as the home location.
Generated Example
- foreach <player.essentials_homes> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
RequiresDepenizen, Essentials
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsPlayerProperties.java#L130

Name<PlayerTag.faction>
ReturnsFactionTag
DescriptionReturns the player's faction.
Generated Example
- narrate <player.faction>
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/factions/FactionsPlayerProperties.java#L110

Name<PlayerTag.factions.power>
ReturnsElementTag(Decimal)
DescriptionReturns the player's power level.
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/factions/FactionsPlayerProperties.java#L67

Name<PlayerTag.factions.role>
ReturnsElementTag
DescriptionReturns the player's role in their faction.
Note: In modern Factions these are called ranks instead of roles.
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/factions/FactionsPlayerProperties.java#L80

Name<PlayerTag.factions.title>
ReturnsElementTag
DescriptionReturns the player's title.
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/factions/FactionsPlayerProperties.java#L94

Name<PlayerTag.formatted_money>
ReturnsElementTag
DescriptionReturns the formatted form of the player's money balance in the registered Economy system.
Generated Example
- narrate <player.formatted_money>
RequiresVault
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L714

Name<PlayerTag.god_mode>
ReturnsElementTag(Boolean)
MechanismPlayerTag.god_mode
DescriptionReturns whether the player is currently in god mode.
Generated Example
- if <player.god_mode>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, Essentials
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsPlayerProperties.java#L71

Name<PlayerTag.griefprevention.blocks>
ReturnsElementTag(Number)
MechanismPlayerTag.normal_blocks
DescriptionReturns the number of normal claim blocks the player has.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/griefprevention/GriefPreventionPlayerProperties.java#L134

Name<PlayerTag.griefprevention.blocks.bonus>
ReturnsElementTag(Number)
MechanismPlayerTag.bonus_blocks
DescriptionReturns the number of bonus claim blocks the player has.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/griefprevention/GriefPreventionPlayerProperties.java#L110

Name<PlayerTag.griefprevention.blocks.remaining>
ReturnsElementTag(Number)
DescriptionReturns the number of claim blocks the player has left.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/griefprevention/GriefPreventionPlayerProperties.java#L99

Name<PlayerTag.griefprevention.blocks.total>
ReturnsElementTag(Number)
DescriptionReturns the total number of claim blocks the player has.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/griefprevention/GriefPreventionPlayerProperties.java#L122

Name<PlayerTag.griefprevention.claims>
ReturnsElementTag(Number)
DescriptionReturns the number of claims the player has in GriefPrevention.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/griefprevention/GriefPreventionPlayerProperties.java#L85

Name<PlayerTag.griefprevention.list_claims>
ReturnsListTag(GriefPreventionClaimTag)
DescriptionReturns a list of all claims the player has.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/griefprevention/GriefPreventionPlayerProperties.java#L70

Name<PlayerTag.has_home>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player has set at least one home.
Generated Example
- if <player.has_home>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, Essentials
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsPlayerProperties.java#L83

Name<PlayerTag.has_main_residence>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player has a main Residence.
Generated Example
- if <player.has_main_residence>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, Residence
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/residence/ResidencePlayerExtensions.java#L14

Name<PlayerTag.has_nation>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player is part of a nation.
Generated Example
- if <player.has_nation>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyPlayerProperties.java#L67

Name<PlayerTag.has_town>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player is part of a town.
Generated Example
- if <player.has_town>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyPlayerProperties.java#L78

Name<PlayerTag.ignored_players>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of the ignored players of the player.
Generated Example
- foreach <player.ignored_players> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, Essentials
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsPlayerProperties.java#L192

Name<PlayerTag.is_afk>
ReturnsElementTag(Boolean)
MechanismPlayerTag.is_afk
DescriptionReturns whether the player is AFK.
Generated Example
- if <player.is_afk>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, Essentials
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsPlayerProperties.java#L94

Name<PlayerTag.is_infected>
ReturnsElementTag(Boolean)
DescriptionReturns true if the player is infected.
Generated Example
- if <player.is_infected>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, Vampire
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/vampire/VampirePlayerProperties.java#L71

Name<PlayerTag.is_muted>
ReturnsElementTag(Boolean)
MechanismPlayerTag.is_muted
DescriptionReturns whether the player is muted.
Generated Example
- if <player.is_muted>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, Essentials
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsPlayerProperties.java#L106

Name<PlayerTag.is_vampire>
ReturnsElementTag(Boolean)
DescriptionReturns true if the player is a vampire.
Generated Example
- if <player.is_vampire>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, Vampire
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/vampire/VampirePlayerProperties.java#L60

Name<PlayerTag.is_vanished>
ReturnsElementTag(Boolean)
MechanismPlayerTag.vanish
DescriptionReturns whether the player is vanished.
Generated Example
- if <player.is_vanished>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, Essentials
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsPlayerProperties.java#L118

Name<PlayerTag.is_vivecraft>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player is running on VR or not.
Generated Example
- if <player.is_vivecraft>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, ViveCraft
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/vivecraft/ViveCraftPlayerProperties.java#L12

Name<PlayerTag.job[<job>]>
ReturnsJobsJobTag
DescriptionReturns the job specified with the player's information attached.
RequiresDepenizen, Jobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/jobs/JobsPlayerExtensions.java#L13

Name<PlayerTag.list_mails>
ReturnsListTag
DescriptionReturns a list of mail the player currently has.
Generated Example
- foreach <player.list_mails> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, Essentials
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsPlayerProperties.java#L215

Name<PlayerTag.luckperms_primary_group>
ReturnsLuckPermsGroupTag
DescriptionReturns a player's primary group.
Generated Example
- narrate <player.luckperms_primary_group>
RequiresDepenizen, LuckPerms
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/luckperms/LuckPermsPlayerExtensions.java#L51

Name<PlayerTag.luckperms_tracks>
ReturnsListTag(LuckPermsTrackTag)
DescriptionReturns a list of tracks the player is in.
Generated Example
- foreach <player.luckperms_tracks> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, LuckPerms
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/luckperms/LuckPermsPlayerExtensions.java#L18

Name<PlayerTag.magicspells.known_spells>
ReturnsListTag
DescriptionReturns a list of spells the player knows, by internal name.
RequiresDepenizen, MagicSpells
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/magicspells/MagicSpellsPlayerProperties.java#L97

Name<PlayerTag.magicspells.mana>
ReturnsElementTag(Number)
DescriptionReturns the mana of the player.
RequiresDepenizen, MagicSpells
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/magicspells/MagicSpellsPlayerProperties.java#L65

Name<PlayerTag.magicspells.max_mana>
ReturnsElementTag(Number)
DescriptionReturns the maximum mana of the player.
RequiresDepenizen, MagicSpells
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/magicspells/MagicSpellsPlayerProperties.java#L81

Name<PlayerTag.main_residence>
ReturnsResidenceTag
DescriptionReturns the player's current main Residence if they have one.
Generated Example
- narrate <player.main_residence>
RequiresDepenizen, Residence
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/residence/ResidencePlayerExtensions.java#L26

Name<PlayerTag.mcmmo.level[(<skill>)]>
ReturnsElementTag(Number)
DescriptionReturns the player's level in a skill.
If no skill is specified, this returns the player's overall level.
RequiresDepenizen, mcMMO
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mcmmo/McMMOPlayerProperties.java#L64

Name<PlayerTag.mcmmo.party>
ReturnsElementTag
DescriptionReturns the name of the player's party.
RequiresDepenizen, mcMMO
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mcmmo/McMMOPlayerProperties.java#L95

Name<PlayerTag.mcmmo.rank[(<skill>)]>
ReturnsElementTag(Number)
DescriptionReturns the player's current rank in a skill.
If no skill is specified, this returns the player's overall rank.
RequiresDepenizen, mcMMO
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mcmmo/McMMOPlayerProperties.java#L168

Name<PlayerTag.mcmmo.xp[<skill>]>
ReturnsElementTag(Number)
DescriptionReturns the player's amount of experience in a skill.
RequiresDepenizen, mcMMO
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mcmmo/McMMOPlayerProperties.java#L150

Name<PlayerTag.mcmmo.xp[<skill>].level>
ReturnsElementTag(Number)
DescriptionReturns the player's experience level in a skill.
RequiresDepenizen, mcMMO
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mcmmo/McMMOPlayerProperties.java#L132

Name<PlayerTag.mcmmo.xp[<skill>].to_next_level>
ReturnsElementTag(Number)
DescriptionReturns the amount of experience a player needs to level up in a skill.
RequiresDepenizen, mcMMO
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mcmmo/McMMOPlayerProperties.java#L114

Name<PlayerTag.mobarena.class>
ReturnsElementTag
DescriptionReturns the name of the class the player is using.
NOTE: requires the player to be in an arena.
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mobarena/MobArenaPlayerProperties.java#L97

Name<PlayerTag.mobarena.current_arena>
ReturnsMobArenaArenaTag
DescriptionReturns the arena the player is in.
NOTE: requires the player to be in an arena.
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mobarena/MobArenaPlayerProperties.java#L85

Name<PlayerTag.mobarena.in_arena>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player is in an arena.
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mobarena/MobArenaPlayerProperties.java#L71

Name<PlayerTag.mobarena.stats[<mobarena>].damage_done>
ReturnsElementTag(Number)
DescriptionReturns the amount of damage the player has dealt in the arena.
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mobarena/MobArenaPlayerProperties.java#L138

Name<PlayerTag.mobarena.stats[<mobarena>].damage_taken>
ReturnsElementTag(Number)
DescriptionReturns the amount of damage the player has taken in the arena.
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mobarena/MobArenaPlayerProperties.java#L149

Name<PlayerTag.mobarena.stats[<mobarena>].kills>
ReturnsElementTag(Number)
DescriptionReturns the number of kills the player has in the arena.
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mobarena/MobArenaPlayerProperties.java#L127

Name<PlayerTag.mobarena.stats[<mobarena>].last_wave>
ReturnsElementTag(Number)
DescriptionReturns the wave the player reached in their last match in the arena.
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mobarena/MobArenaPlayerProperties.java#L160

Name<PlayerTag.mobarena.stats[<mobarena>].times_hit>
ReturnsElementTag(Number)
DescriptionReturns the number of times the player has hit an enemy in the arena.
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mobarena/MobArenaPlayerProperties.java#L182

Name<PlayerTag.mobarena.stats[<mobarena>].times_swung>
ReturnsElementTag(Number)
DescriptionReturns the number of times the player has swung their weapon in the arena.
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mobarena/MobArenaPlayerProperties.java#L171

Name<PlayerTag.mode_list>
ReturnsListTag
DescriptionReturns the player's towny modes as a list.
Generated Example
- foreach <player.mode_list> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyPlayerProperties.java#L89

Name<PlayerTag.money>
ReturnsElementTag(Decimal)
DescriptionReturns the amount of money the player has with the registered Economy system.
May work offline depending on economy provider.
Generated Example
- narrate "the decimal value is <player.money>"
RequiresVault
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L731

Name<PlayerTag.mute_timeout>
ReturnsDurationTag
DescriptionReturns how much time is left until the player is unmuted.
Generated Example
- flag server myflag expire:<player.mute_timeout>
RequiresDepenizen, Essentials
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsPlayerProperties.java#L226

Name<PlayerTag.mythic_variable[<name>]>
ReturnsElementTag
DescriptionReturns the value of a MythicMobs variable for this player.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mythicmobs/MythicMobsPlayerProperties.java#L55

Name<PlayerTag.mythic_variable_map>
ReturnsMapTag
MechanismPlayerTag.mythic_variable_map
DescriptionReturns a map of the player's variables.
Generated Example
- foreach <player.mythic_variable_map> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mythicmobs/MythicMobsPlayerProperties.java#L66

Name<PlayerTag.nation>
ReturnsNationTag
DescriptionReturns the player's nation.
Generated Example
- narrate <player.nation>
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyPlayerProperties.java#L119

Name<PlayerTag.nation_ranks>
ReturnsListTag
DescriptionReturns the player's nation ranks.
Generated Example
- foreach <player.nation_ranks> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyPlayerProperties.java#L104

Name<PlayerTag.nbs_is_playing>
ReturnsElementTag(Boolean)
DescriptionReturns true if the player is currently listening to a note block song.
Generated Example
- if <player.nbs_is_playing>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, NoteBlockAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/noteblockapi/NoteBlockAPIPlayerProperties.java#L52

Name<PlayerTag.ncp.infractions>
ReturnsElementTag(Number)
DescriptionReturns the number of infractions this player has with NoCheatPlus
NOTE: Cannot guarantee the accuracy of this tag, due to lack of API in NoCheatPlus.
RequiresDepenizen, NoCheatPlus
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/nocheatplus/NoCheatPlusPlayerProperties.java#L58

Name<PlayerTag.playerpoints_points>
ReturnsElementTag(Number)
DescriptionReturns the amount of points the player has. Only works on online players.
Generated Example
- narrate "the number value is <player.playerpoints_points>"
RequiresDepenizen, PlayerPoints
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/playerpoints/PlayerPointsPlayerProperties.java#L53

Name<PlayerTag.plotsquared_plots[<WorldTag>]>
ReturnsListTag(PlotSquaredPlotTag)
DescriptionReturns a list of plots a player has in a world. Exclude the context to get plots in all worlds.
Generated Example
- foreach <player.plotsquared_plots[<player.location.world>]> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, PlotSquared
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/plotsquared/PlotSquaredPlayerProperties.java#L55

Name<PlayerTag.pvparena.class>
ReturnsElementTag
DescriptionReturns the player's class if they're in an arena. Otherwise, returns null.
RequiresDepenizen, PvP Arena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/pvparena/PVPArenaPlayerProperties.java#L90

Name<PlayerTag.pvparena.in_arena[<pvparena>]>
ReturnsElementTag(Boolean)
DescriptionReturns true if the player is in the specified arena. If no arena is specified,
this returns true if the player is in any arena.
RequiresDepenizen, PvP Arena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/pvparena/PVPArenaPlayerProperties.java#L63

Name<PlayerTag.pvparena.is_ready>
ReturnsElementTag(Boolean)
DescriptionReturns true if the player is ready.
RequiresDepenizen, PvP Arena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/pvparena/PVPArenaPlayerProperties.java#L101

Name<PlayerTag.pvparena.team.name>
ReturnsElementTag
DescriptionReturns the player's team name if they're in an arena. Otherwise, returns null.
RequiresDepenizen, PvP Arena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/pvparena/PVPArenaPlayerProperties.java#L129

Name<PlayerTag.pvparena.team.player_count>
ReturnsElementTag(Number)
DescriptionReturns the number of players in the team.
RequiresDepenizen, PvP Arena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/pvparena/PVPArenaPlayerProperties.java#L117

Name<PlayerTag.pvpstats.deaths>
ReturnsElementTag(Number)
DescriptionReturns the number of times the player has died.
RequiresDepenizen, PvP Stats
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/pvpstats/PVPStatsPlayerProperties.java#L59

Name<PlayerTag.pvpstats.elo>
ReturnsElementTag(Number)
DescriptionReturns the Elo rating of the player.
RequiresDepenizen, PvP Stats
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/pvpstats/PVPStatsPlayerProperties.java#L70

Name<PlayerTag.pvpstats.kills>
ReturnsElementTag(Number)
DescriptionReturns the number of players the player has killed.
RequiresDepenizen, PvP Stats
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/pvpstats/PVPStatsPlayerProperties.java#L81

Name<PlayerTag.pvpstats.max_streak>
ReturnsElementTag(Number)
DescriptionReturns the highest kill streak of the player.
RequiresDepenizen, PvP Stats
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/pvpstats/PVPStatsPlayerProperties.java#L103

Name<PlayerTag.pvpstats.streak>
ReturnsElementTag(Number)
DescriptionReturns the current kill streak of the player.
RequiresDepenizen, PvP Stats
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/pvpstats/PVPStatsPlayerProperties.java#L92

Name<PlayerTag.quests.active>
ReturnsElementTag(Number)
DescriptionReturns the number of quests the player has active.
RequiresDepenizen, Quests
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/quests/QuestsPlayerProperties.java#L141

Name<PlayerTag.quests.active_ids>
ReturnsListTag
DescriptionReturns the IDs of quests the player has active.
RequiresDepenizen, Quests
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/quests/QuestsPlayerProperties.java#L106

Name<PlayerTag.quests.active_names>
ReturnsListTag
DescriptionReturns the names of quests the player has active.
RequiresDepenizen, Quests
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/quests/QuestsPlayerProperties.java#L118

Name<PlayerTag.quests.completed>
ReturnsElementTag(Number)
DescriptionReturns the number of quests the player has completed.
RequiresDepenizen, Quests
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/quests/QuestsPlayerProperties.java#L130

Name<PlayerTag.quests.completed_ids>
ReturnsListTag
DescriptionReturns the IDs of quests the player has completed.
RequiresDepenizen, Quests
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/quests/QuestsPlayerProperties.java#L82

Name<PlayerTag.quests.completed_names>
ReturnsListTag
DescriptionReturns the names of quests the player has completed.
RequiresDepenizen, Quests
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/quests/QuestsPlayerProperties.java#L94

Name<PlayerTag.quests.points>
ReturnsElementTag(Number)
DescriptionReturns the number of quest points the player has.
RequiresDepenizen, Quests
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/quests/QuestsPlayerProperties.java#L68

Name<PlayerTag.residences>
ReturnsListTag(ResidenceTag)
DescriptionReturns the player's current list of Residences.
Generated Example
- foreach <player.residences> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, Residence
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/residence/ResidencePlayerExtensions.java#L41

Name<PlayerTag.skillapi.class_exp[<class>]>
ReturnsElementTag(Decimal)
DescriptionReturns the amount of experience the player has toward the next level in the specified class.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L152

Name<PlayerTag.skillapi.class_health[<class>]>
ReturnsElementTag(Decimal)
DescriptionReturns the amount of health the player gets from the specified class.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L219

Name<PlayerTag.skillapi.class_level[<class>]>
ReturnsElementTag(Number)
DescriptionReturns the level the player is in the specified class.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L186

Name<PlayerTag.skillapi.class_mana[<class>]>
ReturnsElementTag(Decimal)
DescriptionReturns the amount of mana the player gets from the specified class.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L230

Name<PlayerTag.skillapi.class_maxed[<class>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player has hit maximum level in the specified class.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L208

Name<PlayerTag.skillapi.class_points[<class>]>
ReturnsElementTag(Number)
DescriptionReturns the number of skill points the player has in the specified class.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L197

Name<PlayerTag.skillapi.class_required_exp[<class>]>
ReturnsElementTag(Decimal)
DescriptionReturns the amount of experience the player must receive to get to the next level
in the specified class.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L163

Name<PlayerTag.skillapi.class_total_exp[<class>]>
ReturnsElementTag(Decimal)
DescriptionReturns the total amount of experience the player has in the specified class.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L175

Name<PlayerTag.skillapi.has_skill[<skill>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player has the specified skill.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L102

Name<PlayerTag.skillapi.in_class[<class>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player professes in the specified class. If none is specified, returns
whether the player professes in any class.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L83

Name<PlayerTag.skillapi.main_class>
ReturnsSkillAPIClassTag
DescriptionReturns the player's main SkillAPI class.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L69

Name<PlayerTag.skillapi.mana>
ReturnsElementTag(Decimal)
DescriptionReturns the player's current amount of mana.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L113

Name<PlayerTag.skillapi.max_mana>
ReturnsElementTag(Decimal)
DescriptionReturns the player's maximum amount of mana.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L124

Name<PlayerTag.skillapi.skill_bind[<skill>]>
ReturnsMaterialTag
DescriptionReturns the material this skill is currently bound to.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L260

Name<PlayerTag.skillapi.skill_cooldown[<skill>]>
ReturnsDurationTag
DescriptionReturns the remaining cooldown the player has in the specified skill.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L326

Name<PlayerTag.skillapi.skill_cost[<skill>]>
ReturnsElementTag(Number)
DescriptionReturns the cost the for the player to level up the specified skill.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L304

Name<PlayerTag.skillapi.skill_indicator[<skill>]>
ReturnsItemTag
DescriptionReturns the indicator item for the skill.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L249

Name<PlayerTag.skillapi.skill_level[<skill>]>
ReturnsElementTag(Number)
DescriptionReturns the level the player is in the specified skill.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L282

Name<PlayerTag.skillapi.skill_level_requirement[<skill>]>
ReturnsElementTag(Number)
DescriptionReturns the level the player must be to level up the specified skill.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L271

Name<PlayerTag.skillapi.skill_maxed[<skill>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player has reached max level in the specified skill.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L337

Name<PlayerTag.skillapi.skill_on_cooldown[<skill>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the specified skill is currently on cooldown for the player.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L315

Name<PlayerTag.skillapi.skill_points[<skill>]>
ReturnsElementTag(Number)
DescriptionReturns how many skill points the player has invested in the specified skill.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L293

Name<PlayerTag.skillapi.skill_status[<skill>]>
ReturnsElementTag
DescriptionReturns the player's current status for the specified skill.
Can be: ON_COOLDOWN, MISSING_MANA, or READY
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L348

Name<PlayerTag.skyblock.center>
ReturnsLocationTag
DescriptionReturns the centre of the player's skyblock.
RequiresDepenizen, A SkyBlock
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/askyblock/ASkyBlockPlayerProperties.java#L84

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

Name<PlayerTag.skyblock.level>
ReturnsElementTag(Number)
DescriptionReturns the level of the player's skyblock.
RequiresDepenizen, A SkyBlock
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/askyblock/ASkyBlockPlayerProperties.java#L121

Name<PlayerTag.skyblock.members>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of members of the player's skyblock.
RequiresDepenizen, A SkyBlock
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/askyblock/ASkyBlockPlayerProperties.java#L106

Name<PlayerTag.skyblock.spawn_point>
ReturnsLocationTag
DescriptionReturns the spawnpoint of the player's skyblock.
RequiresDepenizen, A SkyBlock
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/askyblock/ASkyBlockPlayerProperties.java#L95

Name<PlayerTag.socialspy>
ReturnsElementTag(Boolean)
MechanismPlayerTag.socialspy
DescriptionReturns whether the player has SocialSpy enabled.
Generated Example
- if <player.socialspy>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, Essentials
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsPlayerProperties.java#L238

Name<PlayerTag.town>
ReturnsTownTag
DescriptionReturns the player's town.
Generated Example
- narrate <player.town>
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyPlayerProperties.java#L157

Name<PlayerTag.town_ranks>
ReturnsListTag
DescriptionReturns the player's town ranks.
Generated Example
- foreach <player.town_ranks> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyPlayerProperties.java#L142

Name<PlayerTag.townychat.channels>
ReturnsListTag
DescriptionReturns a list of all channels the player is in.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyChatPlayerProperties.java#L68

Name<PlayerTag.townychat.has_permission[<channel_name>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player has permissions to join the specified channel.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyChatPlayerProperties.java#L98

Name<PlayerTag.townychat.muted_in[<channel_name>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the player is muted in the specified channel.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyChatPlayerProperties.java#L83

Name<PlayerTag.viaversion>
ReturnsElementTag(Number)
DescriptionDeprecated in favor of Tag:PlayerTag.viaversion_protocol.
Generated Example
- narrate "the number value is <player.viaversion>"
RequiresDepenizen, ViaVersion
DeprecatedUse 'PlayerTag.viaversion_protocol'
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/viaversion/ViaVersionPlayerExtensions.java#L12

Name<PlayerTag.viaversion_protocol>
ReturnsElementTag(Number)
DescriptionReturns the protocol version number of the player's client.
See 🔗https://wiki.vg/Protocol_version_numbers as a reference list.
See also Tag:PlayerTag.viaversion_version
Generated Example
- narrate "the number value is <player.viaversion_protocol>"
RequiresDepenizen, ViaVersion
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/viaversion/ViaVersionPlayerExtensions.java#L21

Name<PlayerTag.viaversion_version>
ReturnsElementTag
DescriptionReturns the player's client version ("1.19.4", "1.18.2"...).
See also Tag:PlayerTag.viaversion_protocol
Generated Example
- narrate <player.viaversion_version>
RequiresDepenizen, ViaVersion
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/viaversion/ViaVersionPlayerExtensions.java#L34

Name<PlayerTag.vivecraft>
ReturnsViveCraftPlayerTag
DescriptionReturns the ViveCraftPlayerTag for this player.
Generated Example
- narrate <player.vivecraft>
RequiresDepenizen, ViveCraft
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/vivecraft/ViveCraftPlayerProperties.java#L23

Name<PlayerTag.we_brush_info[(<item>)]>
ReturnsListTag
DescriptionReturns information about a player's current brush for an item.
If no item is specified, will be based on their held item.
Output is in format: type|size|range|material

Note that some values may be listed as "unknown" or strange values due to WorldEdit having a messy API (no way to automatically stringify brush data).
Generated Example
- foreach <player.we_brush_info> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, WorldEdit
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldedit/WorldEditPlayerProperties.java#L81

Name<PlayerTag.we_selection>
ReturnsObjectTag
MechanismPlayerTag.we_selection
DescriptionReturns the player's current block area selection, as a CuboidTag, EllipsoidTag, or PolygonTag.
Generated Example
- narrate "debug - the object is: <player.we_selection>"
RequiresDepenizen, WorldEdit
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldedit/WorldEditPlayerProperties.java#L124

Name<PlayerTag.worldguard.can_build[<location>]>
ReturnsElementTag(Boolean)
DescriptionWhether WorldGuard allows to build at a location.
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardPlayerProperties.java#L77

Name<PlayerTag.worldguard.test_flag[<name>]>
ReturnsElementTag
DescriptionReturns the boolean state of a flag for that player at their location.
For non-state tags, returns the current value of the flag.
Example
# Returns 'true' if the player can be attacked (according to WG) or 'false' if not.
- narrate <player.worldguard.test_flag[pvp]>
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardPlayerProperties.java#L94

Name<PlayerTag.worldguard.test_flag[<name>].at[<location>]>
ReturnsElementTag
DescriptionReturns the boolean state of a flag for that player at the specified location.
For non-state tags, returns the current value of the flag.
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardPlayerProperties.java#L120

Name<PlayerTag.affects_monster_spawning>
ReturnsElementTag(Boolean)
MechanismPlayerTag.affects_monster_spawning
DescriptionReturns whether the player affects monster spawning. When false, no monsters will spawn naturally because of this player.
Generated Example
- if <player.affects_monster_spawning>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Grouppaper
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperPlayerExtensions.java#L16

Name<PlayerTag.flying_fall_damage>
ReturnsElementTag(Boolean)
MechanismPlayerTag.flying_fall_damage
DescriptionReturns whether the player will take fall damage while Tag:PlayerTag.can_fly is true.
Generated Example
- if <player.flying_fall_damage>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Grouppaper
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperPlayerExtensions.java#L88



Category: PluginTag


Name<PluginTag.authors>
ReturnsListTag
DescriptionGets the list of authors for the plugin specified.
Generated Example
- foreach <plugin[Denizen].authors> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PluginTag.java#L183

Name<PluginTag.commands>
ReturnsMapTag(MapTag)
DescriptionGets a map of commands registered this plugin registers by default.
Note that dynamically registered commands won't show up (for example, command scripts won't be listed under Denizen).
Map key is command name, map value is a sub-mapping with keys:
description (ElementTag), usage (ElementTag), permission (ElementTag), aliases (ListTag)
Not all keys will be present.
For example, <plugin[denizen].commands.get[ex]> will return a MapTag with:
[description=Executes a Denizen script command.;usage=/ex (-q) <Denizen script command> (arguments);permission=denizen.ex]
Generated Example
- foreach <plugin[Denizen].commands> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PluginTag.java#L213

Name<PluginTag.depends>
ReturnsListTag
DescriptionGets the list of hard dependencies for the plugin specified.
Generated Example
- foreach <plugin[Denizen].depends> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PluginTag.java#L193

Name<PluginTag.description>
ReturnsElementTag
DescriptionGets the description for the plugin specified.
Generated Example
- narrate <plugin[Denizen].description>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PluginTag.java#L173

Name<PluginTag.name>
ReturnsElementTag
DescriptionGets the name of this plugin.
Generated Example
- narrate <plugin[Denizen].name>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PluginTag.java#L153

Name<PluginTag.soft_depends>
ReturnsListTag
DescriptionGets the list of soft dependencies for the plugin specified.
Generated Example
- foreach <plugin[Denizen].soft_depends> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PluginTag.java#L203

Name<PluginTag.version>
ReturnsElementTag
DescriptionGets the version for the plugin specified.
Generated Example
- narrate <plugin[Denizen].version>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PluginTag.java#L163



Category: PolygonTag


Name<PolygonTag.blocks_inclusive[(<matcher>)]>
ReturnsListTag(LocationTag)
DescriptionReturns each block location within the polygon.
Optionally, specify a material matcher to only return locations with that block type.
Uses block-inclusive containment: contains a wider section of blocks along the edge (this mode is equivalent to WorldEdit's block selection).
Example
# Displays a debugblock at each block of wool contained within the polygon "my_polygon".
- debugblock <polygon[my_polygon].blocks_inclusive[*wool]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L875

Name<PolygonTag.contains_inclusive[<location>]>
ReturnsElementTag(Boolean)
DescriptionReturns a boolean indicating whether the specified location is inside this polygon.
Uses block-inclusive containment: contains a wider section of blocks along the edge (this mode is equivalent to WorldEdit's block selection).
Example
- if <polygon[my_polygon].contains_inclusive[<player.location>]>:
    - narrate "The player's location is contained within the polygon!"
- else:
    - narrate "The player's location is not contained within the polygon!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L859

Name<PolygonTag.corners>
ReturnsListTag(LocationTag)
DescriptionReturns a list of the polygon's corners, as locations with Y coordinate set to the y-min value.
Example
# Displays a debugblock at each corner of the polygon "my_polygon".
- debugblock <polygon[my_polygon].corners>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L665

Name<PolygonTag.include_y[<#.#>]>
ReturnsPolygonTag
DescriptionReturns a copy of the polygon, with the specified Y value included as part of the Y range (expanding the Y-min or Y-max as needed).
Example
# Notes "my_polygon" as "my_new_polygon" but with the player's Y location included in the Y range.
# For example, if "my_polygon" has a maximum-Y of 80 and a minimum-Y of 60,
# and the player's Y location was 95, then "my_new_polygon" will have a maximum-Y of 95 and a minimum-Y of 60.
# However, if the player's Y location was 50, then the maximum-Y value would stay the same and the minimum-Y value would change to 50 instead.
- note <polygon[my_polygon].include_y[<player.location.y>]> as:my_new_polygon
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L776

Name<PolygonTag.max_y>
ReturnsElementTag(Decimal)
DescriptionReturns the maximum Y level for this polygon.
Example
# For example, this might return something like:
# "The maximum Y level for the polygon, 'my_polygon', is 73!"
- narrate "The maximum Y level for the polygon, 'my_polygon', is <polygon[my_polygon].max_y>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L619

Name<PolygonTag.min_y>
ReturnsElementTag(Decimal)
DescriptionReturns the minimum Y level for this polygon.
Example
# For example, this might return something like:
# "The minimum Y level for the polygon, 'my_polygon', is 62!"
- narrate "The minimum Y level for the polygon, 'my_polygon', is <polygon[my_polygon].min_y>!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L633

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

Name<PolygonTag.outline>
ReturnsListTag(LocationTag)
DescriptionReturns a list of locations along the 3D outline of this polygon (roughly a block-width of separation between each).
Example
# Plays the "flame" effect along the outline of the polygon, "my_polygon".
- playeffect effect:flame at:<polygon[my_polygon].outline> offset:0.0
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L820

Name<PolygonTag.outline_2d[<#.#>]>
ReturnsListTag(LocationTag)
DescriptionReturns a list of locations along the 2D outline of this polygon, at the specified Y level (roughly a block-width of separation between each).
Example
# Plays the "flame" effect along the 2D outline of the polygon, "my_polygon" at the player's Y location.
- playeffect effect:flame at:<polygon[my_polygon].outline_2d[<player.location.y>]> offset:0.0
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L800

Name<PolygonTag.shell_inclusive>
ReturnsListTag(LocationTag)
DescriptionReturns each block location on the 3D outer shell of the polygon.
Uses block-inclusive containment: contains a wider section of blocks along the edge (this mode is equivalent to WorldEdit's block selection).
Example
# Plays the "flame" effect at the outer 3D shell of the polygon "my_polygon".
- playeffect effect:flame at:<polygon[my_polygon].shell_inclusive> offset:0.0
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L901

Name<PolygonTag.shift[<vector>]>
ReturnsPolygonTag
DescriptionReturns a copy of the polygon, with all coordinates shifted by the given location-vector.
Example
# Notes the polygon "my_polygon" as "my_shifted_polygon" but shifted over by 25,25,25.
- note <polygon[my_polygon].shift[25,25,25]> as:my_shifted_polygon
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L682

Name<PolygonTag.with_corner[<location>]>
ReturnsPolygonTag
MechanismPolygonTag.add_corner
DescriptionReturns a copy of the polygon, with the specified corner added to the end of the corner list.
Example
# Notes a new polygon with a new corner added.
# If the new corner has a location of "10,66,-2", and "my_polygon" has corners "0.0,0.0", "7.0,7.0", and "-5.0,6.0",
# then "my_new_polygon" will have corners  "0.0,0.0", "7.0,7.0", "-5.0,6.0", and "10.0,-2.0".
- note <polygon[my_polygon].with_corner[10,66,-2]> as:my_new_polygon
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L711

Name<PolygonTag.with_y_max[<#.#>]>
ReturnsPolygonTag
DescriptionReturns a copy of the polygon, with the specified maximum-Y value.
Example
# Notes a new polygon from "my_polygon" with the maximum-Y value being 10.
# For example, if "my_polygon" had a maximum-Y of 50 and a minimum-Y of 30, then "my_new_polygon" will have a maximum-Y of 70 and a minimum-Y of 30.
- note <polygon[my_polygon].with_y_max[70]> as:my_new_polygon
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L756

Name<PolygonTag.with_y_min[<#.#>]>
ReturnsPolygonTag
DescriptionReturns a copy of the polygon, with the specified minimum-Y value.
Example
# Notes a new polygon from "my_polygon" with the minimum-Y value being 10.
# For example, if "my_polygon" had a maximum-Y of 50 and a minimum-Y of 30, then "my_new_polygon" will have a maximum-Y of 50 and a minimum-Y of 10.
- note <polygon[my_polygon].with_y_min[10]> as:my_new_polygon
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L736



Category: proc


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



Category: QuaternionTag


Name<QuaternionTag.axis_angle_for[<vector>]>
ReturnsElementTag(Decimal)
DescriptionReturns the angle (in radians) around the specified axis vector created by this quaternion.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L318

Name<QuaternionTag.conjugate>
ReturnsQuaternionTag
DescriptionReturns the conjugate of this quaternion.
This is equivalent to (-x, -y, -z, w).
Generated Example
- narrate "TODO: Placeholder: quaternion is <quaternion[identity].conjugate>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L271

Name<QuaternionTag.inverse>
ReturnsQuaternionTag
DescriptionReturns the inverse of this quaternion.
The inverse is the same amount of rotation, in the opposite direction.
Generated Example
- narrate "TODO: Placeholder: quaternion is <quaternion[identity].inverse>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L282

Name<QuaternionTag.length>
ReturnsElementTag(Decimal)
DescriptionReturns the length of this quaternion.
This value is not very useful in most cases.
Generated Example
- narrate "the decimal value is <quaternion[identity].length>"
Synonyms (Search Aid)quaterniontag.magnitude
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L247

Name<QuaternionTag.length_squared>
ReturnsElementTag(Decimal)
DescriptionReturns the squared length of this quaternion.
This value is not very useful in most cases.
Generated Example
- narrate "the decimal value is <quaternion[identity].length_squared>"
Synonyms (Search Aid)quaterniontag.magnitude_squared
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L259

Name<QuaternionTag.mul[<quaternion>]>
ReturnsQuaternionTag
DescriptionReturns this quaternion multiplied by another, using quaternion multiplication.
Effectively combines the rotation represented by two quaternions.
Generated Example
- narrate "TODO: Placeholder: quaternion is <quaternion[identity].mul[identity]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L214

Name<QuaternionTag.negative>
ReturnsQuaternionTag
DescriptionReturns the negative of this quaternion.
That is, (-x, -y, -z, -w).
This is not just making the rotation backwards, for that use Tag:QuaternionTag.inverse.
Generated Example
- narrate "TODO: Placeholder: quaternion is <quaternion[identity].negative>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L294

Name<QuaternionTag.normalize>
ReturnsQuaternionTag
DescriptionReturns a copy of this quaternion, normalized.
Generated Example
- narrate "TODO: Placeholder: quaternion is <quaternion[identity].normalize>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L237

Name<QuaternionTag.plus[<quaternion>]>
ReturnsQuaternionTag
DescriptionReturns this quaternion "plus" another, using simple addition.
This is NOT the same as combining quaternions! For that, use Tag:QuaternionTag.mul.
Generated Example
- narrate "TODO: Placeholder: quaternion is <quaternion[identity].plus[identity]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L203

Name<QuaternionTag.quaternion_between[<quaternion>]>
ReturnsQuaternionTag
DescriptionReturns the quaternion representing the rotation between this quaternion and another.
Equivalent to '[a].mul[<[b].conjugate>]'.
Returns a result such that b == a.mul[result].
Generated Example
- narrate "TODO: Placeholder: quaternion is <quaternion[identity].quaternion_between[identity]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L306

Name<QuaternionTag.represented_angle>
ReturnsElementTag(Decimal)
DescriptionReturns the angle (in radians) represented by this quaternion.
Pairs with Tag:QuaternionTag.represented_axis.
Generated Example
- narrate "the decimal value is <quaternion[identity].represented_angle>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L346

Name<QuaternionTag.represented_axis>
ReturnsVectorObject
DescriptionReturns the axis represented by this quaternion, as a vector.
Pairs with Tag:QuaternionTag.represented_angle.
Generated Example
- adjust <player> velocity:<quaternion[identity].represented_axis>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L357

Name<QuaternionTag.scale[<factor>]>
ReturnsQuaternionTag
DescriptionReturns this quaternion multiplied by scaling factor.
This does NOT increase rotation angle.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L225

Name<QuaternionTag.slerp[end=<quaternion>;amount=<amount>]>
ReturnsQuaternionTag
DescriptionReturns the spherical linear interpolation ('slerp') between this quaternion and another.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L368

Name<QuaternionTag.transform[<vector>]>
ReturnsVectorObject
DescriptionReturns a copy of the given vector, transformed by this quaternion.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L336

Name<QuaternionTag.w>
ReturnsElementTag(Decimal)
DescriptionReturns the raw W value of this quaternion.
Generated Example
- narrate "the decimal value is <quaternion[identity].w>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L162

Name<QuaternionTag.x>
ReturnsElementTag(Decimal)
DescriptionReturns the raw X value of this quaternion.
Generated Example
- narrate "the decimal value is <quaternion[identity].x>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L132

Name<QuaternionTag.xyz>
ReturnsElementTag
DescriptionReturns the X, Y, and Z values of this quaternion as a simple "x,y,z" format.
Generated Example
- narrate <quaternion[identity].xyz>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L172

Name<QuaternionTag.xyz_vector>
ReturnsVectorObject
DescriptionReturns the X, Y, and Z values of this quaternion as a ObjectType:VectorObject.
Generated Example
- adjust <player> velocity:<quaternion[identity].xyz_vector>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L193

Name<QuaternionTag.xyzw>
ReturnsElementTag
DescriptionReturns the X, Y, Z, and W values of this quaternion as a simple "x,y,z,w" format.
Generated Example
- narrate <quaternion[identity].xyzw>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L182

Name<QuaternionTag.y>
ReturnsElementTag(Decimal)
DescriptionReturns the raw Y value of this quaternion.
Generated Example
- narrate "the decimal value is <quaternion[identity].y>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L142

Name<QuaternionTag.z>
ReturnsElementTag(Decimal)
DescriptionReturns the raw Z value of this quaternion.
Generated Example
- narrate "the decimal value is <quaternion[identity].z>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L152



Category: QueueTag


Name<QueueTag.commands>
ReturnsListTag
DescriptionReturns a list of commands waiting in the queue.
Generated Example
- foreach <queue.commands> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L248

Name<QueueTag.definition[<definition>]>
ReturnsObjectTag
DescriptionReturns the value of the specified definition.
Returns null if the queue lacks the definition.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L306

Name<QueueTag.definition_map>
ReturnsMapTag
DescriptionReturns a map of all definitions on the queue.
Generated Example
- foreach <queue.definition_map> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L296

Name<QueueTag.definitions>
ReturnsListTag
DescriptionReturns the names of all definitions that were added to the current queue.
Generated Example
- foreach <queue.definitions> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L286

Name<QueueTag.determination>
ReturnsListTag
DescriptionReturns the values that have been determined via Command:Determine
for this queue, or null if there is none.
Generated Example
- foreach <queue.determination> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L317

Name<QueueTag.id>
ReturnsElementTag
DescriptionReturns the full textual id of the queue.
Generated Example
- narrate <queue.id>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L147

Name<QueueTag.is_valid>
ReturnsElementTag(Boolean)
DescriptionReturns true if the queue has not yet stopped.
Generated Example
- if <queue.is_valid>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L202

Name<QueueTag.last_command>
ReturnsElementTag
DescriptionReturns the last command executed in this queue (if any).
Generated Example
- narrate <queue.last_command>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L267

Name<QueueTag.npc>
ReturnsNPCTag
MechanismQueueTag.linked_npc
DescriptionReturns the NPCTag linked to a queue.
Generated Example
- walk <queue.npc> <player.location>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitQueueExtensions.java#L13

Name<QueueTag.numeric_id>
ReturnsElementTag(Number)
DescriptionReturns the raw numeric id of the queue. This is an incremental ID one higher than the previous queue's numeric ID.
Generated Example
- narrate "the number value is <queue.numeric_id>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L157

Name<QueueTag.player>
ReturnsPlayerTag
MechanismQueueTag.linked_player
DescriptionReturns the PlayerTag linked to a queue.
Generated Example
- kill <queue.player>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitQueueExtensions.java#L34

Name<QueueTag.script>
ReturnsScriptTag
DescriptionReturns the script that started this queue.
Generated Example
- narrate <queue.script>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L235

Name<QueueTag.size>
ReturnsElementTag(Number)
DescriptionReturns the number of script entries in the queue.
Generated Example
- narrate "the number value is <queue.size>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L167

Name<QueueTag.speed>
ReturnsDurationTag
DescriptionReturns the speed of the queue as a Duration. A return of '0' implies it is 'instant'.
This is largely considered historical - most queues now default to instant.
Generated Example
- flag server myflag expire:<queue.speed>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L333

Name<QueueTag.started_time>
ReturnsTimeTag
DescriptionReturns the time this queue started as a duration.
Generated Example
- flag server myflag expire:<queue.started_time>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L177

Name<QueueTag.state>
ReturnsElementTag
DescriptionReturns 'stopping', 'running', 'paused', or 'unknown'.
Generated Example
- narrate <queue.state>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L212

Name<QueueTag.time_ran>
ReturnsDurationTag
DescriptionReturns the time this queue has ran for (the length of time between now and when the queue started) as a duration.
Generated Example
- ratelimit <player> <queue.time_ran>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L191



Category: schematic


Name<schematic[<name>].block[<location>]>
ReturnsMaterialTag
DescriptionReturns the material for the block at the location in the schematic.
An input location of 0,0,0 corresponds to the minimum corner of the schematic.
Generated Example
- foreach <player.location.find_blocks[<schematic.block[<npc.location>]>].within[5]> as:loc:
    - modifyblock <[loc]> air
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L682

Name<schematic[<name>].blocks>
ReturnsElementTag(Number)
DescriptionReturns the number of blocks in the schematic.
Generated Example
- narrate "the number value is <schematic.blocks>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L711

Name<schematic[<name>].cuboid[<origin_location>]>
ReturnsCuboidTag
DescriptionReturns a cuboid of where the schematic would be if it was pasted at an origin.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L723

Name<schematic[<name>].exists>
ReturnsElementTag(Boolean)
DescriptionReturns whether the schematic exists.
Generated Example
- if <schematic.exists>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L634

Name<schematic[<name>].height>
ReturnsElementTag(Number)
DescriptionReturns the height (Y) of the schematic.
Generated Example
- narrate "the number value is <schematic.height>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L646

Name<schematic[<name>].length>
ReturnsElementTag(Number)
DescriptionReturns the length (Z) of the schematic.
Generated Example
- narrate "the number value is <schematic.length>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L658

Name<schematic.list>
ReturnsListTag
DescriptionReturns a list of all loaded schematics.
Generated Example
- foreach <schematic.list> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L610

Name<schematic[<name>].origin>
ReturnsLocationTag
DescriptionReturns the origin location of the schematic.
Generated Example
- teleport <player> <schematic.origin>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L699

Name<schematic[<name>].width>
ReturnsElementTag(Number)
DescriptionReturns the width (X) of the schematic.
Generated Example
- narrate "the number value is <schematic.width>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L670



Category: ScriptTag


Name<ScriptTag.container_type>
ReturnsElementTag
DescriptionReturns the type of script container that is associated with this ScriptTag object. For example: 'task', or
'world'.
Generated Example
- narrate <script.container_type>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L234

Name<ScriptTag.cooldown[(<player>)]>
ReturnsDurationTag
DescriptionReturns the time left for the player to cooldown for the script.
Generated Example
- flag server myflag expire:<script.cooldown>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitScriptExtensions.java#L36

Name<ScriptTag.cooled_down[(<player>)]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the script is currently cooled down for the player. Any global
cooldown present on the script will also be taken into account. Not specifying a player will result in
using the attached player available in the script entry. Not having a valid player will result in 'null'.
Generated Example
- if <script.cooled_down>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitScriptExtensions.java#L17

Name<ScriptTag.data_key[<key_name>]>
ReturnsObjectTag
DescriptionReturns the value from a data key on the script as an ElementTag, ListTag, or MapTag.
For example, "script.data_key[type]" on a task script will return "task".
Custom keys should usually go in a 'data' script container, or under a key labeled 'data' for other script containers.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L333

Name<ScriptTag.default_step>
ReturnsElementTag
DescriptionReturns the name of the default step of an interact script.
Generated Example
- narrate <script.default_step>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitScriptExtensions.java#L81

Name<ScriptTag.filename>
ReturnsElementTag
DescriptionReturns the absolute filename that contains the script.
Generated Example
- narrate <script.filename>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L265

Name<ScriptTag.list_deep_keys[(<start_key>)]>
ReturnsListTag
DescriptionReturns a list of all keys within a script, searching recursively, with an optional starting-key.
Generated Example
- foreach <script.list_deep_keys> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L374

Name<ScriptTag.list_keys[(<start_key>)]>
ReturnsListTag
DescriptionReturns a list of all data keys within a script, with an optional starting-key.
Generated Example
- foreach <script.list_keys> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L360

Name<ScriptTag.name>
ReturnsElementTag
DescriptionReturns the name of the script container.
Generated Example
- narrate <script.name>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L245

Name<ScriptTag.original_name>
ReturnsElementTag
DescriptionReturns the originally cased script name.
Generated Example
- narrate <script.original_name>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L275

Name<ScriptTag.parsed_key[<key_name>]>
ReturnsObjectTag
DescriptionReturns the value from a data key on the script as an ElementTag, ListTag, or MapTag.
Will automatically parse any tags contained within the value of the key, preserving key data structure
(meaning, a tag that returns a ListTag, inside a data list, will insert a ListTag inside the returned ListTag, as you would expect).
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L307

Name<ScriptTag.queues>
ReturnsListTag(QueueTag)
DescriptionReturns all queues which are running for this script.
Generated Example
- foreach <script.queues> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L416

Name<ScriptTag.relative_filename>
ReturnsElementTag
DescriptionReturns the filename that contains the script, relative to the denizen/ folder.
Generated Example
- narrate <script.relative_filename>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L255

Name<ScriptTag.step[(<player>)]>
ReturnsElementTag
DescriptionReturns the name of a script step that the player is currently on.
Must be an INTERACT script.
Generated Example
- narrate <script.step>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitScriptExtensions.java#L48

Name<ScriptTag.step_expiration[(<player>)]>
ReturnsTimeTag
DescriptionReturns the time that an interact script step expires at, if applied by Command:zap with a duration limit.
Generated Example
- flag server myflag expire:<script.step_expiration>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitScriptExtensions.java#L65

Name<ScriptTag.to_json>
ReturnsElementTag
DescriptionConverts the Script Container to a JSON array.
Best used with 'data' type scripts.
Generated Example
- narrate <script.to_json>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L388

Name<ScriptTag.to_yaml>
ReturnsElementTag
DescriptionConverts the Script Container to raw YAML text.
Best used with 'data' type scripts.
Generated Example
- narrate <script.to_yaml>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L401



Category: SecretTag


Name<SecretTag.key>
ReturnsElementTag
DescriptionReturns the secret key for this secret object.
Generated Example
- narrate <secret[my_secret_key].key>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/SecretTag.java#L158



Category: server


Name<server.advancement_types>
ReturnsListTag
DescriptionReturns a list of all registered advancement names.
Generally used with Tag:PlayerTag.has_advancement.
See also 🔗https://minecraft.wiki/w/Advancement.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L685

Name<server.area_notes_debug>
ReturnsMapTag
DescriptionGenerates a report about noted area tracking.
This tag is strictly for internal debugging reasons.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1809

Name<server.art_types>
ReturnsListTag
DescriptionReturns a list of all known art types.
Generally used with Tag:EntityTag.painting and Mechanism:EntityTag.painting.
This is only their Bukkit enum names, as seen at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Art.html.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L675

Name<server.available_processors>
ReturnsElementTag(Number)
DescriptionDeprecated in favor of Tag:util.available_processors
Deprecateduse util.available_processors
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2076

Name<server.ban_info[<address>].created_time>
ReturnsTimeTag
DescriptionReturns when the ip address's ban was created, if it is banned.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1464

Name<server.ban_info[<address>].expiration_time>
ReturnsTimeTag
DescriptionReturns the expiration of the ip address's ban, if it is banned.
Potentially can be null.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1436

Name<server.ban_info[<address>].reason>
ReturnsElementTag
DescriptionReturns the reason for the ip address's ban, if it is banned.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1453

Name<server.ban_info[<address>].source>
ReturnsElementTag
DescriptionReturns the source of the ip address's ban, if it is banned.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1480

Name<server.banned_addresses>
ReturnsListTag
DescriptionReturns a list of all banned ip addresses.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1401

Name<server.banned_players>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of all banned players.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1386

Name<server.biome_types>
ReturnsListTag(BiomeTag)
DescriptionReturns a list of all biomes known to the server.
Generally used with ObjectType:BiomeTag.
This is based on Bukkit Biome enum, as seen at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/Biome.html.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L730

Name<server.bossbar_viewers[<bossbar_id>]>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of players that should be able to see the given bossbar ID from Command:bossbar.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1588

Name<server.bukkit_version>
ReturnsElementTag
DescriptionReturns the version of Bukkit currently being used.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1077

Name<server.color_names>
ReturnsListTag
DescriptionDeprecated in favor of Tag:util.color_names
Deprecateduse util.color_names
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2180

Name<server.command_plugin[<name>]>
ReturnsPluginTag
DescriptionReturns the plugin that created a command (if known).
Example
# Should show "Denizen".
- narrate <server.command_plugin[ex].name>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L661

Name<server.commands>
ReturnsListTag
DescriptionReturns a list of all registered command names in Bukkit.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L649

Name<server.current_bossbars>
ReturnsListTag
DescriptionReturns a list of all currently active boss bar IDs from Command:bossbar.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1578

Name<server.current_tick>
ReturnsElementTag(Number)
DescriptionDeprecated in favor of Tag:util.current_tick
Deprecateduse util.current_tick
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2084

Name<server.current_time_millis>
ReturnsElementTag(Number)
DescriptionDeprecated in favor of Tag:util.current_time_millis
Deprecateduse util.current_time_millis
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2108

Name<server.damage_causes>
ReturnsListTag
DescriptionReturns a list of all registered damage causes.
Generally used with Event:entity damaged.
This is only their Bukkit enum names, as seen at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityDamageEvent.DamageCause.html.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L710

Name<server.debug_enabled>
ReturnsElementTag(Boolean)
DescriptionDeprecated in favor of Tag:util.debug_enabled
Deprecateduse util.debug_enabled
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2172

Name<server.delta_time_since_start>
ReturnsDurationTag
DescriptionDeprecated in favor of Tag:util.delta_time_since_start
Deprecateduse util.delta_time_since_start
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2092

Name<server.denizen_version>
ReturnsElementTag
DescriptionReturns the version of Denizen currently being used.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1067

Name<server.disk_free>
ReturnsElementTag(Number)
DescriptionDeprecated in favor of Tag:util.disk_free
Deprecateduse util.disk_free
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2020

Name<server.disk_total>
ReturnsElementTag(Number)
DescriptionDeprecated in favor of Tag:util.disk_total
Deprecateduse util.disk_total
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2028

Name<server.disk_usage>
ReturnsElementTag(Number)
DescriptionDeprecated in favor of Tag:util.disk_usage
Deprecateduse util.disk_usage
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2036

Name<server.effect_types>
ReturnsListTag
DescriptionReturns a list of all 'effect' types known to the server.
Generally used with Command:playeffect.
This is only their Bukkit enum names, as seen at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Effect.html.
Refer also to Tag:server.particle_types.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L841

Name<server.enchantments>
ReturnsListTag(EnchantmentTag)
DescriptionReturns a list of all enchantments known to the server.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L750

Name<server.entity_types>
ReturnsListTag
DescriptionReturns a list of all entity types known to the server.
Generally used with ObjectType:EntityTag.
This is only their Bukkit enum names, as seen at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/EntityType.html.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L784

Name<server.flag[<flag_name>]>
ReturnsObjectTag
DescriptionSee Tag:FlaggableObject.flag
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L605

Name<server.flag_expiration[<flag_name>]>
ReturnsTimeTag
DescriptionSee Tag:FlaggableObject.flag_expiration
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L596

Name<server.flag_map[<name>|...]>
ReturnsMapTag
DescriptionSee Tag:FlaggableObject.flag_map
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L625

Name<server.gamerules>
ReturnsListTag
DescriptionReturns a list of all available gamerules on the server.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L635

Name<server.generate_loot_table[id=<id>;location=<location>;(killer=<entity>);(entity=<entity>);(loot_bonus=<#>/{-1});(luck=<#.#>/{0})]>
ReturnsListTag(ItemTag)
DescriptionReturns a list of items from a loot table, given a map of input data.
Required input: id: the loot table ID, location: the location where it's being generated (LocationTag).
Optional inputs: killer: an online player (or player-type NPC) that is looting, entity: a dead entity being looted from (a valid EntityTag instance that is or was spawned in the world),
loot_bonus: the loot bonus level (defaults to -1) as an integer number, luck: the luck potion level (defaults to 0) as a decimal number.

Some inputs will be strictly required for some loot tables, and ignored for others.

A list of valid loot tables can be found here: 🔗https://minecraft.wiki/w/Loot_table#List_of_loot_tables
Note that the tree view represented on the wiki should be split by slashes for the input - for example, "cow" is under "entities" in the tree so "entities/cow" is how you input that.
CAUTION: Invalid loot table IDs will generate an empty list rather than an error.
Example
- give <server.generate_loot_table[id=chests/spawn_bonus_chest;killer=<player>;location=<player.location>]>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1740

Name<server.group_prefix[<group>]>
ReturnsElementTag
DescriptionReturns an ElementTag of a group's chat prefix.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1107

Name<server.group_prefix[<group>].world[<world>]>
ReturnsElementTag
DescriptionReturns an ElementTag of a group's chat prefix for the specified WorldTag.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1125

Name<server.group_suffix[<group>]>
ReturnsElementTag
DescriptionReturns an ElementTag of a group's chat suffix.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1141

Name<server.group_suffix[<group>].world[<world>]>
ReturnsElementTag
DescriptionReturns an ElementTag of a group's chat suffix for the specified WorldTag.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1159

Name<server.has_file[<name>]>
ReturnsElementTag(Boolean)
DescriptionDeprecated in favor of Tag:util.has_file
Deprecateduse util.has_file
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2116

Name<server.has_flag[<flag_name>]>
ReturnsElementTag(Boolean)
DescriptionSee Tag:FlaggableObject.has_flag
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L586

Name<server.has_permissions>
ReturnsElementTag(Boolean)
DescriptionReturns whether the server has a known permission plugin loaded.
Note: should not be considered incredibly reliable.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1045

Name<server.has_whitelist>
ReturnsElementTag(Boolean)
Mechanismserver.has_whitelist
DescriptionReturns whether the server's whitelist is active.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L561

Name<server.idle_timeout>
ReturnsDurationTag
Mechanismserver.idle_timeout
DescriptionReturns the server's current idle timeout limit (how long a player can sit still before getting kicked).
Internally used with Tag:PlayerTag.last_action_time.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1630

Name<server.is_banned[<address>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the given ip address is banned.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1414

Name<server.java_version>
ReturnsElementTag
DescriptionDeprecated in favor of Tag:util.java_version
Deprecateduse util.java_version
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2132

Name<server.last_reload>
ReturnsTimeTag
DescriptionDeprecated in favor of Tag:util.last_reload
Deprecateduse util.last_reload
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2156

Name<server.list_files[<path>]>
ReturnsListTag
DescriptionDeprecated in favor of Tag:util.list_files
Deprecateduse util.list_files
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2124

Name<server.list_flags>
ReturnsListTag
DescriptionSee Tag:FlaggableObject.list_flags
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L615

Name<server.map_cursor_types>
ReturnsListTag
DescriptionReturns a list of all map cursor types known to the server.
Generally used with Command:map and Language:Map Script Containers.
This is only their Bukkit enum names, as seen at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/map/MapCursor.Type.html.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L902

Name<server.match_offline_player[<name>]>
ReturnsPlayerTag
DescriptionReturns any player (online or offline) that best matches the input name.
EG, in a group of 'bo', 'bob', and 'bobby'... input 'bob' returns player object for 'bob',
input 'bobb' returns player object for 'bobby', and input 'b' returns player object for 'bo'.
When both an online player and an offline player match the name search, the online player will be returned.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1219

Name<server.match_player[<name>]>
ReturnsPlayerTag
DescriptionReturns the online player that best matches the input name.
EG, in a group of 'bo', 'bob', and 'bobby'... input 'bob' returns player object for 'bob',
input 'bobb' returns player object for 'bobby', and input 'b' returns player object for 'bo'.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1190

Name<server.material_types>
ReturnsListTag(MaterialTag)
DescriptionReturns a list of all materials known to the server.
Generally used with ObjectType:MaterialTag.
This is only types listed in the Bukkit Material enum, as seen at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L803

Name<server.max_players>
ReturnsElementTag(Number)
DescriptionReturns the maximum number of players allowed on the server.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1097

Name<server.motd>
ReturnsElementTag
DescriptionReturns the server's current MOTD.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1543

Name<server.nbt_attribute_types>
ReturnsListTag
DescriptionReturns a list of all registered attribute names.
Generally used with Tag:EntityTag.has_attribute.
This is only their Bukkit enum names, as seen at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/attribute/Attribute.html.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L700

Name<server.notes[<type>]>
ReturnsListTag
DescriptionDeprecated in favor of Tag:util.notes
Deprecateduse util.notes
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2004

Name<server.npc_registries>
ReturnsListTag
DescriptionReturns a list of all NPC registries.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2339

Name<server.npcs[(<registry>)]>
ReturnsListTag(NPCTag)
DescriptionReturns a list of all NPCs.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2353

Name<server.npcs_assigned[<assignment_script>]>
ReturnsListTag(NPCTag)
DescriptionReturns a list of all NPCs assigned to a specified script.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2268

Name<server.npcs_flagged[<flag_name>]>
ReturnsListTag(NPCTag)
DescriptionReturns a list of all NPCs with a specified flag set.
Can use "!<flag_name>" style to only return NPCs *without* the flag.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2314

Name<server.npcs_named[<name>]>
ReturnsListTag(NPCTag)
DescriptionReturns a list of NPCs with a certain name.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2250

Name<server.object_is_valid[<object>]>
ReturnsElementTag(Boolean)
DescriptionDeprecated in favor of Tag:ObjectTag.exists or Tag:ObjectTag.is_truthy
DeprecatedUse 'exists' or 'is_truthy'
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L548

Name<server.offline_ops>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of all offline ops.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1526

Name<server.offline_players>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of all offline players.
This specifically excludes currently online players.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1368

Name<server.online_ops>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of all online ops.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1509

Name<server.online_players>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of all online players.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1353

Name<server.online_players_flagged[<flag_name>]>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of all online players with a specified flag set.
Can use "!<flag_name>" style to only return players *without* the flag.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1256

Name<server.ops>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of all ops, online or not.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1494

Name<server.parse_bukkit_item[<serial>]>
ReturnsItemTag
DescriptionReturns the ItemTag resultant from parsing Bukkit item serialization data (under subkey "item").
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L175

Name<server.particle_types>
ReturnsListTag
DescriptionReturns a list of all particle effect types known to the server.
Generally used with Command:playeffect.
This is only their Bukkit enum names, as seen at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Particle.html.
Refer also to Tag:server.effect_types.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L830

Name<server.pattern_types>
ReturnsListTag
DescriptionReturns a list of all banner patterns known to the server.
Generally used with Tag:ItemTag.patterns.
This is only their Bukkit enum names, as seen at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/banner/PatternType.html.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L852

Name<server.permission_groups>
ReturnsListTag
DescriptionReturns a list of all permission groups on the server.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1175

Name<server.players>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of all players that have ever played on the server, online or not.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1337

Name<server.players_flagged[<flag_name>]>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of all players (online or offline) with a specified flag set.
Warning: this will cause the player flag cache to temporarily fill with ALL historical playerdata.
Can use "!<flag_name>" style to only return players *without* the flag.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1281

Name<server.plugins>
ReturnsListTag(PluginTag)
DescriptionGets a list of currently enabled PluginTags from the server.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1322

Name<server.plugins_handling_event[<bukkit_event>]>
ReturnsListTag(PluginTag)
DescriptionReturns a list of all plugins that handle a given Bukkit event.
Can specify by ScriptEvent name ("PlayerBreaksBlock"), or by full Bukkit class name ("org.bukkit.event.block.BlockBreakEvent").
This is a primarily a dev tool and is not necessarily useful to most players or scripts.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1698

Name<server.port>
ReturnsElementTag(Number)
DescriptionReturns the port that the server is running on.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1620

Name<server.potion_effect_types>
ReturnsListTag
DescriptionReturns a list of all potion effects known to the server.
Can be used with Command:cast.
This is only their Bukkit enum names, as seen at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionEffectType.html.
Refer also to Tag:server.potion_types.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L862

Name<server.potion_types>
ReturnsListTag
DescriptionReturns a list of all potion types known to the server.
This is only their Bukkit enum names, as seen at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionType.html.
Refer also to Tag:server.potion_effect_types.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L882

Name<server.ram_allocated>
ReturnsElementTag(Number)
DescriptionDeprecated in favor of Tag:util.ram_allocated
Deprecateduse util.ram_allocated
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2044

Name<server.ram_free>
ReturnsElementTag(Number)
DescriptionDeprecated in favor of Tag:util.ram_free
Deprecateduse util.ram_free
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2060

Name<server.ram_max>
ReturnsElementTag(Number)
DescriptionDeprecated in favor of Tag:util.ram_max
Deprecateduse util.ram_max
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2052

Name<server.ram_usage>
ReturnsElementTag(Number)
DescriptionDeprecated in favor of Tag:util.ram_usage
Deprecateduse util.ram_usage
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2068

Name<server.real_time_since_start>
ReturnsDurationTag
DescriptionDeprecated in favor of Tag:util.real_time_since_start
Deprecateduse util.real_time_since_start
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2100

Name<server.recent_tps>
ReturnsListTag
DescriptionReturns the 3 most recent ticks per second measurements.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1606

Name<server.recipe_ids[(<type>)]>
ReturnsListTag
DescriptionReturns a list of all recipe IDs on the server.
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, CAMPFIRE, STONECUTTING, SMITHING, BREWING)
to limit to just recipes of that type.
Brewing recipes are only supported on Paper, and only custom ones are available.
Note: this will produce an error if all recipes of any one type have been removed from the server, due to an error in Spigot.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L196

Name<server.recipe_items[<id>]>
ReturnsListTag(ItemTag)
DescriptionReturns a list of the items used as input to the recipe within the input ID.
This is formatted equivalently to the item script recipe input, with "material:" for non-exact matches, and a full ItemTag for exact matches.
Note that this won't represent all recipes perfectly (primarily those with multiple input choices per slot).
Brewing recipes are only supported on Paper, and only custom ones are available.
For brewing recipes, currently "matcher:<item matcher>" input options are only supported in recipes added by Denizen.
For furnace-style and stonecutting recipes, this will return a list with only 1 item.
For shaped recipes, this will include 'air' for slots that are part of the shape but don't require an item.
For smithing recipes, this will return a list with the 'base' item and the 'addition'.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L226

Name<server.recipe_result[<id>]>
ReturnsItemTag
DescriptionReturns the item that a recipe will create when crafted.
Brewing recipes are only supported on Paper, and only custom ones are available.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L334

Name<server.recipe_shape[<id>]>
ReturnsElementTag
DescriptionReturns the shape of a shaped recipe, like '2x2' or '3x3'.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L300

Name<server.recipe_type[<id>]>
ReturnsElementTag
DescriptionReturns the type of recipe that the given recipe ID is.
Will be one of FURNACE, BLASTING, SHAPED, SHAPELESS, SMOKING, CAMPFIRE, STONECUTTING, SMITHING, BREWING.
Brewing recipes are only supported on Paper, and only custom ones are available.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L314

Name<server.scoreboard[<board>].exists>
ReturnsElementTag(Boolean)
DescriptionReturns whether a given scoreboard exists on the server.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L381

Name<server.scoreboard[(<board>)].objective[<name>].criteria>
ReturnsElementTag
DescriptionReturns the criteria specified for the given objective.
Optionally, specify which scoreboard to use.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L420

Name<server.scoreboard[(<board>)].objective[<name>].display_name>
ReturnsElementTag
DescriptionReturns the display name specified for the given objective.
Optionally, specify which scoreboard to use.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L432

Name<server.scoreboard[(<board>)].objective[<name>].display_slot>
ReturnsElementTag
DescriptionReturns the display slot specified for the given objective. Can be any of 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/scoreboard/DisplaySlot.html.
Note that not all objectives have a display slot.
Optionally, specify which scoreboard to use.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L444

Name<server.scoreboard[(<board>)].objective[<name>].score[<input>]>
ReturnsElementTag(Number)
DescriptionReturns the current score in the objective for the given input.
Input can be a PlayerTag (translates to name internally), EntityTag (translates to UUID internally) or any plaintext score holder label.
Optionally, specify which scoreboard to use.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L458

Name<server.scoreboard[(<board>)].objectives>
ReturnsListTag
DescriptionReturns a list of all objective names in the scoreboard.
Optionally, specify which scoreboard to use.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L396

Name<server.scoreboard[(<board>)].team_names>
ReturnsListTag
DescriptionReturns a list of the names of all teams within the scoreboard.
Optionally, specify which scoreboard to use.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L484

Name<server.scoreboard[(<board>)].team[<team>].members>
ReturnsListTag
DescriptionReturns a list of all members of a scoreboard team. Generally returns as a list of names or text entries.
Members are not necessarily written in any given format and are not guaranteed to validly fit any requirements.
Optionally, specify which scoreboard to use.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L508

Name<server.scoreboard[(<board>)].team[<team>].prefix>
ReturnsElementTag
DescriptionReturns the team's prefix.
Optionally, specify which scoreboard to use.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L521

Name<server.scoreboard[(<board>)].team[<team>].suffix>
ReturnsElementTag
DescriptionReturns the team's suffix.
Optionally, specify which scoreboard to use.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L533

Name<server.scoreboards>
ReturnsListTag
DescriptionReturns a list of scoreboard IDs currently registered on the server.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L356

Name<server.scripts>
ReturnsListTag(ScriptTag)
DescriptionDeprecated in favor of Tag:util.scripts
Deprecateduse util.scripts
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2148

Name<server.selected_npc>
ReturnsNPCTag
DescriptionReturns the server's currently selected NPC.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2239

Name<server.slot_id[<slot>]>
ReturnsElementTag(Number)
DescriptionReturns the slot ID number for an input slot (see Language:Slot Inputs).
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L164

Name<server.sound_types>
ReturnsListTag
DescriptionReturns a list of all sounds known to the server.
Generally used with Command:playsound.
This is only their Bukkit enum names, as seen at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L820

Name<server.spawned_npcs_flagged[<flag_name>]>
ReturnsListTag(NPCTag)
DescriptionReturns a list of all spawned NPCs with a specified flag set.
Can use "!<flag_name>" style to only return NPCs *without* the flag.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2289

Name<server.sql_connections>
ReturnsListTag
DescriptionDeprecated in favor of Tag:util.sql_connections
Deprecateduse util.sql_connections
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2140

Name<server.stack_trace>
ReturnsElementTag
DescriptionDeprecated in favor of Tag:util.stack_trace
Deprecateduse util.stack_trace
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2164

Name<server.started_time>
ReturnsTimeTag
DescriptionDeprecated in favor of Tag:util.started_time
Deprecateduse util.started_time
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2012

Name<server.statistic_type[<statistic>]>
ReturnsElementTag
DescriptionReturns the qualifier type of the given statistic, will be one of 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Statistic.Type.html.
Generally relevant to usage with Tag:PlayerTag.statistic.qualifier.
Refer also to Tag:server.statistic_types.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L960

Name<server.statistic_types[(<type>)]>
ReturnsListTag
DescriptionReturns a list of all statistic types known to the server.
Generally used with Tag:PlayerTag.statistic.
This is only their Bukkit enum names, as seen at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Statistic.html.
Optionally, specify a type to limit to statistics of a given type. Can be any of 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Statistic.Type.html.
Refer also to Tag:server.statistic_type.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L922

Name<server.structure_types>
ReturnsListTag
DescriptionReturns a list of all structure types known to the server.
Generally used with Tag:LocationTag.find.structure.within.
This is NOT their Bukkit names, as seen at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/StructureType.html.
Instead these are the internal names tracked by Spigot and presumably matching Minecraft internals.
These are all lowercase, as the internal names are lowercase and supposedly are case-sensitive.
It is unclear why the "StructureType" class in Bukkit is not simply an enum as most similar listings are.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L944

Name<server.teleport_causes>
ReturnsListTag
DescriptionReturns a list of all registered player teleport causes.
Generally used with Event:entity teleports.
See Language:teleport cause for the current list of causes.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L720

Name<server.tree_types>
ReturnsListTag
DescriptionReturns a list of all tree types known to the server.
Generally used with Mechanism:LocationTag.generate_tree.
This is only their Bukkit enum names, as seen at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/TreeType.html.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L892

Name<server.vanilla_entity_tags>
ReturnsListTag
DescriptionReturns a list of vanilla tags applicable to entity types. See also 🔗https://minecraft.wiki/w/Tag.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1642

Name<server.vanilla_material_tags>
ReturnsListTag
DescriptionReturns a list of vanilla tags applicable to blocks, fluids, or items. See also 🔗https://minecraft.wiki/w/Tag.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1670

Name<server.vanilla_tagged_entities[<tag>]>
ReturnsListTag(EntityTag)
DescriptionReturns a list of entity types referred to by the specified vanilla tag. See also 🔗https://minecraft.wiki/w/Tag.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1652

Name<server.vanilla_tagged_materials[<tag>]>
ReturnsListTag(MaterialTag)
DescriptionReturns a list of materials referred to by the specified vanilla tag. See also 🔗https://minecraft.wiki/w/Tag.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1680

Name<server.version>
ReturnsElementTag
DescriptionReturns the version of the server.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1087

Name<server.view_distance>
ReturnsElementTag(Number)
DescriptionReturns the server's current view distance.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1553

Name<server.whitelisted_players>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of all players whitelisted on this server.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L572

Name<server.world_types>
ReturnsListTag
DescriptionReturns a list of all world types known to the server.
Generally used with Command:createworld.
This is only their Bukkit enum names, as seen at 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/WorldType.html.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L912

Name<server.worlds>
ReturnsListTag(WorldTag)
DescriptionReturns a list of all worlds.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1307

Name<server.economy.currency_name[<#.#>]>
ReturnsElementTag
DescriptionReturns the server's economy currency name (automatically singular or plural based on input value).
RequiresVault
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L125

Name<server.economy.currency_plural>
ReturnsElementTag
DescriptionReturns the server's economy currency name (in the plural form, like "Dollars").
RequiresVault
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L137

Name<server.economy.currency_singular>
ReturnsElementTag
DescriptionReturns the server's economy currency name (in the singular form, like "Dollar").
RequiresVault
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L149

Name<server.economy.format[<#.#>]>
ReturnsElementTag
DescriptionReturns the amount of money, formatted according to the server's economy.
RequiresVault
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L113

Name<server.has_economy>
ReturnsElementTag(Boolean)
DescriptionReturns whether the server has a known economy plugin loaded.
RequiresVault
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1056

Name<server.traits>
ReturnsListTag
DescriptionReturns a list of all available NPC traits on the server.
RequiresCitizens
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2376



Category: tern


Name<tern[<condition>].pass[<result>].fail[<result>]>
ReturnsObjectTag
DescriptionReturns either the 'pass' input, or 'fail' input depending on the outcome of the condition.
The 'pass' input will be returned when the condition returns 'true', otherwise the 'fail' input will be returned.
Example: '<tern[<player.is_spawned>].pass[Player is spawned!].fail[Player is not spawned!]>'
Consider instead using Tag:ElementTag.if_true.if_false
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/TernaryTagBase.java#L23



Category: TimeTag


Name<TimeTag.add[<duration>]>
ReturnsTimeTag
DescriptionReturns the time that is this TimeTag plus a duration.
For example, a TimeTag on Monday, '.add[1d]', will return a time on Tuesday.
Generated Example
- flag server myflag expire:<util.time_now.add[12h]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L629

Name<TimeTag.day>
ReturnsElementTag(Number)
DescriptionReturns the day-of-month of this TimeTag, starting at 1.
Generated Example
- narrate "the number value is <util.time_now.day>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L287

Name<TimeTag.day_of_week>
ReturnsElementTag(Number)
DescriptionReturns the day-of-week of this TimeTag, with Monday as 1 and Sunday as 7 (per ISO standard).
Generated Example
- narrate "the number value is <util.time_now.day_of_week>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L307

Name<TimeTag.day_of_week_name>
ReturnsElementTag
DescriptionReturns the name of the day-of-week of this TimeTag, like 'MONDAY'.
Generated Example
- narrate <util.time_now.day_of_week_name>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L317

Name<TimeTag.day_of_year>
ReturnsElementTag(Number)
DescriptionReturns the day-of-year of this TimeTag, from 1 to 365 (or 366 in leap years).
Generated Example
- narrate "the number value is <util.time_now.day_of_year>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L297

Name<TimeTag.days_in_month>
ReturnsElementTag(Number)
DescriptionReturns the number of days in the month that this TimeTag is within.
Generated Example
- narrate "the number value is <util.time_now.days_in_month>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L277

Name<TimeTag.duration_since[<time>]>
ReturnsDurationTag
DescriptionReturns the DurationTag that passed between the input time and this time.
That is, a.duration_since[b] returns (a - b).
For example, a time on Monday, .duration_since[a time on Sunday], will return '1d'.
Generated Example
- flag server myflag expire:<util.time_now.duration_since[<util.time_now>]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L666

Name<TimeTag.epoch_millis>
ReturnsElementTag(Number)
DescriptionReturns the number of milliseconds between this TimeTag and the Unix Epoch (Jan. 1st 1970).
Generated Example
- narrate "the number value is <util.time_now.epoch_millis>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L367

Name<TimeTag.format[(<format>)]>
ReturnsElementTag
DescriptionReturns the time, formatted to the date format specification given.
If no format input is given, uses "yyyy/MM/dd HH:mm:ss".
The optional input to this tag uses semi-standard date format symbols, such as 'yyyy' to mean a 4-digit year or 'MM' to mean a 2-digit month.
There are a variety of additional symbols accepted, as listed under "Patterns for Formatting and Parsing" on 🔗https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html.
Generated Example
- narrate <util.time_now.format>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L698

Name<TimeTag.from_now>
ReturnsDurationTag
DescriptionReturns the DurationTag between this time object and the real current system time.
The value will always be positive.
This is equivalent to the absolute value of ".duration_since[<util.time_now>]", and exists primarily as a convenience tag.
For example, a TimeTag for Tuesday will return a DurationTag of '1d' when the tag is used on a Monday.
A TimeTag for Sunday will also return a DurationTag of '1d' when used on a Monday.
If positive/negative differences are required, consider instead using Tag:TimeTag.duration_since.
Generated Example
- ratelimit <player> <util.time_now.from_now>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L651

Name<TimeTag.hour>
ReturnsElementTag(Number)
DescriptionReturns the hour-of-day of this TimeTag, from 1 to 24.
Generated Example
- narrate "the number value is <util.time_now.hour>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L327

Name<TimeTag.is_after[<time>]>
ReturnsElementTag(Boolean)
DescriptionReturns true if this time object comes after the input time value, or false if it's before (or equal).
Generated Example
- if <util.time_now.is_after[<util.time_now>]>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L678

Name<TimeTag.is_before[<time>]>
ReturnsElementTag(Boolean)
DescriptionReturns true if this time object comes before the input time value, or false if it's after (or equal).
Generated Example
- if <util.time_now.is_before[<util.time_now>]>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L688

Name<TimeTag.last_day_of_month[<day>]>
ReturnsTimeTag
DescriptionReturns the timetag of the last occurrence of the specified day-of-month.
This can either be in the same month, or the previous month.
For example, last_day_of_month[3] on a TimeTag on February 1st will return the 3rd of January.
The hour/minute/second/millisecond will be zeroed.
Be careful with inputs of 29/30/31, as only some months contain those days.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L543

Name<TimeTag.last_day_of_week[<day>]>
ReturnsTimeTag
DescriptionReturns the timetag of the previous day of the specified input day-of-week (like 'sunday').
The hour/minute/second/millisecond will be zeroed.
If the TimeTag is on the input day, will return a day 7 days before then.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L487

Name<TimeTag.last_hour_of_day[<hour>]>
ReturnsTimeTag
DescriptionReturns the timetag that represents the previous time the specified hour number was hit.
For example, if the input hour is '14', and the original TimeTag is 5 AM, the return will be 2 PM yesterday.
If the input is '14' and the TimeTag is 5 PM, the return will be 2 PM today.
The minute/second/millisecond will be zeroed.
If the input hour is 5, and the TimeTag is at 5 AM, will return the same day.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L447

Name<TimeTag.millisecond>
ReturnsElementTag(Number)
DescriptionReturns the millisecond of this TimeTag, from 0 to 999.
Generated Example
- narrate "the number value is <util.time_now.millisecond>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L357

Name<TimeTag.minute>
ReturnsElementTag(Number)
DescriptionReturns the minute-of-hour of this TimeTag, from 0 to 59.
Generated Example
- narrate "the number value is <util.time_now.minute>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L337

Name<TimeTag.month>
ReturnsElementTag(Number)
DescriptionReturns the month of this TimeTag, where January is 1 and December is 12.
Generated Example
- narrate "the number value is <util.time_now.month>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L257

Name<TimeTag.month_name>
ReturnsElementTag
DescriptionReturns the name of the month of this TimeTag, like 'JANUARY'.
Generated Example
- narrate <util.time_now.month_name>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L267

Name<TimeTag.next_day_of_month[<day>]>
ReturnsTimeTag
DescriptionReturns the timetag of the next occurrence of the specified day-of-month.
This can either be in the same month, or the next month.
For example, next_day_of_month[1] on a TimeTag on January 3rd will return the 1st of February.
The hour/minute/second/millisecond will be zeroed.
Be careful with inputs of 29/30/31, as only some months contain those days.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L571

Name<TimeTag.next_day_of_week[<day>]>
ReturnsTimeTag
DescriptionReturns the timetag of the next day of the specified input day-of-week (like 'thursday').
The hour/minute/second/millisecond will be zeroed.
If the TimeTag is on the input day, will return a day 7 days from then.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L515

Name<TimeTag.next_hour_of_day[<hour>]>
ReturnsTimeTag
DescriptionReturns the timetag that represents the next time the specified hour number will be hit.
For example, if the input hour is '14', and the original TimeTag is 5 AM, the return will be 2 PM today.
If the input is '14' and the TimeTag is 5 PM, the return will be 2 PM tomorrow.
The minute/second/millisecond will be zeroed.
If the input hour is 5, and the TimeTag is at 5 AM, will return the next day.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L467

Name<TimeTag.second>
ReturnsElementTag(Number)
DescriptionReturns the second-of-minute of this TimeTag, from 0 to 59.
Generated Example
- narrate "the number value is <util.time_now.second>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L347

Name<TimeTag.start_of_day>
ReturnsTimeTag
DescriptionReturns this time tag, with the hour/minute/second/millisecond zeroed (that is, midnight the morning of the same day).
Generated Example
- flag server myflag expire:<util.time_now.start_of_day>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L619

Name<TimeTag.start_of_month>
ReturnsTimeTag
DescriptionReturns this time tag, with the day/hour/minute/second/millisecond zeroed (that is, midnight the morning of the first day of the same month).
Generated Example
- flag server myflag expire:<util.time_now.start_of_month>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L609

Name<TimeTag.start_of_year>
ReturnsTimeTag
DescriptionReturns this time tag, with the month/day/hour/minute/second/millisecond zeroed (that is, midnight the morning of the first day of the same year).
Generated Example
- flag server myflag expire:<util.time_now.start_of_year>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L599

Name<TimeTag.sub[<duration>]>
ReturnsTimeTag
DescriptionReturns the time that is this TimeTag minus a duration.
For example, a TimeTag on Monday, '.sub[1d]', will return a time on Sunday.
Generated Example
- flag server myflag expire:<util.time_now.sub[1m]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L640

Name<TimeTag.time_zone_id>
ReturnsElementTag
DescriptionReturns the ID of the time zone of this TimeTag.
Generated Example
- narrate <util.time_now.time_zone_id>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L387

Name<TimeTag.time_zone_name>
ReturnsElementTag
DescriptionReturns the display name of the time zone of this TimeTag.
Generated Example
- narrate <util.time_now.time_zone_name>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L397

Name<TimeTag.time_zone_offset>
ReturnsElementTag
DescriptionReturns the time zone offset (from UTC) of this TimeTag.
Generated Example
- narrate <util.time_now.time_zone_offset>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L377

Name<TimeTag.to_local>
ReturnsTimeTag
DescriptionReturns a copy of the TimeTag, converted to the local time zone.
Generated Example
- flag server myflag expire:<util.time_now.to_local>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L427

Name<TimeTag.to_utc>
ReturnsTimeTag
DescriptionReturns a copy of the TimeTag, converted to Universal Coordinated Time.
Generated Example
- flag server myflag expire:<util.time_now.to_utc>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L437

Name<TimeTag.to_zone[<zone>]>
ReturnsTimeTag
DescriptionReturns a copy of the TimeTag, converted to the specified time zone.
The hour (and when relevant: day/month/year) of this TimeTag will automatically be converted from the value for the original TimeTag's timezone to the new timezone.
For some zones, the minute might also change.
Zone input can be like 'UTC-5' or like 'America/New_York'
You can find a list of named zones here: 🔗https://en.wikipedia.org/wiki/List_of_tz_database_time_zones using the "TZ database name"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L407

Name<TimeTag.year>
ReturnsElementTag(Number)
DescriptionReturns the year of this TimeTag, like '2020'.
Generated Example
- narrate "the number value is <util.time_now.year>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L247

Name<TimeTag.format_discord[(<style>)]>
ReturnsElementTag
DescriptionReturns the time formatted for display on Discord, optionally using the specified style from 🔗https://discord.com/developers/docs/reference#message-formatting-timestamp-styles.
For example: <util.time_now.format_discord> or <util.time_now.format_discord[R]>
Note that style input, if used, is case sensitive.
Generated Example
- narrate <util.time_now.format_discord>
Groupextensions
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/properties/DiscordTimeTagExtensions.java#L10



Category: util


Name<util.available_processors>
ReturnsElementTag(Number)
DescriptionHow many virtual processors are available to the server.
(In general, Minecraft only uses one, unfortunately.)
Generated Example
- narrate "the number value is <util.available_processors>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L783

Name<util.color_names>
ReturnsListTag
DescriptionReturns a list of all color names recognized by ObjectType:ColorTag.
Generated Example
- foreach <util.color_names> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L430

Name<util.current_tick>
ReturnsElementTag(Number)
DescriptionReturns the number of ticks since the server was started.
Note that this is NOT an accurate indicator for real server uptime, as ticks fluctuate based on server lag.
Generated Example
- narrate "the number value is <util.current_tick>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L794

Name<util.current_time_millis>
ReturnsElementTag(Number)
DescriptionReturns the number of milliseconds since Jan 1, 1970.
Note that this can change every time the tag is read!
Use Tag:util.time_now if you need stable time.
Generated Example
- narrate "the number value is <util.current_time_millis>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L831

Name<util.debug_enabled>
ReturnsElementTag(Boolean)
DescriptionReturns whether script debug is currently globally enabled.
Generated Example
- if <util.debug_enabled>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L996

Name<util.default_encoding>
ReturnsElementTag
DescriptionReturns the name of the default system text encoding charset, such as "UTF-8".
Generated Example
- narrate <util.default_encoding>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L611

Name<util.delta_time_since_start>
ReturnsDurationTag
DescriptionReturns the duration of delta time since the server started.
Note that this is delta time, not real time, meaning it is calculated based on the server tick,
which may change longer or shorter than expected due to lag or other influences.
If you want real time instead of delta time, use Tag:util.real_time_since_start.
Generated Example
- flag server myflag expire:<util.delta_time_since_start>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L805

Name<util.disk_free>
ReturnsElementTag(Number)
DescriptionHow much remaining disk space is available to this server, in bytes.
This counts only the drive the server folder is on, not any other drives.
This may be limited below the actual drive capacity by operating system settings.
Generated Example
- narrate "the number value is <util.disk_free>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L702

Name<util.disk_total>
ReturnsElementTag(Number)
DescriptionHow much total disk space is on the drive containing this server, in bytes.
This counts only the drive the server folder is on, not any other drives.
Generated Example
- narrate "the number value is <util.disk_total>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L715

Name<util.disk_usage>
ReturnsElementTag(Number)
DescriptionHow much space on the drive is already in use, in bytes.
This counts only the drive the server folder is on, not any other drives.
This is approximately equivalent to "disk_total" minus "disk_free", but is not always exactly the same,
as this tag will not include space "used" by operating system settings that simply deny the server write access.
Generated Example
- narrate "the number value is <util.disk_usage>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L727

Name<util.e>
ReturnsElementTag(Decimal)
DescriptionReturns e (Euler's number): 2.7182818284590452354
Generated Example
- narrate "the decimal value is <util.e>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L410

Name<util.empty_list_entries[<#>]>
ReturnsListTag
DescriptionReturns a list of the specified size where each entry is blank (zero characters long).
Generated Example
- foreach <util.empty_list_entries[4]> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L315

Name<util.event_stats>
ReturnsElementTag
DescriptionReturns a simple debuggable stats report for all ScriptEvents during this server session.
Generated Example
- narrate <util.event_stats>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L591

Name<util.event_stats_data>
ReturnsListTag(MapTag)
DescriptionReturns the raw data for Tag:util.event_stats, as a ListTag of MapTags.
Generated Example
- foreach <util.event_stats_data> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L601

Name<util.has_file[<name>]>
ReturnsElementTag(Boolean)
DescriptionReturns true if the specified file exists. The starting path is /plugins/Denizen.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L642

Name<util.int_max>
ReturnsElementTag(Number)
DescriptionReturns the maximum value of a 32 bit signed integer (a java 'int'): 2147483647
Generated Example
- narrate "the number value is <util.int_max>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L350

Name<util.int_min>
ReturnsElementTag(Number)
DescriptionReturns the minimum value of a 32 bit signed integer (a java 'int'): -2147483648
Generated Example
- narrate "the number value is <util.int_min>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L360

Name<util.java_class_context>
ReturnsListTag
DescriptionReturns a list of class names in the current stack history.
More stable than Tag:util.stack_trace
This contains a lot of stray content, the first 4 to 20 or so classes in this list are likely irrelevant to what you're searching for.
Each entry in the list is a raw class name, like "com.denizenscript.denizencore.tags.core.UtilTagBase".
Class names may appear multiple times in a row if that class contains methods that call each other.
Generated Example
- foreach <util.java_class_context> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L981

Name<util.java_version>
ReturnsElementTag
DescriptionReturns the current Java version of the server.
Generated Example
- narrate <util.java_version>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L632

Name<util.last_reload>
ReturnsTimeTag
DescriptionReturns the time that Denizen scripts were last reloaded.
Generated Example
- flag server myflag expire:<util.last_reload>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L924

Name<util.list_denizen_commands>
ReturnsListTag
DescriptionReturns a list of all currently loaded Denizen commands.
Generated Example
- foreach <util.list_denizen_commands> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L420

Name<util.list_files[<path>]>
ReturnsListTag
DescriptionReturns a list of all files (and directories) in the specified directory. The starting path is /plugins/Denizen.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L663

Name<util.list_numbers[to=<#>;(from=<#>/{1});(every=<#>/{1})]>
ReturnsListTag
DescriptionReturns a list of integer numbers in the specified range.
You must specify at least the 'to' input, you can optionally specify 'from' (default 1), and 'every' (default 1).
Note that this generally should not be used as input to the 'foreach' command. Instead, use Command:repeat.
Example
# Narrates "1, 2, and 3"
- narrate <util.list_numbers[to=3].formatted>
Example
# Narrates "3, 4, and 5"
- narrate <util.list_numbers[from=3;to=5].formatted>
Example
# Narrates "4, 8, and 12"
- narrate <util.list_numbers[from=4;to=12;every=4].formatted>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L265

Name<util.list_numbers_to[<#>]>
ReturnsListTag
DescriptionReturns a list of integer numbers from 1 to the specified input number (inclusive).
Note that you should NEVER use this as the input to a "foreach" command. Instead, use Command:repeat.
In most cases, there's a better way to do what you're trying to accomplish than using this tag.
Consider instead using Tag:util.list_numbers
Generated Example
- foreach <util.list_numbers_to[3]> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L297

Name<util.list_tag_bases>
ReturnsListTag
DescriptionReturns a list of all currently loaded Denizen tag bases (including "player", "context", "util", "server", etc).
Generated Example
- foreach <util.list_tag_bases> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L440

Name<util.long_max>
ReturnsElementTag(Number)
DescriptionReturns the maximum value of a 64 bit signed integer (a java 'long'): 9223372036854775807
Generated Example
- narrate "the number value is <util.long_max>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L370

Name<util.long_min>
ReturnsElementTag(Number)
DescriptionReturns the minimum value of a 64 bit signed integer (a java 'long'): -9223372036854775808
Generated Example
- narrate "the number value is <util.long_min>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L380

Name<util.mongo_connections>
ReturnsElementTag
DescriptionReturns a list of all Mongo connections opened by Command:mongo.
Generated Example
- narrate <util.mongo_connections>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L902

Name<util.notes[<type>]>
ReturnsListTag
DescriptionLists all saved notable objects of a specific type currently on the server.
Valid types: locations, cuboids, ellipsoids, inventories, polygons
This is primarily intended for debugging purposes, and it's best to avoid using this in a live script if possible.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L843

Name<util.parse_yaml[<yaml>]>
ReturnsMapTag
DescriptionParses the input YAML or JSON text into a MapTag.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L566

Name<util.pi>
ReturnsElementTag(Decimal)
DescriptionReturns PI: 3.14159265358979323846
Generated Example
- narrate "the decimal value is <util.pi>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L390

Name<util.queues>
ReturnsListTag(QueueTag)
DescriptionReturns a list of all currently running queues on the server.
Generated Example
- foreach <util.queues> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L581

Name<util.ram_allocated>
ReturnsElementTag(Number)
DescriptionHow much RAM is allocated to the server, in bytes (total memory).
This is how much of the system memory is reserved by the Java process, NOT how much is actually in use by the minecraft server.
Generated Example
- narrate "the number value is <util.ram_allocated>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L741

Name<util.ram_free>
ReturnsElementTag(Number)
DescriptionHow much RAM is unused but available on the server, in bytes (free memory).
Generated Example
- narrate "the number value is <util.ram_free>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L762

Name<util.ram_max>
ReturnsElementTag(Number)
DescriptionHow much RAM is available to the server (total), in bytes (max memory).
Generated Example
- narrate "the number value is <util.ram_max>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L752

Name<util.ram_usage>
ReturnsElementTag(Number)
DescriptionHow much RAM is used by the server, in bytes (free memory).
Equivalent to ram_max minus ram_free
Generated Example
- narrate "the number value is <util.ram_usage>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L772

Name<util.random_boolean>
ReturnsElementTag(Boolean)
DescriptionReturns a random boolean (true or false). Essentially a coin flip.
Generated Example
- if <util.random_boolean>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L204

Name<util.random_chance[<percent>]>
ReturnsElementTag(Boolean)
DescriptionReturns a random boolean (true or false) with the given percent chance (from 0 to 100).
Example
- if <util.random_chance[25]>:
    - narrate "This happens 25% of the time"
- else:
    - narrate "This happens 75% of the time"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L189

Name<util.random_decimal>
ReturnsElementTag(Decimal)
DescriptionReturns a random decimal number from 0 to 1.
Generated Example
- narrate "the decimal value is <util.random_decimal>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L179

Name<util.random_gauss>
ReturnsElementTag(Decimal)
DescriptionReturns a random decimal number with a gaussian distribution.
70% of all results will be within the range of -1 to 1.
Generated Example
- narrate "the decimal value is <util.random_gauss>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L214

Name<util.random_simplex[x=<#.#>;(y=<#.#>);(z=<#.#>);(w=<#.#>)]>
ReturnsElementTag(Decimal)
DescriptionReturns a pseudo-random decimal number from -1 to 1, based on a Simplex Noise algorithm. See 🔗https://en.wikipedia.org/wiki/Simplex_noise
Input map is like "x=1.0", or "x=1.0;y=2.0", or "x=1.0;y=2.0;z=3" or "x=1;y=2;z=3;w=4"
(That is: 1d, 2d, 3d, or 4d).
Generated Example
- narrate "the decimal value is <util.random_simplex>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L235

Name<util.random_uuid>
ReturnsElementTag
DescriptionReturns a random unique ID.
Generated Example
- narrate <util.random_uuid>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L225

Name<util.random.boolean>
ReturnsElementTag(Boolean)
DescriptionDeprecated in favor of Tag:util.random_boolean
Deprecateduse 'util.random_boolean' with a '_'
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L124

Name<util.random.decimal>
ReturnsElementTag(Decimal)
DescriptionDeprecated in favor of Tag:util.random_decimal
Deprecateduse 'util.random_decimal' with a '_'
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L112

Name<util.random.decimal[<#.#>].to[<#.#>]>
ReturnsElementTag(Decimal)
DescriptionReturns a random decimal number between the 2 specified decimal numbers, inclusive.
Example
# Will narrate '1.5', or '1.75', or '1.01230123', or any other decimal in range.
- narrate <util.random.decimal[1].to[2]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L85

Name<util.random.duuid[(<source>)]>
ReturnsElementTag
DescriptionReturns a random 'denizen' unique ID, which is made of a randomly generated sentence.
Optionally specify the source context to base the value on.
There is no guarantee of format or content of the returned value - generally, use any other random tag instead of this.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L160

Name<util.random.gauss>
ReturnsElementTag(Decimal)
DescriptionDeprecated in favor of Tag:util.random_gauss
Deprecateduse 'util.random_gauss' with a '_'
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L136

Name<util.random.int[<#>].to[<#>]>
ReturnsElementTag(Number)
DescriptionReturns a random integer number between the 2 specified integer numbers, inclusive.
Example
# Will narrate '1', '2', or '3'
- narrate <util.random.int[1].to[3]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L58

Name<util.random.uuid>
ReturnsElementTag
DescriptionDeprecated in favor of Tag:util.random_uuid
Deprecateduse 'util.random_uuid' with a '_'
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L148

Name<util.real_time_since_start>
ReturnsDurationTag
DescriptionReturns the duration of real time since the server started.
Note that this is real time, not delta time, meaning that the it is accurate to the system clock, not the server's tick.
System clock changes may cause this value to become inaccurate.
In many cases Tag:util.delta_time_since_start is preferable.
Generated Example
- flag server myflag expire:<util.real_time_since_start>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L818

Name<util.redis_connections>
ReturnsListTag
DescriptionReturns a list of all Redis connections opened by Command:redis.
Generated Example
- foreach <util.redis_connections> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L890

Name<util.reflect_class[<name>]>
ReturnsJavaReflectedObjectTag
DescriptionReturns a reflected reference to the class of the given full class name.
Note that the class-name input is case-sensitive.
This can be used like having an object of that class, but cannot read non-static fields.
Example
# Narrates the current NMS version known to Denizen, for example "v1_19"
- narrate <util.reflect_class[com.denizenscript.denizen.nms.NMSHandler].read_field[version]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L934

Name<util.runlater_ids>
ReturnsListTag
DescriptionReturns a list of all scheduled task IDs for Command:runlater.
Note that usages of runlater that didn't specify an ID will not show up here.
Generated Example
- foreach <util.runlater_ids> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L621

Name<util.scripts>
ReturnsListTag(ScriptTag)
DescriptionGets a list of all scripts currently loaded into Denizen.
Generated Example
- foreach <util.scripts> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L914

Name<util.short_max>
ReturnsElementTag(Number)
DescriptionReturns the maximum value of a 16 bit signed integer (a java 'short'): 32767
Generated Example
- narrate "the number value is <util.short_max>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L330

Name<util.short_min>
ReturnsElementTag(Number)
DescriptionReturns the minimum value of a 16 bit signed integer (a java 'short'): -32768
Generated Example
- narrate "the number value is <util.short_min>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L340

Name<util.sql_connections>
ReturnsListTag
DescriptionReturns a list of all SQL connections opened by Command:sql.
Generated Example
- foreach <util.sql_connections> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L866

Name<util.stack_trace>
ReturnsElementTag
DescriptionGenerates and shows a stack trace for the current context.
This tag is strictly for internal debugging reasons.
WARNING: Different Java versions generate different stack trace formats and details.
WARNING: Java internally limits stack trace generation in a variety of ways. This tag cannot be relied on to output anything.
For gathering stable context, prefer Tag:util.java_class_context
Generated Example
- narrate <util.stack_trace>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L967

Name<util.started_time>
ReturnsTimeTag
DescriptionReturns the time the server started.
Generated Example
- flag server myflag expire:<util.started_time>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L692

Name<util.tau>
ReturnsElementTag(Decimal)
DescriptionReturns Tau: 6.28318530717958647692
Generated Example
- narrate "the decimal value is <util.tau>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L400

Name<util.time_now>
ReturnsTimeTag
DescriptionReturns the current system date/time.
This value may be wrong if a server is currently heavily lagging, as it only updates once each tick.
Use Tag:util.current_time_millis if you need sub-tick precision.
Generated Example
- flag server myflag expire:<util.time_now>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L473



Category: ViveCraftPlayerTag


Name<ViveCraftPlayerTag.active_hand>
ReturnsElementTag
DescriptionReturns the active hand of the ViveCraftPlayer. Returns either right or left.
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/vivecraft/ViveCraftPlayerTag.java#L126

Name<ViveCraftPlayerTag.is_seated>
ReturnsElementTag(Boolean)
DescriptionReturns whether the ViveCraftPlayer sits or not.
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/vivecraft/ViveCraftPlayerTag.java#L136

Name<ViveCraftPlayerTag.position[head/left/right]>
ReturnsLocationTag
DescriptionReturns a LocationTag of the given position.
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/vivecraft/ViveCraftPlayerTag.java#L146



Category: WorldTag


Name<WorldTag.allows_animals>
ReturnsElementTag(Boolean)
DescriptionReturns whether animals can spawn in this world.
Generated Example
- if <player.location.world.allows_animals>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L448

Name<WorldTag.allows_monsters>
ReturnsElementTag(Boolean)
DescriptionReturns whether monsters can spawn in this world.
Generated Example
- if <player.location.world.allows_monsters>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L458

Name<WorldTag.allows_pvp>
ReturnsElementTag(Boolean)
DescriptionReturns whether player versus player combat is allowed in this world.
Generated Example
- if <player.location.world.allows_pvp>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L468

Name<WorldTag.ambient_spawn_limit>
ReturnsElementTag(Number)
MechanismWorldTag.ambient_spawn_limit
DescriptionReturns the number of ambient mobs that can spawn in a chunk in this world.
Generated Example
- narrate "the number value is <player.location.world.ambient_spawn_limit>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L489

Name<WorldTag.animal_spawn_limit>
ReturnsElementTag(Number)
MechanismWorldTag.animal_spawn_limit
DescriptionReturns the number of animals that can spawn in a chunk in this world.
Generated Example
- narrate "the number value is <player.location.world.animal_spawn_limit>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L500

Name<WorldTag.auto_save>
ReturnsElementTag(Boolean)
MechanismWorldTag.auto_save
DescriptionReturns whether the world automatically saves.
Generated Example
- if <player.location.world.auto_save>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L478

Name<WorldTag.biomes>
ReturnsListTag(BiomeTag)
DescriptionReturns a list of all biomes in this world (including custom biomes).
Generated Example
- foreach <player.location.world.biomes> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L888

Name<WorldTag.border_center>
ReturnsLocationTag
DescriptionReturns the center of the world border in this world.
Generated Example
- teleport <player> <player.location.world.border_center>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L747

Name<WorldTag.border_damage>
ReturnsElementTag(Decimal)
DescriptionReturns the amount of damage caused by crossing the world border in this world.
Generated Example
- narrate "the decimal value is <player.location.world.border_damage>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L757

Name<WorldTag.border_damage_buffer>
ReturnsElementTag(Decimal)
DescriptionReturns the damage buffer of the world border in this world.
Generated Example
- narrate "the decimal value is <player.location.world.border_damage_buffer>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L767

Name<WorldTag.border_size>
ReturnsElementTag(Decimal)
DescriptionReturns the size of the world border in this world.
Generated Example
- narrate "the decimal value is <player.location.world.border_size>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L737

Name<WorldTag.border_warning_distance>
ReturnsElementTag(Number)
DescriptionReturns the warning distance of the world border in this world.
Generated Example
- narrate "the number value is <player.location.world.border_warning_distance>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L777

Name<WorldTag.border_warning_time>
ReturnsDurationTag
DescriptionReturns warning time of the world border in this world as a duration.
Generated Example
- ratelimit <player> <player.location.world.border_warning_time>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L787

Name<WorldTag.can_generate_structures>
ReturnsElementTag(Boolean)
DescriptionReturns whether the world will generate structures.
Generated Example
- if <player.location.world.can_generate_structures>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L343

Name<WorldTag.difficulty>
ReturnsElementTag
MechanismWorldTag.difficulty
DescriptionReturns the name of the difficulty level.
Generated Example
- narrate <player.location.world.difficulty>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L533

Name<WorldTag.dragon_portal_location>
ReturnsLocationTag
DescriptionReturns the location of the ender dragon exit portal, if any (only for end worlds).
Generated Example
- teleport <player> <player.location.world.dragon_portal_location>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L831

Name<WorldTag.duration_since_created>
ReturnsDurationTag
MechanismWorldTag.duration_since_created
DescriptionReturns the total duration of time since this world was first created.
Generated Example
- flag server myflag expire:<player.location.world.duration_since_created>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L588

Name<WorldTag.ender_dragon>
ReturnsEntityTag
DescriptionReturns the ender dragon entity currently fighting in this world, if any (only for end worlds).
Generated Example
- heal <player.location.world.ender_dragon>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L848

Name<WorldTag.enough_deep_sleeping[(<#>)]>
ReturnsElementTag(Boolean)
DescriptionReturns whether enough players have been in bed long enough for the night to advance (generally 100 ticks).
Loops through all online players, so is typically used after checking Tag:WorldTag.enough_sleeping
By default, automatically checks the playersSleepingPercentage gamerule,
but this can optionally be overridden by specifying a percentage integer.
Any integer above 100 will always yield 'false'. Requires at least one player to be sleeping to return 'true'.
Generated Example
- if <player.location.world.enough_deep_sleeping>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L951

Name<WorldTag.enough_sleeping[(<#>)]>
ReturnsElementTag(Boolean)
DescriptionReturns whether enough players are sleeping to prepare for the night to advance.
Typically used before checking Tag:WorldTag.enough_deep_sleeping
By default, automatically checks the playersSleepingPercentage gamerule,
but this can optionally be overridden by specifying a percentage integer.
Any integer above 100 will always yield 'false'. Requires at least one player to be sleeping to return 'true'.
Generated Example
- if <player.location.world.enough_sleeping>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L930

Name<WorldTag.entities[(<matcher>)]>
ReturnsListTag(EntityTag)
DescriptionReturns a list of entities in this world.
Optionally specify an entity type matcher to filter down to.
Generated Example
- foreach <player.location.world.entities> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L251

Name<WorldTag.environment>
ReturnsElementTag
DescriptionReturns the environment of the world: NORMAL, NETHER, or THE_END.
Generated Example
- narrate <player.location.world.environment>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L723

Name<WorldTag.gamerule[<gamerule>]>
ReturnsElementTag
DescriptionReturns the current value of the specified gamerule in the world.
Note that the name is case-sensitive... so "doFireTick" is correct, but "dofiretick" is not.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L797

Name<WorldTag.gamerule_map>
ReturnsMapTag
DescriptionReturns a map of all the current values of all gamerules in the world.
Generated Example
- foreach <player.location.world.gamerule_map> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L814

Name<WorldTag.gateway_locations>
ReturnsListTag(LocationTag)
DescriptionReturns a list of possible gateway portal locations, if any (only for end worlds).
Not all of these will necessarily generate.
In current implementation, this is a list of exactly 20 locations in a circle around the world origin (with radius of 96 blocks).
Generated Example
- foreach <player.location.world.gateway_locations> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L865

Name<WorldTag.hardcore>
ReturnsElementTag(Boolean)
MechanismWorldTag.hardcore
DescriptionReturns whether the world is in hardcore mode.
Generated Example
- if <player.location.world.hardcore>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L544

Name<WorldTag.has_storm>
ReturnsElementTag(Boolean)
DescriptionReturns whether there is currently a storm in this world.
ie, whether it is raining. To check for thunder, use Tag:WorldTag.thundering.
Generated Example
- if <player.location.world.has_storm>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L679

Name<WorldTag.is_day>
ReturnsElementTag(Boolean)
DescriptionReturns whether it is considered day in this world. Players are not allowed to sleep at this time.
Note that in certain worlds, this and Tag:WorldTag.is_night can both be 'false'! (The nether, for example!)
In typical worlds, this is 'true' if Tag:WorldTag.sky_darkness is less than 4.
To check the current time without storm interference, see Tag:WorldTag.time and related tags.
Generated Example
- if <player.location.world.is_day>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L984

Name<WorldTag.is_night>
ReturnsElementTag(Boolean)
DescriptionReturns whether it is considered night in this world. Players are typically allowed to sleep at this time.
Note that in certain worlds, this and Tag:WorldTag.is_day can both be 'false'! (The nether, for example!)
In typical worlds, this is 'true' if Tag:WorldTag.sky_darkness is 4 or higher.
To check the current time without storm interference, see Tag:WorldTag.time and related tags.
Generated Example
- if <player.location.world.is_night>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L997

Name<WorldTag.keep_spawn>
ReturnsElementTag(Boolean)
MechanismWorldTag.keep_spawn
DescriptionReturns whether the world's spawn area should be kept loaded into memory.
Generated Example
- if <player.location.world.keep_spawn>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L555

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

Name<WorldTag.loaded_chunks>
ReturnsListTag(ChunkTag)
DescriptionReturns a list of all the currently loaded chunks.
Generated Example
- foreach <player.location.world.loaded_chunks> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L353

Name<WorldTag.max_height>
ReturnsElementTag(Number)
DescriptionReturns the maximum block height of the world.
Generated Example
- narrate "the number value is <player.location.world.max_height>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L378

Name<WorldTag.min_height>
ReturnsElementTag(Number)
DescriptionReturns the minimum block height of the world.
Generated Example
- narrate "the number value is <player.location.world.min_height>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L388

Name<WorldTag.monster_spawn_limit>
ReturnsElementTag(Number)
MechanismWorldTag.monster_spawn_limit
DescriptionReturns the number of monsters that can spawn in a chunk in this world.
Generated Example
- narrate "the number value is <player.location.world.monster_spawn_limit>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L511

Name<WorldTag.moon_phase>
ReturnsElementTag(Number)
DescriptionReturns the current phase of the moon, as a number from 1 to 8.
Generated Example
- narrate "the number value is <player.location.world.moon_phase>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L665

Name<WorldTag.name>
ReturnsElementTag
DescriptionReturns the name of the world.
Generated Example
- narrate <player.location.world.name>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L424

Name<WorldTag.npcs>
ReturnsListTag(NPCTag)
DescriptionReturns a list of all NPCs in this world.
Generated Example
- foreach <player.location.world.npcs> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L318

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

Name<WorldTag.sea_level>
ReturnsElementTag(Number)
DescriptionReturns the level of the sea.
Generated Example
- narrate "the number value is <player.location.world.sea_level>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L368

Name<WorldTag.seed>
ReturnsElementTag
DescriptionReturns the world seed.
Generated Example
- narrate <player.location.world.seed>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L434

Name<WorldTag.sky_darkness>
ReturnsElementTag(Number)
DescriptionReturns the current darkness level of the sky in this world.
This is determined by an equation that factors in rain, thunder, and time of day.
When 4 or higher, players are typically allowed to sleep through the night.
Generated Example
- narrate "the number value is <player.location.world.sky_darkness>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L972

Name<WorldTag.spawn_location>
ReturnsLocationTag
MechanismWorldTag.spawn_location
DescriptionReturns the spawn location of the world.
Generated Example
- teleport <player> <player.location.world.spawn_location>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L398

Name<WorldTag.spawned_npcs>
ReturnsListTag(NPCTag)
DescriptionReturns a list of spawned NPCs in this world.
Generated Example
- foreach <player.location.world.spawned_npcs> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L301

Name<WorldTag.thunder_duration>
ReturnsDurationTag
MechanismWorldTag.thunder_duration
DescriptionReturns the duration of thunder.
Generated Example
- flag server myflag expire:<player.location.world.thunder_duration>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L690

Name<WorldTag.thundering>
ReturnsElementTag(Boolean)
MechanismWorldTag.thundering
DescriptionReturns whether it is currently thundering in this world.
Generated Example
- if <player.location.world.thundering>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L701

Name<WorldTag.ticks_per_animal_spawn>
ReturnsDurationTag
MechanismWorldTag.ticks_per_animal_spawns
DescriptionReturns the world's ticks per animal spawn value.
Generated Example
- ratelimit <player> <player.location.world.ticks_per_animal_spawn>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L566

Name<WorldTag.ticks_per_monster_spawn>
ReturnsDurationTag
MechanismWorldTag.ticks_per_monster_spawns
DescriptionReturns the world's ticks per monster spawn value.
Generated Example
- ratelimit <player> <player.location.world.ticks_per_monster_spawn>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L577

Name<WorldTag.time>
ReturnsElementTag(Number)
MechanismWorldTag.time
DescriptionReturns the relative in-game time of this world.
Generated Example
- narrate "the number value is <player.location.world.time>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L603

Name<WorldTag.time.duration>
ReturnsDurationTag
DescriptionReturns the relative in-game time of this world as a duration.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L611

Name<WorldTag.time.full>
ReturnsDurationTag
DescriptionReturns the in-game time of this world.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L622

Name<WorldTag.time.period>
ReturnsElementTag
DescriptionReturns the time as 'day', 'night', 'dawn', or 'dusk'.
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L633

Name<WorldTag.water_animal_spawn_limit>
ReturnsElementTag(Number)
MechanismWorldTag.water_animal_spawn_limit
DescriptionReturns the number of water animals that can spawn in a chunk in this world.
Generated Example
- narrate "the number value is <player.location.world.water_animal_spawn_limit>"
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L522

Name<WorldTag.weather_duration>
ReturnsDurationTag
MechanismWorldTag.weather_duration
DescriptionReturns the duration of storms.
Generated Example
- ratelimit <player> <player.location.world.weather_duration>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L712

Name<WorldTag.world_type>
ReturnsElementTag
DescriptionReturns the world type of the world.
Can return any enum from: 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/WorldType.html
Generated Example
- narrate <player.location.world.world_type>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L409

Name<WorldTag.simulation_distance>
ReturnsElementTag(Number)
MechanismWorldTag.simulation_distance
DescriptionReturns the simulation distance of this world. Chunks inside of this radius to players are ticked and processed.
See also Tag:WorldTag.view_distance
Generated Example
- narrate "the number value is <player.location.world.simulation_distance>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L916

Name<WorldTag.view_distance>
ReturnsElementTag(Number)
MechanismWorldTag.view_distance
DescriptionReturns the view distance of this world. Chunks are visible to players inside this radius.
See also Tag:WorldTag.simulation_distance
Generated Example
- narrate "the number value is <player.location.world.view_distance>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L902

Name<WorldTag.bigdoors>
ReturnsListTag(BigDoorsDoorTag)
DescriptionReturns a list of Big Doors doors in the world.
Generated Example
- foreach <player.location.world.bigdoors> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, Big Doors
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/bigdoors/BigDoorsWorldProperties.java#L48

Name<WorldTag.griefprevention_claims>
ReturnsListTag(GriefPreventionClaimTag)
DescriptionReturns a list of GriefPreventionClaim in this world.
Generated Example
- foreach <player.location.world.griefprevention_claims> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/griefprevention/GriefPreventionWorldProperties.java#L49

Name<WorldTag.has_region[<name>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether a region exists in this world for the given name.
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardWorldProperties.java#L75

Name<WorldTag.is_skyblock_world>
ReturnsElementTag(Boolean)
DescriptionReturns whether the world is used by A SkyBlock.
Generated Example
- if <player.location.world.is_skyblock_world>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, A SkyBlock
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/askyblock/ASkyBlockWorldProperties.java#L61

Name<WorldTag.list_regions>
ReturnsListTag(WorldGuardRegionTag)
DescriptionReturns a list of WorldGuard regions in this world.
Generated Example
- foreach <player.location.world.list_regions> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardWorldProperties.java#L60

Name<WorldTag.towny_enabled>
ReturnsElementTag(Boolean)
DescriptionReturns whether this world has Towny enabled.
Generated Example
- if <player.location.world.towny_enabled>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyWorldProperties.java#L51

Name<WorldTag.no_tick_view_distance>
ReturnsElementTag(Number)
MechanismWorldTag.no_tick_view_distance
DescriptionDeprecated: replaced by Minecraft's simulation_distance and view_distance config pairing
Generated Example
- narrate "the number value is <player.location.world.no_tick_view_distance>"
Grouppaper
RequiresPaper
Deprecatedreplaced by Minecraft's simulation_distance and view_distance config pairing
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperWorldExtensions.java#L11



Category: yaml


Name<yaml[<id>].contains[<path>]>
ReturnsElementTag(Boolean)
DescriptionReturns true if the file has the specified path.
Otherwise, returns false.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L722

Name<yaml[<id>].has_changes>
ReturnsElementTag(Boolean)
DescriptionReturns whether this YAML object has had changes since the last save or load.
Generated Example
- if <yaml.has_changes>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L832

Name<yaml[<id>].is_list[<path>]>
ReturnsElementTag(Boolean)
DescriptionReturns true if the specified path results in a list.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L733

Name<yaml.list>
ReturnsListTag
DescriptionReturns a list of all currently loaded YAML ID's.
Generated Example
- foreach <yaml.list> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L703

Name<yaml[<id>].list_deep_keys[<path>]>
ReturnsListTag
DescriptionReturns a ListTag of all the keys at the path and all subpaths.
Use empty path input to represent the root of the yaml document tree.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L774

Name<yaml[<id>].list_keys[<path>]>
ReturnsListTag
DescriptionReturns a ListTag of all the keys at the path (and not sub-keys).
Use empty path input to represent the root of the yaml document tree.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L803

Name<yaml[<id>].parsed_key[<path>]>
ReturnsElementTag
DescriptionReturns the value from a data key on the YAML document as an ElementTag, ListTag, or MapTag.
Will automatically parse any tags contained within the value of the key, preserving key data structure
(meaning, a tag that returns a ListTag, inside a data list, will insert a ListTag inside the returned ListTag, as you would expect).
Generally, prefer to use Tag:yaml.read.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L743

Name<yaml[<id>].read[<path>]>
ReturnsObjectTag
DescriptionReturns the value from a data key on the YAML document as an ElementTag, ListTag, or MapTag.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L760

Name<yaml[<id>].to_json>
ReturnsElementTag
DescriptionConverts the YAML container to a JSON array.
Generated Example
- narrate <yaml.to_json>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L842

Name<yaml[<id>].to_text>
ReturnsElementTag
DescriptionConverts the YAML container to raw YAML text.
Generated Example
- narrate <yaml.to_text>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L852



Category: VectorObject


Name<VectorObject.with_x[<number>]>
ReturnsVectorObject
DescriptionReturns a copy of this object with a changed X value.
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L123

Name<VectorObject.with_y[<number>]>
ReturnsVectorObject
DescriptionReturns a copy of this object with a changed Y value.
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L139

Name<VectorObject.with_z[<number>]>
ReturnsVectorObject
DescriptionReturns a copy of this object with a changed Z value.
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L155

Name<VectorObject.x>
ReturnsElementTag(Decimal)
DescriptionReturns the X coordinate of this object.
Generated Example
- narrate "the decimal value is <location[1,2,3].x>"
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L77

Name<VectorObject.xyz>
ReturnsElementTag
DescriptionReturns the basic vector in "x,y,z" format.
For example: 1,2,3
Other values, such as world, yaw, and pitch will be excluded from this output.
Generated Example
- narrate <location[1,2,3].xyz>
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L110

Name<VectorObject.y>
ReturnsElementTag(Decimal)
DescriptionReturns the Y coordinate of this object.
Generated Example
- narrate "the decimal value is <location[1,2,3].y>"
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L88

Name<VectorObject.z>
ReturnsElementTag(Decimal)
DescriptionReturns the Z coordinate of this object.
Generated Example
- narrate "the decimal value is <location[1,2,3].z>"
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L99

Name<VectorObject.add[<vector/location/x,y,z>]>
ReturnsVectorObject
DescriptionReturns a copy of this object with the specified coordinates added to it.
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L171

Name<VectorObject.div[<length>]>
ReturnsVectorObject
DescriptionReturns a copy of this object divided by the specified length.
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L212

Name<VectorObject.mul[<length>]>
ReturnsVectorObject
DescriptionReturns a copy of this object multiplied by the specified length.
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L201

Name<VectorObject.normalize>
ReturnsVectorObject
DescriptionReturns a 1-length vector in the same direction as this vector.
Generated Example
- adjust <player> velocity:<location[1,2,3].normalize>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L228

Name<VectorObject.sub[<vector/location/x,y,z>]>
ReturnsVectorObject
DescriptionReturns a copy of this object with the specified coordinates subtracted from it.
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L186

Name<VectorObject.quaternion_between_vectors[<vector>]>
ReturnsQuaternionTag
DescriptionReturns a quaternion that represents the rotation from this vector to another.
GroupVectorObject
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L285

Name<VectorObject.to_axis_angle_quaternion[<angle>]>
ReturnsQuaternionTag
DescriptionReturns a quaternion that is a rotation around this vector as an axis, by the given angle input (in radians).
GroupVectorObject
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L272

Name<VectorObject.vector_length>
ReturnsElementTag(Decimal)
DescriptionReturns the 3D length of the vector.
Generated Example
- narrate "the decimal value is <location[1,2,3].vector_length>"
Synonyms (Search Aid)vectorobject.magnitude
GroupVectorObject
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L260

Name<VectorObject.vector_length_squared>
ReturnsElementTag(Decimal)
DescriptionReturns the square of the 3D length of the vector.
Generated Example
- narrate "the decimal value is <location[1,2,3].vector_length_squared>"
Synonyms (Search Aid)vectorobject.magnitude_squared
GroupVectorObject
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L248



Category: PropertyHolderObject


Name<PropertyHolderObject.property_map>
ReturnsMapTag
DescriptionReturns the object's property map.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/properties/PropertyParser.java#L560

Name<PropertyHolderObject.supports[<property-name>]>
ReturnsElementTag(Boolean)
DescriptionReturns true if the property named is supported by the object.
This does not necessarily mean it has a valid current value, just that it's supported at all.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/properties/PropertyParser.java#L536

Name<PropertyHolderObject.with[<mechanism>=<value>;...]>
ReturnsPropertyHolderObject
DescriptionReturns a copy of the object with mechanism adjustments applied.
Be careful with dynamic inputs, they may break from escaping flaws.
Consider using Tag:PropertyHolderObject.with_single instead.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/properties/PropertyParser.java#L463

Name<PropertyHolderObject.with_map[<property-map>]>
ReturnsPropertyHolderObject
DescriptionReturns a copy of the object with the MapTag of mechanism adjustments applied.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/properties/PropertyParser.java#L513

Name<PropertyHolderObject.with_single[<mechanism>=<value>]>
ReturnsPropertyHolderObject
DescriptionReturns a copy of the object with a single mechanism adjustment applied.
This avoids the risk of escaping issues.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/properties/PropertyParser.java#L490



Category: TradeTag


Name<TradeTag.demand>
ReturnsElementTag(Number)
MechanismTradeTag.demand
Description(Property) Sets the demand level of the trade.
Generated Example
- narrate "the number value is <trade[trade[result=diamond;max_uses=10;inputs=stick]].demand>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/trade/TradeDemand.java#L9

Name<TradeTag.has_xp>
ReturnsElementTag(Boolean)
MechanismTradeTag.has_xp
Description(Property) Sets whether this trade will reward XP upon successful trading.
Generated Example
- if <trade[trade[result=diamond;max_uses=10;inputs=stick]].has_xp>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/trade/TradeHasXp.java#L9

Name<TradeTag.inputs>
ReturnsListTag(ItemTag)
MechanismTradeTag.inputs
Description(Property) Controls the items required to make a successful trade. Use an empty input to make the trade impossible.
NOTE: If more than two items are specified, then only the first two items will be used.
Generated Example
- foreach <trade[trade[result=diamond;max_uses=10;inputs=stick]].inputs> as:entry:
    - narrate "found <[entry]>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/trade/TradeInputs.java#L14

Name<TradeTag.max_uses>
ReturnsElementTag(Number)
MechanismTradeTag.max_uses
Description(Property) Sets the maximum amount of times that the trade can be used.
Generated Example
- narrate "the number value is <trade[trade[result=diamond;max_uses=10;inputs=stick]].max_uses>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/trade/TradeMaxUses.java#L9

Name<TradeTag.price_multiplier>
ReturnsElementTag(Decimal)
MechanismTradeTag.price_multiplier
Description(Property) Controls the price multiplier for this trade.
Generated Example
- narrate "the decimal value is <trade[trade[result=diamond;max_uses=10;inputs=stick]].price_multiplier>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/trade/TradePriceMultiplier.java#L9

Name<TradeTag.result>
ReturnsItemTag
MechanismTradeTag.result
Description(Property) Controls what the trade will give the player.
Generated Example
- give <trade[trade[result=diamond;max_uses=10;inputs=stick]].result>
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/trade/TradeResult.java#L9

Name<TradeTag.special_price>
ReturnsElementTag(Number)
MechanismTradeTag.special_price
Description(Property) Sets the special price for this trade.
Generated Example
- narrate "the number value is <trade[trade[result=diamond;max_uses=10;inputs=stick]].special_price>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/trade/TradeSpecialPrice.java#L9

Name<TradeTag.uses>
ReturnsElementTag(Number)
MechanismTradeTag.uses
Description(Property) Controls the amount of times the trade has been used.
Generated Example
- narrate "the number value is <trade[trade[result=diamond;max_uses=10;inputs=stick]].uses>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/trade/TradeUses.java#L9

Name<TradeTag.villager_xp>
ReturnsElementTag(Number)
MechanismTradeTag.villager_xp
Description(Property) Controls the amount of experience a villager gains from this trade.
Generated Example
- narrate "the number value is <trade[trade[result=diamond;max_uses=10;inputs=stick]].villager_xp>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/trade/TradeVillagerXP.java#L9



Category: AreaShopTag


Name<AreaShopTag.groups>
ReturnsListTag
DescriptionReturns a list of groups that control this AreaShop.
RequiresDepenizen, AreaShop
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/areashop/AreaShopTag.java#L135

Name<AreaShopTag.is_bought>
ReturnsElementTag(Boolean)
DescriptionReturns whether this AreaShop has been bought.
RequiresDepenizen, AreaShop
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/areashop/AreaShopTag.java#L113

Name<AreaShopTag.is_rented>
ReturnsElementTag(Boolean)
DescriptionReturns whether this AreaShop is being rented.
RequiresDepenizen, AreaShop
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/areashop/AreaShopTag.java#L124

Name<AreaShopTag.landlord>
ReturnsPlayerTag
DescriptionReturns the landlord of the AreaShop.
RequiresDepenizen, AreaShop
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/areashop/AreaShopTag.java#L146

Name<AreaShopTag.name>
ReturnsElementTag
DescriptionReturns the name of the AreaShop.
RequiresDepenizen, AreaShop
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/areashop/AreaShopTag.java#L157

Name<AreaShopTag.owner>
ReturnsPlayerTag
DescriptionReturns the owner of the AreaShop.
RequiresDepenizen, AreaShop
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/areashop/AreaShopTag.java#L189

Name<AreaShopTag.price>
ReturnsElementTag(Decimal)
DescriptionReturns the price of the AreaShop.
RequiresDepenizen, AreaShop
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/areashop/AreaShopTag.java#L168

Name<AreaShopTag.worldguard_region>
ReturnsWorldGuardRegionTag
DescriptionReturns the WorldGuardRegionTag that holds the AreaShop.
RequiresDepenizen, AreaShop
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/areashop/AreaShopTag.java#L200



Category: BigDoorsDoorTag


Name<BigDoorsDoorTag.auto_close>
ReturnsDurationTag
MechanismBigDoorsDoorTag.auto_close
DescriptionReturns the auto close time for the door.
Returns 0 if the door does not auto close.
RequiresDepenizen, Big Doors
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/bigdoors/BigDoorsDoorTag.java#L154

Name<BigDoorsDoorTag.cuboid>
ReturnsCuboidTag
DescriptionReturns the cuboid of the door.
RequiresDepenizen, Big Doors
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/bigdoors/BigDoorsDoorTag.java#L143

Name<BigDoorsDoorTag.door_type>
ReturnsElementTag
DescriptionReturns the type of door.
RequiresDepenizen, Big Doors
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/bigdoors/BigDoorsDoorTag.java#L193

Name<BigDoorsDoorTag.is_busy>
ReturnsElementTag(Boolean)
DescriptionReturns whether the door is busy (currently animated/opening/closing).
RequiresDepenizen, Big Doors
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/bigdoors/BigDoorsDoorTag.java#L120

Name<BigDoorsDoorTag.is_loaded>
ReturnsElementTag(Boolean)
DescriptionReturns whether the door is currently loaded (the chunks it sits in are loaded).
If this returns false, the door cannot open or close.
RequiresDepenizen, Big Doors
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/bigdoors/BigDoorsDoorTag.java#L131

Name<BigDoorsDoorTag.is_locked>
ReturnsElementTag(Boolean)
MechanismBigDoorsDoorTag.is_locked
DescriptionReturns whether the door is locked.
RequiresDepenizen, Big Doors
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/bigdoors/BigDoorsDoorTag.java#L108

Name<BigDoorsDoorTag.is_open>
ReturnsElementTag(Boolean)
MechanismBigDoorsDoorTag.is_open
DescriptionReturns whether the door is open.
RequiresDepenizen, Big Doors
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/bigdoors/BigDoorsDoorTag.java#L96

Name<BigDoorsDoorTag.name>
ReturnsElementTag
DescriptionReturns the name of the door (this is not always unique).
RequiresDepenizen, Big Doors
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/bigdoors/BigDoorsDoorTag.java#L204

Name<BigDoorsDoorTag.owners>
ReturnsListTag(PlayerTag)
DescriptionReturns the list of owners of the door.
RequiresDepenizen, Big Doors
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/bigdoors/BigDoorsDoorTag.java#L178

Name<BigDoorsDoorTag.power_block>
ReturnsLocationTag
DescriptionReturns the location of the power block for the door.
RequiresDepenizen, Big Doors
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/bigdoors/BigDoorsDoorTag.java#L167



Category: bungee


Name<bungee.connected>
ReturnsElementTag(Boolean)
DescriptionReturns whether this server is currently connected to the BungeeCord proxy server.
RequiresDepenizen, DepenizenBungee, BungeeCord
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bungee/BungeeBridge.java#L296

Name<bungee.list_servers>
ReturnsListTag
DescriptionReturns a list of known bungee server names.
RequiresDepenizen, DepenizenBungee, BungeeCord
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bungee/BungeeBridge.java#L284

Name<bungee.server>
ReturnsElementTag
DescriptionReturns the name of the current server (according to the Bungee proxy config).
RequiresDepenizen, DepenizenBungee, BungeeCord
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bungee/BungeeBridge.java#L272



Category: crackshot


Name<crackshot.weapon[<weapon_name>]>
ReturnsItemTag
DescriptionReturns the ItemTag for the CrackShot weapon title specified, if it exists. 🔗https://github.com/Shampaggon/CrackShot/wiki/The-Complete-Guide-to-CrackShot#title
RequiresDepenizen, CrackShot
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/CrackShotBridge.java#L51



Category: DiscordBotTag


Name<DiscordBotTag.command[<name>]>
ReturnsDiscordCommandTag
DescriptionReturns the application command that best matches the input name, or null if there's no match.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordBotTag.java#L194

Name<DiscordBotTag.commands>
ReturnsListTag(DiscordCommandTag)
DescriptionReturns a list of all application commands.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordBotTag.java#L141

Name<DiscordBotTag.group[<name>]>
ReturnsDiscordGroupTag
DescriptionReturns the Discord group (aka 'guild' or 'server') that best matches the input name, or null if there's no match.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordBotTag.java#L160

Name<DiscordBotTag.groups>
ReturnsListTag(DiscordGroupTag)
DescriptionReturns a list of all groups (aka 'guilds' or 'servers') that this Discord bot has access to.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordBotTag.java#L122

Name<DiscordBotTag.name>
ReturnsElementTag
DescriptionReturns the name of the bot.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordBotTag.java#L94

Name<DiscordBotTag.self_user>
ReturnsDiscordUserTag
DescriptionReturns the bot's own Discord user object.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordBotTag.java#L106



Category: DiscordButtonTag


Name<DiscordButtonTag.map>
ReturnsMapTag
DescriptionReturns the MapTag internally backing this button tag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordButtonTag.java#L169

Name<DiscordButtonTag.with_map[<map>]>
ReturnsDiscordButtonTag
DescriptionReturns a copy of this Button tag, with the map of keys to values applied.
Refer to Tag:DiscordButtonTag.with.as.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordButtonTag.java#L101

Name<DiscordButtonTag.with[<key>].as[<value>]>
ReturnsDiscordButtonTag
DescriptionReturns a copy of this Button tag, with the specified data key set to the specified value.
The following keys are accepted, with values of the listed type:
style: ElementTag of either primary, secondary, success, danger, or link
id: ElementTag, can be a URL
label: ElementTag
disabled: ElementTag(Boolean)
emoji: ElementTag
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordButtonTag.java#L132



Category: DiscordChannelTag


Name<DiscordChannelTag.active_threads>
ReturnsListTag(DiscordChannelTag)
DescriptionReturns the list of all current (non-archived) thread channels inside this text channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L282

Name<DiscordChannelTag.archived_threads>
ReturnsListTag(DiscordChannelTag)
DescriptionReturns the list of all archived thread channels inside this text channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L304

Name<DiscordChannelTag.channel_type>
ReturnsElementTag
DescriptionReturns the type of the channel.
Will be any of: TEXT, PRIVATE, VOICE, GROUP, CATEGORY, NEWS, STAGE, GUILD_NEWS_THREAD, GUILD_PUBLIC_THREAD, GUILD_PRIVATE_THREAD, FORUM, or UNKNOWN.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L155

Name<DiscordChannelTag.connected_users>
ReturnsListTag(DiscordUserTag)
DescriptionIf the channel is a voice channel, returns the users connected to it.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L411

Name<DiscordChannelTag.first_message>
ReturnsDiscordMessageTag
DescriptionReturns the first message sent in the channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L375

Name<DiscordChannelTag.group>
ReturnsDiscordGroupTag
DescriptionReturns the group that owns this channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L337

Name<DiscordChannelTag.id>
ReturnsElementTag(Number)
DescriptionReturns the ID number of the channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L167

Name<DiscordChannelTag.is_thread>
ReturnsElementTag(Boolean)
DescriptionReturns true if the channel is a thread, or false if it is some other type of channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L215

Name<DiscordChannelTag.is_thread_archived>
ReturnsElementTag(Boolean)
MechanismDiscordChannelTag.is_thread_archived
DescriptionReturns true if the thread is archived, or false if it is still open.
Only applicable to thread-channels.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L226

Name<DiscordChannelTag.is_thread_locked>
ReturnsElementTag(Boolean)
MechanismDiscordChannelTag.is_thread_locked
DescriptionReturns true if the thread is locked (cannot be pulled from archive).
Only applicable to thread-channels.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L244

Name<DiscordChannelTag.last_message>
ReturnsDiscordMessageTag
DescriptionReturns the last message sent in the channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L391

Name<DiscordChannelTag.mention>
ReturnsElementTag
DescriptionReturns the raw mention string for the channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L326

Name<DiscordChannelTag.name>
ReturnsElementTag
MechanismDiscordChannelTag.name
DescriptionReturns the name of the channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L143

Name<DiscordChannelTag.parent>
ReturnsDiscordChannelTag
DescriptionReturns the parent channel of this thread channel (if this channel is a thread).
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L178

Name<DiscordChannelTag.pinned_messages>
ReturnsListTag(DiscordMessageTag)
DescriptionReturns a list of the messages that are pinned in the channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L356

Name<DiscordChannelTag.thread_members>
ReturnsListTag(DiscordUserTag)
DescriptionReturns the list of users joined into this thread channel (if this channel is a thread).
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L195

Name<DiscordChannelTag.threads>
ReturnsListTag(DiscordChannelTag)
DescriptionReturns the list of all (archived or not) thread channels inside this text channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L262

Name<DiscordChannelTag.topic>
ReturnsElementTag
MechanismDiscordChannelTag.topic
DescriptionReturns the topic for this channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L432



Category: DiscordCommandTag


Name<DiscordCommandTag.description>
ReturnsElementTag
DescriptionReturns the description of the command.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordCommandTag.java#L199

Name<DiscordCommandTag.id>
ReturnsElementTag(Number)
DescriptionReturns the ID of the command.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordCommandTag.java#L177

Name<DiscordCommandTag.name>
ReturnsElementTag
DescriptionReturns the name of the command.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordCommandTag.java#L188

Name<DiscordCommandTag.options>
ReturnsListTag(MapTag)
DescriptionReturns the option MapTags of the command. This is the same value as the one provided when creating a command, as documented in Command:DiscordCommand.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordCommandTag.java#L210



Category: DiscordEmbedTag


Name<DiscordEmbedTag.add_field[<title>].value[<value>]>
ReturnsDiscordEmbedTag
DescriptionReturns a copy of this Embed tag, with a field added with the given title and value.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L310

Name<DiscordEmbedTag.add_inline_field[<title>].value[<value>]>
ReturnsDiscordEmbedTag
DescriptionReturns a copy of this Embed tag, with an inline field added with the given title and value.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L341

Name<DiscordEmbedTag.map>
ReturnsMapTag
DescriptionReturns the MapTag internally backing this embed tag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L299

Name<DiscordEmbedTag.output_length>
ReturnsElementTag(Number)
DescriptionReturns the total number of displayed characters this embed contains.
Discord rejects embeds with a total character count above 6000.
There are other limits for embed objects, refer to 🔗https://discordjs.guide/popular-topics/embeds.html#embed-limits
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L373

Name<DiscordEmbedTag.to_json>
ReturnsElementTag
DescriptionReturns the raw Discord-API-compatible JSON text of this embed.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L387

Name<DiscordEmbedTag.with_map[<map>]>
ReturnsDiscordEmbedTag
DescriptionReturns a copy of this Embed tag, with the map of keys to values applied.
Refer to Tag:DiscordEmbedTag.with.as.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L210

Name<DiscordEmbedTag.with[<key>].as[<value>]>
ReturnsDiscordEmbedTag
DescriptionReturns a copy of this Embed tag, with the specified data key set to the specified value.
The following keys are accepted, with values of the listed type:
author_name: ElementTag
author_url: ElementTag of a URL (requires author_name set)
author_icon_url: ElementTag of a URL (requires author_name set)
color: ColorTag
description: ElementTag
footer: ElementTag
footer_icon: ElementTag of a URL (requires footer set)
image: ElementTag of a URL
thumbnail: ElementTag of a URL
timestamp: TimeTag
title: ElementTag
title_url: ElementTag of a URL (requires title set)
fields: generally don't use directly, but can be set to a list of maps wherein each sub-map has keys "title", "value", and "inline" (boolean)
For fields, instead prefer Tag:DiscordEmbedTag.add_field.value and Tag:DiscordEmbedTag.add_inline_field.value.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L247



Category: DiscordGroupTag


Name<DiscordGroupTag.banned_members>
ReturnsListTag(DiscordUserTag)
DescriptionReturns a list of all banned users in the group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L192

Name<DiscordGroupTag.channel[<name>]>
ReturnsDiscordChannelTag
DescriptionReturns the channel that best matches the input name, or null if there's no match.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L269

Name<DiscordGroupTag.channels>
ReturnsListTag(DiscordChannelTag)
DescriptionReturns a list of all channels in the group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L162

Name<DiscordGroupTag.command[<name>]>
ReturnsDiscordCommandTag
DescriptionReturns the guild command that best matches the input name, or null if there's no match.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L327

Name<DiscordGroupTag.commands>
ReturnsListTag(DiscordCommandTag)
DescriptionReturns a list of all commands in the group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L222

Name<DiscordGroupTag.emoji_id[<name>]>
ReturnsElementTag
DescriptionReturns the ID of the emoji that best matches the input name, or null if there's no match.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L371

Name<DiscordGroupTag.emoji_names>
ReturnsListTag
DescriptionReturns a list of emoji names in the group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L356

Name<DiscordGroupTag.id>
ReturnsElementTag(Number)
DescriptionReturns the ID number of the group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L151

Name<DiscordGroupTag.member[<name>]>
ReturnsDiscordUserTag
DescriptionReturns the group member that best matches the input name, or null if there's no match.
For input of username#id, will always only match for the exact user.
For input of only the username, return value might be unexpected if multiple members have the same username
(this happens more often than you might expect - many users accidentally join new Discord groups from the
web on a temporary web account, then rejoin on a local client with their 'real' account).
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L237

Name<DiscordGroupTag.members>
ReturnsListTag(DiscordUserTag)
DescriptionReturns a list of all users in the group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L177

Name<DiscordGroupTag.name>
ReturnsElementTag
DescriptionReturns the name of the group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L140

Name<DiscordGroupTag.role[<name>]>
ReturnsDiscordRoleTag
DescriptionReturns the role that best matches the input name, or null if there's no match.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L298

Name<DiscordGroupTag.roles>
ReturnsListTag(DiscordRoleTag)
DescriptionReturns a list of all roles in the group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L207

Name<DiscordGroupTag.users_with_roles[<role>|...]>
ReturnsListTag(DiscordUserTag)
DescriptionReturns a list of all users in the group who have all the specified roles.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L400



Category: DiscordInteractionTag


Name<DiscordInteractionTag.channel>
ReturnsDiscordChannelTag
DescriptionReturns the channel that the interaction was created in.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordInteractionTag.java#L168

Name<DiscordInteractionTag.id>
ReturnsElementTag(Number)
DescriptionReturns the ID of the interaction.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordInteractionTag.java#L157

Name<DiscordInteractionTag.is_direct>
ReturnsElementTag(Boolean)
DescriptionReturns true if the interaction was sent in a direct (private) channel, or false if in a public channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordInteractionTag.java#L179

Name<DiscordInteractionTag.target_message>
ReturnsDiscordMessageTag
DescriptionReturns the message being targeted by a MESSAGE application interaction.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordInteractionTag.java#L216

Name<DiscordInteractionTag.target_user>
ReturnsDiscordUserTag
DescriptionReturns the user being targeted by a USER application interaction.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordInteractionTag.java#L202

Name<DiscordInteractionTag.user>
ReturnsDiscordUserTag
DescriptionReturns the user of the interaction.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordInteractionTag.java#L191



Category: DiscordMessageTag


Name<DiscordMessageTag.attachments>
ReturnsListTag
DescriptionReturns a list of attachment URLs for this message. Most messages will return an empty list, or a single-entry list,
however it is possible in some cases for a single message to have multiple attachments.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L424

Name<DiscordMessageTag.author>
ReturnsDiscordUserTag
DescriptionReturns the author of the message.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L283

Name<DiscordMessageTag.channel>
ReturnsDiscordChannelTag
DescriptionReturns the channel that the message was sent to.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L228

Name<DiscordMessageTag.embed>
ReturnsListTag(DiscordEmbedTag)
DescriptionReturns a list of "embed" formatted data on this message.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L342

Name<DiscordMessageTag.id>
ReturnsElementTag(Number)
DescriptionReturns the ID of the message.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L203

Name<DiscordMessageTag.is_direct>
ReturnsElementTag(Boolean)
DescriptionReturns true if the message was sent in a direct (private) channel, or false if in a public channel.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L331

Name<DiscordMessageTag.is_pinned>
ReturnsElementTag(Boolean)
DescriptionReturns whether this message is pinned.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L305

Name<DiscordMessageTag.mentioned_users>
ReturnsListTag(DiscordUserTag)
DescriptionReturns a list of users mentioned (pinged) by this message.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L316

Name<DiscordMessageTag.next_messages[<#>]>
ReturnsListTag(DiscordMessageTag)
DescriptionReturns a list of the next (specified number) messages sent in the channel after this message.
The list is ordered from most recent to least recent.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L390

Name<DiscordMessageTag.previous_messages[<#>]>
ReturnsListTag(DiscordMessageTag)
DescriptionReturns a list of the last (specified number) messages sent in the channel prior to this message.
The list is ordered from most recent to least recent.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L372

Name<DiscordMessageTag.reactions>
ReturnsListTag
DescriptionReturns a list of reaction on this message.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L357

Name<DiscordMessageTag.replied_to>
ReturnsDiscordMessageTag
DescriptionReturns the message that this message was in reply to (if any).
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L408

Name<DiscordMessageTag.text>
ReturnsElementTag
DescriptionReturns the full text of the message.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L239

Name<DiscordMessageTag.text_display>
ReturnsElementTag
DescriptionReturns the display text of the message (special codes like pings formatted to how they should look for users).
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L261

Name<DiscordMessageTag.text_no_mentions>
ReturnsElementTag
DescriptionReturns the text of the message, with '@' mentions removed.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L272

Name<DiscordMessageTag.text_stripped>
ReturnsElementTag
DescriptionReturns the stripped text of the message (format codes like bold removed).
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L250

Name<DiscordMessageTag.url>
ReturnsElementTag
DescriptionReturns the full jump URL to this message.
This returns link text that looks something like "https://discord.com/channels/315163488085475337/315163488085475337/980909305589026906"
Where the URL is Discord's webserver, followed by Group ID, Channel ID, then Message ID.
DM messages follow a slightly different but very similar format.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L214

Name<DiscordMessageTag.was_edited>
ReturnsElementTag(Boolean)
DescriptionReturns whether this message was edited.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L294



Category: DiscordReactionTag


Name<DiscordReactionTag.count>
ReturnsElementTag(Number)
DescriptionReturns the amount of times this reaction exists on the message.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordReactionTag.java#L228

Name<DiscordReactionTag.id>
ReturnsElementTag
DescriptionReturns the ID of the reaction emote.
For custom emoji, this is a numeric ID. For default emoji, this is the unicode symbol.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordReactionTag.java#L200

Name<DiscordReactionTag.is_animated>
ReturnsElementTag
DescriptionReturns whether the emote reacted is animated (an "animoji").
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordReactionTag.java#L253

Name<DiscordReactionTag.message>
ReturnsDiscordMessageTag
DescriptionReturns the message this reaction is attached to.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordReactionTag.java#L212

Name<DiscordReactionTag.name>
ReturnsElementTag
DescriptionReturns the name of the emoji.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordReactionTag.java#L242

Name<DiscordReactionTag.reactors>
ReturnsListTag(DiscordUserTag)
DescriptionReturns the list of users that added this reaction to the message.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordReactionTag.java#L264



Category: DiscordRoleTag


Name<DiscordRoleTag.color>
ReturnsColorTag
MechanismDiscordRoleTag.color
DescriptionReturns the display color of the role, if any.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L212

Name<DiscordRoleTag.group>
ReturnsDiscordGroupTag
DescriptionReturns the group that owns this role.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L201

Name<DiscordRoleTag.id>
ReturnsElementTag(Number)
DescriptionReturns the ID number of the role.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L179

Name<DiscordRoleTag.mention>
ReturnsElementTag
DescriptionReturns the raw mention string of the role.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L190

Name<DiscordRoleTag.name>
ReturnsElementTag
DescriptionReturns the name of the role.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L168

Name<DiscordRoleTag.permissions>
ReturnsListTag
DescriptionReturns a list of permissions that the role provides for users. You can get a list of possible outputs here: 🔗https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/Permission.html
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L243

Name<DiscordRoleTag.users>
ReturnsListTag(DiscordUserTag)
DescriptionReturns a list of all users with this role.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L228



Category: DiscordSelectionTag


Name<DiscordSelectionTag.map>
ReturnsMapTag
DescriptionReturns the MapTag internally backing this selection tag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordSelectionTag.java#L222

Name<DiscordSelectionTag.with_map[<map>]>
ReturnsDiscordSelectionTag
DescriptionReturns a copy of this Selection tag, with the map of keys to values applied.
Refer to Tag:DiscordSelectionTag.with.as.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordSelectionTag.java#L152

Name<DiscordSelectionTag.with[<key>].as[<value>]>
ReturnsDiscordSelectionTag
DescriptionReturns a copy of this Selection tag, with the specified data key set to the specified value.
The following keys are accepted, with values of the listed type:
id: ElementTag
placeholder: ElementTag
options: MapTag where the values are also a MapTag consisting of:
- label: ElementTag
- value: ElementTag
- description: ElementTag
- emoji: ElementTag
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordSelectionTag.java#L183



Category: DiscordTextInputTag


Name<DiscordTextInputTag.map>
ReturnsMapTag
DescriptionReturns the MapTag internally backing this text input tag.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordTextInputTag.java#L193

Name<DiscordTextInputTag.with_map[<map>]>
ReturnsDiscordTextInputTag
DescriptionReturns a copy of this TextInput tag, with the map of keys to values applied.
Refer to Tag:DiscordTextInputTag.with.as.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordTextInputTag.java#L122

Name<DiscordTextInputTag.with[<key>].as[<value>]>
ReturnsDiscordTextInputTag
DescriptionReturns a copy of this TextInput tag, with the specified data key set to the specified value.
The following keys are accepted, with values of the listed type:
style: short or paragraph
id: ElementTag
label: ElementTag
min_length: ElementTag(Number)
max_length: ElementTag(Number)
is_required: ElementTag(Boolean)
value: ElementTag
placeholder: ElementTag
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordTextInputTag.java#L153



Category: DiscordUserTag


Name<DiscordUserTag.activity_name[<group>]>
ReturnsElementTag
DescriptionReturns the name of the activity of the user, as seen from the given group.
Not present for all users.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L361

Name<DiscordUserTag.activity_type[<group>]>
ReturnsElementTag
DescriptionReturns the activity type of the user, as seen from the given group.
Can be any of: DEFAULT, STREAMING, LISTENING, WATCHING, CUSTOM_STATUS, COMPETING.
Not present for all users.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L334

Name<DiscordUserTag.activity_url[<group>]>
ReturnsElementTag
DescriptionReturns the stream URL of the activity of the user, as seen from the given group.
Not present for all users.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L387

Name<DiscordUserTag.avatar_url>
ReturnsElementTag
DescriptionReturns the URL to the user's avatar.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L243

Name<DiscordUserTag.discriminator>
ReturnsElementTag
DescriptionReturns the discriminator ID of the user.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L215

Name<DiscordUserTag.id>
ReturnsElementTag(Number)
DescriptionReturns the ID number of the user.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L289

Name<DiscordUserTag.is_banned[<group>]>
ReturnsElementTag(boolean)
DescriptionReturns whether the user is banned from a certain group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L464

Name<DiscordUserTag.is_bot>
ReturnsElementTag(Boolean)
DescriptionReturns a boolean indicating whether the user is a bot.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L229

Name<DiscordUserTag.is_in_group[<group>]>
ReturnsElementTag(Boolean)
DescriptionReturns true if the user exists and is recognized, or false if it can't be seen.
If this returns false, some usages of the object may still be valid.
It may return false due to caching issues or because the user doesn't share a guild with the bot.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L197

Name<DiscordUserTag.is_timed_out[<group>]>
ReturnsElementTag(boolean)
DescriptionReturns whether the user is timed out in a certain group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L486

Name<DiscordUserTag.is_valid>
ReturnsElementTag(Boolean)
DescriptionReturns true if the user exists and is recognized, or false if it can't be seen.
If this returns false, some usages of the object may still be valid.
It may return false due to caching issues or because the user doesn't share a guild with the bot.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L184

Name<DiscordUserTag.mention>
ReturnsElementTag
DescriptionReturns the raw mention string for the user.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L301

Name<DiscordUserTag.name>
ReturnsElementTag
DescriptionReturns the base username of the user.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L170

Name<DiscordUserTag.nickname[<group>]>
ReturnsElementTag
DescriptionReturns the group-specific nickname of the user (if any).
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L257

Name<DiscordUserTag.permissions[<group>]>
ReturnsListTag
DescriptionReturns a list of permissions that the user has in a certain group. You can get a list of possible outputs here: 🔗https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/Permission.html
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L439

Name<DiscordUserTag.roles[<group>]>
ReturnsListTag(DiscordRoleTag)
DescriptionReturns a list of all roles the user has in the given group.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L416

Name<DiscordUserTag.status[<group>]>
ReturnsElementTag
DescriptionReturns the status of the user, as seen from the given group.
Can be any of: online, dnd, idle, invisible, offline.
RequiresdDiscordBot
Sourcehttps://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L312



Category: essentials


Name<essentials.list_warps>
ReturnsListTag
DescriptionReturns a list of all Warp names.
Generated Example
- foreach <essentials.list_warps> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, Essentials
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/EssentialsBridge.java#L70

Name<essentials.warp[<warp_name>]>
ReturnsLocationTag
DescriptionReturns the location of the warp name.
RequiresDepenizen, Essentials
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/EssentialsBridge.java#L47



Category: factions


Name<factions.list_factions>
ReturnsListTag(FactionTag)
DescriptionReturns a list of all current factions.
Generated Example
- foreach <factions.list_factions> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/FactionsBridge.java#L70



Category: FactionTag


Name<FactionTag.balance>
ReturnsElementTag(Decimal)
DescriptionReturns the amount of money the faction currently has.
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L126

Name<FactionTag.claimed_chunks>
ReturnsListTag(ChunkTag)
DescriptionReturns a list of all chunks claimed in the faction.
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L285

Name<FactionTag.id>
ReturnsElementTag
DescriptionReturns the unique ID for this faction.
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L161

Name<FactionTag.is_open>
ReturnsElementTag(Boolean)
DescriptionReturns true if the faction is open.
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L172

Name<FactionTag.is_peaceful>
ReturnsElementTag(Boolean)
DescriptionReturns true if the faction is peaceful.
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L184

Name<FactionTag.is_permanent>
ReturnsElementTag(Boolean)
DescriptionReturns true if the faction is permanent.
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L196

Name<FactionTag.leader>
ReturnsPlayerTag
DescriptionReturns the faction's leader as a PlayerTag.
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L208

Name<FactionTag.list_players>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of all players in the faction.
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L301

Name<FactionTag.name>
ReturnsElementTag
DescriptionReturns the name of the faction.
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L222

Name<FactionTag.player_count>
ReturnsElementTag(Number)
DescriptionReturns the number of players in the faction.
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L234

Name<FactionTag.power>
ReturnsElementTag(Decimal)
DescriptionReturns the amount of power the faction currently has.
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L246

Name<FactionTag.relation[<faction>]>
ReturnsElementTag
DescriptionReturns the current relation between the faction and another faction.
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L258

Name<FactionTag.size>
ReturnsElementTag(Number)
DescriptionReturns the amount of land the faction has.
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L273

Name<FactionTag.warp[<name>]>
ReturnsLocationTag
DescriptionReturns the location of the faction's warp by name, if any.
Note that this was previously named "home" instead of "warp".
RequiresDepenizen, Factions
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L138



Category: griefprevention


Name<griefprevention.list_claims>
ReturnsListTag(GriefPreventionClaimTag)
DescriptionReturns a list of all GriefPrevention claims.
Generated Example
- foreach <griefprevention.list_claims> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/GriefPreventionBridge.java#L49



Category: GriefPreventionClaimTag


Name<GriefPreventionClaimTag.accessors>
ReturnsListTag(PlayerTag)
DescriptionReturns the GriefPreventionClaim's accessors.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L212

Name<GriefPreventionClaimTag.builders>
ReturnsListTag(PlayerTag)
DescriptionReturns the GriefPreventionClaim's builders.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L178

Name<GriefPreventionClaimTag.can_siege[<player>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the GriefPreventionClaim can siege the player.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L296

Name<GriefPreventionClaimTag.chunks>
ReturnsListTag(ChunkTag)
DescriptionReturns a list of all chunks in the GriefPreventionClaim.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L281

Name<GriefPreventionClaimTag.containers>
ReturnsListTag(PlayerTag)
DescriptionReturns the GriefPreventionClaim's containers.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L195

Name<GriefPreventionClaimTag.cuboid>
ReturnsCuboidTag
DescriptionReturns the GriefPreventionClaim's cuboid area.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L245

Name<GriefPreventionClaimTag.id>
ReturnsElementTag(Number)
DescriptionReturns the GriefPreventionClaim's ID.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L135

Name<GriefPreventionClaimTag.is_adminclaim>
ReturnsElementTag(Boolean)
DescriptionReturns whether GriefPreventionClaim is an Admin Claim.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L270

Name<GriefPreventionClaimTag.is_sieged>
ReturnsElementTag(Boolean)
DescriptionReturns whether the GriefPreventionClaim is currently under siege.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L314

Name<GriefPreventionClaimTag.managers>
ReturnsListTag(PlayerTag)
DescriptionReturns the GriefPreventionClaim's managers.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L146

Name<GriefPreventionClaimTag.owner>
ReturnsObjectTag
MechanismGriefPreventionClaimTag.owner
DescriptionReturns the GriefPreventionClaim's owner.
Can be "Admin" or a PlayerTag.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L229

Name<GriefPreventionClaimTag.trusted>
ReturnsListTag(PlayerTag)
DescriptionReturns the GriefPreventionClaim's trusted.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L161

Name<GriefPreventionClaimTag.world>
ReturnsWorldTag
DescriptionReturns the world this GriefPreventionClaim is in.
RequiresDepenizen, GriefPrevention
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L259



Category: JobsJobTag


Name<JobsJobTag.description>
ReturnsElementTag
DescriptionSingle line description is deprecated in Jobs. Use Tag:JobsJobTag.full_description instead.
RequiresDepenizen, Jobs
DeprecatedUse 'JobsJobTag.full_description'
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L148

Name<JobsJobTag.full_description>
ReturnsListTag
DescriptionReturns the full description of the job.
RequiresDepenizen, Jobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L161

Name<JobsJobTag.level>
ReturnsElementTag(Number)
DescriptionReturns the current level a player has in a specified job.
RequiresDepenizen, Jobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L251

Name<JobsJobTag.max_xp[(<level>)]>
ReturnsElementTag(Number)
DescriptionReturns the amount of experience required for the specified job level.
If the level is not specified, uses the current level of the player.
RequiresDepenizen, Jobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L262

Name<JobsJobTag.name>
ReturnsElementTag
DescriptionReturns the name of the job.
RequiresDepenizen, Jobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L181

Name<JobsJobTag.name.short>
ReturnsElementTag
DescriptionDeprecated in favor of Tag:JobsJobTag.short_name.
RequiresDepenizen, Jobs
DeprecatedUse 'JobsJobTag.short_name'
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L172

Name<JobsJobTag.player>
ReturnsPlayerTag
DescriptionReturns the player the job progression for this tag belongs to.
RequiresDepenizen, Jobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L280

Name<JobsJobTag.short_name>
ReturnsElementTag
DescriptionReturns the shortened name of the job.
RequiresDepenizen, Jobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L197

Name<JobsJobTag.xp>
ReturnsElementTag(Decimal)
MechanismJobsJobTag.xp
DescriptionReturns the current experience a player has for the current level in a specified job.
RequiresDepenizen, Jobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L226

Name<JobsJobTag.xp.level>
ReturnsElementTag(Number)
DescriptionDeprecated in favor of Tag:JobsJobTag.level.
RequiresDepenizen, Jobs
DeprecatedUse 'JobsJobTag.level'
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L217

Name<JobsJobTag.xp.max>
ReturnsElementTag(Number)
DescriptionDeprecated in favor of Tag:JobsJobTag.max_xp.
RequiresDepenizen, Jobs
DeprecatedUse 'JobsJobTag.max_xp'
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L208



Category: LibsDisguiseTag


Name<LibsDisguiseTag.disguise_type>
ReturnsElementTag
DescriptionReturns the type of the disguise.
RequiresDepenizen, LibsDisguises
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/libsdisguises/LibsDisguiseTag.java#L116

Name<LibsDisguiseTag.display_name>
ReturnsElementTag
DescriptionReturns the display name of the disguise.
RequiresDepenizen, LibsDisguises
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/libsdisguises/LibsDisguiseTag.java#L138

Name<LibsDisguiseTag.entity>
ReturnsEntityTag
DescriptionReturns the entity of the disguise.
RequiresDepenizen, LibsDisguises
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/libsdisguises/LibsDisguiseTag.java#L127



Category: luckperms


Name<luckperms.list_groups>
ReturnsListTag(LuckPermsGroupTag)
DescriptionReturns a list of all luckperms groups.
Generated Example
- foreach <luckperms.list_groups> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, LuckPerms
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/LuckPermsBridge.java#L49

Name<luckperms.list_tracks>
ReturnsListTag(LuckPermsTrackTag)
DescriptionReturns a list of all tracks.
Generated Example
- foreach <luckperms.list_tracks> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, LuckPerms
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/LuckPermsBridge.java#L27

Name<luckperms.track[<track_name>]>
ReturnsLuckPermsTrackTag
DescriptionReturns the track from the name given.
RequiresDepenizen, LuckPerms
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/LuckPermsBridge.java#L38



Category: LuckPermsGroupTag


Name<LuckPermsGroupTag.group_name>
ReturnsElementTag
DescriptionReturns the group's name.
RequiresDepenizen, LuckPerms
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/luckperms/LuckPermsGroupTag.java#L99

Name<LuckPermsGroupTag.group_prefix>
ReturnsElementTag
DescriptionReturns the group's prefix, if any.
RequiresDepenizen, LuckPerms
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/luckperms/LuckPermsGroupTag.java#L110

Name<LuckPermsGroupTag.group_suffix>
ReturnsElementTag
DescriptionReturns the group's suffix, if any.
RequiresDepenizen, LuckPerms
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/luckperms/LuckPermsGroupTag.java#L122

Name<LuckPermsGroupTag.group_weight>
ReturnsElementTag
DescriptionReturns the group's weight, if any.
RequiresDepenizen, LuckPerms
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/luckperms/LuckPermsGroupTag.java#L134

Name<LuckPermsGroupTag.has_permission[<permission.node>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the group has the specified permission node.
RequiresDepenizen, LuckPerms
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/luckperms/LuckPermsGroupTag.java#L146



Category: LuckPermsTrackTag


Name<LuckPermsTrackTag.groups[(<player>)]>
ReturnsListTag
DescriptionThis returns names of the groups instead of ObjectType:LuckPermsGroupTags, as groups can be unloaded from LuckPerms but still be part of the track.
If a player input is specified, limits to only the groups that the player is in.
RequiresDepenizen, LuckPerms
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/luckperms/LuckPermsTrackTag.java#L149

Name<LuckPermsTrackTag.loaded_groups[(<player>)]>
ReturnsListTag(LuckPermsGroupTag)
DescriptionReturns the list of loaded groups in the track.
If a player input is specified, limits to only the groups that the player is in.
RequiresDepenizen, LuckPerms
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/luckperms/LuckPermsTrackTag.java#L180

Name<LuckPermsTrackTag.name>
ReturnsElementTag
DescriptionReturns the name of the track.
RequiresDepenizen, LuckPerms
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/luckperms/LuckPermsTrackTag.java#L138



Category: mobarena


Name<mobarena.list_arenas>
ReturnsListTag(MobArenaArenaTag)
DescriptionReturns a list of all MobArenas.
Generated Example
- foreach <mobarena.list_arenas> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/MobArenaBridge.java#L67



Category: MobArenaArenaTag


Name<MobArenaArenaTag.config_name>
ReturnsElementTag
DescriptionReturns the configuration name of the arena.
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L120

Name<MobArenaArenaTag.current_wave>
ReturnsElementTag(Number)
DescriptionReturns the current wave number.
NOTE: Requires the arena to be running.
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L154

Name<MobArenaArenaTag.is_enabled>
ReturnsElementTag(Boolean)
DescriptionReturns whether the arena is enabled.
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L180

Name<MobArenaArenaTag.is_running>
ReturnsElementTag(Boolean)
DescriptionReturns whether the arena is running.
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L131

Name<MobArenaArenaTag.name>
ReturnsElementTag
DescriptionReturns the name of the arena.
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L109

Name<MobArenaArenaTag.players>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of all players in the arena (including the lobby).
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L243

Name<MobArenaArenaTag.players.in_arena>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of players in the arena.
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L213

Name<MobArenaArenaTag.players.in_lobby>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of players in the lobby.
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L228

Name<MobArenaArenaTag.status>
ReturnsElementTag
DescriptionReturns the status of the arena.
Will return 'closed', 'open', or 'running'.
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L191

Name<MobArenaArenaTag.wave_count>
ReturnsElementTag(Number)
DescriptionReturns the number of waves this arena has in total.
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L142

Name<MobArenaArenaTag.wave_type>
ReturnsElementTag
DescriptionReturns the type of the current wave.
NOTE: Requires the arena to be running.
RequiresDepenizen, MobArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L167



Category: mythicmobs


Name<mythicmobs.active_mobs>
ReturnsListTag(MythicMobsMobTag)
DescriptionReturns a ListTag of all active MythicMobs on the server.
Generated Example
- foreach <mythicmobs.active_mobs> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/MythicMobsBridge.java#L151

Name<mythicmobs.spawners>
ReturnsListTag(MythicSpawnerTag)
DescriptionReturns a ListTag of all MythicSpawners.
Generated Example
- foreach <mythicmobs.spawners> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/MythicMobsBridge.java#L166



Category: MythicMobsMobTag


Name<MythicMobsMobTag.armor>
ReturnsElementTag(Decimal)
DescriptionReturns the armor the MythicMob has.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L227

Name<MythicMobsMobTag.damage>
ReturnsElementTag(Decimal)
DescriptionReturns the damage the MythicMob deals.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L216

Name<MythicMobsMobTag.display_name>
ReturnsElementTag
DescriptionReturns the display name of the MythicMob.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L152

Name<MythicMobsMobTag.entity>
ReturnsEntityTag
DescriptionReturns the EntityTag for the MythicMob.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L341

Name<MythicMobsMobTag.global_cooldown>
ReturnsDurationTag
MechanismMythicMobsMobTag.global_cooldown
DescriptionReturns the MythicMob's global cooldown.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L352

Name<MythicMobsMobTag.has_target>
ReturnsElementTag(Boolean)
DescriptionReturns whether the MythicMob has a target.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L238

Name<MythicMobsMobTag.has_threat_table>
ReturnsElementTag(Boolean)
DescriptionReturns whether the MythicMob has a threat table.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L265

Name<MythicMobsMobTag.internal_name>
ReturnsElementTag
DescriptionReturns the name MythicMobs identifies the MythicMob with.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L141

Name<MythicMobsMobTag.is_damaging>
ReturnsElementTag(Boolean)
DescriptionReturns whether the MythicMob is using its damaging skill.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L318

Name<MythicMobsMobTag.level>
ReturnsElementTag(Number)
MechanismMythicMobsMobTag.level
DescriptionReturns the level of the MythicMob.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L193

Name<MythicMobsMobTag.mythic_variable[<name>]>
ReturnsElementTag
DescriptionReturns the value of a MythicMobs variable for this MythicMob.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L364

Name<MythicMobsMobTag.mythic_variable_map>
ReturnsMapTag
MechanismMythicMobsMobTag.mythic_variable_map
DescriptionReturns a map of the MythicMob's variables.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L375

Name<MythicMobsMobTag.players_killed>
ReturnsElementTag(Number)
DescriptionReturns the number of players the MythicMob has killed.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L205

Name<MythicMobsMobTag.spawner>
ReturnsMythicSpawnerTag
DescriptionReturns the MythicSpawnerTag that spawned this mob.
Returns null, if the mob was spawned by something other than a spawner.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L178

Name<MythicMobsMobTag.spawner_name>
ReturnsElementTag
DescriptionReturns the name of the spawner (as set on creation in-game) that spawned this mob.
Returns null, if the mob was spawned by something other than a spawner.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L163

Name<MythicMobsMobTag.stance>
ReturnsElementTag
MechanismMythicMobsMobTag.stance
DescriptionReturns the current stance of the MythicMob.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L329

Name<MythicMobsMobTag.target>
ReturnsEntityTag
MechanismMythicMobsMobTag.target
DescriptionReturns the MythicMob's target.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L249

Name<MythicMobsMobTag.threat_table>
ReturnsMapTag
DescriptionReturns the MythicMob's threat table, can contain multiple types of entities.
Map is in the formatting of "UUID/Threat|UUID/Threat"
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L276

Name<MythicMobsMobTag.threat_table_players>
ReturnsMapTag
DescriptionReturns the MythicMob's threat table, only containing players.
Map is in the formatting of "UUID/Threat|UUID/Threat"
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L296



Category: MythicSpawnerTag


Name<MythicSpawnerTag.cooldown>
ReturnsDurationTag
MechanismMythicSpawnerTag.cooldown
DescriptionReturns the MythicSpawner's configured cooldown.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicSpawnerTag.java#L128

Name<MythicSpawnerTag.group>
ReturnsElementTag
MechanismMythicSpawnerTag.group
DescriptionReturns the MythicSpawner's group, if applicable.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicSpawnerTag.java#L195

Name<MythicSpawnerTag.location>
ReturnsLocationTag
MechanismMythicSpawnerTag.location
DescriptionReturns a LocationTag of the MythicSpawner's location.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicSpawnerTag.java#L182

Name<MythicSpawnerTag.mob_type>
ReturnsElementTag
MechanismMythicSpawnerTag.mob_type
DescriptionReturns the internal name the MythicMob mob type spawned.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicSpawnerTag.java#L155

Name<MythicSpawnerTag.mobs>
ReturnsListTag(EntityTag)
DescriptionReturns a ListTag of all active MythicMobs from this spawner.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicSpawnerTag.java#L167

Name<MythicSpawnerTag.mythic_mobs>
ReturnsListTag(MythicMobsMobTag)
DescriptionReturns a ListTag of all active MythicMobs from this spawner.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicSpawnerTag.java#L140

Name<MythicSpawnerTag.name>
ReturnsElementTag
DescriptionReturns the name of the MythicSpawner.
RequiresDepenizen, MythicMobs
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicSpawnerTag.java#L117



Category: NationTag


Name<NationTag.allies>
ReturnsListTag(NationTag)
DescriptionReturns a list of the nation's allies.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L155

Name<NationTag.assistants>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of the nation's assistants.
Deprecated in favor of Tag:NationTag.members_by_rank[<rank>].
RequiresDepenizen, Towny
Deprecateduse 'members_by_rank'
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L170

Name<NationTag.balance>
ReturnsElementTag(Decimal)
DescriptionReturns the current money balance of the nation.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L187

Name<NationTag.capital>
ReturnsTownTag
DescriptionReturns the capital city of the nation as a TownTag.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L198

Name<NationTag.enemies>
ReturnsListTag(NationTag)
DescriptionReturns a list of the nation's enemies.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L212

Name<NationTag.is_neutral>
ReturnsElementTag(Boolean)
DescriptionReturns true if the nation is neutral.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L243

Name<NationTag.king>
ReturnsPlayerTag
DescriptionReturns the king of the nation.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L254

Name<NationTag.members_by_rank[<rank>]>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of the nation's members with a given rank.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L227

Name<NationTag.name>
ReturnsElementTag
DescriptionReturns the nation's name.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L265

Name<NationTag.player_count>
ReturnsElementTag(Number)
DescriptionReturns the amount of players in the nation.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L276

Name<NationTag.relation[<nation>]>
ReturnsElementTag
DescriptionReturns the nation's current relation with another nation.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L287

Name<NationTag.residents>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of the nation's residents.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L313

Name<NationTag.tag>
ReturnsElementTag
DescriptionReturns the nation's tag.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L328

Name<NationTag.taxes>
ReturnsElementTag(Decimal)
DescriptionReturns the nation's current taxes.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L342

Name<NationTag.town_count>
ReturnsElementTag(Number)
DescriptionReturns the number of towns in the nation.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L353



Category: paper


Name<paper.tick_times>
ReturnsListTag(DurationTag)
DescriptionReturns a sample of the server's last 5s of tick times as a list of durations.
On average, a tick should take 50ms or less for a stable 20tps.
Generated Example
- foreach <paper.tick_times> as:entry:
    - narrate "found <[entry]>"
RequiresPaper
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/tags/PaperTagBase.java#L29



Category: PartyTag


Name<PartyTag.leader>
ReturnsPlayerTag
DescriptionReturns the leader of the party.
RequiresDepenizen, mcMMO
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mcmmo/PartyTag.java#L124

Name<PartyTag.members>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of all party members.
RequiresDepenizen, mcMMO
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mcmmo/PartyTag.java#L135

Name<PartyTag.name>
ReturnsElementTag
DescriptionReturns the name of the party.
RequiresDepenizen, mcMMO
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mcmmo/PartyTag.java#L113



Category: placeholder


Name<placeholder[<name>].player[<player>]>
ReturnsElementTag
DescriptionReturns the value of the placeholder for the specified player.
Generated Example
- narrate <placeholder.player[<player>]>
RequiresDepenizen, PlaceholderAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/PlaceholderAPIBridge.java#L73



Category: playerpoints


Name<playerpoints.leaders>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of all players known to PlayerPoints, sorted in order of point value.
Use like, for example, '<playerpoints.leaders.get[1].to[10]>' to get the top 10.
Generated Example
- foreach <playerpoints.leaders> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, PlayerPoints
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/PlayerPointsBridge.java#L59



Category: PlotSquaredPlotTag


Name<PlotSquaredPlotTag.all_cuboids>
ReturnsListTag(CuboidTag)
DescriptionReturns all the plot's cuboids in a list. Useful for merged plots.
RequiresDepenizen, PlotSquared
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L263

Name<PlotSquaredPlotTag.cuboid>
ReturnsCuboidTag
DescriptionReturns the plot's cuboid.
RequiresDepenizen, PlotSquared
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L249

Name<PlotSquaredPlotTag.default_home>
ReturnsLocationTag
DescriptionReturns the plot's default home location.
RequiresDepenizen, PlotSquared
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L166

Name<PlotSquaredPlotTag.denied>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of all players denied from the plot.
RequiresDepenizen, PlotSquared
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L219

Name<PlotSquaredPlotTag.home>
ReturnsLocationTag
DescriptionReturns the plot's current home location.
RequiresDepenizen, PlotSquared
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L154

Name<PlotSquaredPlotTag.id_x>
ReturnsElementTag(Number)
DescriptionReturns the plot's X coordinate portion of its ID.
RequiresDepenizen, PlotSquared
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L132

Name<PlotSquaredPlotTag.id_Z>
ReturnsElementTag(Number)
DescriptionReturns the plot's Z coordinate portion of its ID.
RequiresDepenizen, PlotSquared
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L143

Name<PlotSquaredPlotTag.members>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of all members of the plot.
RequiresDepenizen, PlotSquared
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L234

Name<PlotSquaredPlotTag.owners>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of all owners of the plot.
RequiresDepenizen, PlotSquared
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L189

Name<PlotSquaredPlotTag.trusted>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of all trusted of the plot.
RequiresDepenizen, PlotSquared
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L204

Name<PlotSquaredPlotTag.world>
ReturnsWorldTag
DescriptionReturns the plot's world.
RequiresDepenizen, PlotSquared
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L178



Category: pvparena


Name<pvparena.list_arenas>
ReturnsListTag(PVPArenaArenaTag)
DescriptionReturns a list of all PVPArenas.
Generated Example
- foreach <pvparena.list_arenas> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, PVPArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/PVPArenaBridge.java#L61



Category: PVPArenaArenaTag


Name<PVPArenaArenaTag.fighters>
ReturnsListTag(PlayerTag)
DescriptionReturns a list of all fighters in the arena.
RequiresDepenizen, PvPArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/pvparena/PVPArenaArenaTag.java#L113

Name<PVPArenaArenaTag.name>
ReturnsElementTag
DescriptionReturns the name of the arena.
RequiresDepenizen, PVPArena
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/pvparena/PVPArenaArenaTag.java#L102



Category: quests


Name<quests.list_quests>
ReturnsListTag
DescriptionReturns a list of all quest IDs from the Quests plugin.
Generated Example
- foreach <quests.list_quests> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, Quests
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/QuestsBridge.java#L46



Category: ResidenceTag


Name<ResidenceTag.area>
ReturnsCuboidTag
DescriptionReturns the area of the Residences.
Generated Example
- note <residence[myresidence].area> as:my_new_cuboid
RequiresDepenizen, Residence
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/residence/ResidenceTag.java#L162

Name<ResidenceTag.is_within[<location>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the specified location is within this Residence.
Generated Example
- if <residence[myresidence].is_within[<player.location>]>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, Residence
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/residence/ResidenceTag.java#L174

Name<ResidenceTag.name>
ReturnsElementTag
DescriptionReturns the name of this Residence.
Generated Example
- narrate <residence[myresidence].name>
RequiresDepenizen, Residence
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/residence/ResidenceTag.java#L125

Name<ResidenceTag.owner>
ReturnsPlayerTag
DescriptionReturns the owner of the Residence.
Generated Example
- kill <residence[myresidence].owner>
RequiresDepenizen, Residence
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/residence/ResidenceTag.java#L136

Name<ResidenceTag.subzones>
ReturnsListTag(ResidenceTag)
DescriptionReturns a list of subzones in this Residence.
Generated Example
- foreach <residence[myresidence].subzones> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, Residence
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/residence/ResidenceTag.java#L147



Category: ShopKeeperTag


Name<ShopKeeperTag.entity>
ReturnsEntityTag
DescriptionReturns the EntityTag for this ShopKeeper, if any.
RequiresDepenizen, ShopKeepers
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/shopkeepers/ShopKeeperTag.java#L142

Name<ShopKeeperTag.is_active>
ReturnsElementTag(Boolean)
DescriptionReturns whether the Shopkeeper is active (has been spawned and is still valid and present in the world).
RequiresDepenizen, ShopKeepers
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/shopkeepers/ShopKeeperTag.java#L108

Name<ShopKeeperTag.is_ui_active>
ReturnsElementTag(Boolean)
DescriptionReturns whether the Shopkeeper's UI is currently active (may be false when the UI is about to be closed).
RequiresDepenizen, ShopKeepers
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/shopkeepers/ShopKeeperTag.java#L119

Name<ShopKeeperTag.owner>
ReturnsPlayerTag
DescriptionReturns the player that owns this ShopKeeper, if any.
RequiresDepenizen, ShopKeepers
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/shopkeepers/ShopKeeperTag.java#L153

Name<ShopKeeperTag.trades>
ReturnsListTag(ListTag(ItemTag))
DescriptionReturns a ListTag of the Shopkeeper's trades (as sub-lists).
RequiresDepenizen, ShopKeepers
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/shopkeepers/ShopKeeperTag.java#L131



Category: SkillAPIClassTag


Name<SkillAPIClassTag.base_health>
ReturnsElementTag(Decimal)
DescriptionReturns the base amount of health for this SkillAPI class.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L211

Name<SkillAPIClassTag.base_mana>
ReturnsElementTag(Decimal)
DescriptionReturns the base amount of mana for this SkillAPI class.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L233

Name<SkillAPIClassTag.class_prefix>
ReturnsElementTag
DescriptionReturns the prefix of this SkillAPI class.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L130

Name<SkillAPIClassTag.group_name>
ReturnsElementTag
DescriptionReturns the name of the group that this SkillAPI class falls into.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L152

Name<SkillAPIClassTag.has_mana_regen>
ReturnsElementTag(Boolean)
DescriptionReturns whether this SkillAPI class has mana regeneration.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L266

Name<SkillAPIClassTag.has_parent>
ReturnsElementTag(Boolean)
DescriptionReturns the whether this SkillAPI class has a parent class.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L167

Name<SkillAPIClassTag.health_scale>
ReturnsElementTag(Decimal)
DescriptionReturns the amount of health gained per level for this SkillAPI class.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L222

Name<SkillAPIClassTag.icon>
ReturnsItemTag
DescriptionReturns the item icon representing this SkillAPI class in menus.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L189

Name<SkillAPIClassTag.mana_name>
ReturnsElementTag
DescriptionReturns the alias for mana that this SkillAPI class uses.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L255

Name<SkillAPIClassTag.mana_regen>
ReturnsElementTag(Decimal)
DescriptionReturns the amount of mana regeneration that this SkillAPI class has.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L277

Name<SkillAPIClassTag.mana_scale>
ReturnsElementTag(Decimal)
DescriptionReturns the amount of mana gained per level for this SkillAPI class.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L244

Name<SkillAPIClassTag.max_level>
ReturnsElementTag(Number)
DescriptionReturns the maximum level that this SkillAPI class can reach.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L200

Name<SkillAPIClassTag.name>
ReturnsElementTag
DescriptionReturns the name of this SkillAPI class.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L108

Name<SkillAPIClassTag.needs_permission>
ReturnsElementTag(Boolean)
DescriptionReturns whether this SkillAPI class requires permission to profess as it.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L141

Name<SkillAPIClassTag.parent>
ReturnsSkillAPIClassTag
DescriptionReturns the parent class of this SkillAPI class.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L178

Name<SkillAPIClassTag.prefix_color>
ReturnsElementTag
DescriptionReturns the color of the prefix of this SkillAPI class.
RequiresDepenizen, SkillAPI
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L119



Category: skyblock


Name<skyblock.island_count>
ReturnsElementTag(Number)
DescriptionReturns the number of Skyblock Islands that exist.
Generated Example
- narrate "the number value is <skyblock.island_count>"
RequiresDepenizen, A SkyBlock
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/ASkyBlockBridge.java#L73

Name<skyblock.island_world>
ReturnsWorldTag
DescriptionReturns the world that A Skyblock uses for islands.
Generated Example
- adjust <skyblock.island_world> full_time:0
RequiresDepenizen, A SkyBlock
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/ASkyBlockBridge.java#L51

Name<skyblock.nether_world>
ReturnsWorldTag
DescriptionReturns the world that A Skyblock uses for the nether.
Generated Example
- adjust <skyblock.nether_world> destroy
RequiresDepenizen, A SkyBlock
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/ASkyBlockBridge.java#L62



Category: TownTag


Name<TownTag.assistants>
ReturnsListTag
DescriptionReturns a list of the town's assistants. Players will be valid PlayerTag instances, non-players will be plaintext of the name.
Deprecated in favor of Tag:TownTag.members_by_rank[<rank>].
RequiresDepenizen, Towny
Deprecateduse 'members_by_rank'
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L194

Name<TownTag.balance>
ReturnsElementTag(Decimal)
MechanismTownTag.balance
DescriptionReturns the current money balance of the object.town.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L207

Name<TownTag.board>
ReturnsElementTag
DescriptionReturns the town's current board.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L219

Name<TownTag.cuboids>
ReturnsListTag(CuboidTag)
DescriptionReturns a list of plot cuboids claimed by the town.
Note that the cuboids may be in separate worlds if the town has outposts.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L506

Name<TownTag.has_explosions>
ReturnsElementTag(Boolean)
DescriptionReturns if the town has explosions turned on.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L416

Name<TownTag.has_firespread>
ReturnsElementTag(Boolean)
DescriptionReturns if the town has firespread turned on.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L449

Name<TownTag.has_mobs>
ReturnsElementTag(Boolean)
DescriptionReturns if the town has mobs turned on.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L427

Name<TownTag.has_pvp>
ReturnsElementTag(Boolean)
DescriptionReturns if the town has PvP turned on.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L438

Name<TownTag.has_taxpercent>
ReturnsElementTag(Boolean)
DescriptionReturns if the town has taxes in percentage.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L460

Name<TownTag.is_open>
ReturnsElementTag(Boolean)
DescriptionReturns true if the town is currently open.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L241

Name<TownTag.is_public>
ReturnsElementTag(Boolean)
DescriptionReturns true if the town is currently public.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L252

Name<TownTag.mayor>
ReturnsPlayerTag
DescriptionReturns the mayor of the object.town.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L263

Name<TownTag.members_by_rank[<rank>]>
ReturnsListTag
DescriptionReturns a list of the town's members with a given rank. Players will be valid PlayerTag instances, non-players will be plaintext of the name.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L230

Name<TownTag.name>
ReturnsElementTag
DescriptionReturns the town's name.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L281

Name<TownTag.nation>
ReturnsNationTag
DescriptionReturns the nation that the town belongs to.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L292

Name<TownTag.outlaws>
ReturnsListTag
DescriptionReturns a list of the town's outlaws. Players will be valid PlayerTag instances, non-players will be plaintext of the name.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L308

Name<TownTag.outposts>
ReturnsListTag(LocationTag)
DescriptionReturns a list of the town's outpost locations.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L401

Name<TownTag.player_count>
ReturnsElementTag(Number)
DescriptionReturns the number of players in the object.town.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L319

Name<TownTag.plot_object_group_names>
ReturnsListTag
DescriptionReturns a list of the names of town plot object groups.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L471

Name<TownTag.plotprice>
ReturnsElementTag(Decimal)
DescriptionReturns the price of a plot.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L533

Name<TownTag.plots>
ReturnsListTag(ChunkTag)
DescriptionReturns a list of chunks the town has claimed.
Note that this will not be accurate if the plot size has been changed in your Towny config.
Generally, use Tag:TownTag.cuboids instead.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L489

Name<TownTag.plottax>
ReturnsElementTag(Decimal)
DescriptionReturns the amount of taxes collected from plots.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L522

Name<TownTag.residents>
ReturnsListTag
DescriptionReturns a list of the town's residents. Players will be valid PlayerTag instances, non-players will be plaintext of the name.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L330

Name<TownTag.size>
ReturnsElementTag(Number)
DescriptionReturns the number of blocks the town owns.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L352

Name<TownTag.spawn>
ReturnsLocationTag
DescriptionReturns the spawn point of the object.town.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L363

Name<TownTag.tag>
ReturnsElementTag
DescriptionReturns the town's tag.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L379

Name<TownTag.taxes>
ReturnsElementTag(Decimal)
DescriptionReturns the town's current taxes.
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L390



Category: towny


Name<towny.list_towns[(<world>)]>
ReturnsListTag(TownTag)
DescriptionReturns a list of all towns. Optionally specify a world name.
Generated Example
- foreach <towny.list_towns> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/TownyBridge.java#L68

Name<towny.nations>
ReturnsListTag(NationTag)
DescriptionReturns a list of all nations.
Generated Example
- foreach <towny.nations> as:entry:
    - narrate "found <[entry]>"
RequiresDepenizen, Towny
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/TownyBridge.java#L95



Category: WorldGuardRegionTag


Name<WorldGuardRegionTag.children>
ReturnsListTag(WorldGuardRegionTag)
DescriptionGets a list of all children of this region.
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L208

Name<WorldGuardRegionTag.id>
ReturnsElementTag
DescriptionGets the ID name of the region.
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L185

Name<WorldGuardRegionTag.members>
ReturnsListTag(PlayerTag)
DescriptionGets a list of all members of a region. (Members are permitted to build, etc.)
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L226

Name<WorldGuardRegionTag.owners>
ReturnsListTag(PlayerTag)
DescriptionGets a list of all owners of a region. (Owners are permitted to build, edit settings, etc.)
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L241

Name<WorldGuardRegionTag.parent>
ReturnsWorldGuardRegionTag
DescriptionGets the parent region of this region (if any).
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L196

Name<WorldGuardRegionTag.world>
ReturnsWorldTag
DescriptionGets the WorldTag this region is in.
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L256

Name<WorldGuardRegionTag.area>
ReturnsAreaObject
DescriptionReturns the region's block area as a CuboidTag or PolygonTag.
Groupconversion
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L151