Name | <&[<custom_color_name>]> |
Returns | ElementTag |
Description | Returns 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'. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/CustomColorTagBase.java#L42 |
Name | <&0> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Black. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L347 |
Name | <&1> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Blue. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L354 |
Name | <&2> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Green. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L361 |
Name | <&3> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Cyan. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L368 |
Name | <&4> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Red. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L375 |
Name | <&5> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Magenta. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L382 |
Name | <&6> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Gold. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L389 |
Name | <&7> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Light Gray. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L396 |
Name | <&8> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Gray. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L403 |
Name | <&9> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Light Blue. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L410 |
Name | <&a> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Light Green. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L417 |
Name | <&at> |
Returns | ElementTag |
Description | Returns a at symbol: @ |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L19 |
Name | <&b> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Cyan. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L424 |
Name | <&bs> |
Returns | ElementTag |
Description | Returns a backslash symbol: \ |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L148 |
Name | <&c> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Light Red. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L431 |
Name | <&chr[<character>]> |
Returns | ElementTag |
Description | Returns the Unicode character specified. e.g. <&chr[2665]> returns a heart. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L156 |
Name | <&click[<click_command>]> |
Returns | ElementTag |
Description | Returns 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 Denizen Text Formatting. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L67 |
Name | <&click[<click_command>].type[<type>]> |
Returns | ElementTag |
Description | Returns 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 Denizen Text Formatting. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L84 |
Name | <&co> |
Returns | ElementTag |
Description | Returns a colon symbol: : |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L84 |
Name | <&color[<color>]> |
Returns | ElementTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L249 |
Name | <&d> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Magenta. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L438 |
Name | <&dq> |
Returns | ElementTag |
Description | Returns a double-quote symbol: " |
Generated Example |
|
Synonyms (Search Aid) | "e |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L75 |
Name | <&e> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Yellow. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L445 |
Name | <&end_click> |
Returns | ElementTag |
Description | Returns a special chat code that ends a '&click' tag.
Note that this is a magic Denizen tool - refer to Denizen Text Formatting. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L119 |
Name | <&end_hover> |
Returns | ElementTag |
Description | Returns a special chat code that ends a '&hover' tag.
Note that this is a magic Denizen tool - refer to Denizen Text Formatting. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L130 |
Name | <&end_insertion> |
Returns | ElementTag |
Description | Returns a special chat code that ends an '&insertion' tag.
Note that this is a magic Denizen tool - refer to Denizen Text Formatting. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L141 |
Name | <&f> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters White. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L452 |
Name | <&font[<font>]> |
Returns | ElementTag |
Description | Returns 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 Denizen Text Formatting. |
Source | https://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)]> |
Returns | ElementTag |
Description | Returns a chat code that makes the following text be the specified color.
Input works equivalently to 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 Denizen Text Formatting. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L293 |
Name | <>> |
Returns | ElementTag |
Description | Returns a greater than symbol: > |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L140 |
Name | <&hover[<hover_text>]> |
Returns | ElementTag |
Description | Returns 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 Denizen Text Formatting. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L33 |
Name | <&hover[<hover_text>].type[<type>]> |
Returns | ElementTag |
Description | Returns 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 Denizen Text Formatting. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L48 |
Name | <&insertion[<message>]> |
Returns | ElementTag |
Description | Returns 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 Denizen Text Formatting. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L102 |
Name | <&k> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters obfuscated. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L459 |
Name | <&keybind[<key>]> |
Returns | ElementTag |
Description | Returns 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 Denizen Text Formatting. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L152 |
Name | <&l> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters bold. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L466 |
Name | <&lb> |
Returns | ElementTag |
Description | Returns a left-bracket symbol: [ |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L100 |
Name | <&lc> |
Returns | ElementTag |
Description | Returns a left-brace symbol: { |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L116 |
Name | <<> |
Returns | ElementTag |
Description | Returns a less than symbol: < |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L132 |
Name | <&m> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters have a strike-through. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L473 |
Name | <&n> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters have an underline. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L480 |
Name | < > |
Returns | ElementTag |
Description | Returns a non-breaking space symbol. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L67 |
Name | <&nl> |
Returns | ElementTag |
Description | Returns a newline symbol. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L35 |
Name | <&ns> |
Returns | ElementTag |
Description | Returns a number sign / hash / pound symbol: # |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L124 |
Name | <&o> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters italicized. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L487 |
Name | <&optimize> |
Returns | ElementTag |
Description | Returns 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 Denizen Text Formatting. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L333 |
Name | <&pc> |
Returns | ElementTag |
Description | Returns a percent symbol: % |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L27 |
Name | <&r> |
Returns | ElementTag |
Description | Returns the ChatColor that resets the following characters to normal. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L494 |
Name | <&rb> |
Returns | ElementTag |
Description | Returns a right-bracket symbol: ] |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L92 |
Name | <&rc> |
Returns | ElementTag |
Description | Returns a right-brace symbol: } |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L108 |
Name | <&score[<name>|<objective>(|<value>)]> |
Returns | ElementTag |
Description | Returns 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 Denizen Text Formatting. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L226 |
Name | <&selector[<key>]> |
Returns | ElementTag |
Description | Returns a special chat code that displays a vanilla selector.
Note that this is a magic Denizen tool - refer to Denizen Text Formatting. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L168 |
Name | <&sp> |
Returns | ElementTag |
Description | Returns a space symbol. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L59 |
Name | <&sq> |
Returns | ElementTag |
Description | Returns a single-quote symbol: ' |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L51 |
Name | <&ss> |
Returns | ElementTag |
Description | Returns an internal coloring symbol: § |
Generated Example |
|
Source | https://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>|...)]> |
Returns | ElementTag |
Description | Returns 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 Denizen Text Formatting. You can use ElementTag.strip_color to convert the translated output to plain text (pre-translated). |
Example |
|
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L183 |
Name | <&translate[<key>].with[<text>|...]> |
Returns | ElementTag |
Description | Deprecated in favor of &translate. |
Deprecated | Use '<&translate[key=<key>;with=<text>|...]>'. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L211 |
Name | <aqua> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Cyan. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L578 |
Name | <binary[<binary>]> |
Returns | BinaryTag |
Description | Returns a BinaryTag constructed from the input binary data in hexadecimal format.
Refer to BinaryTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L74 |
Name | <biome[<biome>]> |
Returns | BiomeTag |
Description | Returns a biome object constructed from the input value.
Refer to BiomeTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L121 |
Name | <black> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Black. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L501 |
Name | <blue> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Light Blue. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L564 |
Name | <bold> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters bold. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L620 |
Name | <chunk[<chunk>]> |
Returns | ChunkTag |
Description | Returns a chunk object constructed from the input value.
Refer to ChunkTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L130 |
Name | <color[<color>]> |
Returns | ColorTag |
Description | Returns a color object constructed from the input value.
Refer to ColorTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L83 |
Name | <cuboid[<cuboid>]> |
Returns | CuboidTag |
Description | Returns a cuboid object constructed from the input value.
Refer to CuboidTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L139 |
Name | <custom_object[<custom-object>]> |
Returns | CustomObjectTag |
Description | Returns a custom object constructed from the input value.
Refer to CustomObjectTag. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L92 |
Name | <dark_aqua> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Cyan. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L522 |
Name | <dark_blue> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Blue. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L508 |
Name | <dark_gray> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Gray. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L557 |
Name | <dark_green> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Green. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L515 |
Name | <dark_purple> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Magenta. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L536 |
Name | <dark_red> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Red. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L529 |
Name | <definition[<name>]> |
Returns | ObjectTag |
Description | Returns 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 |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/DefinitionTagBase.java#L14 |
Name | <duration[<duration>]> |
Returns | DurationTag |
Description | Returns a duration object constructed from the input value.
Refer to DurationTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L101 |
Name | <element[<element>]> |
Returns | ElementTag |
Description | Returns an element constructed from the input value.
Refer to ElementTag. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L110 |
Name | <ellipsoid[<ellipsoid>]> |
Returns | EllipsoidTag |
Description | Returns an ellipsoid object constructed from the input value.
Refer to EllipsoidTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L148 |
Name | <empty> |
Returns | ElementTag |
Description | Returns an empty element. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L11 |
Name | <enchantment[<enchantment>]> |
Returns | EnchantmentTag |
Description | Returns an enchantment object constructed from the input value.
Refer to EnchantmentTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L157 |
Name | <entity[<entity>]> |
Returns | EntityTag |
Description | Returns an entity object constructed from the input value.
Refer to EntityTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L166 |
Name | <gold> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Gold. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L543 |
Name | <gray> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Light Gray. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L550 |
Name | <green> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Light Green. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L571 |
Name | <image[<image>]> |
Returns | ImageTag |
Description | Returns an ImageTag constructed from the input value.
Refer to ImageTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L121 |
Name | <inventory[<inventory>]> |
Returns | InventoryTag |
Description | Returns an inventory object constructed from the input value.
Refer to InventoryTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L228 |
Name | <italic> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters italicized. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L641 |
Name | <item[<item>]> |
Returns | ItemTag |
Description | Returns an item object constructed from the input value.
Refer to ItemTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L238 |
Name | <light_purple> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Magenta. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L592 |
Name | <list[(<list>)]> |
Returns | ListTag |
Description | Returns a list object constructed from the input value.
Give no input to create an empty list. Refer to ListTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/ListTagBase.java#L10 |
Name | <list_single[<object>]> |
Returns | ListTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/ListSingleTagBase.java#L11 |
Name | <location[<location>]> |
Returns | LocationTag |
Description | Returns a location object constructed from the input value.
Refer to LocationTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L248 |
Name | <magic> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters obfuscated. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L613 |
Name | <map[(<map>)]> |
Returns | MapTag |
Description | Returns a map object constructed from the input value.
Give no input to create an empty map. Refer to MapTag. For example: <map[a=1;b=2;c=3]> |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/MapTagBase.java#L10 |
Name | <material[<material>]> |
Returns | MaterialTag |
Description | Returns a material object constructed from the input value.
Refer to MaterialTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L257 |
Name | <n> |
Returns | ElementTag |
Description | Returns a newline symbol. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/CoreTextTagBases.java#L164 |
Name | <npc[(<npc>)]> |
Returns | NPCTag |
Description | Returns an npc object constructed from the input value.
Refer to NPCTag. If no input value is specified, returns the linked NPC. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/NPCTagBase.java#L45 |
Name | <p> |
Returns | ElementTag |
Description | Returns a paragraph, for use in books. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L25 |
Name | <player[(<player>)]> |
Returns | PlayerTag |
Description | Returns a player object constructed from the input value.
Refer to PlayerTag. If no input value is specified, returns the linked player. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/PlayerTagBase.java#L20 |
Name | <plugin[<plugin>]> |
Returns | PluginTag |
Description | Returns a plugin object constructed from the input value.
Refer to PluginTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L330 |
Name | <polygon[<polygon>]> |
Returns | PolygonTag |
Description | Returns a polygon object constructed from the input value.
Refer to PolygonTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L339 |
Name | <proc[<procedure_script_name>]> |
Returns | ObjectTag |
Description | Returns the 'determine' result of a procedure script. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/ProcedureScriptTagBase.java#L29 |
Name | <quaternion[<quaternion>]> |
Returns | QuaternionTag |
Description | Returns a QuaternionTag object constructed from the input value.
Refer to QuaternionTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L167 |
Name | <queue[(<queue>)]> |
Returns | QueueTag |
Description | Returns a queue object constructed from the input value.
Refer to QueueTag. If no input is given, returns the current queue. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/QueueTagBase.java#L18 |
Name | <red> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Light Red. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L585 |
Name | <reflected[<reflected-tag>]> |
Returns | JavaReflectedObjectTag |
Description | Returns a JavaReflectedObjectTag constructed from the input reference ID lookup.
Refer to JavaReflectedObjectTag. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L130 |
Name | <reset> |
Returns | ElementTag |
Description | Returns the ChatColor that resets the following characters to normal. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L648 |
Name | <script[(<script>)]> |
Returns | ScriptTag |
Description | Returns 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 ScriptTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/ScriptTagBase.java#L10 |
Name | <secret[<secret>]> |
Returns | SecretTag |
Description | Returns a SecretTag object constructed from the input value.
Refer to SecretTag. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L182 |
Name | <static[<tagged-value>]> |
Returns | ObjectTag |
Description | Forces the tag inside to static-parse.
That is, any value, no matter how dynamic, will parse only exactly once at reload time. This is a special internal behavior of Denizen that usually should not be used unless you have a very specific reason. Whatever tag is inside should be globally-unique to the use case, as the raw text of the tag itself is used for a cache lookup. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/StaticTagBase.java#L10 |
Name | <strikethrough> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters have a strike-through. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L627 |
Name | <time[<time>]> |
Returns | TimeTag |
Description | Returns a time object constructed from the input value.
Refer to TimeTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L193 |
Name | <trade[<trade>]> |
Returns | TradeTag |
Description | Returns a trade object constructed from the input value.
Refer to TradeTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L348 |
Name | <underline> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters have an underline. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L634 |
Name | <white> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters White. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L606 |
Name | <world[<world>]> |
Returns | WorldTag |
Description | Returns a world object constructed from the input value.
Refer to WorldTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L358 |
Name | <yellow> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Yellow. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/TextTagBase.java#L599 |
Name | <bigdoor[<door>]> |
Returns | BigDoorsDoorTag |
Description | Returns a BigDoorsDoorTag object constructed from the input value.
Refer to BigDoorsDoorTag. |
Requires | Depenizen, Big Doors |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/BigDoorsBridge.java#L32 |
Name | <discord[<bot-id>]> |
Returns | DiscordBotTag |
Description | Returns the Discord bot for the given bot ID. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L117 |
Name | <discord_bots> |
Returns | ListTag(DiscordBotTag) |
Description | Returns a list of all Discord bots currently loaded in dDiscordBot. |
Generated Example |
|
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L102 |
Name | <discord_button[(<button>)]> |
Returns | DiscordButtonTag |
Description | Returns 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 DiscordButtonTag. |
Generated Example |
|
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L132 |
Name | <discord_channel[<channel>]> |
Returns | DiscordChannelTag |
Description | Returns a Discord Channel object constructed from the input value.
Refer to DiscordChannelTag. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L148 |
Name | <discord_command[<command>]> |
Returns | DiscordCommandTag |
Description | Returns a Discord Command object constructed from the input value.
Refer to DiscordCommandTag. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L164 |
Name | <discord_embed[(<embed>)]> |
Returns | DiscordEmbedTag |
Description | Returns 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 DiscordEmbedTag. |
Generated Example |
|
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L180 |
Name | <discord_group[<group>]> |
Returns | DiscordGroupTag |
Description | Returns a Discord Group object constructed from the input value.
Refer to DiscordGroupTag. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L196 |
Name | <discord_interaction[<interaction>]> |
Returns | DiscordInteractionTag |
Description | Returns a Discord Interaction object constructed from the input value.
Refer to DiscordInteractionTag. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L212 |
Name | <discord_message[<message>]> |
Returns | DiscordMessageTag |
Description | Returns a Discord Message object constructed from the input value.
Refer to DiscordMessageTag. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L228 |
Name | <discord_reaction[<reaction>]> |
Returns | DiscordReactionTag |
Description | Returns a Discord Reaction object constructed from the input value.
Refer to DiscordReactionTag. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L244 |
Name | <discord_role[<role>]> |
Returns | DiscordRoleTag |
Description | Returns a Discord Role object constructed from the input value.
Refer to DiscordRoleTag. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L260 |
Name | <discord_selection[(<menu>)]> |
Returns | DiscordSelectionTag |
Description | Returns 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 DiscordSelectionTag. |
Generated Example |
|
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L276 |
Name | <discord_text_input[(<button>)]> |
Returns | DiscordTextInputTag |
Description | Returns 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 DiscordTextInputTag. |
Generated Example |
|
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L292 |
Name | <discord_user[<user>]> |
Returns | DiscordUserTag |
Description | Returns a Discord User object constructed from the input value.
Refer to DiscordUserTag. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/DenizenDiscordBot.java#L308 |
Name | <faction[<name>]> |
Returns | FactionTag |
Description | Returns the faction for the input name. |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/FactionsBridge.java#L49 |
Name | <jobs> |
Returns | ListTag(JobsJobTag) |
Description | Returns the list of all jobs on the server. |
Generated Example |
|
Requires | Depenizen, Jobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/JobsBridge.java#L37 |
Name | <jobs_job[<name>]> |
Returns | JobsJobTag |
Description | Returns the job tag with the given name. |
Requires | Depenizen, Jobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/JobsBridge.java#L52 |
Name | <luckperms_group[<name>]> |
Returns | LuckPermsGroupTag |
Description | Returns the luckperms group tag with the given name. |
Requires | Depenizen, LuckPerms |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/LuckPermsBridge.java#L73 |
Name | <mobarena[<name>]> |
Returns | MobArenaArenaTag |
Description | Returns the mob arena for the input name. |
Requires | Depenizen, MobArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/MobArenaBridge.java#L47 |
Name | <mythic_item[<name>]> |
Returns | ItemTag |
Description | Returns an ItemTag of the named mythic item. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/MythicMobsBridge.java#L94 |
Name | <mythicmob[<name>]> |
Returns | MythicMobsMobTag |
Description | Returns a MythicMobsMobTag based on the name input.
Refer to MythicMobsMobTag. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/MythicMobsBridge.java#L116 |
Name | <mythicspawner[<name>]> |
Returns | MythicSpawnerTag |
Description | Returns a MythicSpawnerTag based on the name input.
Refer to MythicSpawnerTag. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/MythicMobsBridge.java#L132 |
Name | <nation[<name>]> |
Returns | NationTag |
Description | Returns the nation by the input name. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/TownyBridge.java#L142 |
Name | <party[<party>]> |
Returns | PartyTag |
Description | Returns a party object constructed from the input value.
Refer to PartyTag. |
Requires | Depenizen, mcMMO |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/McMMOBridge.java#L48 |
Name | <placeholder[<name>]> |
Returns | ElementTag |
Description | Returns 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. |
Requires | Depenizen, PlaceholderAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/PlaceholderAPIBridge.java#L53 |
Name | <pvparena[<name>]> |
Returns | PVPArenaArenaTag |
Description | Returns the PVPArena by the input name. |
Requires | Depenizen, PVPArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/PVPArenaBridge.java#L43 |
Name | <region[<region>]> |
Returns | WorldGuardRegionTag |
Description | Returns a WorldGuard region object constructed from the input value.
Refer to WorldGuardRegionTag. |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/WorldGuardBridge.java#L39 |
Name | <residence[<name>]> |
Returns | ResidenceTag |
Description | Returns a residence object constructed from the input value.
Refer to ResidenceTag. |
Requires | Depenizen, Residence |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/ResidenceBridge.java#L16 |
Name | <town[<name>]> |
Returns | TownTag |
Description | Returns the town by the input name. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/TownyBridge.java#L114 |
Name | <AreaObject.approximate_overlap_areas> |
Returns | ListTag(AreaObject) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L348 |
Name | <AreaObject.blocks[(<matcher>)]> |
Returns | ListTag(LocationTag) |
Description | Returns each block location within the area.
Optionally, specify a material matcher to only return locations with that block type. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L214 |
Name | <AreaObject.blocks_flagged[<flag_name>]> |
Returns | ListTag(LocationTag) |
Description | Gets 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L265 |
Name | <AreaObject.bounding_box> |
Returns | CuboidTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L93 |
Name | <AreaObject.contains[<location>]> |
Returns | ElementTag(Boolean) |
Description | Returns a boolean indicating whether the specified location is inside this area. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L198 |
Name | <AreaObject.entities[(<matcher>)]> |
Returns | ListTag(EntityTag) |
Description | Gets a list of all entities currently within the area, with an optional search parameter for the entity. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L157 |
Name | <AreaObject.is_within[<cuboid>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether this area is fully inside another cuboid. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L293 |
Name | <AreaObject.living_entities> |
Returns | ListTag(EntityTag) |
Description | Gets a list of all living entities currently within the area.
This includes Players, mobs, NPCs, etc., but excludes dropped items, experience orbs, etc. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L181 |
Name | <AreaObject.npcs> |
Returns | ListTag(NPCTag) |
Description | Gets a list of all NPCs currently within the area. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L134 |
Name | <AreaObject.players> |
Returns | ListTag(PlayerTag) |
Description | Gets a list of all players currently within the area. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L120 |
Name | <AreaObject.shell> |
Returns | ListTag(LocationTag) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L279 |
Name | <AreaObject.spawnable_blocks[(<matcher>)]> |
Returns | ListTag(LocationTag) |
Description | Returns 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 LocationTag.is_spawnable |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L239 |
Name | <AreaObject.with_world[<world>]> |
Returns | AreaObject |
Description | Returns a copy of the area, with the specified world. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L335 |
Name | <AreaObject.world> |
Returns | WorldTag |
Description | Returns the area's world. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L108 |
Name | <BinaryTag.decode_integer> |
Returns | ElementTag(Number) |
Description | Returns 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 ElementTag.integer_to_binary |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L233 |
Name | <BinaryTag.gzip_compress> |
Returns | BinaryTag |
Description | Returns the binary data, compressed via gzip.
See also BinaryTag.gzip_decompress |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L265 |
Name | <BinaryTag.gzip_decompress> |
Returns | BinaryTag |
Description | Returns the binary data, compressed via gzip.
See also BinaryTag.gzip_compress |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L282 |
Name | <BinaryTag.hash[<format>]> |
Returns | BinaryTag |
Description | Returns 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 |
|
Source | https://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>]> |
Returns | BinaryTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L355 |
Name | <BinaryTag.length> |
Returns | ElementTag(Number) |
Description | Returns the number of bytes in this BinaryTag. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L155 |
Name | <BinaryTag.text_decode[<encoding>]> |
Returns | ElementTag |
Description | Returns 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 ElementTag.text_encode |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L212 |
Name | <BinaryTag.to_base64> |
Returns | ElementTag |
Description | Returns a base64 encoding of the binary data.
See also ElementTag.base64_to_binary |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L181 |
Name | <BinaryTag.to_hex> |
Returns | ElementTag |
Description | Returns a flat hexadecimal encoding of the binary data. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L168 |
Name | <BinaryTag.to_image> |
Returns | ImageTag |
Description | Returns an ImageTag of the image represented by the binary data, or null if the binary data doesn't represent an image. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L394 |
Name | <BinaryTag.utf8_decode> |
Returns | ElementTag |
Description | Returns the raw text represented by this binary data, decoding using the standard UTF-8 encoding.
See also ElementTag.utf8_encode |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L198 |
Name | <BinaryTag.zlib_compress> |
Returns | BinaryTag |
Description | Returns the binary data, compressed via zlib.
See also BinaryTag.zlib_decompress |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L299 |
Name | <BinaryTag.zlib_decompress> |
Returns | BinaryTag |
Description | Returns the binary data, compressed via zlib.
See also BinaryTag.zlib_compress |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/BinaryTag.java#L316 |
Name | <BinaryTag.nbt_to_map> |
Returns | MapTag |
Description | Converts raw NBT binary data to a MapTag.
This under some circumstances might not return a map, depending on the underlying data. Refer to Raw NBT Encoding |
Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitBinaryTagExtensions.java#L16 |
Name | <BiomeTag.base_temperature> |
Returns | ElementTag(Decimal) |
Mechanism | BiomeTag.base_temperature |
Description | Returns the base temperature of this biome, which is used for per-location temperature calculations (see BiomeTag.temperature_at). |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L215 |
Name | <BiomeTag.downfall_at[<location>]> |
Returns | ElementTag |
Description | Returns this biome's downfall type at a location (for when a world has weather).
This can be RAIN, SNOW, or NONE. Generally LocationTag.downfall_type should be preferred, other than some special cases. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L307 |
Name | <BiomeTag.downfall_type> |
Returns | ElementTag |
Mechanism | BiomeTag.downfall_type |
Description | Deprecated in favor of 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 |
|
Deprecated | Minecraft changed the way biome downfall works, use BiomeTag.downfall_at on 1.19+. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L168 |
Name | <BiomeTag.fog_color> |
Returns | ColorTag |
Mechanism | BiomeTag.fog_color |
Description | Returns the biome's fog color, which is visible when outside water (see also BiomeTag.water_fog_color). |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L339 |
Name | <BiomeTag.foliage_color> |
Returns | ColorTag |
Mechanism | BiomeTag.foliage_color |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L276 |
Name | <BiomeTag.has_downfall> |
Returns | ElementTag(Boolean) |
Mechanism | BiomeTag.has_downfall |
Description | Returns whether the biome has downfall (rain/snow). |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L322 |
Name | <BiomeTag.humidity> |
Returns | ElementTag(Decimal) |
Mechanism | BiomeTag.humidity |
Description | Returns the humidity of this biome. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L201 |
Name | <BiomeTag.name> |
Returns | ElementTag |
Description | Returns this biome's name. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L188 |
Name | <BiomeTag.spawnable_entities[(<type>)]> |
Returns | ListTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L229 |
Name | <BiomeTag.temperature_at[<location>]> |
Returns | ElementTag(Decimal) |
Description | Returns 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 LocationTag.temperature should be preferred, other than some special cases. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L291 |
Name | <BiomeTag.water_fog_color> |
Returns | ColorTag |
Mechanism | BiomeTag.water_fog_color |
Description | Returns the biome's water fog color, which is visible when underwater (see also BiomeTag.fog_color). |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L353 |
Name | <ChunkTag.add[<#>,<#>]> |
Returns | ChunkTag |
Description | Returns the chunk with the specified coordinates added to it. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L263 |
Name | <ChunkTag.average_height> |
Returns | ElementTag(Decimal) |
Description | Returns the average height of the blocks in the chunk. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L631 |
Name | <ChunkTag.blocks_flagged[<flag_name>]> |
Returns | ListTag(LocationTag) |
Description | Gets 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L716 |
Name | <ChunkTag.cuboid> |
Returns | CuboidTag |
Description | Returns a cuboid of this chunk. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L462 |
Name | <ChunkTag.entities[(<entity>|...)]> |
Returns | ListTag(EntityTag) |
Description | Returns a list of entities in the chunk.
Optionally specify entity types to filter down to. |
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L509 |
Name | <ChunkTag.force_loaded> |
Returns | ElementTag(Boolean) |
Mechanism | ChunkTag.force_loaded |
Description | Returns whether the chunk is forced to stay loaded at all times. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L348 |
Name | <ChunkTag.height_map> |
Returns | ListTag |
Description | Returns a list of the height of each block in the chunk. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L609 |
Name | <ChunkTag.inhabited_time> |
Returns | DurationTag |
Mechanism | ChunkTag.inhabited_time |
Description | Returns the total time the chunk has been inhabited for.
This is a primary deciding factor in the "local difficulty" setting. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L758 |
Name | <ChunkTag.is_flat[(<#>)]> |
Returns | ElementTag(Boolean) |
Description | Scans 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 |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L653 |
Name | <ChunkTag.is_generated> |
Returns | ElementTag(Boolean) |
Description | Returns true if the chunk has already been generated. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L315 |
Name | <ChunkTag.is_loaded> |
Returns | ElementTag(Boolean) |
Description | Returns true if the chunk is currently loaded into memory. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L332 |
Name | <ChunkTag.living_entities> |
Returns | ListTag(EntityTag) |
Description | Returns a list of living entities in the chunk.
This includes Players, mobs, NPCs, etc., but excludes dropped items, experience orbs, etc. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L554 |
Name | <ChunkTag.players> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of players in the chunk. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L585 |
Name | <ChunkTag.plugin_tickets> |
Returns | ListTag(PluginTag) |
Mechanism | ChunkTag.clear_plugin_tickets |
Description | Returns a list of plugins that are keeping this chunk loaded.
This is related to the chunkload command. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L368 |
Name | <ChunkTag.simple> |
Returns | ElementTag |
Description | Returns the X,Z coordinates and world name of the chunk in the format "X,Z,world". |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L448 |
Name | <ChunkTag.spawn_slimes> |
Returns | ElementTag(Boolean) |
Description | Returns whether the chunk is a specially located 'slime spawner' chunk. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L739 |
Name | <ChunkTag.sub[<#>,<#>]> |
Returns | ChunkTag |
Description | Returns the chunk with the specified coordinates subtracted from it. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L289 |
Name | <ChunkTag.surface_blocks> |
Returns | ListTag(LocationTag) |
Description | Returns a list of the highest non-air surface blocks in the chunk. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L691 |
Name | <ChunkTag.tile_entities> |
Returns | ListTag(LocationTag) |
Description | Returns a list of tile entity locations in the chunk. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L482 |
Name | <ChunkTag.world> |
Returns | WorldTag |
Description | Returns the world associated with the chunk. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L420 |
Name | <ChunkTag.x> |
Returns | ElementTag(Number) |
Description | Returns the x coordinate of the chunk. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L392 |
Name | <ChunkTag.xz> |
Returns | ElementTag |
Description | Returns the X,Z coordinates of the chunk in the format "X,Z". |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L434 |
Name | <ChunkTag.z> |
Returns | ElementTag(Number) |
Description | Returns the z coordinate of the chunk. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L406 |
Name | <ColorTag.alpha> |
Returns | ElementTag(Number) |
Description | Returns the alpha value of this color (0 to 255). |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L344 |
Name | <ColorTag.argb_integer> |
Returns | ElementTag(Number) |
Description | Returns the Alpha, Red, Green, and Blue values of this ColorTag as an integer number, equivalent to an integer reparse of 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L293 |
Name | <ColorTag.blue> |
Returns | ElementTag(Number) |
Description | Returns the blue value of this color (0 to 255). |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L331 |
Name | <ColorTag.brightness> |
Returns | ElementTag(Number) |
Description | Returns the brightness value of this color (0 to 255). |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L409 |
Name | <ColorTag.green> |
Returns | ElementTag(Number) |
Description | Returns the green value of this color (0 to 255). |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L318 |
Name | <ColorTag.hex> |
Returns | ElementTag |
Description | Returns a hex code formatting of this color. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L263 |
Name | <ColorTag.hsv> |
Returns | ElementTag |
Description | Returns the HSV value of this color. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L422 |
Name | <ColorTag.hue> |
Returns | ElementTag(Number) |
Description | Returns the hue value of this color (0 to 255). |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L383 |
Name | <ColorTag.mix[<color>]> |
Returns | ColorTag |
Description | Returns the color that results if you mix this color with another. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L549 |
Name | <ColorTag.name> |
Returns | ElementTag |
Description | Returns the name of this color (or red,green,blue if none). |
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L533 |
Name | <ColorTag.red> |
Returns | ElementTag(Number) |
Description | Returns the red value of this color (0 to 255). |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L305 |
Name | <ColorTag.rgb> |
Returns | ElementTag |
Description | Returns the RGB value of this color. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L357 |
Name | <ColorTag.rgb_integer> |
Returns | ElementTag(Number) |
Description | Returns the Red, Green, and Blue values of this ColorTag as an integer number, equivalent to an integer reparse of 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L281 |
Name | <ColorTag.rgba> |
Returns | ElementTag |
Description | Returns the RGBA value of this color. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L370 |
Name | <ColorTag.saturation> |
Returns | ElementTag(Number) |
Description | Returns the saturation value of this color (0 to 255). |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L396 |
Name | <ColorTag.to_particle_offset> |
Returns | LocationTag |
Description | Returns the color as a particle offset, for use with playeffect. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitColorExtensions.java#L29 |
Name | <ColorTag.with_alpha[<alpha>]> |
Returns | ColorTag |
Description | Returns a copy of this color object with a different alpha value (0 to 255). |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L475 |
Name | <ColorTag.with_blue[<blue>]> |
Returns | ColorTag |
Description | Returns a copy of this color object with a different blue value (0 to 255). |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L462 |
Name | <ColorTag.with_brightness[<brightness>]> |
Returns | ColorTag |
Description | Returns a copy of this color object with a different brightness value (0 to 255). |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L518 |
Name | <ColorTag.with_green[<green>]> |
Returns | ColorTag |
Description | Returns a copy of this color object with a different green value (0 to 255). |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L449 |
Name | <ColorTag.with_hue[<hue>]> |
Returns | ColorTag |
Description | Returns a copy of this color object with a different hue value (0 to 255). |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L488 |
Name | <ColorTag.with_red[<red>]> |
Returns | ColorTag |
Description | Returns a copy of this color object with a different red value (0 to 255). |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L436 |
Name | <ColorTag.with_saturation[<saturation>]> |
Returns | ColorTag |
Description | Returns a copy of this color object with a different saturation value (0 to 255). |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ColorTag.java#L503 |
Name | <CuboidTag.add_member[<cuboid>|...]> |
Returns | CuboidTag |
Mechanism | CuboidTag.add_member |
Description | Returns a modified copy of this cuboid, with the input cuboid(s) added at the end. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L954 |
Name | <CuboidTag.add_member[<cuboid>|...].at[<index>]> |
Returns | CuboidTag |
Mechanism | CuboidTag.add_member |
Description | Returns a modified copy of this cuboid, with the input cuboid(s) added at the specified index. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L974 |
Name | <CuboidTag.center> |
Returns | LocationTag |
Description | Returns the location of the exact center of the cuboid.
Not valid for multi-member CuboidTags. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1045 |
Name | <CuboidTag.chunks> |
Returns | ListTag(ChunkTag) |
Description | Gets a list of all chunks entirely within the CuboidTag (ignoring the Y axis). |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1526 |
Name | <CuboidTag.contained_cuboids> |
Returns | ListTag(CuboidTag) |
Description | Returns a list of all noted cuboid areas that this cuboid fully contains. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1608 |
Name | <CuboidTag.contains_cuboid[<cuboid>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether this cuboid fully contains another cuboid. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L808 |
Name | <CuboidTag.corners> |
Returns | ListTag(LocationTag) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1176 |
Name | <CuboidTag.expand[<location>]> |
Returns | CuboidTag |
Description | Expands 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 |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1376 |
Name | <CuboidTag.expand_one_side[<location>]> |
Returns | CuboidTag |
Description | Expands 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 CuboidTag.shrink_one_side Not valid for multi-member CuboidTags. |
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1411 |
Name | <CuboidTag.get[<index>]> |
Returns | CuboidTag |
Description | Returns a cuboid representing the one component of this cuboid (for cuboids that contain multiple sub-cuboids). |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L890 |
Name | <CuboidTag.include[<location>/<cuboid>]> |
Returns | CuboidTag |
Description | Expands the first member of the CuboidTag to contain the given location (or entire cuboid), and returns the expanded cuboid. |
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1225 |
Name | <CuboidTag.include_x[<number>]> |
Returns | CuboidTag |
Description | Expands the first member of the CuboidTag to contain the given X value, and returns the expanded cuboid. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1253 |
Name | <CuboidTag.include_y[<number>]> |
Returns | CuboidTag |
Description | Expands the first member of the CuboidTag to contain the given Y value, and returns the expanded cuboid. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1278 |
Name | <CuboidTag.include_z[<number>]> |
Returns | CuboidTag |
Description | Expands the first member of the CuboidTag to contain the given Z value, and returns the expanded cuboid. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1303 |
Name | <CuboidTag.intersecting_cuboids> |
Returns | ListTag(CuboidTag) |
Description | Returns a list of all noted cuboid areas that this cuboid intersects with. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1627 |
Name | <CuboidTag.intersection[<cuboid>]> |
Returns | CuboidTag |
Description | Returns 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 |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L840 |
Name | <CuboidTag.intersects[<cuboid>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether this cuboid and another intersect. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L824 |
Name | <CuboidTag.list_members> |
Returns | ListTag(CuboidTag) |
Description | Returns a list of all sub-cuboids in this CuboidTag (for cuboids that contain multiple sub-cuboids). |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L871 |
Name | <CuboidTag.max> |
Returns | LocationTag |
Description | Returns the highest-numbered (maximum) corner location.
Not valid for multi-member CuboidTags. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1124 |
Name | <CuboidTag.members_size> |
Returns | ElementTag(Number) |
Description | Returns the number of cuboids defined in the CuboidTag. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L751 |
Name | <CuboidTag.min> |
Returns | LocationTag |
Description | Returns the lowest-numbered (minimum) corner location.
Not valid for multi-member CuboidTags. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1150 |
Name | <CuboidTag.note_name> |
Returns | ElementTag |
Description | Gets the name of a noted CuboidTag. If the cuboid isn't noted, this is null. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1590 |
Name | <CuboidTag.outline> |
Returns | ListTag(LocationTag) |
Description | Returns each block location on the outline of the CuboidTag. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L765 |
Name | <CuboidTag.outline_2d[<#.#>]> |
Returns | ListTag(LocationTag) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L778 |
Name | <CuboidTag.partial_chunks> |
Returns | ListTag(ChunkTag) |
Description | Gets a list of all chunks partially or entirely within the CuboidTag. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1565 |
Name | <CuboidTag.random> |
Returns | LocationTag |
Description | Returns a random block location within the cuboid.
(Note: random selection will not be fairly weighted for multi-member cuboids). |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L730 |
Name | <CuboidTag.remove_member[<#>]> |
Returns | CuboidTag |
Mechanism | CuboidTag.remove_member |
Description | Returns a modified copy of this cuboid, with member at the input index removed. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1014 |
Name | <CuboidTag.set[<cuboid>].at[<index>]> |
Returns | CuboidTag |
Mechanism | CuboidTag.set_member |
Description | Returns a modified copy of this cuboid, with the specific sub-cuboid index changed to hold the input cuboid. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L917 |
Name | <CuboidTag.shift[<vector>]> |
Returns | CuboidTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1203 |
Name | <CuboidTag.shrink_one_side[<location>]> |
Returns | CuboidTag |
Description | Shrinks 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 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 |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1468 |
Name | <CuboidTag.size> |
Returns | LocationTag |
Description | Returns the size of the cuboid.
Effectively equivalent to: (max - min) + (1,1,1) Not valid for multi-member CuboidTags. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1094 |
Name | <CuboidTag.volume> |
Returns | ElementTag(Number) |
Description | Returns the volume of the cuboid.
Effectively equivalent to: (size.x * size.y * size.z). Not valid for multi-member CuboidTags. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1077 |
Name | <CuboidTag.walls> |
Returns | ListTag(LocationTag) |
Description | Returns each block location on the walls of the CuboidTag - that is, the shell minus top and bottom. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L795 |
Name | <CuboidTag.with_max[<location>]> |
Returns | CuboidTag |
Description | Changes 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1352 |
Name | <CuboidTag.with_min[<location>]> |
Returns | CuboidTag |
Description | Changes 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L1328 |
Name | <CuboidTag.has_region> |
Returns | ElementTag(Boolean) |
Description | Returns whether the cuboid contains any region. |
Generated Example |
|
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardCuboidProperties.java#L90 |
Name | <CuboidTag.has_town> |
Returns | ElementTag(Boolean) |
Description | Returns whether the cuboid contains any town at all. |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyCuboidProperties.java#L64 |
Name | <CuboidTag.list_towns> |
Returns | ListTag(TownTag) |
Description | Returns all the towns within the cuboid. |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyCuboidProperties.java#L80 |
Name | <CuboidTag.regions> |
Returns | ListTag(WorldGuardRegionTag) |
Description | Returns a list of regions that are in this cuboid. |
Generated Example |
|
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardCuboidProperties.java#L101 |
Name | <DurationTag.add[<duration>]> |
Returns | DurationTag |
Description | Returns this duration plus another. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L416 |
Name | <DurationTag.formatted> |
Returns | ElementTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L483 |
Name | <DurationTag.formatted_words> |
Returns | ElementTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L495 |
Name | <DurationTag.in_days> |
Returns | ElementTag(Decimal) |
Description | Returns the number of days in the duration. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L346 |
Name | <DurationTag.in_hours> |
Returns | ElementTag(Decimal) |
Description | Returns the number of hours in the duration. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L356 |
Name | <DurationTag.in_milliseconds> |
Returns | ElementTag(Decimal) |
Description | Returns the number of milliseconds in the duration. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L386 |
Name | <DurationTag.in_minutes> |
Returns | ElementTag(Decimal) |
Description | Returns the number of minutes in the duration. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L366 |
Name | <DurationTag.in_seconds> |
Returns | ElementTag(Decimal) |
Description | Returns the number of seconds in the duration. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L376 |
Name | <DurationTag.in_ticks> |
Returns | ElementTag(Number) |
Description | Returns the number of ticks in the duration. (20t/second) |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L396 |
Name | <DurationTag.in_weeks> |
Returns | ElementTag(Decimal) |
Description | Returns the number of weeks in the duration. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L336 |
Name | <DurationTag.in_years> |
Returns | ElementTag(Decimal) |
Description | Returns the number of years in the duration. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L326 |
Name | <DurationTag.sub[<duration>]> |
Returns | DurationTag |
Description | Returns this duration minus another. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L406 |
Name | <DurationTag.is_less_than[<duration>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether this duration is less than the input duration.
Equivalent to if comparison: < |
Generated Example |
|
Group | comparison |
Source | https://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>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether this duration is less than or equal to the input duration.
Equivalent to if comparison: <= |
Generated Example |
|
Group | comparison |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L462 |
Name | <DurationTag.is_more_than[<duration>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether this duration is greater than the input duration.
Equivalent to if comparison: > |
Generated Example |
|
Group | comparison |
Source | https://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>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether this duration is greater than or equal to the input duration.
Equivalent to if comparison: >= |
Generated Example |
|
Group | comparison |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/DurationTag.java#L450 |
Name | <ElementTag.parse_yaml> |
Returns | MapTag |
Description | Parses the input YAML or JSON text into a MapTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2496 |
Name | <ElementTag.snbt_to_map> |
Returns | MapTag |
Description | Parses a raw SNBT string into an NBT MapTag.
See 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L920 |
Name | <ElementTag.unaccented> |
Returns | ElementTag |
Description | Returns the input text with any accented characters replaced with their base counterparts.
Note that not all characters have a normalized form, such as "æ", and will be unchanged. |
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2522 |
Name | <ElementTag.equals[<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns 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. |
Group | comparison |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L442 |
Name | <ElementTag.is_boolean> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element is a boolean ('true' or 'false'). |
Generated Example |
|
Group | comparison |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L507 |
Name | <ElementTag.is_decimal> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element is a valid decimal number (the decimal point is optional). |
Generated Example |
|
Group | comparison |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L538 |
Name | <ElementTag.is_even> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element is an even-valued decimal number. Returns 'false' for non-numbers. |
Generated Example |
|
Group | comparison |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L569 |
Name | <ElementTag.is_integer> |
Returns | ElementTag(Boolean) |
Description | Returns 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 |
|
Group | comparison |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L518 |
Name | <ElementTag.is_less_than[<number>]> |
Returns | ElementTag(Boolean) |
Description | Returns 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. |
Group | comparison |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L468 |
Name | <ElementTag.is_less_than_or_equal_to[<number>]> |
Returns | ElementTag(Boolean) |
Description | Returns 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. |
Group | comparison |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L494 |
Name | <ElementTag.is_more_than[<number>]> |
Returns | ElementTag(Boolean) |
Description | Returns 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. |
Group | comparison |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L455 |
Name | <ElementTag.is_more_than_or_equal_to[<number>]> |
Returns | ElementTag(Boolean) |
Description | Returns 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. |
Group | comparison |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L481 |
Name | <ElementTag.is_odd> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element is an odd-valued decimal number. Returns 'false' for non-numbers. |
Generated Example |
|
Group | comparison |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L557 |
Name | <ElementTag.as_biome> |
Returns | BiomeTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[biome] |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L48 |
Name | <ElementTag.as_boolean> |
Returns | ElementTag(Boolean) |
Description | Returns the element as true/false.
'true', 't', or '1' become 'true', anything else becomes 'false'. |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L593 |
Name | <ElementTag.as_chunk> |
Returns | ChunkTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[chunk] |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L61 |
Name | <ElementTag.as_color> |
Returns | ColorTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[color] |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L74 |
Name | <ElementTag.as_cuboid> |
Returns | CuboidTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[cuboid] |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L87 |
Name | <ElementTag.as_custom> |
Returns | CustomObjectTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[custom] |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L700 |
Name | <ElementTag.as_decimal> |
Returns | ElementTag(Decimal) |
Description | Returns 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 |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L608 |
Name | <ElementTag.as_duration> |
Returns | DurationTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[duration] |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L742 |
Name | <ElementTag.as_element> |
Returns | ElementTag |
Description | Returns the element as itself.
For use in special cases, generally not very useful. |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L581 |
Name | <ElementTag.as_ellipsoid> |
Returns | EllipsoidTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[ellipsoid] |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L100 |
Name | <ElementTag.as_enchantment> |
Returns | EnchantmentTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[enchantment] |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L113 |
Name | <ElementTag.as_entity> |
Returns | EntityTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[entity] |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L126 |
Name | <ElementTag.as_inventory> |
Returns | InventoryTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[inventory] |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L139 |
Name | <ElementTag.as_item> |
Returns | ItemTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[item] |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L152 |
Name | <ElementTag.as_list> |
Returns | ListTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[list] |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L672 |
Name | <ElementTag.as_location> |
Returns | LocationTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[location] |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L165 |
Name | <ElementTag.as_map> |
Returns | MapTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[map] |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L686 |
Name | <ElementTag.as_material> |
Returns | MaterialTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[material] |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L178 |
Name | <ElementTag.as_money> |
Returns | ElementTag(Decimal) |
Description | Returns the element as a number with two decimal places. |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L651 |
Name | <ElementTag.as_npc> |
Returns | NPCTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[npc] |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L191 |
Name | <ElementTag.as_player> |
Returns | PlayerTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[player] |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L204 |
Name | <ElementTag.as_plugin> |
Returns | PluginTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[plugin] |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L217 |
Name | <ElementTag.as_polygon> |
Returns | PolygonTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[polygon] |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L230 |
Name | <ElementTag.as_queue> |
Returns | QueueTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[queue] |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L728 |
Name | <ElementTag.as_script> |
Returns | ScriptTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[script] |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L714 |
Name | <ElementTag.as_trade> |
Returns | TradeTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[trade] |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L243 |
Name | <ElementTag.as_world> |
Returns | WorldTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[world] |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L256 |
Name | <ElementTag.base64_decode> |
Returns | ElementTag |
Description | Decodes a Base64 UTF-8 encoded text to its original text.
Equivalent to using ElementTag.base64_to_binary and then BinaryTag.utf8_decode. |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2309 |
Name | <ElementTag.base64_encode> |
Returns | ElementTag |
Description | Encodes some text to UTF-8 Base64.
Equivalent to using ElementTag.utf8_encode and then BinaryTag.to_base64. |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2296 |
Name | <ElementTag.base64_to_binary> |
Returns | BinaryTag |
Description | Converts base64 encoded text to its raw binary form.
See also BinaryTag.to_base64 |
Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2322 |
Name | <ElementTag.escaped> |
Returns | ElementTag |
Description | Returns the element, escaped for safe reuse.
Inverts ElementTag.unescaped. See Escaping System. |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L756 |
Name | <ElementTag.from_raw_json> |
Returns | ElementTag |
Description | Un-hides the element's text from invisible color codes back to normal text.
Inverts ElementTag.to_raw_json. |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L436 |
Name | <ElementTag.from_secret_colors> |
Returns | ElementTag |
Description | Un-hides the element's text from invisible color codes back to normal text.
Inverts ElementTag.to_secret_colors. |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L410 |
Name | <ElementTag.hex_decode> |
Returns | ElementTag |
Description | Deprecated in favor of BinaryTag.utf8_decode or BinaryTag.text_decode |
Generated Example |
|
Group | conversion |
Deprecated | use BinaryTag.utf8_decode |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2392 |
Name | <ElementTag.hex_encode> |
Returns | ElementTag |
Description | Deprecated in favor of ElementTag.utf8_encode or ElementTag.text_encode |
Generated Example |
|
Group | conversion |
Deprecated | use utf8_encode |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2378 |
Name | <ElementTag.hex_to_number> |
Returns | ElementTag(Number) |
Description | Encodes base-16 hexadecimal value to an integer number.
For example input of "F" will return "15". See also ElementTag.number_to_hex Consider instead BinaryTag.decode_integer |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2262 |
Name | <ElementTag.html_escaped> |
Returns | ElementTag |
Description | Returns the element, escaped for safe use in HTML. |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L770 |
Name | <ElementTag.integer_to_binary> |
Returns | BinaryTag |
Description | Returns a BinaryTag holding 8 bytes of this integer number converted to binary format using big-endian 64-bit integer twos-complement encoding. |
Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2280 |
Name | <ElementTag.millis_to_time> |
Returns | TimeTag |
Description | Returns a TimeTag constructed from the given number of milliseconds after the Unix Epoch (Jan. 1st 1970).
See also util.current_time_millis and TimeTag.epoch_millis. |
Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2506 |
Name | <ElementTag.number_to_hex> |
Returns | ElementTag |
Description | Encodes base-10 integer number to hexadecimal (base-16) format.
For example input of "15" will return "F". See also ElementTag.hex_to_number Consider instead ElementTag.integer_to_binary |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2244 |
Name | <ElementTag.optimize_json> |
Returns | ElementTag |
Description | 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 Denizen Text Formatting. |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L448 |
Name | <ElementTag.parsed> |
Returns | ObjectTag |
Description | Returns 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 |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L812 |
Name | <ElementTag.sql_escaped> |
Returns | ElementTag |
Description | Returns the element, escaped for safe use in SQL. |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L786 |
Name | <ElementTag.text_encode[<encoding>]> |
Returns | BinaryTag |
Description | Converts 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 BinaryTag.text_decode |
Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2355 |
Name | <ElementTag.to_itemscript_hash> |
Returns | ElementTag |
Description | Shortens 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 |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L379 |
Name | <ElementTag.to_raw_json> |
Returns | ElementTag |
Description | Converts normal colored text to Minecraft-style "raw JSON" format.
Inverts ElementTag.from_raw_json. |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L424 |
Name | <ElementTag.to_secret_colors> |
Returns | ElementTag |
Description | Hides the element's text in invisible color codes.
Inverts ElementTag.from_secret_colors. |
Generated Example |
|
Group | conversion |
Source | https://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>]> |
Returns | ElementTag |
Description | Returns 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". |
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2459 |
Name | <ElementTag.truncate> |
Returns | ElementTag(Number) |
Description | Returns 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 elementtag.round or elementtag.round_down instead. |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L629 |
Name | <ElementTag.unescaped> |
Returns | ElementTag |
Description | Returns the element, unescaped.
Inverts ElementTag.escaped. See Escaping System. |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L798 |
Name | <ElementTag.url_decode> |
Returns | ElementTag |
Description | Decodes the element using URL encoding. Must be valid URL-encoded input. |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2424 |
Name | <ElementTag.url_encode> |
Returns | ElementTag |
Description | Encodes the element using URL encoding. |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2406 |
Name | <ElementTag.utf8_encode> |
Returns | BinaryTag |
Description | Converts the text to a binary representation encoded with the standard UTF-8 encoding.
See also BinaryTag.utf8_decode |
Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2340 |
Name | <ElementTag.and[<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether both the element and the second element are true.
You should never ever use this tag inside any 'if', 'while', etc. command. |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1055 |
Name | <ElementTag.char_at[<#>]> |
Returns | ElementTag |
Description | Returns the character at a specified index, supporting negative indexes to count from the end.
Returns null if the index is outside the range of the element. |
Example |
|
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1127 |
Name | <ElementTag.contains_all_case_sensitive_text[<element>|...]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element contains all of the specified elements, case sensitive. |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L923 |
Name | <ElementTag.contains_all_text[<element>|...]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element contains all of the specified elements, case insensitive. |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L905 |
Name | <ElementTag.contains_any_case_sensitive_text[<element>|...]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element contains any of a list of specified elements, case sensitive. |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L840 |
Name | <ElementTag.contains_any_text[<element>|...]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element contains any of a list of specified elements, case insensitive. |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L858 |
Name | <ElementTag.contains_case_sensitive_text[<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element contains a specified element, case sensitive. |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L876 |
Name | <ElementTag.contains_text[<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element contains a specified element, case insensitive.
Can use regular expression by prefixing the element with 'regex:'. |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L888 |
Name | <ElementTag.difference[<element>]> |
Returns | ElementTag(Number) |
Description | Returns a number representing the difference between the two elements. (Uses Levenshtein logic). |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L829 |
Name | <ElementTag.ends_with[<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element ends with a specified element. |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L941 |
Name | <ElementTag.equals_case_sensitive[<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element matches another element, case-sensitive. |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L953 |
Name | <ElementTag.if_true[<object>].if_false[<object>]> |
Returns | ObjectTag |
Description | If 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. |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2476 |
Name | <ElementTag.index_of[<element>]> |
Returns | ElementTag(Number) |
Description | Returns the index of the first occurrence of a specified element.
Returns 0 if the element never occurs within the element. |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1101 |
Name | <ElementTag.is_in[<list>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element is contained by a list.
Essentially equivalent to ListTag.contains_single, but with input order reversed. |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1004 |
Name | <ElementTag.last_index_of[<element>]> |
Returns | ElementTag(Number) |
Description | Returns the index of the last occurrence of a specified element.
Returns 0 if the element never occurs within the element. |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1114 |
Name | <ElementTag.length> |
Returns | ElementTag(Number) |
Description | Returns the length of the element. |
Generated Example |
|
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1021 |
Name | <ElementTag.matches_character_set[<characters>]> |
Returns | ElementTag(Boolean) |
Description | Returns 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". |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2442 |
Name | <ElementTag.not> |
Returns | ElementTag(Boolean) |
Description | Returns 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 |
|
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1032 |
Name | <ElementTag.or[<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether either the element or the second element are true.
You should never ever use this tag inside any 'if', 'while', etc. command. |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1067 |
Name | <ElementTag.regex_matches[<regex>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element matches a regex input. |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L964 |
Name | <ElementTag.regex[<regex>].group[<group>]> |
Returns | ElementTag |
Description | Returns the specific group from a regex match.
Specify group 0 for the whole match. For example, <element[hello5world].regex[.*(\d).*].group[1]> returns '5'. |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L975 |
Name | <ElementTag.starts_with[<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element starts with a specified element. |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1090 |
Name | <ElementTag.xor[<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element and the second element are true and false (exclusive or). |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1079 |
Name | <ElementTag.after[<element>]> |
Returns | ElementTag |
Description | Returns the portion of an element after the first occurrence of a specified element.
For example: HelloWorld .after[Hello] returns World. |
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1192 |
Name | <ElementTag.after_last[<element>]> |
Returns | ElementTag |
Description | Returns the portion of an element after the last occurrence of a specified element.
For example: abcabc .after_last[b] returns c. |
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1174 |
Name | <ElementTag.before[<element>]> |
Returns | ElementTag |
Description | Returns the portion of an element before the first occurrence of specified element.
For example: abcd .before[c] returns ab. |
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1228 |
Name | <ElementTag.before_last[<element>]> |
Returns | ElementTag |
Description | Returns the portion of an element before the last occurrence of a specified element.
For example: abcabc .before_last[b] returns abca. |
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1210 |
Name | <ElementTag.format_number[(<format>)]> |
Returns | ElementTag |
Description | Returns 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 |
|
Synonyms (Search Aid) | elementtag.number_with_commas, elementtag.thousands_separated |
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1292 |
Name | <ElementTag.from_roman_numerals> |
Returns | ElementTag |
Description | Returns the roman numeral string in integer form.
For example: <element[MCLXIX].from_roman_numerals> returns 1169. |
Generated Example |
|
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1497 |
Name | <ElementTag.is_lowercase> |
Returns | ElementTag(Boolean) |
Description | Returns whether all characters in the element are lowercase.
Numbers and symbols will return false. |
Generated Example |
|
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1394 |
Name | <ElementTag.is_uppercase> |
Returns | ElementTag(Boolean) |
Description | Returns whether all characters in the element are uppercase letters.
Numbers and symbols will return false. |
Generated Example |
|
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1377 |
Name | <ElementTag.lines_to_colored_list> |
Returns | ListTag |
Description | Returns a list of lines in the element, with colors spread over the lines manually.
Useful for things like item lore. |
Generated Example |
|
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L317 |
Name | <ElementTag.pad_left[<#>]> |
Returns | ElementTag |
Description | Returns the value of an element extended to reach a minimum specified length by adding spaces to the left side. |
Generated Example |
|
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1602 |
Name | <ElementTag.pad_left[<#>].with[<element>]> |
Returns | ElementTag |
Description | Returns the value of an element extended to reach a minimum specified length
by adding a specific symbol to the left side. |
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1613 |
Name | <ElementTag.pad_right[<#>]> |
Returns | ElementTag |
Description | Returns the value of an element extended to reach a minimum specified length by adding spaces to the right side. |
Generated Example |
|
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1634 |
Name | <ElementTag.pad_right[<#>].with[<element>]> |
Returns | ElementTag |
Description | Returns the value of an element extended to reach a minimum specified length by adding a specific symbol to the right side. |
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1645 |
Name | <ElementTag.repeat[<#>]> |
Returns | ElementTag |
Description | Returns 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 |
|
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1153 |
Name | <ElementTag.replace_text[((first)regex:)<element>]> |
Returns | ElementTag |
Description | Returns the element with all instances of an element removed. |
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1246 |
Name | <ElementTag.replace_text[((first)regex:)<element>].with[<element>]> |
Returns | ElementTag |
Description | Returns 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' |
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1254 |
Name | <ElementTag.split[((regex:)<string>)]> |
Returns | ListTag |
Description | Returns a list of portions of this element, split by the specified string.
If a split string is unspecified, splits by space. |
Generated Example |
|
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1561 |
Name | <ElementTag.split_args> |
Returns | ListTag |
Description | Returns 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 |
|
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1549 |
Name | <ElementTag.split_lines[<#>]> |
Returns | ElementTag |
Description | Returns 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 |
|
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1363 |
Name | <ElementTag.split_lines_by_width[<#>]> |
Returns | ElementTag |
Description | Returns 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 |
|
Group | element manipulation |
Source | https://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[<#>]> |
Returns | ListTag |
Description | Returns 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. |
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1582 |
Name | <ElementTag.substring[<#>(,<#>)]> |
Returns | ElementTag |
Description | Returns 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 |
|
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1514 |
Name | <ElementTag.text_width> |
Returns | ElementTag(Number) |
Description | Returns 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 |
|
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L303 |
Name | <ElementTag.to_list> |
Returns | ListTag |
Description | Returns a ListTag of each letter in the element. |
Generated Example |
|
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1337 |
Name | <ElementTag.to_lowercase> |
Returns | ElementTag |
Description | Returns the value of an element in all lowercase letters. |
Generated Example |
|
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1423 |
Name | <ElementTag.to_roman_numerals> |
Returns | ElementTag |
Description | Returns 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 |
|
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1476 |
Name | <ElementTag.to_sentence_case> |
Returns | ElementTag |
Description | Returns the value in sentence case (the first letter capitalized, the rest lowercase). |
Generated Example |
|
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1462 |
Name | <ElementTag.to_titlecase> |
Returns | ElementTag |
Description | Returns The Value Of An ElementTag In Title Case. |
Generated Example |
|
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1435 |
Name | <ElementTag.to_uppercase> |
Returns | ElementTag |
Description | Returns the value of an element in all uppercase letters. |
Generated Example |
|
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1411 |
Name | <ElementTag.trim> |
Returns | ElementTag |
Description | Returns the value of an element minus any leading or trailing whitespace. |
Generated Example |
|
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1352 |
Name | <ElementTag.abs> |
Returns | ElementTag(Decimal) |
Description | Returns the absolute value of the element.
For example: <element[-5].abs> returns 5. |
Generated Example |
|
Synonyms (Search Aid) | elementtag.absolute_value |
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1667 |
Name | <ElementTag.acos> |
Returns | ElementTag(Decimal) |
Description | Returns the arc-cosine of the element in radians. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1986 |
Name | <ElementTag.add[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Returns the element plus a number. |
Generated Example |
|
Synonyms (Search Aid) | elementtag.plus, elementtag.addition, elementtag.+ |
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1785 |
Name | <ElementTag.add_int[<#>]> |
Returns | ElementTag(Number) |
Description | Don't use this, just use "add". |
Generated Example |
|
Group | math |
Deprecated | This tag hasn't conferred any real benefit for years. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1718 |
Name | <ElementTag.asin> |
Returns | ElementTag(Decimal) |
Description | Returns the arc-sine of the element in radians. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1971 |
Name | <ElementTag.atan> |
Returns | ElementTag(Decimal) |
Description | Returns the arc-tangent of the element in radians. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2001 |
Name | <ElementTag.atan2[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Interprets 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 |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2016 |
Name | <ElementTag.cos> |
Returns | ElementTag(Decimal) |
Description | Returns the cosine of the input radian angle. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2032 |
Name | <ElementTag.div[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Returns the element divided by a number. |
Generated Example |
|
Synonyms (Search Aid) | elementtag.divide, elementtag./ |
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1808 |
Name | <ElementTag.div_int[<#>]> |
Returns | ElementTag(Number) |
Description | Returns 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 |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1735 |
Name | <ElementTag.factorial> |
Returns | ElementTag(Number) |
Description | Returns 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 |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2077 |
Name | <ElementTag.ln> |
Returns | ElementTag(Decimal) |
Description | Returns the natural logarithm of the element. |
Generated Example |
|
Synonyms (Search Aid) | elementtag.natural_logarithm |
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1938 |
Name | <ElementTag.log[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Returns the logarithm of the element, with the base of the specified number. |
Generated Example |
|
Synonyms (Search Aid) | elementtag.logarithm |
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1922 |
Name | <ElementTag.max[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Returns the higher number: this element or the specified one.
For example: <element[5].max[10]> returns 10. |
Generated Example |
|
Synonyms (Search Aid) | elementtag.larger, elementtag.greater, elementtag.higher, elementtag.bigger, elementtag.maximum |
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1684 |
Name | <ElementTag.min[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Returns the lower number: this element or the specified one.
For example: <element[5].min[10]> returns 5. |
Generated Example |
|
Synonyms (Search Aid) | elementtag.smaller, elementtag.lesser, elementtag.lower, elementtag.minimum |
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1701 |
Name | <ElementTag.mod[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Returns the remainder of the element divided by a number. |
Generated Example |
|
Synonyms (Search Aid) | elementtag.modulo, elementtag.modulus, elementtag.remainder/elementtag.% |
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1831 |
Name | <ElementTag.mul[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Returns the element multiplied by a number. |
Generated Example |
|
Synonyms (Search Aid) | elementtag.multiply, elementtag.times, elementtag.* |
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1856 |
Name | <ElementTag.mul_int[<#>]> |
Returns | ElementTag(Number) |
Description | Don't use this, just use "mul". |
Generated Example |
|
Group | math |
Deprecated | This tag hasn't conferred any real benefit for years. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1751 |
Name | <ElementTag.power[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Returns the element to the power of a number. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1954 |
Name | <ElementTag.round> |
Returns | ElementTag(Number) |
Description | Rounds a decimal. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2229 |
Name | <ElementTag.round_down> |
Returns | ElementTag(Number) |
Description | Rounds a decimal downward. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2142 |
Name | <ElementTag.round_down_to_precision[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Rounds a decimal downward to the specified precision. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2195 |
Name | <ElementTag.round_to[<#>]> |
Returns | ElementTag(Decimal) |
Description | Rounds a decimal to the specified place.
For example, 0.12345 .round_to[3] returns "0.123". |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2157 |
Name | <ElementTag.round_to_precision[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Rounds a decimal to the specified precision.
For example, 0.12345 .round_to_precision[0.005] returns "0.125". |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2177 |
Name | <ElementTag.round_up> |
Returns | ElementTag(Number) |
Description | Rounds a decimal upward. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2127 |
Name | <ElementTag.round_up_to_precision[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Rounds a decimal upward to the specified precision. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2212 |
Name | <ElementTag.sin> |
Returns | ElementTag(Decimal) |
Description | Returns the sine of the input radian angle. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2047 |
Name | <ElementTag.sqrt> |
Returns | ElementTag(Decimal) |
Description | Returns the square root of the element.
Null for negative numbers. |
Generated Example |
|
Synonyms (Search Aid) | elementtag.square_root |
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1902 |
Name | <ElementTag.sub[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Returns the element minus a number. |
Generated Example |
|
Synonyms (Search Aid) | elementtag.subtract, elementtag.- |
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1879 |
Name | <ElementTag.sub_int[<#>]> |
Returns | ElementTag(Number) |
Description | Don't use this, just use "sub". |
Generated Example |
|
Group | math |
Deprecated | This tag hasn't conferred any real benefit for years. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1768 |
Name | <ElementTag.tan> |
Returns | ElementTag(Decimal) |
Description | Returns the tangent of the input radian angle. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2062 |
Name | <ElementTag.to_degrees> |
Returns | ElementTag(Decimal) |
Description | Converts the element from radians to degrees. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2097 |
Name | <ElementTag.to_radians> |
Returns | ElementTag(Decimal) |
Description | Converts the element from degrees to radians. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2112 |
Name | <ElementTag.last_color> |
Returns | ElementTag |
Description | Returns the ChatColors used last in an element. |
Generated Example |
|
Group | text checking |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L335 |
Name | <ElementTag.bold> |
Returns | ElementTag |
Description | Makes the input text bold. Equivalent to "<&l><ELEMENT_HERE><&l.end_format>"
Note that this is a magic Denizen tool - refer to Denizen Text Formatting. |
Generated Example |
|
Group | text manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L640 |
Name | <ElementTag.click_chat[<message>]> |
Returns | ElementTag |
Description | Adds a click command to the element, which makes the element pseudo-chat the input message when clicked, for activating interact script chat triggers (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 Denizen Text Formatting. |
Example |
|
Group | text manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L526 |
Name | <ElementTag.click_url[<url>]> |
Returns | ElementTag |
Description | Adds 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 Denizen Text Formatting. |
Example |
|
Group | text manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L512 |
Name | <ElementTag.color[<color>]> |
Returns | ElementTag |
Description | Makes 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 Denizen Text Formatting. |
Generated Example |
|
Group | text manipulation |
Source | https://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)]> |
Returns | ElementTag |
Description | Returns 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 |
|
Example |
|
Example |
|
Example |
|
Group | text manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L859 |
Name | <ElementTag.custom_color[<custom_color_name>]> |
Returns | ElementTag |
Description | Makes 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 Denizen Text Formatting. |
Group | text manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L688 |
Name | <ElementTag.end_format> |
Returns | ElementTag |
Description | Makes 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 Denizen Text Formatting. |
Generated Example |
|
Group | text manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L609 |
Name | <ElementTag.font[<font>]> |
Returns | ElementTag |
Description | Makes 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 Denizen Text Formatting. |
Group | text manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L771 |
Name | <ElementTag.format[<format_script>]> |
Returns | ElementTag |
Description | Returns the text re-formatted according to a format script. |
Group | text manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L269 |
Name | <ElementTag.hex_rainbow[(<length>)]> |
Returns | ElementTag |
Description | Returns 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 |
|
Group | text manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L806 |
Name | <ElementTag.hover_item[<item>]> |
Returns | ElementTag |
Description | Adds 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 Denizen Text Formatting. |
Example |
|
Group | text manipulation |
Source | https://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>]> |
Returns | ElementTag |
Description | Deprecated in favor of using ElementTag.color_gradient with "style=hsb" |
Group | text manipulation |
Deprecated | use color_gradient[from=color;to=color;style=HSB] |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L896 |
Name | <ElementTag.italicize> |
Returns | ElementTag |
Description | Makes the input text italic. Equivalent to "<&o><ELEMENT_HERE><&o.end_format>"
Note that this is a magic Denizen tool - refer to Denizen Text Formatting. |
Generated Example |
|
Group | text manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L628 |
Name | <ElementTag.no_reset> |
Returns | ElementTag |
Description | Makes 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 Denizen Text Formatting. |
Generated Example |
|
Group | text manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L593 |
Name | <ElementTag.obfuscate> |
Returns | ElementTag |
Description | Makes the input text obfuscated. Equivalent to "<&k><ELEMENT_HERE><&k.end_format>"
Note that this is a magic Denizen tool - refer to Denizen Text Formatting. |
Generated Example |
|
Group | text manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L676 |
Name | <ElementTag.on_click[<command>]> |
Returns | ElementTag |
Description | Adds 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 (Chat Triggers), you can use the command "/denizenclickable chat SOME MESSAGE HERE" (requires players have permission "denizen.clickable") For that, instead prefer ElementTag.click_chat Note that this is a magic Denizen tool - refer to Denizen Text Formatting. |
Example |
|
Example |
|
Group | text manipulation |
Source | https://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>]> |
Returns | ElementTag |
Description | Adds 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 Denizen Text Formatting. For run_command, prefer ElementTag.on_click For chat, prefer ElementTag.click_chat For URLs, prefer ElementTag.click_url |
Group | text manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L559 |
Name | <ElementTag.on_hover[<message>]> |
Returns | ElementTag |
Description | Adds 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 Denizen Text Formatting. |
Group | text manipulation |
Source | https://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>]> |
Returns | ElementTag |
Description | Adds 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 Denizen Text Formatting. For show_text, prefer ElementTag.on_hover For show_item, prefer ElementTag.hover_item |
Group | text manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L492 |
Name | <ElementTag.parse_color[(<prefix>)]> |
Returns | ElementTag |
Description | Returns 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 ElementTag.parse_minimessage |
Generated Example |
|
Group | text manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L359 |
Name | <ElementTag.rainbow[(<pattern>)]> |
Returns | ElementTag |
Description | Returns 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 |
|
Group | text manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L784 |
Name | <ElementTag.strikethrough> |
Returns | ElementTag |
Description | Makes the input text struck-through. Equivalent to "<&m><ELEMENT_HERE><&m.end_format>"
Note that this is a magic Denizen tool - refer to Denizen Text Formatting. |
Generated Example |
|
Group | text manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L664 |
Name | <ElementTag.strip_color> |
Returns | ElementTag |
Description | Returns 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 |
|
Group | text manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L346 |
Name | <ElementTag.underline> |
Returns | ElementTag |
Description | Makes the input text underlined. Equivalent to "<&n><ELEMENT_HERE><&n.end_format>"
Note that this is a magic Denizen tool - refer to Denizen Text Formatting. |
Generated Example |
|
Group | text manipulation |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L652 |
Name | <ElementTag.with_insertion[<message>]> |
Returns | ElementTag |
Description | Adds 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 Denizen Text Formatting. |
Group | text manipulation |
Source | https://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> |
Returns | TimeTag |
Description | Returns the TimeTag converted from the given discord ID.
Discord IDs internally are just timestamps in a Discord-specific numeric format. |
Example |
|
Group | extensions |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/properties/DiscordElementTagExtensions.java#L11 |
Name | <ElementTag.parse_minimessage> |
Returns | ElementTag |
Description | Returns 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 |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperElementExtensions.java#L16 |
Name | <ElementTag.to_minimessage> |
Returns | ElementTag |
Description | Returns 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 |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperElementExtensions.java#L29 |
Name | <EllipsoidTag.add[<location>]> |
Returns | EllipsoidTag |
Description | Returns a copy of this ellipsoid, shifted by the input location. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L461 |
Name | <EllipsoidTag.chunks> |
Returns | ListTag(ChunkTag) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L571 |
Name | <EllipsoidTag.include[<location>]> |
Returns | EllipsoidTag |
Description | Returns a copy of this ellipsoid, with the size value adapted to include the specified world location. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L480 |
Name | <EllipsoidTag.location> |
Returns | LocationTag |
Description | Returns the center location of the ellipsoid. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L435 |
Name | <EllipsoidTag.note_name> |
Returns | ElementTag |
Description | Gets the name of a noted EllipsoidTag. If the ellipsoid isn't noted, this is null. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L605 |
Name | <EllipsoidTag.random> |
Returns | LocationTag |
Description | Returns a random decimal location within the ellipsoid.
Note that distribution of results will not be completely even. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L409 |
Name | <EllipsoidTag.size> |
Returns | LocationTag |
Description | Returns the size of the ellipsoid. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L448 |
Name | <EllipsoidTag.with_location[<location>]> |
Returns | EllipsoidTag |
Description | Returns a copy of this ellipsoid, set to the specified location. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L536 |
Name | <EllipsoidTag.with_size[<location>]> |
Returns | EllipsoidTag |
Description | Returns a copy of this ellipsoid, set to the specified size. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L554 |
Name | <EnchantmentTag.can_enchant[<item>]> |
Returns | ElementTag(Boolean) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L352 |
Name | <EnchantmentTag.category> |
Returns | ElementTag |
Description | Returns 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 |
|
Source | https://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>]> |
Returns | ElementTag(Decimal) |
Description | Returns 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 EntityTag.monster_type for getting the category of another mob. |
Example |
|
Source | https://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>)]> |
Returns | ElementTag(Number) |
Description | Returns 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 Damage Cause. For entity damage causes, optionally specify the entity attacker. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L446 |
Name | <EnchantmentTag.full_name[<level>]> |
Returns | ElementTag |
Description | Returns the full name for this enchantment for a given level, like "Sharpness V".
For vanilla enchantments, uses language translation keys. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L191 |
Name | <EnchantmentTag.is_compatible[<enchantment>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether this enchantment is compatible with another given enchantment. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L373 |
Name | <EnchantmentTag.is_curse> |
Returns | ElementTag(Boolean) |
Description | Returns whether this enchantment is only considered to be a curse. Curses are removed at grindstones, and spread from crafting table repairs. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L308 |
Name | <EnchantmentTag.is_discoverable> |
Returns | ElementTag(Boolean) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L290 |
Name | <EnchantmentTag.is_tradable> |
Returns | ElementTag(Boolean) |
Description | Returns whether this enchantment is only considered to be tradable. Villagers won't trade this enchantment if set to false. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L273 |
Name | <EnchantmentTag.key> |
Returns | ElementTag |
Description | Returns the full key for this enchantment, like "minecraft:sharpness". |
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L174 |
Name | <EnchantmentTag.max_cost[<level>]> |
Returns | ElementTag(Decimal) |
Description | Returns the maximum cost for this enchantment for the given level. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L409 |
Name | <EnchantmentTag.max_level> |
Returns | ElementTag(Number) |
Description | Returns the maximum level of this enchantment. Usually between 1 and 5. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L243 |
Name | <EnchantmentTag.min_cost[<level>]> |
Returns | ElementTag(Decimal) |
Description | Returns the minimum cost for this enchantment for the given level. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L393 |
Name | <EnchantmentTag.min_level> |
Returns | ElementTag(Number) |
Description | Returns the minimum level of this enchantment. Usually '1'. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L230 |
Name | <EnchantmentTag.name> |
Returns | ElementTag |
Description | Gets 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L158 |
Name | <EnchantmentTag.rarity> |
Returns | ElementTag |
Description | Returns the rarity of this enchantment. Can be any of: COMMON, UNCOMMON, RARE, VERY_RARE |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L339 |
Name | <EnchantmentTag.script> |
Returns | ScriptTag |
Description | Returns the script that created this enchantment type, if any. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L209 |
Name | <EnchantmentTag.treasure_only> |
Returns | ElementTag(Boolean) |
Description | Returns whether this enchantment is only for spawning as treasure. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EnchantmentTag.java#L256 |
Name | <EntityTag.absorption_health> |
Returns | ElementTag(Decimal) |
Mechanism | EntityTag.absorption_health |
Description | Returns the living entity's absorption health. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2069 |
Name | <EntityTag.all_raw_nbt> |
Returns | MapTag |
Mechanism | EntityTag.raw_nbt |
Description | Returns the entity's entire raw NBT data as a MapTag.
See Raw NBT Encoding for more information. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L3270 |
Name | <EntityTag.anger_at[<entity>]> |
Returns | ElementTag(Number) |
Mechanism | EntityTag.anger_at |
Description | Returns a warden's anger level at a specific entity. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2959 |
Name | <EntityTag.anger_level> |
Returns | ElementTag |
Description | Returns a warden's current anger level, which will be any of https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/Warden.AngerLevel.html. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2982 |
Name | <EntityTag.angry_at> |
Returns | EntityTag |
Description | Returns the entity a warden is the most angry at, if any. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2998 |
Name | <EntityTag.attached_entities[(<player>)]> |
Returns | ListTag(EntityTag) |
Description | Returns the entities attached to this entity by attach.
Optionally, specify a player. If specified, will return entities attached visible to that player. If not specified, returns entities globally attached. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2777 |
Name | <EntityTag.attached_offset[(<player>)]> |
Returns | LocationTag |
Description | Returns the offset of an attachment for this entity to another that was attached by 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2819 |
Name | <EntityTag.attached_to[(<player>)]> |
Returns | EntityTag |
Description | Returns the entity that this entity was attached to by 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2799 |
Name | <EntityTag.attack_cooldown_duration> |
Returns | DurationTag |
Mechanism | EntityTag.attack_cooldown |
Description | Returns the amount of time that passed since the start of the attack cooldown. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2839 |
Name | <EntityTag.attack_cooldown_max_duration> |
Returns | DurationTag |
Mechanism | EntityTag.attack_cooldown |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2854 |
Name | <EntityTag.attack_cooldown_percent> |
Returns | ElementTag(Decimal) |
Mechanism | EntityTag.attack_cooldown_percent |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2872 |
Name | <EntityTag.bookshelf_slot> |
Returns | ElementTag(Number) |
Description | Returns the Chiseled Bookshelf slot that the entity is looking at, if any.
See also LocationTag.slot |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L3252 |
Name | <EntityTag.fish_hook_apply_lure> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.fish_hook_apply_lure |
Description | Returns whether this fish hook should respect the lure enchantment.
Every level of lure enchantment reduces lure time by 5 seconds. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2746 |
Name | <EntityTag.fish_hook_hooked_entity> |
Returns | EntityTag |
Mechanism | EntityTag.fish_hook_hooked_entity |
Description | Returns the entity this fish hook is attached to. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2730 |
Name | <EntityTag.fish_hook_in_open_water> |
Returns | ElementTag(Boolean) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2762 |
Name | <EntityTag.fish_hook_lure_time> |
Returns | DurationTag |
Mechanism | EntityTag.fish_hook_lure_time |
Description | Returns the remaining time before this fish hook will lure a fish. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2685 |
Name | <EntityTag.fish_hook_max_lure_time> |
Returns | DurationTag |
Mechanism | EntityTag.fish_hook_max_lure_time |
Description | Returns the maximum possible time before this fish hook will lure a fish. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2715 |
Name | <EntityTag.fish_hook_min_lure_time> |
Returns | DurationTag |
Mechanism | EntityTag.fish_hook_min_lure_time |
Description | Returns the minimum possible time before this fish hook can lure a fish. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2700 |
Name | <EntityTag.fish_hook_state> |
Returns | ElementTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2671 |
Name | <EntityTag.highest_anger> |
Returns | ElementTag(Number) |
Description | Returns a warden's anger level at its current target, or its highest anger level. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2942 |
Name | <EntityTag.is_hand_raised> |
Returns | ElementTag(Boolean) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2889 |
Name | <EntityTag.is_sleeping> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player, NPC, or villager is currently sleeping. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1989 |
Name | <EntityTag.is_trading> |
Returns | ElementTag(Boolean) |
Description | Returns whether the villager entity is trading. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1437 |
Name | <EntityTag.last_attack> |
Returns | MapTag |
Description | Returns 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 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2906 |
Name | <EntityTag.last_interaction> |
Returns | MapTag |
Description | Returns 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 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2924 |
Name | <EntityTag.left_shoulder> |
Returns | EntityTag |
Mechanism | EntityTag.left_shoulder |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1784 |
Name | <EntityTag.loot_table_id> |
Returns | ElementTag |
Mechanism | EntityTag.loot_table_id |
Description | Returns an element indicating the minecraft key for the loot-table for the entity (if any). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2654 |
Name | <EntityTag.precise_target[(<range>)]> |
Returns | EntityTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2139 |
Name | <EntityTag.precise_target_position[(<range>)]> |
Returns | LocationTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2175 |
Name | <EntityTag.precise_target_position[(<range>)].type[<matcher>]> |
Returns | LocationTag |
Description | Returns 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). |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2188 |
Name | <EntityTag.precise_target[(<range>)].type[<matcher>]> |
Returns | EntityTag |
Description | Returns 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). |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2152 |
Name | <EntityTag.right_shoulder> |
Returns | EntityTag |
Mechanism | EntityTag.right_shoulder |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1805 |
Name | <EntityTag.skin_layers> |
Returns | ListTag |
Mechanism | EntityTag.skin_layers |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2502 |
Name | <EntityTag.trades> |
Returns | ListTag(TradeTag) |
Mechanism | EntityTag.trades |
Description | Returns a list of the Villager's trade recipes. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityTrades.java#L64 |
Name | <EntityTag.trading_with> |
Returns | PlayerTag |
Description | Returns the player who is trading with the villager entity, or null if it is not trading. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1450 |
Name | <EntityTag.translated_name> |
Returns | ElementTag |
Description | Returns the localized name of the entity.
Note that this is a magic Denizen tool - refer to Denizen Text Formatting. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1261 |
Name | <EntityTag.vanilla_tags> |
Returns | ListTag |
Description | Returns a list of vanilla tags that apply to this entity type. See also https://minecraft.wiki/w/Tag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1273 |
Name | <EntityTag.effects_data> |
Returns | ListTag(MapTag) |
Mechanism | EntityTag.potion_effects |
Description | Returns the active potion effects on the entity, in the MapTag format of the mechanism. |
Generated Example |
|
Group | attribute |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPotionEffects.java#L110 |
Name | <EntityTag.list_effects> |
Returns | ListTag |
Mechanism | EntityTag.potion_effects |
Description | Deprecated in favor of EntityTag.effects_data |
Generated Example |
|
Group | attribute |
Deprecated | use 'effects_data' instead |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPotionEffects.java#L96 |
Name | <EntityTag.armor_bonus> |
Returns | ElementTag(Decimal) |
Mechanism | EntityTag.armor_bonus |
Description | Returns the entity's base armor bonus. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityArmorBonus.java#L55 |
Name | <EntityTag.armor_pose> |
Returns | LocationTag |
Mechanism | EntityTag.armor_pose |
Description | Deprecated in favor of EntityTag.armor_pose_map |
Generated Example |
|
Group | attributes |
Deprecated | Use 'armor_pose_map' |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityArmorPose.java#L105 |
Name | <EntityTag.armor_pose_list> |
Returns | ListTag |
Mechanism | EntityTag.armor_pose |
Description | Deprecated in favor of EntityTag.armor_pose_map |
Generated Example |
|
Group | attributes |
Deprecated | Use 'armor_pose_map' |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityArmorPose.java#L91 |
Name | <EntityTag.armor_pose_map> |
Returns | MapTag |
Mechanism | EntityTag.armor_pose |
Description | Returns 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 |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityArmorPose.java#L77 |
Name | <EntityTag.attached_block> |
Returns | LocationTag |
Description | Returns the location of the block that the arrow/trident or hanging entity is attached to. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2249 |
Name | <EntityTag.breeding> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.breed |
Description | Returns whether the animal entity is trying to mate with another of its kind. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1855 |
Name | <EntityTag.can_breed> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.can_breed |
Description | Returns whether the animal entity is capable of mating with another of its kind. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1840 |
Name | <EntityTag.can_pickup_items> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.can_pickup_items |
Description | Returns whether the entity can pick up items. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1656 |
Name | <EntityTag.custom_name> |
Returns | ElementTag |
Mechanism | EntityTag.custom_name |
Description | Returns the entity's custom name (as set by plugin or name tag item), if any. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityCustomName.java#L44 |
Name | <EntityTag.custom_name_visible> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.custom_name_visible |
Description | Returns whether the entity's custom name is visible. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityCustomNameVisible.java#L47 |
Name | <EntityTag.dark_duration> |
Returns | DurationTag |
Mechanism | EntityTag.dark_duration |
Description | Returns the duration remaining before a glow squid starts glowing. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityDarkDuration.java#L53 |
Name | <EntityTag.direction> |
Returns | LocationTag |
Mechanism | EntityTag.direction |
Description | Returns the movement/acceleration direction of a fireball entity, as a LocationTag vector. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityDirection.java#L53 |
Name | <EntityTag.fall_distance> |
Returns | ElementTag(Decimal) |
Mechanism | EntityTag.fall_distance |
Description | Returns how far the entity has fallen. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1686 |
Name | <EntityTag.fallingblock_material> |
Returns | MaterialTag |
Mechanism | EntityTag.fallingblock_type |
Description | Returns the material of a fallingblock-type entity. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1671 |
Name | <EntityTag.fire_time> |
Returns | DurationTag |
Mechanism | EntityTag.fire_time |
Description | Returns the duration for which the entity will remain on fire |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1698 |
Name | <EntityTag.fixed> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.fixed |
Description | Returns whether the item frame is fixed. (Meaning, it can't be altered by players or broken by block obstructions). |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityFixed.java#L57 |
Name | <EntityTag.force_no_persist> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.force_no_persist |
Description | Returns 'true' if the entity is forced to not save to file when chunks unload.
Returns 'false' if not forced to not-save (ie is allowed to 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 EntityTag.is_persistent. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1955 |
Name | <EntityTag.formatted_health> |
Returns | ElementTag |
Mechanism | EntityTag.health_data |
Description | Returns a formatted value of the player's current health level.
May be 'dying', 'seriously wounded', 'injured', 'scraped', or 'healthy'. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityHealth.java#L83 |
Name | <EntityTag.freeze_duration> |
Returns | DurationTag |
Mechanism | EntityTag.freeze_duration |
Description | Returns the duration an entity has been freezing for (from powdered snow). |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityFreezeDuration.java#L57 |
Name | <EntityTag.gliding> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.gliding |
Description | Returns whether this entity is gliding. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2270 |
Name | <EntityTag.glowing> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.glowing |
Description | Returns whether this entity is glowing. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2307 |
Name | <EntityTag.has_effect[<effect>]> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.potion_effects |
Description | Returns 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. |
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPotionEffects.java#L122 |
Name | <EntityTag.has_passenger> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.passenger |
Description | Returns whether the entity has a passenger. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1870 |
Name | <EntityTag.health> |
Returns | ElementTag(Decimal) |
Mechanism | EntityTag.health |
Description | Returns the current health of the entity. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityHealth.java#L157 |
Name | <EntityTag.health_data> |
Returns | ElementTag |
Mechanism | EntityTag.health |
Description | Returns the current health data of the entity, in the format of current/max. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityHealth.java#L144 |
Name | <EntityTag.health_max> |
Returns | ElementTag(Decimal) |
Mechanism | EntityTag.max_health |
Description | Returns the maximum health of the entity. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityHealth.java#L100 |
Name | <EntityTag.health_percentage> |
Returns | ElementTag(Decimal) |
Mechanism | EntityTag.health |
Description | Returns the entity's current health as a percentage. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityHealth.java#L118 |
Name | <EntityTag.is_collidable> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.collidable |
Description | Returns whether the entity is collidable.
Returns the persistent collidable value for NPCs. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1973 |
Name | <EntityTag.is_empty> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity does not have a passenger. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1882 |
Name | <EntityTag.is_in_block> |
Returns | ElementTag(Boolean) |
Description | Returns whether the arrow/trident entity is in a block. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2238 |
Name | <EntityTag.is_inside_vehicle> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is inside a vehicle. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1893 |
Name | <EntityTag.is_leashed> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is leashed. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1904 |
Name | <EntityTag.is_on_ground> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is supported by a block.
This can be inaccurate for players. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1929 |
Name | <EntityTag.is_persistent> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.persistent |
Description | Returns 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, EntityTag.force_no_persist may be preferred. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1941 |
Name | <EntityTag.is_sheared> |
Returns | ElementTag(Boolean) |
Description | Returns whether a sheep is sheared. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1915 |
Name | <EntityTag.killer> |
Returns | PlayerTag |
Description | Returns the player that last killed the entity. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2005 |
Name | <EntityTag.last_damage.amount> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of the last damage taken by the entity. |
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2017 |
Name | <EntityTag.last_damage.cause> |
Returns | ElementTag |
Description | Returns the cause of the last damage taken by the entity. |
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2028 |
Name | <EntityTag.last_damage.duration> |
Returns | DurationTag |
Mechanism | EntityTag.no_damage_duration |
Description | Returns the duration of the last damage taken by the entity. |
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2042 |
Name | <EntityTag.last_damage.max_duration> |
Returns | DurationTag |
Mechanism | EntityTag.max_no_damage_duration |
Description | Returns the maximum duration of the last damage taken by the entity. |
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2054 |
Name | <EntityTag.leash_holder> |
Returns | EntityTag |
Mechanism | EntityTag.leash_holder |
Description | Returns the leash holder of entity. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1721 |
Name | <EntityTag.max_freeze_duration> |
Returns | DurationTag |
Mechanism | EntityTag.freeze_duration |
Description | Returns the maximum duration an entity can be freezing for (from powdered snow). (When reached, an entity is fully frozen over). |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityFreezeDuration.java#L45 |
Name | <EntityTag.max_oxygen> |
Returns | DurationTag |
Description | Returns the maximum duration of oxygen the entity can have.
Works with offline players. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2080 |
Name | <EntityTag.on_fire> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is currently ablaze or not. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1710 |
Name | <EntityTag.oxygen> |
Returns | DurationTag |
Mechanism | EntityTag.oxygen |
Description | Returns the duration of oxygen the entity has left.
Works with offline players. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2092 |
Name | <EntityTag.passenger> |
Returns | EntityTag |
Mechanism | EntityTag.passenger |
Description | Returns the entity's passenger, if any. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1752 |
Name | <EntityTag.passengers> |
Returns | ListTag(EntityTag) |
Mechanism | EntityTag.passengers |
Description | Returns a list of the entity's passengers, if any. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1736 |
Name | <EntityTag.pickup_delay> |
Returns | DurationTag |
Mechanism | EntityTag.pickup_delay |
Description | Returns how long before the item-type entity can be picked up by a player. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2223 |
Name | <EntityTag.scoreboard_tags> |
Returns | ListTag |
Mechanism | EntityTag.scoreboard_tags |
Description | Returns a list of the scoreboard tags on the entity. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityScoreboardTags.java#L64 |
Name | <EntityTag.shooter> |
Returns | EntityTag |
Mechanism | EntityTag.shooter |
Description | Returns the projectile's shooter or TNT's priming source, if any. |
Generated Example |
|
Synonyms (Search Aid) | entitytag.arrow_firer, entitytag.fishhook_shooter, entitytag.snowball_thrower |
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1767 |
Name | <EntityTag.silent> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.silent |
Description | Returns whether the entity is silent (Plays no sounds). |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntitySilent.java#L56 |
Name | <EntityTag.speed> |
Returns | ElementTag(Decimal) |
Mechanism | EntityTag.speed |
Description | Returns how fast the entity can move.
Compatible with minecarts, boats, and living entities. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntitySpeed.java#L81 |
Name | <EntityTag.swimming> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.swimming |
Description | Returns whether this entity is swimming. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2282 |
Name | <EntityTag.target> |
Returns | EntityTag |
Description | Returns 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 |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2115 |
Name | <EntityTag.time_lived> |
Returns | DurationTag |
Mechanism | EntityTag.time_lived |
Description | Returns how long the entity has lived. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2211 |
Name | <EntityTag.vehicle> |
Returns | EntityTag |
Description | If the entity is in a vehicle, returns the vehicle as a EntityTag. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1826 |
Name | <EntityTag.visible> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.visible |
Description | Returns whether the entity is visible.
Supports armor stands, item frames, and living entities. |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityVisible.java#L60 |
Name | <EntityTag.visual_pose> |
Returns | ElementTag |
Mechanism | EntityTag.visual_pose |
Description | Returns the name of the entity's current visual pose.
See https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Pose.html |
Generated Example |
|
Group | attributes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2294 |
Name | <EntityTag.eid> |
Returns | ElementTag(Number) |
Description | Returns the entity's temporary server entity ID. |
Generated Example |
|
Group | data |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1298 |
Name | <EntityTag.entity_type> |
Returns | ElementTag |
Description | Returns the type of the entity. |
Generated Example |
|
Group | data |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1250 |
Name | <EntityTag.is_living> |
Returns | ElementTag(Boolean) |
Description | Returns 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 EntityTag.is_spawned. |
Generated Example |
|
Group | data |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2323 |
Name | <EntityTag.is_mob> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity type is a mob (Not a player or NPC). |
Generated Example |
|
Group | data |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2346 |
Name | <EntityTag.is_monster> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity type is a hostile monster. |
Generated Example |
|
Group | data |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2335 |
Name | <EntityTag.is_npc> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is a Citizens NPC. |
Generated Example |
|
Group | data |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2357 |
Name | <EntityTag.is_player> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is a player.
Works with offline players. |
Generated Example |
|
Group | data |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2368 |
Name | <EntityTag.is_projectile> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity type is a projectile. |
Generated Example |
|
Group | data |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2380 |
Name | <EntityTag.is_spawned> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is spawned. |
Generated Example |
|
Group | data |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1287 |
Name | <EntityTag.monster_type> |
Returns | ElementTag |
Description | Returns 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 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 |
|
Group | data |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1368 |
Name | <EntityTag.name> |
Returns | ElementTag |
Description | Returns 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 |
|
Group | data |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1355 |
Name | <EntityTag.script> |
Returns | ScriptTag |
Description | Returns the entity script that spawned this entity, if any. |
Generated Example |
|
Group | data |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1321 |
Name | <EntityTag.scriptname> |
Returns | ElementTag |
Description | Use ".script.name" instead. |
Generated Example |
|
Group | data |
Deprecated | use ".script.name" instead. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1335 |
Name | <EntityTag.uuid> |
Returns | ElementTag |
Description | Returns the permanent unique ID of the entity.
Works with offline players. |
Generated Example |
|
Group | data |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1309 |
Name | <EntityTag.has_equipped[<item-matcher>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity has any armor equipment item that matches the given item matcher, using the system behind Advanced Object Matching.
For example, has_equipped[diamond_*] will return true if the entity is wearing at least one piece of diamond armor. |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2630 |
Name | <EntityTag.equipment> |
Returns | ListTag(ItemTag) |
Mechanism | EntityTag.equipment |
Description | Returns a ListTag containing the entity's equipment.
Output list is boots|leggings|chestplate|helmet |
Generated Example |
|
Group | inventory |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityEquipment.java#L55 |
Name | <EntityTag.equipment_map> |
Returns | MapTag |
Mechanism | EntityTag.equipment |
Description | Returns 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 |
|
Group | inventory |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityEquipment.java#L93 |
Name | <EntityTag.has_saddle> |
Returns | ElementTag(Boolean) |
Description | If the entity is a pig or horse, returns whether it has a saddle equipped. |
Generated Example |
|
Group | inventory |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1420 |
Name | <EntityTag.horse_armor> |
Returns | ItemTag |
Description | If the entity is a horse, returns the item equipped as the horses armor, or air if none. |
Generated Example |
|
Group | inventory |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1406 |
Name | <EntityTag.inventory> |
Returns | InventoryTag |
Description | Returns the entity's inventory, if it has one. |
Generated Example |
|
Group | inventory |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityInventory.java#L61 |
Name | <EntityTag.item_in_hand> |
Returns | ItemTag |
Mechanism | EntityTag.item_in_hand |
Description | Returns the item the entity is holding, or air if none. |
Generated Example |
|
Group | inventory |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityItemInHand.java#L69 |
Name | <EntityTag.item_in_offhand> |
Returns | ItemTag |
Mechanism | EntityTag.item_in_offhand |
Description | Returns the item the entity is holding in their off hand, or air if none. |
Generated Example |
|
Group | inventory |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityItemInOffHand.java#L69 |
Name | <EntityTag.saddle> |
Returns | ItemTag |
Description | If the entity is a horse or pig, returns the saddle as a ItemTag, or air if none. |
Generated Example |
|
Group | inventory |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1389 |
Name | <EntityTag.body_yaw> |
Returns | ElementTag(Decimal) |
Description | Returns a living entity's body yaw (separate from head yaw). |
Generated Example |
|
Group | location |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1617 |
Name | <EntityTag.can_see[<entity>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity can see the specified other entity (has an uninterrupted line-of-sight). |
Generated Example |
|
Group | location |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1499 |
Name | <EntityTag.cursor_on[(<range>)]> |
Returns | LocationTag |
Description | Returns 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 LocationTag.precise_cursor_on_block. 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 EntityTag.cursor_on_solid to exclude passable blocks. Equivalent to <EntityTag.eye_location.ray_trace[return=block;fluids=true;nonsolids=true]> |
Generated Example |
|
Group | location |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1564 |
Name | <EntityTag.cursor_on_solid[(<range>)]> |
Returns | LocationTag |
Description | Returns 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 EntityTag.cursor_on to include passable blocks. Equivalent to <EntityTag.eye_location.ray_trace[return=block]> |
Generated Example |
|
Group | location |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1541 |
Name | <EntityTag.eye_height> |
Returns | ElementTag(Number) |
Description | Returns the height of the entity's eyes above its location. |
Generated Example |
|
Group | location |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1527 |
Name | <EntityTag.eye_location> |
Returns | LocationTag |
Description | Returns the location of the entity's eyes. |
Generated Example |
|
Group | location |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1516 |
Name | <EntityTag.location> |
Returns | LocationTag |
Description | Returns the location of the entity.
For living entities, this is at the center of their feet. For eye location, use EntityTag.eye_location Works with offline players. |
Generated Example |
|
Group | location |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1588 |
Name | <EntityTag.map_trace> |
Returns | LocationTag |
Description | Deprecated in favor of EntityTag.trace_framed_map |
Generated Example |
|
Group | location |
Deprecated | use EntityTag.trace_framed_map |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1482 |
Name | <EntityTag.standing_on> |
Returns | LocationTag |
Description | Returns the location of the block the entity is standing on top of (if on the ground, returns null if in the air). |
Generated Example |
|
Group | location |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1602 |
Name | <EntityTag.trace_framed_map> |
Returns | MapTag |
Description | Returns 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 |
|
Group | location |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1467 |
Name | <EntityTag.velocity> |
Returns | LocationTag |
Mechanism | EntityTag.velocity |
Description | Returns the movement velocity of the entity.
Note: Does not accurately calculate player clientside movement velocity. |
Generated Example |
|
Group | location |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1628 |
Name | <EntityTag.world> |
Returns | WorldTag |
Description | Returns the world the entity is in. Works with offline players. |
Generated Example |
|
Group | location |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1641 |
Name | <EntityTag.ageable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is ageable.
If this returns true, it will enable access to: EntityTag.age, EntityTag.age_lock, EntityTag.is_baby, EntityTag.age, and EntityTag.is_age_locked |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2412 |
Name | <EntityTag.allowed_colors> |
Returns | ListTag |
Mechanism | EntityTag.color |
Description | If the entity can have a color, returns the list of allowed colors.
See also Entity Color Types. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityColor.java#L344 |
Name | <EntityTag.anger> |
Returns | DurationTag |
Mechanism | EntityTag.anger |
Description | Returns the remaining anger time of a PigZombie or Bee. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAnger.java#L76 |
Name | <EntityTag.angry> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.angry |
Description | If 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAngry.java#L68 |
Name | <EntityTag.arms> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.arms |
Description | If the entity is an armor stand, returns whether the armor stand has arms. |
Generated Example |
|
Group | properties |
Source | https://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>]> |
Returns | ElementTag(Decimal) |
Mechanism | EntityTag.attribute_base_values |
Description | Returns the base value of the named attribute for the entity.
See also EntityTag.has_attribute. Valid attribute names are listed at https://hub.spigotmc.org/javadocs/spigot/org/bukkit/attribute/Attribute.html See also attribute modifiers. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAttributeBaseValues.java#L116 |
Name | <EntityTag.attribute_default_value[<attribute>]> |
Returns | ElementTag(Decimal) |
Mechanism | EntityTag.attribute_base_values |
Description | Returns the default value of the named attribute for the entity.
See also EntityTag.has_attribute. Valid attribute names are listed at https://hub.spigotmc.org/javadocs/spigot/org/bukkit/attribute/Attribute.html See also attribute modifiers. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAttributeBaseValues.java#L141 |
Name | <EntityTag.attribute_modifiers> |
Returns | MapTag |
Mechanism | EntityTag.attribute_modifiers |
Description | Returns 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 attribute modifiers. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAttributeModifiers.java#L275 |
Name | <EntityTag.attribute_value[<attribute>]> |
Returns | ElementTag(Decimal) |
Mechanism | EntityTag.attribute_base_values |
Description | Returns the final calculated value of the named attribute for the entity.
See also EntityTag.has_attribute. Valid attribute names are listed at https://hub.spigotmc.org/javadocs/spigot/org/bukkit/attribute/Attribute.html See also attribute modifiers. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAttributeBaseValues.java#L91 |
Name | <EntityTag.base_plate> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.base_plate |
Description | If the entity is an armor stand, returns whether the armor stand has a base plate. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityBasePlate.java#L53 |
Name | <EntityTag.base_potion> |
Returns | ElementTag |
Mechanism | EntityTag.base_potion |
Description | Returns the Area Effect Cloud's base potion data.
In the format Type,Upgraded,Extended |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L74 |
Name | <EntityTag.base_potion.is_extended> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Area Effect Cloud's base potion is extended. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L110 |
Name | <EntityTag.base_potion.is_upgraded> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Area Effect Cloud's base potion is upgraded. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L98 |
Name | <EntityTag.base_potion.type> |
Returns | ElementTag |
Description | Returns the Area Effect Cloud's base potion type. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L86 |
Name | <EntityTag.beam_target> |
Returns | LocationTag |
Mechanism | EntityTag.beam_target |
Description | Returns the target location of the ender crystal's beam, if any. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityBeamTarget.java#L55 |
Name | <EntityTag.body_arrows> |
Returns | ElementTag(Number) |
Mechanism | EntityTag.body_arrows |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityBodyArrows.java#L57 |
Name | <EntityTag.bounding_box> |
Returns | ListTag(LocationTag) |
Mechanism | EntityTag.bounding_box |
Description | Returns the collision bounding box of the entity in the format "<low>|<high>", essentially a cuboid with decimals. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityBoundingBox.java#L75 |
Name | <EntityTag.can_join_raid> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.can_join_raid |
Description | If the entity is raider mob (like a pillager), returns whether the entity is allowed to join active raids. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityCanJoinRaid.java#L53 |
Name | <EntityTag.cannot_enter_hive> |
Returns | DurationTag |
Mechanism | EntityTag.cannot_enter_hive |
Description | Returns the minimum duration until a Bee entity is allowed to enter a hive. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityCannotEnterHive.java#L66 |
Name | <EntityTag.carries_chest> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.carries_chest |
Description | Returns whether a horse-like entity is carrying a chest. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityChestCarrier.java#L53 |
Name | <EntityTag.charged> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.charged |
Description | If 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityCharged.java#L55 |
Name | <EntityTag.colorable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity can be colored.
If this returns true, it will enable access to EntityTag.color. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2427 |
Name | <EntityTag.conversion_duration> |
Returns | DurationTag |
Mechanism | EntityTag.conversion_duration |
Description | Returns the duration of time until an entity completes a conversion. See EntityTag.is_converting for examples of conversions.
When this value hits 0, the conversion completes. See also EntityTag.in_water_duration |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityConversionTime.java#L57 |
Name | <EntityTag.conversion_player> |
Returns | PlayerTag |
Mechanism | EntityTag.conversion_player |
Description | Returns the player that caused a zombie villager to start converting back to a villager, if any. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityConversionPlayer.java#L58 |
Name | <EntityTag.critical> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.critical |
Description | If the entity is an arrow or trident, returns whether the arrow/trident is critical. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityCritical.java#L53 |
Name | <EntityTag.custom_effects> |
Returns | ListTag |
Mechanism | EntityTag.custom_effects |
Description | Returns a ListTag of the Area Effect Cloud's custom effects
In the form Type,Amplifier,Duration,Ambient,Particles|... |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L284 |
Name | <EntityTag.custom_effects[<#>].amplifier> |
Returns | ElementTag(Number) |
Description | Returns the specified Area Effect Cloud potion effect amplifier. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L325 |
Name | <EntityTag.custom_effects[<#>].duration> |
Returns | DurationTag |
Description | Returns the specified Area Effect Cloud potion effect duration. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L337 |
Name | <EntityTag.custom_effects[<#>].has_particles> |
Returns | ElementTag(Boolean) |
Description | Returns whether the specified Area Effect Cloud potion effect has particles. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L349 |
Name | <EntityTag.custom_effects[<#>].is_ambient> |
Returns | ElementTag(Boolean) |
Description | Returns whether the specified Area Effect Cloud potion effect is ambient. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L361 |
Name | <EntityTag.custom_effects[<#>].type> |
Returns | ElementTag |
Description | Returns the specified Area Effect Cloud potion effect type. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L313 |
Name | <EntityTag.describe> |
Returns | EntityTag |
Description | Returns the entity's full description, including all properties. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2619 |
Name | <EntityTag.disabled_slots> |
Returns | ListTag |
Mechanism | EntityTag.disabled_slots |
Description | Deprecated in favor of EntityTag.disabled_slots_data. |
Generated Example |
|
Group | properties |
Deprecated | Use 'EntityTag.disabled_slots_data' |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityDisabledSlots.java#L97 |
Name | <EntityTag.disabled_slots_data> |
Returns | MapTag |
Mechanism | EntityTag.disabled_slots |
Description | If the entity is an armor stand, returns its disabled slots as a map of slot names to list of actions. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityDisabledSlots.java#L127 |
Name | <EntityTag.disabled_slots.raw> |
Returns | ElementTag(Number) |
Mechanism | EntityTag.disabled_slots_raw |
Description | Deprecated in favor of EntityTag.disabled_slots_data. |
Group | properties |
Deprecated | Use 'disabled_slots_data' |
Source | https://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>)]> |
Returns | EntityTag |
Description | Returns 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 disguise. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2582 |
Name | <EntityTag.disguised_type[(<player>)]> |
Returns | EntityTag |
Description | Returns the entity type the entity is disguised as, either globally (if no context input given), or to the specified player.
Relates to disguise. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2548 |
Name | <EntityTag.dragon_phase> |
Returns | ElementTag |
Mechanism | EntityTag.dragon_phase |
Description | Returns the phase an EnderDragon is currently in.
Valid phases: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/EnderDragon.Phase.html |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2469 |
Name | <EntityTag.duration> |
Returns | DurationTag |
Mechanism | EntityTag.duration |
Description | Returns the Area Effect Cloud's duration. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L151 |
Name | <EntityTag.duration.on_use> |
Returns | DurationTag |
Description | Returns the duration the Area Effect Cloud
will increase by when it applies an effect to an entity. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L162 |
Name | <EntityTag.ender_eye_target_location> |
Returns | LocationTag |
Mechanism | EntityTag.ender_eye_target_location |
Description | Returns a thrown eye of ender's target location - the location it's moving towards, which in vanilla is a stronghold location. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityEyeTargetLocation.java#L39 |
Name | <EntityTag.experience> |
Returns | ElementTag(Number) |
Mechanism | EntityTag.experience |
Description | Returns the experience value of this experience orb entity. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2439 |
Name | <EntityTag.explosion_fire> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.explosion_fire |
Description | If this entity is explosive, returns whether its explosion creates fire. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityExplosionFire.java#L57 |
Name | <EntityTag.explosion_radius> |
Returns | ElementTag(Decimal) |
Mechanism | EntityTag.explosion_radius |
Description | If this entity can explode, returns its explosion radius. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityExplosionRadius.java#L62 |
Name | <EntityTag.firework_item> |
Returns | ItemTag |
Mechanism | EntityTag.firework_item |
Description | If the entity is a firework, returns the firework item used to launch it. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityFirework.java#L62 |
Name | <EntityTag.firework_lifetime> |
Returns | DurationTag |
Mechanism | EntityTag.firework_lifetime |
Description | Returns the duration that a firework will live for (before detonating). |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityFireworkLifetime.java#L53 |
Name | <EntityTag.flower> |
Returns | LocationTag |
Mechanism | EntityTag.flower |
Description | Returns the location of a bee's flower (if any). |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityFlower.java#L69 |
Name | <EntityTag.framed_item> |
Returns | ItemTag |
Mechanism | EntityTag.framed |
Description | If the entity is an item frame, returns the item currently framed. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityFramed.java#L100 |
Name | <EntityTag.framed_item_rotation> |
Returns | ElementTag |
Mechanism | EntityTag.framed |
Description | If the entity is an item frame, returns the rotation of the item currently framed. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityFramed.java#L87 |
Name | <EntityTag.fuse_ticks> |
Returns | ElementTag(Number) |
Mechanism | EntityTag.fuse_ticks |
Description | Returns the number of ticks until the explosion of the primed TNT. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2454 |
Name | <EntityTag.gravity> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.gravity |
Description | Returns whether the entity has gravity. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityGravity.java#L62 |
Name | <EntityTag.has_attribute[<attribute>]> |
Returns | ElementTag(Boolean) |
Description | Returns 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 attribute modifiers. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAttributeBaseValues.java#L73 |
Name | <EntityTag.has_custom_effect[(<effect>)]> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.custom_effects |
Description | Returns whether the Area Effect Cloud has a specified effect.
If no effect is specified, returns whether it has any custom effect. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L245 |
Name | <EntityTag.has_framed_item> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.framed |
Description | If the entity is an item frame, returns whether the frame has an item in it. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityFramed.java#L113 |
Name | <EntityTag.has_nectar> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.has_nectar |
Description | Returns whether a bee entity has nectar on it. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityHasNectar.java#L66 |
Name | <EntityTag.has_pumpkin_head> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.has_pumpkin_head |
Description | If the entity is a snowman, returns whether the snowman has a pumpkin on its head. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPumpkinHead.java#L57 |
Name | <EntityTag.has_stung> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.has_stung |
Description | Returns whether a bee entity has already used its stinger. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityHasStung.java#L66 |
Name | <EntityTag.hive> |
Returns | LocationTag |
Mechanism | EntityTag.hive |
Description | Returns the location of a bee's hive (if any). |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityHive.java#L69 |
Name | <EntityTag.horns> |
Returns | ListTag |
Mechanism | EntityTag.horns |
Description | Returns a ListTag of a goat's horns. can include "left" and "right", for the left and right horns. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityHorns.java#L57 |
Name | <EntityTag.immune> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.immune |
Description | Returns whether this piglin or hoglin entity is immune to zombification. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityImmune.java#L79 |
Name | <EntityTag.in_water_duration> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.in_water_duration |
Description | If 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 EntityTag.conversion_duration |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityInWaterTime.java#L49 |
Name | <EntityTag.invulnerable> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.invulnerable |
Description | Returns whether the entity is invulnerable (cannot be damaged). |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityInvulnerable.java#L61 |
Name | <EntityTag.is_age_locked> |
Returns | ElementTag(Boolean) |
Description | Deprecated in favor of EntityTag.age_locked. |
Generated Example |
|
Group | properties |
Deprecated | use 'age_locked'. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAgeLocked.java#L53 |
Name | <EntityTag.is_baby> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.age |
Description | If the entity is ageable, returns whether the entity is a baby. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAge.java#L91 |
Name | <EntityTag.is_converting> |
Returns | ElementTag(Boolean) |
Description | Returns whether an entity is currently undergoing a conversion process. This can be:
A zombie villager being cured, A zombie becoming a drowned (See also EntityTag.in_water_duration), A husk becoming a zombie, or A skeleton becoming a stray. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityConversionTime.java#L75 |
Name | <EntityTag.is_disguised[(<player>)]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is currently disguised, either globally (if no context input given), or to the specified player.
Relates to disguise. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2522 |
Name | <EntityTag.is_patrol_leader> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.is_patrol_leader |
Description | If the entity is raider mob (like a pillager), returns whether the entity is a patrol leader. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPatrolLeader.java#L48 |
Name | <EntityTag.is_showing_bottom> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.is_showing_bottom |
Description | If the entity is an ender crystal, returns whether the ender crystal has its bottom showing. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityIsShowingBottom.java#L62 |
Name | <EntityTag.is_small> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.is_small |
Description | Returns whether the armor stand is small. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntitySmall.java#L61 |
Name | <EntityTag.is_tamed> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.tame |
Description | Returns whether the entity has been tamed. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityTame.java#L72 |
Name | <EntityTag.is_using_riptide> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.is_using_riptide |
Description | Returns whether this entity is using the Riptide enchantment. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityRiptide.java#L56 |
Name | <EntityTag.jump_strength> |
Returns | ElementTag(Number) |
Mechanism | EntityTag.jump_strength |
Description | Returns the power of a horse's jump.
Also applies to horse-like mobs, such as donkeys and mules. |
Generated Example |
|
Synonyms (Search Aid) | entitytag.horse_jump_height |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityJumpStrength.java#L58 |
Name | <EntityTag.knockback> |
Returns | ElementTag(Number) |
Mechanism | EntityTag.knockback |
Description | Returns the knockback strength of an arrow or trident. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityKnockback.java#L43 |
Name | <EntityTag.marker> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.marker |
Description | If the entity is an armor stand, returns whether the armor stand is a marker.
Marker armor stands have a tiny hitbox. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityMarker.java#L63 |
Name | <EntityTag.max_fuse_ticks> |
Returns | ElementTag(Number) |
Mechanism | EntityTag.max_fuse_ticks |
Description | Returns the default number of ticks until the creeper explodes when primed (NOT the time remaining if already primed). |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityMaxFuseTicks.java#L58 |
Name | <EntityTag.owner> |
Returns | PlayerTag |
Mechanism | EntityTag.owner |
Description | Returns the owner of a tamed entity. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityTame.java#L85 |
Name | <EntityTag.painting> |
Returns | ElementTag |
Mechanism | EntityTag.painting |
Description | If the entity is a painting, returns what art it shows.
See also server.art_types. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPainting.java#L88 |
Name | <EntityTag.painting_height> |
Returns | ElementTag(Number) |
Mechanism | EntityTag.painting |
Description | If the entity is a painting, returns its height. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPainting.java#L75 |
Name | <EntityTag.painting_width> |
Returns | ElementTag(Number) |
Mechanism | EntityTag.painting |
Description | If the entity is a painting, returns its width. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPainting.java#L62 |
Name | <EntityTag.particle> |
Returns | ElementTag |
Mechanism | EntityTag.particle |
Description | Returns the Area Effect Cloud's particle. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L125 |
Name | <EntityTag.particle.color> |
Returns | ColorTag |
Description | Returns the Area Effect Cloud's particle color. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L136 |
Name | <EntityTag.patrol_target> |
Returns | LocationTag |
Mechanism | EntityTag.patrol_target |
Description | If the entity is raider mob (like a pillager), returns whether the entity is allowed to join active raids. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPatrolTarget.java#L53 |
Name | <EntityTag.pickup_status> |
Returns | ElementTag |
Mechanism | EntityTag.pickup_status |
Description | If the entity is an arrow or trident, returns the pickup status of the arrow/trident. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPickupStatus.java#L55 |
Name | <EntityTag.player_created> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.player_created |
Description | Returns whether this Iron_Golem was created by a player. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPlayerCreated.java#L62 |
Name | <EntityTag.playing_dead> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.playing_dead |
Description | If the entity is an axolotl, returns whether the entity is playing dead. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPlayingDead.java#L40 |
Name | <EntityTag.potion> |
Returns | ItemTag |
Mechanism | EntityTag.potion |
Description | If 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPotion.java#L94 |
Name | <EntityTag.powered> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.powered |
Description | If the entity is a creeper, returns whether the creeper is powered. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPowered.java#L75 |
Name | <EntityTag.profession> |
Returns | ElementTag |
Mechanism | EntityTag.profession |
Description | If 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityProfession.java#L82 |
Name | <EntityTag.radius> |
Returns | ElementTag(Decimal) |
Mechanism | EntityTag.radius |
Description | Returns the Area Effect Cloud's radius. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L178 |
Name | <EntityTag.radius.on_use> |
Returns | ElementTag(Decimal) |
Description | Returns the amount the Area Effect Cloud's radius
will increase by when it applies an effect to an entity. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L189 |
Name | <EntityTag.radius.per_tick> |
Returns | ElementTag(Decimal) |
Description | Returns the amount the Area Effect Cloud's radius
will increase by every tick. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L202 |
Name | <EntityTag.reapplication_delay> |
Returns | DurationTag |
Mechanism | EntityTag.reapplication_delay |
Description | Returns the duration an entity will be immune
from the Area Effect Cloud's subsequent exposure. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L218 |
Name | <EntityTag.rotation> |
Returns | ElementTag |
Mechanism | EntityTag.rotation |
Description | If 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityRotation.java#L85 |
Name | <EntityTag.rotation_vector> |
Returns | LocationTag |
Mechanism | EntityTag.rotation |
Description | If 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityRotation.java#L71 |
Name | <EntityTag.shivering> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.shivering |
Description | Returns whether the strider is shivering. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityShivering.java#L39 |
Name | <EntityTag.shot_at_angle> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.shot_at_angle |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityShotAtAngle.java#L52 |
Name | <EntityTag.shulker_peek> |
Returns | ElementTag(Number) |
Mechanism | EntityTag.shulker_peek |
Description | Returns the peek value of a shulker box (where 0 is fully closed, 100 is fully open). |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityShulkerPeek.java#L62 |
Name | <EntityTag.sitting> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.sitting |
Description | If the entity is a wolf, cat, or parrot, returns whether the animal is sitting. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntitySitting.java#L61 |
Name | <EntityTag.size> |
Returns | ElementTag(Number) |
Mechanism | EntityTag.size |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntitySize.java#L60 |
Name | <EntityTag.source> |
Returns | EntityTag |
Mechanism | EntityTag.source |
Description | Returns the source of the Area Effect Cloud. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L268 |
Name | <EntityTag.strength> |
Returns | ElementTag |
Mechanism | EntityTag.strength |
Description | Returns the strength of a Llama. A llama's inventory contains (strength times three) slots.
Can be from 1 to 5 (inclusive). |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityStrength.java#L52 |
Name | <EntityTag.tameable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is tameable.
If this returns true, it will enable access to: EntityTag.tame, EntityTag.owner, EntityTag.is_tamed, and EntityTag.owner |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2398 |
Name | <EntityTag.trap_time> |
Returns | DurationTag |
Mechanism | EntityTag.trap_time |
Description | Returns the skeleton horse's trap time in ticks.
Trap time will go up every tick for as long as the horse is trapped (see EntityTag.trapped). A trapped horse will despawn after it reaches 18000 ticks (15 minutes). |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityTrapTime.java#L44 |
Name | <EntityTag.trapped> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.trapped |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityTrapped.java#L44 |
Name | <EntityTag.villager_experience> |
Returns | ElementTag(Number) |
Mechanism | EntityTag.villager_experience |
Description | Returns the experience amount of a villager. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityVillagerExperience.java#L58 |
Name | <EntityTag.villager_level> |
Returns | ElementTag(Number) |
Mechanism | EntityTag.villager_level |
Description | Returns the level of a villager. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityVillagerLevel.java#L58 |
Name | <EntityTag.wait_time> |
Returns | DurationTag |
Mechanism | EntityTag.wait_time |
Description | Returns the duration before the Area Effect Cloud starts applying potion effects. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAreaEffectCloud.java#L232 |
Name | <EntityTag.weapon_damage[(<entity>)]> |
Returns | ElementTag(Number) |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2485 |
Name | <EntityTag.age> |
Returns | ElementTag |
Mechanism | EntityTag.age |
Description | (Property) Returns 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: EntityTag.age_locked and EntityTag.is_baby |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAge.java#L17 |
Name | <EntityTag.age_locked> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.age_locked |
Description | (Property) Returns whether the entity is locked into its current age. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAgeLocked.java#L11 |
Name | <EntityTag.aggressive> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.aggressive |
Description | (Property) Returns whether the entity is currently aggressive. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAggressive.java#L11 |
Name | <EntityTag.background_color> |
Returns | ColorTag |
Mechanism | EntityTag.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 |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityBackgroundColor.java#L12 |
Name | <EntityTag.boat_type> |
Returns | ElementTag |
Mechanism | EntityTag.boat_type |
Description | (Property) Returns 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 EntityTag.color. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityBoatType.java#L15 |
Name | <EntityTag.brightness> |
Returns | MapTag |
Mechanism | EntityTag.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 |
|
Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityBrightness.java#L11 |
Name | <EntityTag.can_break_doors> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.can_break_doors |
Description | (Property) Whether a zombie can break doors. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityCanBreakDoors.java#L10 |
Name | <EntityTag.color> |
Returns | ElementTag |
Mechanism | EntityTag.color |
Description | (Property) If the entity can have a color, controls the entity's color.
For the available color options, refer to Entity Color Types. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityColor.java#L22 |
Name | <EntityTag.damage> |
Returns | ElementTag(Decimal) |
Mechanism | EntityTag.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 |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityArrowDamage.java#L10 |
Name | <EntityTag.default_background> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.default_background |
Description | (Property) Whether a text display entity's background is default (same as the chat window), or custom set (see EntityTag.background_color). |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityDefaultBackground.java#L10 |
Name | <EntityTag.display> |
Returns | ElementTag |
Mechanism | EntityTag.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 |
|
Synonyms (Search Aid) | entitytag.display_transform, entitytag.text_alignment |
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityDisplay.java#L11 |
Name | <EntityTag.drops_item> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.drops_item |
Description | (Property) Whether an eye of ender drops an item when breaking or shatters.
See EntityTag.item for controlling an eye's item. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityDropsItem.java#L10 |
Name | <EntityTag.equipment_drop_chance> |
Returns | MapTag |
Mechanism | EntityTag.equipment_drop_chance |
Description | (Property) Returns the chance of each piece of equipment dropping when the entity dies.
A drop chance of 0 will prevent the item from dropping, a drop chance of 1 will always drop the item if killed by a player, and a drop chance of higher than 1 will always drop the item no matter what the entity was killed by. A map of equipment slots to drop chances, with keys "head", "chest", "legs", "feet", "hand", and "off_hand". |
Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityEquipmentDropChance.java#L12 |
Name | <EntityTag.explored_locations> |
Returns | ListTag(LocationTag) |
Mechanism | EntityTag.explored_locations |
Description | (Property) Returns a sniffer's explored locations. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityExploredLocations.java#L11 |
Name | <EntityTag.glow_color> |
Returns | ColorTag |
Mechanism | EntityTag.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 |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityGlowColor.java#L12 |
Name | <EntityTag.has_ai> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.has_ai |
Description | (Property) Returns 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 |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAI.java#L9 |
Name | <EntityTag.height> |
Returns | ElementTag(Decimal) |
Mechanism | EntityTag.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 |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityHeight.java#L11 |
Name | <EntityTag.interpolation_duration> |
Returns | DurationTag |
Mechanism | EntityTag.interpolation_duration |
Description | (Property) The duration a display entity will spend interpolating between interpolated value(s).
See also Display entity interpolation. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityInterpolationDuration.java#L10 |
Name | <EntityTag.interpolation_start> |
Returns | DurationTag |
Mechanism | EntityTag.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 Display entity interpolation. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityInterpolationStart.java#L19 |
Name | <EntityTag.is_aware> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.is_aware |
Description | (Property) For mobs (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 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 |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityAware.java#L13 |
Name | <EntityTag.item> |
Returns | ItemTag |
Mechanism | EntityTag.item |
Description | (Property) An entity's item, which can be:
- the item represented and displayed by a dropped item. - the item represented by a thrown trident. - a throwable projectile's display item. - an eye-of-ender's item, which is both displayed and dropped. - a fireball's display item. - an item display's display item. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityItem.java#L21 |
Name | <EntityTag.left_rotation> |
Returns | QuaternionTag |
Mechanism | EntityTag.left_rotation |
Description | (Property) A display entity's "left" rotation.
Note that EntityTag.right_rotation is also available, but should normally use this instead. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityLeftRotation.java#L12 |
Name | <EntityTag.line_width> |
Returns | ElementTag(Number) |
Mechanism | EntityTag.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 |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityLineWidth.java#L10 |
Name | <EntityTag.material> |
Returns | MaterialTag |
Mechanism | EntityTag.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 |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityMaterial.java#L16 |
Name | <EntityTag.opacity> |
Returns | ElementTag(Number) |
Mechanism | EntityTag.opacity |
Description | (Property) A text display entity's text opacity, from 0 to 255.
Can be interpolated, see 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 |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityOpacity.java#L10 |
Name | <EntityTag.pierce_level> |
Returns | ElementTag(Number) |
Mechanism | EntityTag.pierce_level |
Description | (Property) The number of entities an arrow will pierce through while flying. Must be between 0 and 127. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityArrowPierceLevel.java#L10 |
Name | <EntityTag.pivot> |
Returns | ElementTag |
Mechanism | EntityTag.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 |
|
Synonyms (Search Aid) | entitytag.billboard |
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityPivot.java#L10 |
Name | <EntityTag.right_rotation> |
Returns | QuaternionTag |
Mechanism | EntityTag.right_rotation |
Description | (Property) A display entity's "right" rotation.
Should usually use EntityTag.left_rotation instead. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityRightRotation.java#L12 |
Name | <EntityTag.scale> |
Returns | LocationTag |
Mechanism | EntityTag.scale |
Description | (Property) A display entity's scale, represented as a LocationTag vector.
Can be interpolated, see Display entity interpolation. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityScale.java#L12 |
Name | <EntityTag.see_through> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.see_through |
Description | (Property) Whether a text display entity can be seen through blocks. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntitySeeThrough.java#L10 |
Name | <EntityTag.shadow_radius> |
Returns | ElementTag(Decimal) |
Mechanism | EntityTag.shadow_radius |
Description | (Property) The radius of a display entity's shadow.
Can be interpolated, see Display entity interpolation. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityShadowRadius.java#L10 |
Name | <EntityTag.shadow_strength> |
Returns | ElementTag(Decimal) |
Mechanism | EntityTag.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 Display entity interpolation. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityShadowStrength.java#L10 |
Name | <EntityTag.spell> |
Returns | ElementTag |
Mechanism | EntityTag.spell |
Description | (Property) Returns 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 |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntitySpell.java#L11 |
Name | <EntityTag.step_height> |
Returns | ElementTag(Decimal) |
Mechanism | EntityTag.step_height |
Description | (Property) Deprecated in favor of the step height attribute on MC 1.20+, see Attribute Modifiers. |
Generated Example |
|
Group | Properties |
Deprecated | Use the step height attribute on MC 1.20+. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityStepHeight.java#L14 |
Name | <EntityTag.teleport_duration> |
Returns | DurationTag |
Mechanism | EntityTag.teleport_duration |
Description | (Property) The duration a display entity will spend teleporting between positions.
See also Display entity interpolation. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityTeleportDuration.java#L10 |
Name | <EntityTag.text> |
Returns | ElementTag |
Mechanism | EntityTag.text |
Description | (Property) A text display entity's text, supports new lines. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityText.java#L11 |
Name | <EntityTag.text_shadowed> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.text_shadowed |
Description | (Property) Whether a text display entity's text has a shadow. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityTextShadowed.java#L10 |
Name | <EntityTag.translation> |
Returns | LocationTag |
Mechanism | EntityTag.translation |
Description | (Property) A display entity's translation, represented as a LocationTag vector.
Can be interpolated, see Display entity interpolation. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityTranslation.java#L12 |
Name | <EntityTag.view_range> |
Returns | ElementTag(Decimal) |
Mechanism | EntityTag.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 |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityViewRange.java#L10 |
Name | <EntityTag.visual_fire> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.visual_fire |
Description | (Property) Whether an entity has a fake fire effect. For actual fire, see burn and EntityTag.on_fire. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityVisualFire.java#L9 |
Name | <EntityTag.width> |
Returns | ElementTag(Decimal) |
Mechanism | EntityTag.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 |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityWidth.java#L11 |
Name | <EntityTag.crackshot_weapon> |
Returns | ElementTag |
Description | Returns the CrackShot weapon name that the projectile was shot from. |
Generated Example |
|
Requires | Depenizen, CrackShot |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/crackshot/CrackShotEntityProperties.java#L58 |
Name | <EntityTag.is_mythicmob> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is a MythicMob. |
Generated Example |
|
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mythicmobs/MythicMobsEntityProperties.java#L53 |
Name | <EntityTag.is_shopkeeper> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is a Shopkeeper. |
Generated Example |
|
Requires | Depenizen, ShopKeepers |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/shopkeepers/ShopKeepersEntityExtensions.java#L11 |
Name | <EntityTag.libsdisguise_disguise> |
Returns | LibsDisguiseTag |
Description | Returns the disguise of the entity. |
Generated Example |
|
Requires | Depenizen, LibsDisguises |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/libsdisguise/LibsDisguiseEntityProperties.java#L71 |
Name | <EntityTag.libsdisguise_is_disguised> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is in a disguise. |
Generated Example |
|
Requires | Depenizen, LibsDisguises |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/libsdisguise/LibsDisguiseEntityProperties.java#L60 |
Name | <EntityTag.mcmmo.is_spawned_mob> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is tracked by McMMO as a 'spawned' mob (one from a spawner block or spawn egg). |
Requires | Depenizen, mcMMO |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mcmmo/McMMOEntityProperties.java#L62 |
Name | <EntityTag.mythicmob> |
Returns | MythicMobsMobTag |
Description | Returns the MythicMob for this entity. |
Generated Example |
|
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mythicmobs/MythicMobsEntityProperties.java#L64 |
Name | <EntityTag.shopkeeper> |
Returns | ShopKeeperTag |
Description | Returns the ShopKeeper for this entity, if it is one (see also EntityTag.is_shopkeeper). |
Generated Example |
|
Requires | Depenizen, ShopKeepers |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/shopkeepers/ShopKeepersEntityExtensions.java#L22 |
Name | <EntityTag.collides_at[<location>]> |
Returns | ElementTag(Boolean) |
Description | Returns 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 |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperEntityExtensions.java#L144 |
Name | <EntityTag.from_spawner> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity was spawned from a spawner. |
Generated Example |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperEntityExtensions.java#L115 |
Name | <EntityTag.spawn_location> |
Returns | LocationTag |
Description | Returns the initial spawn location of this entity. |
Generated Example |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperEntityExtensions.java#L102 |
Name | <EntityTag.spawn_reason> |
Returns | ElementTag |
Description | Returns 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 |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperEntityExtensions.java#L22 |
Name | <EntityTag.xp_source> |
Returns | EntityTag |
Description | If 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 |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperEntityExtensions.java#L77 |
Name | <EntityTag.xp_spawn_reason> |
Returns | ElementTag |
Description | If 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 |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperEntityExtensions.java#L35 |
Name | <EntityTag.xp_trigger> |
Returns | EntityTag |
Description | If 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 |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperEntityExtensions.java#L52 |
Name | <EntityTag.arms_raised> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.arms_raised |
Description | Deprecated in favor of EntityTag.aggressive. |
Generated Example |
|
Group | properties |
Requires | Paper |
Deprecated | use 'aggressive' |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityArmsRaised.java#L46 |
Name | <EntityTag.auto_expire> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.auto_expire |
Description | Returns whether a falling_block will auto-expire (after 30 seconds, or 5 when outside the world).
See also EntityTag.time_lived |
Generated Example |
|
Group | properties |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityAutoExpire.java#L39 |
Name | <EntityTag.can_tick> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.can_tick |
Description | If the entity is an armor stand, returns whether the armor stand can tick. |
Generated Example |
|
Group | properties |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityCanTick.java#L47 |
Name | <EntityTag.carrying_egg> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.carrying_egg |
Description | If 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 |
|
Group | properties |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityCarryingEgg.java#L39 |
Name | <EntityTag.drinking_potion> |
Returns | ItemTag |
Mechanism | EntityTag.drinking_potion |
Description | Returns the potion item a witch is drinking, or air if none. |
Generated Example |
|
Group | properties |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityDrinkingPotion.java#L41 |
Name | <EntityTag.has_friction> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.has_friction |
Description | Returns an entity's friction state if one has been set. |
Generated Example |
|
Group | properties |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityFriction.java#L50 |
Name | <EntityTag.invulnerable_duration> |
Returns | DurationTag |
Mechanism | EntityTag.invulnerable_duration |
Description | Returns the duration remaining until the wither becomes vulnerable. |
Generated Example |
|
Group | properties |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityWitherInvulnerable.java#L39 |
Name | <EntityTag.potion_drink_duration> |
Returns | DurationTag |
Mechanism | EntityTag.potion_drink_duration |
Description | Returns the duration remaining until a witch is done drinking a potion. |
Generated Example |
|
Group | properties |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityDrinkingPotion.java#L54 |
Name | <EntityTag.reputation> |
Returns | MapTag |
Mechanism | EntityTag.reputation |
Description | Returns 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 |
|
Group | properties |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityReputation.java#L51 |
Name | <EntityTag.egg_lay_time> |
Returns | DurationTag |
Mechanism | EntityTag.egg_lay_time |
Description | (Property) If the entity is a chicken, controls the duration of time until it next lays an egg. |
Generated Example |
|
Group | Properties |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityEggLayTime.java#L11 |
Name | <EntityTag.is_sneaking> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.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 sneak is also available. |
Generated Example |
|
Group | Properties |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntitySneaking.java#L12 |
Name | <EntityTag.left_handed> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.left_handed |
Description | (Property) Whether a mob is left-handed. Mobs have a rare chance of spawning left-handed. |
Generated Example |
|
Group | Properties |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityLeftHanded.java#L11 |
Name | <EntityTag.should_burn> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.should_burn |
Description | (Property) If the entity is a Zombie, Skeleton, or Phantom, controls whether it should burn in daylight. |
Generated Example |
|
Group | Properties |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityShouldBurn.java#L13 |
Name | <FlaggableObject.flag[<flag_name>]> |
Returns | ObjectTag |
Description | Returns the specified flag from the flaggable object.
If the flag is expired, will return null. Consider also using FlaggableObject.has_flag. See flag system. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L37 |
Name | <FlaggableObject.flag_expiration[<flag_name>]> |
Returns | TimeTag |
Description | Returns a TimeTag indicating when the specified flag will expire.
See flag system. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L71 |
Name | <FlaggableObject.flag_map[<name>|...]> |
Returns | MapTag |
Description | Returns 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 flag system. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L104 |
Name | <FlaggableObject.has_flag[<flag_name>]> |
Returns | ElementTag(Boolean) |
Description | Returns true if the flaggable object has the specified flag, otherwise returns false.
See flag system. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L55 |
Name | <FlaggableObject.list_flags> |
Returns | ListTag |
Description | Returns 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 flag system. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L87 |
Name | <ImageTag.copy> |
Returns | ImageTag |
Description | Returns a copy of the image, useful for getting normal images from id-based ones (see Image). |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ImageTag.java#L204 |
Name | <ImageTag.height> |
Returns | ElementTag(Number) |
Mechanism | ImageTag.scale |
Description | Returns the image's height (in pixels). |
Example |
|
Source | https://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>]> |
Returns | ColorTag |
Description | Returns the color of a specific pixel in an image.
"x" and "y" are the position of the pixel, see Image positions. |
Example |
|
Source | https://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>]> |
Returns | ImageTag |
Description | Returns a part of the image.
"x" and "y" are the position of the upper left corner of the image part, see Image positions. "width" and "height" are the size of the image part. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ImageTag.java#L219 |
Name | <ImageTag.to_binary[<image_format>]> |
Returns | BinaryTag |
Description | Returns a BinaryTag of the image's raw binary data, in the specified image format. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ImageTag.java#L186 |
Name | <ImageTag.width> |
Returns | ElementTag(Number) |
Mechanism | ImageTag.scale |
Description | Returns the image's width (in pixels). |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ImageTag.java#L158 |
Name | <InventoryTag.anvil_max_repair_cost> |
Returns | ElementTag(Number) |
Mechanism | InventoryTag.anvil_max_repair_cost |
Description | Returns the maximum repair cost on an anvil. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2286 |
Name | <InventoryTag.anvil_rename_text> |
Returns | ElementTag |
Description | Returns the current entered renaming text on an anvil. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2300 |
Name | <InventoryTag.anvil_repair_cost> |
Returns | ElementTag(Number) |
Mechanism | InventoryTag.anvil_repair_cost |
Description | Returns the current repair cost on an anvil. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2272 |
Name | <InventoryTag.can_fit[<item>|...]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory can fit an item. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1213 |
Name | <InventoryTag.can_fit[<item>].count> |
Returns | ElementTag(Number) |
Description | Returns the total count of how many times an item can fit into an inventory. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1239 |
Name | <InventoryTag.can_fit[<item>].quantity[<#>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory can fit a certain quantity of an item. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1258 |
Name | <InventoryTag.contains_item[<matcher>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory contains any item that matches the specified item matcher.
Uses the system behind Advanced Object Matching. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1451 |
Name | <InventoryTag.contains_item[<matcher>].quantity[<#>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory contains a certain number of items that match the specified item matcher.
Uses the system behind Advanced Object Matching. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1465 |
Name | <InventoryTag.contains.display[(strict:)<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1491 |
Name | <InventoryTag.contains.display[(strict:)<element>].quantity[<#>]> |
Returns | ElementTag(Boolean) |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1514 |
Name | <InventoryTag.contains.lore[(strict:)<element>|...]> |
Returns | ElementTag(Boolean) |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1573 |
Name | <InventoryTag.contains.lore[(strict:)<element>|...].quantity[<#>]> |
Returns | ElementTag(Boolean) |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1597 |
Name | <InventoryTag.craftable_quantity> |
Returns | ElementTag(Number) |
Description | Returns the quantity of items that would be received if this crafting inventory were fully crafted (eg via a shift click). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2228 |
Name | <InventoryTag.empty_slots> |
Returns | ElementTag(Number) |
Description | Returns the number of empty slots in an inventory. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1190 |
Name | <InventoryTag.equipment> |
Returns | ListTag(ItemTag) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2169 |
Name | <InventoryTag.equipment_map> |
Returns | MapTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2156 |
Name | <InventoryTag.exclude_item[<item_matcher>]> |
Returns | InventoryTag |
Description | Returns a copy of the InventoryTag with all matching items excluded. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1329 |
Name | <InventoryTag.exclude_item[<item_matcher>].quantity[<#>]> |
Returns | InventoryTag |
Description | Returns the InventoryTag with a certain quantity of matching items excluded. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1352 |
Name | <InventoryTag.find_all_items[<matcher>]> |
Returns | ListTag |
Description | Returns 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 Advanced Object Matching. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1885 |
Name | <InventoryTag.find_empty_slots> |
Returns | ListTag |
Description | Returns the index of all the empty slots in an inventory. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2364 |
Name | <InventoryTag.find_item[<matcher>]> |
Returns | ElementTag(Number) |
Description | Returns 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 Advanced Object Matching. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1861 |
Name | <InventoryTag.first_empty> |
Returns | ElementTag(Number) |
Description | Returns the location of the first empty slot.
Returns -1 if the inventory is full. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1849 |
Name | <InventoryTag.fuel> |
Returns | ItemTag |
Mechanism | InventoryTag.fuel |
Description | Returns the item currently in the fuel section of a furnace or brewing stand inventory. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2313 |
Name | <InventoryTag.id_type> |
Returns | ElementTag |
Description | Returns Denizen's type ID for this inventory (player, location, etc.). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1989 |
Name | <InventoryTag.include[<item>|...]> |
Returns | InventoryTag |
Description | Returns a copy of the InventoryTag with items added. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1285 |
Name | <InventoryTag.include[<item>].quantity[<#>]> |
Returns | InventoryTag |
Description | Returns the InventoryTag with a certain quantity of an item added. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1307 |
Name | <InventoryTag.input> |
Returns | ItemTag |
Mechanism | InventoryTag.input |
Description | Returns the item currently in the smelting slot of a furnace inventory, or the ingredient slot of a brewing stand inventory. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2330 |
Name | <InventoryTag.inventory_type> |
Returns | ElementTag |
Description | Returns the type of the inventory (e.g. "PLAYER", "CRAFTING", "HORSE"). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2146 |
Name | <InventoryTag.is_empty> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory is empty. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1414 |
Name | <InventoryTag.is_full> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory is completely full. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1431 |
Name | <InventoryTag.location> |
Returns | LocationTag |
Description | Returns the location of this inventory's holder. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2013 |
Name | <InventoryTag.matrix> |
Returns | ListTag(ItemTag) |
Mechanism | InventoryTag.matrix |
Description | Returns the items currently in a crafting inventory's matrix. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2181 |
Name | <InventoryTag.note_name> |
Returns | ElementTag |
Description | Gets the name of a noted InventoryTag. If the inventory isn't noted, this is null. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L1999 |
Name | <InventoryTag.quantity_item[(<matcher>)]> |
Returns | ElementTag(Number) |
Description | Returns 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 Advanced Object Matching. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2023 |
Name | <InventoryTag.recipe> |
Returns | ElementTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2204 |
Name | <InventoryTag.result> |
Returns | ItemTag |
Mechanism | InventoryTag.result |
Description | Returns the item currently in the result section of a crafting inventory or furnace inventory. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2248 |
Name | <InventoryTag.slot[<#>|...]> |
Returns | ObjectTag |
Description | If 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. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2094 |
Name | <InventoryTag.stacks[(<item>)]> |
Returns | ElementTag(Number) |
Description | Returns the number of itemstacks that match an item if one is specified, or the number of all itemstacks if one is not. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2079 |
Name | <InventoryTag.viewers> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of players viewing the inventory. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L2348 |
Name | <InventoryTag.id_holder> |
Returns | ObjectTag |
Description | Returns Denizen's holder ID for this inventory. (player object, location object, etc.) |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventoryHolder.java#L40 |
Name | <InventoryTag.list_contents> |
Returns | ListTag(ItemTag) |
Mechanism | InventoryTag.contents |
Description | Returns a list of all items in the inventory. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventoryContents.java#L124 |
Name | <InventoryTag.list_contents.simple> |
Returns | ListTag(ItemTag) |
Mechanism | InventoryTag.contents |
Description | Returns a list of all items in the inventory, without item properties. |
Group | properties |
Source | https://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>]> |
Returns | ListTag(ItemTag) |
Mechanism | InventoryTag.contents |
Description | Returns a list of all items in the inventory with the specified
lore. Color codes are ignored. |
Group | properties |
Source | https://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> |
Returns | ListTag(ItemTag) |
Mechanism | InventoryTag.contents |
Description | Returns a list of all items in the inventory with the specified
lore, without item properties. Color codes are ignored. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventoryContents.java#L165 |
Name | <InventoryTag.map_slots> |
Returns | MapTag |
Description | Returns a map of inventory slots to the items in those slots (excludes air). |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventoryContents.java#L105 |
Name | <InventoryTag.script> |
Returns | ScriptTag |
Description | Returns the script that this inventory came from (if any). |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventoryHolder.java#L51 |
Name | <InventoryTag.size> |
Returns | ElementTag(Number) |
Mechanism | InventoryTag.size |
Description | (Property) Returns the size of the inventory.
Note that the mechanism can only be set for "generic" chest inventories. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventorySize.java#L12 |
Name | <InventoryTag.title> |
Returns | ElementTag |
Mechanism | InventoryTag.title |
Description | (Property) Returns the title of the inventory.
Note that the mechanism can only be set for "generic" inventories. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventoryTitle.java#L14 |
Name | <InventoryTag.trades> |
Returns | ListTag(TradeTag) |
Mechanism | InventoryTag.trades |
Description | (Property) Returns the trade recipe list for a merchant inventory. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/inventory/InventoryTrades.java#L15 |
Name | <InventoryTag.is_bossshop> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory is a BossShop. |
Generated Example |
|
Requires | Depenizen, BossShopPro |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/bossshop/BossShopInventoryProperties.java#L60 |
Name | <ItemTag.has_potion_effect> |
Returns | ElementTag(Boolean) |
Mechanism | ItemTag.potion_effects |
Description | Returns whether the item (potion, tipped arrow, or suspicious stew) has a potion effect. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L269 |
Name | <ItemTag.map_to_image[<player>]> |
Returns | ImageTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L752 |
Name | <ItemTag.raw_nbt> |
Returns | MapTag |
Mechanism | ItemTag.raw_nbt |
Description | Returns a map of all non-default raw NBT on this item.
Refer to format details at Raw NBT Encoding. Deprecated in favor of ItemTag.custom_data on MC 1.20+. |
Generated Example |
|
Deprecated | use 'ItemTag.custom_data' |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemRawNBT.java#L312 |
Name | <ItemTag.recipe_ids[(<type>)]> |
Returns | ListTag |
Description | If 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L679 |
Name | <ItemTag.potion_base> |
Returns | ElementTag |
Mechanism | ItemTag.potion_effects |
Description | Deprecated in favor of ItemTag.effects_data |
Generated Example |
|
Group | attribute |
Deprecated | use 'effects_data' instead |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L304 |
Name | <ItemTag.potion_effect[<#>]> |
Returns | ElementTag |
Mechanism | ItemTag.potion_effects |
Description | Deprecated in favor of ItemTag.effects_data |
Generated Example |
|
Group | attribute |
Deprecated | use 'effects_data' instead |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L341 |
Name | <ItemTag.potion_effects> |
Returns | ListTag |
Mechanism | ItemTag.potion_effects |
Description | Deprecated in favor of ItemTag.effects_data |
Generated Example |
|
Group | attribute |
Deprecated | use 'effects_data' instead |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L324 |
Name | <ItemTag.bukkit_serial> |
Returns | ElementTag |
Description | Returns a YAML text section representing the Bukkit serialization of the item, under subkey "item". |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L655 |
Name | <ItemTag.json> |
Returns | ElementTag |
Description | Returns the item converted to a raw JSON object with one layer of escaping for network transmission.
EG, via /tellraw. Generally, prefer tags like ElementTag.on_hover.type with type 'show_item'. |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L630 |
Name | <ItemTag.material> |
Returns | MaterialTag |
Mechanism | ItemTag.material |
Description | Returns 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 |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L589 |
Name | <ItemTag.meta_type> |
Returns | ElementTag |
Description | Returns the name of the Bukkit item meta type that applies to this item.
This is for debugging purposes. |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L643 |
Name | <ItemTag.placed_material> |
Returns | MaterialTag |
Description | Returns 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 |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L613 |
Name | <ItemTag.simple> |
Returns | ElementTag |
Description | Returns a simple reusable item identification for this item, with minimal extra data. |
Generated Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L668 |
Name | <ItemTag.scriptname> |
Returns | ElementTag |
Description | Use ".script.name" instead.
This deprecated tag may be useful for debugging items when item scripts may have been deleted. |
Generated Example |
|
Group | data |
Deprecated | use ".script.name" instead. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemScript.java#L57 |
Name | <ItemTag.formatted> |
Returns | ElementTag |
Description | Returns 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 |
|
Group | formatting |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L723 |
Name | <ItemTag.all_raw_nbt> |
Returns | MapTag |
Mechanism | ItemTag.raw_nbt |
Description | Returns a map of all raw NBT on this item, including default values.
Refer to format details at Raw NBT Encoding. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemRawNBT.java#L348 |
Name | <ItemTag.block_material> |
Returns | MaterialTag |
Mechanism | ItemTag.block_material |
Description | Returns the material for an item with complex-block-data attached. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemBlockMaterial.java#L48 |
Name | <ItemTag.book_author> |
Returns | ElementTag |
Mechanism | ItemTag.book_author |
Description | Returns the author of the book. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemBook.java#L58 |
Name | <ItemTag.book_generation> |
Returns | ListTag |
Mechanism | ItemTag.book_generation |
Description | Returns the generation of the book (if any), as ORIGINAL, COPY_OF_ORIGINAL, COPY_OF_COPY, or TATTERED. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemBookGeneration.java#L48 |
Name | <ItemTag.book_map> |
Returns | MapTag |
Mechanism | ItemTag.book |
Description | Returns a MapTag of data about the book, with keys "pages" (a ListTag), and when available, "author" and "title". |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemBook.java#L101 |
Name | <ItemTag.book_pages> |
Returns | ListTag |
Mechanism | ItemTag.book_pages |
Description | Returns the plain-text pages of the book as a ListTag. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemBook.java#L84 |
Name | <ItemTag.book_title> |
Returns | ElementTag |
Mechanism | ItemTag.book_title |
Description | Returns the title of the book. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemBook.java#L71 |
Name | <ItemTag.can_destroy> |
Returns | ListTag(MaterialTag) |
Mechanism | ItemTag.can_destroy |
Description | Returns a list of materials this item can destroy while in adventure mode, if any. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemCanDestroy.java#L66 |
Name | <ItemTag.can_place_on> |
Returns | ListTag(MaterialTag) |
Mechanism | ItemTag.can_place_on |
Description | Returns a list of materials this item can be placed on while in adventure mode, if any. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemCanPlaceOn.java#L66 |
Name | <ItemTag.charged_projectiles> |
Returns | ListTag(ItemTag) |
Mechanism | ItemTag.charged_projectiles |
Description | Returns a list of charged projectile items on this crossbow. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemChargedProjectile.java#L50 |
Name | <ItemTag.custom_model_data> |
Returns | ElementTag(Number) |
Mechanism | ItemTag.custom_model_data |
Description | Returns 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 ItemTag.has_custom_model_data. |
Generated Example |
|
Group | properties |
Source | https://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>]> |
Returns | MapTag |
Description | Returns 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 ItemTag.attribute_modifiers Slot must be one of: HAND, OFF_HAND, FEET, LEGS, CHEST, or HEAD |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemAttributeModifiers.java#L101 |
Name | <ItemTag.display> |
Returns | ElementTag |
Mechanism | ItemTag.display |
Description | Returns the display name of the item, as set by plugin or an anvil. |
Generated Example |
|
Synonyms (Search Aid) | itemtag.display_name |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemDisplayname.java#L57 |
Name | <ItemTag.durability> |
Returns | ElementTag(Number) |
Mechanism | ItemTag.durability |
Description | Returns the current durability (number of uses) on the item. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemDurability.java#L48 |
Name | <ItemTag.effects_data> |
Returns | ListTag(MapTag) |
Mechanism | ItemTag.potion_effects |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L218 |
Name | <ItemTag.enchantment_map> |
Returns | MapTag |
Mechanism | ItemTag.enchantments |
Description | Returns a map of enchantments on the item.
Map keys are enchantment names (like "sharpness"), and values are the level (as a number). |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemEnchantments.java#L142 |
Name | <ItemTag.enchantment_types> |
Returns | ListTag(EnchantmentTag) |
Mechanism | ItemTag.enchantments |
Description | Returns a list of the types of enchantments on the item. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemEnchantments.java#L106 |
Name | <ItemTag.enchantments> |
Returns | ListTag |
Mechanism | ItemTag.enchantments |
Description | Deprecated in favor of ItemTag.enchantment_types or ItemTag.enchantment_map |
Generated Example |
|
Group | properties |
Deprecated | Use 'enchantment_types' or 'enchantment_map' |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemEnchantments.java#L123 |
Name | <ItemTag.firework> |
Returns | ListTag |
Mechanism | ItemTag.firework |
Description | Returns the firework's property value as a list, matching the non-MapTag format of the mechanism.
Consider instead using ItemTag.firework_data |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemFirework.java#L120 |
Name | <ItemTag.firework_data> |
Returns | ListTag |
Mechanism | ItemTag.firework |
Description | Returns the firework's property value as a ListTag of MapTags, matching the MapTag format of the mechanism. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemFirework.java#L133 |
Name | <ItemTag.firework_power> |
Returns | ElementTag(Number) |
Mechanism | ItemTag.firework_power |
Description | Returns 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 |
|
Group | properties |
Source | https://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> |
Returns | ElementTag(Boolean) |
Mechanism | ItemTag.custom_model_data |
Description | Returns whether the item has a custom model data ID number set on it.
Also see ItemTag.custom_model_data. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemCustomModel.java#L47 |
Name | <ItemTag.has_display> |
Returns | ElementTag(Boolean) |
Mechanism | ItemTag.display |
Description | Returns whether the item has a custom set display name. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemDisplayname.java#L73 |
Name | <ItemTag.has_inventory> |
Returns | ElementTag(Boolean) |
Description | Returns whether the item has an inventory.
If this returns true, it will enable access to: ItemTag.inventory_contents, and ItemTag.inventory_contents. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L563 |
Name | <ItemTag.has_lore> |
Returns | ElementTag(Boolean) |
Mechanism | ItemTag.lore |
Description | Returns whether the item has lore set on it. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemLore.java#L71 |
Name | <ItemTag.has_skin> |
Returns | ElementTag(Boolean) |
Mechanism | ItemTag.skull_skin |
Description | Returns whether the item has a custom skin set.
(Only for 'player_head's) |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSkullskin.java#L102 |
Name | <ItemTag.hides> |
Returns | ListTag |
Mechanism | ItemTag.hides |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemHidden.java#L79 |
Name | <ItemTag.invisible> |
Returns | ElementTag(Boolean) |
Mechanism | ItemTag.invisible |
Description | Returns whether an Item_Frame item will be invisible when placed. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemFrameInvisible.java#L59 |
Name | <ItemTag.is_book> |
Returns | ElementTag(Boolean) |
Description | Returns whether the item is considered an editable book.
If this returns true, it will enable access to: ItemTag.book, ItemTag.book_author, ItemTag.book_title, and ItemTag.book_pages. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L519 |
Name | <ItemTag.is_charged> |
Returns | ElementTag(Boolean) |
Mechanism | ItemTag.charged_projectiles |
Description | Returns whether this crossbow is charged. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemChargedProjectile.java#L63 |
Name | <ItemTag.is_colorable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the item can have a custom color.
If this returns true, it will enable access to: ItemTag.color, and ItemTag.color. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L533 |
Name | <ItemTag.is_enchanted> |
Returns | ElementTag(Boolean) |
Mechanism | ItemTag.enchantments |
Description | Returns whether the item has any enchantments. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemEnchantments.java#L59 |
Name | <ItemTag.is_firework> |
Returns | ElementTag(Boolean) |
Description | Returns whether the item is a firework.
If this returns true, it will enable access to: ItemTag.firework, and ItemTag.firework. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L550 |
Name | <ItemTag.is_lockable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the item is lockable.
If this returns true, it will enable access to: ItemTag.lock, and ItemTag.lock. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L576 |
Name | <ItemTag.is_locked> |
Returns | ElementTag(Boolean) |
Mechanism | ItemTag.lock |
Description | Returns whether this item has a lock password. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemLock.java#L74 |
Name | <ItemTag.knowledge_book_recipes> |
Returns | ListTag |
Mechanism | ItemTag.knowledge_book_recipes |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemKnowledgeBookRecipes.java#L63 |
Name | <ItemTag.lock> |
Returns | ElementTag |
Mechanism | ItemTag.lock |
Description | Returns the lock password of this item. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemLock.java#L59 |
Name | <ItemTag.lodestone_location> |
Returns | LocationTag |
Mechanism | ItemTag.lodestone_location |
Description | Returns the lodestone location this compass is pointing at (if any).
See also ItemTag.lodestone_tracked |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemLodestoneLocation.java#L50 |
Name | <ItemTag.lodestone_tracked> |
Returns | ElementTag(Boolean) |
Mechanism | ItemTag.lodestone_tracked |
Description | Returns 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 ItemTag.lodestone_location |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemLodestoneTracked.java#L49 |
Name | <ItemTag.lore> |
Returns | ListTag |
Mechanism | ItemTag.lore |
Description | Returns lore as a ListTag. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemLore.java#L57 |
Name | <ItemTag.map> |
Returns | ElementTag(Number) |
Mechanism | ItemTag.map |
Description | Returns the ID number of the map item's map. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemMap.java#L46 |
Name | <ItemTag.map_center> |
Returns | LocationTag |
Mechanism | ItemTag.map_center |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemMap.java#L99 |
Name | <ItemTag.map_locked> |
Returns | ElementTag(Boolean) |
Mechanism | ItemTag.map_locked |
Description | Returns whether maps with the same ID as this map are locked. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemMap.java#L80 |
Name | <ItemTag.map_scale> |
Returns | ElementTag(Number) |
Mechanism | ItemTag.map |
Description | Returns the scale of the map, from 0 (smallest) to 4 (largest). |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemMap.java#L61 |
Name | <ItemTag.max_durability> |
Returns | ElementTag(Number) |
Description | Returns the maximum durability (number of uses) of this item.
For use with ItemTag.durability and ItemTag.durability. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemDurability.java#L61 |
Name | <ItemTag.max_stack> |
Returns | ElementTag(Number) |
Description | Returns the max number of this item possible in a single stack of this type.
For use with ItemTag.quantity and ItemTag.quantity. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemQuantity.java#L66 |
Name | <ItemTag.patterns> |
Returns | ListTag |
Mechanism | ItemTag.patterns |
Description | Lists 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPatterns.java#L112 |
Name | <ItemTag.potion_base_type> |
Returns | ElementTag |
Mechanism | ItemTag.potion_effects |
Description | Deprecated in favor of ItemTag.effects_data |
Generated Example |
|
Group | properties |
Deprecated | use 'effects_data.first.get[base_type]' instead |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemPotion.java#L286 |
Name | <ItemTag.quantity> |
Returns | ElementTag(Number) |
Mechanism | ItemTag.quantity |
Description | Returns the number of items in the ItemTag's itemstack. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemQuantity.java#L48 |
Name | <ItemTag.repair_cost> |
Returns | ElementTag(Number) |
Mechanism | ItemTag.repair_cost |
Description | Returns the current repair cost (on an anvil) for this item.
Note that zero indicates no repair cost. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemRepairCost.java#L49 |
Name | <ItemTag.repairable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the item can be repaired.
If this returns true, it will enable access to: ItemTag.durability, ItemTag.max_durability, and 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ItemTag.java#L504 |
Name | <ItemTag.sign_contents> |
Returns | ListTag |
Mechanism | ItemTag.sign_contents |
Description | Returns a list of lines on a sign item. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSignContents.java#L59 |
Name | <ItemTag.skin> |
Returns | ElementTag |
Mechanism | ItemTag.skull_skin |
Description | Returns 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 Player Entity Skins (Skin Blobs). |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSkullskin.java#L75 |
Name | <ItemTag.skull_skin> |
Returns | ElementTag |
Mechanism | ItemTag.skull_skin |
Description | Returns 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 Player Entity Skins (Skin Blobs). |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSkullskin.java#L56 |
Name | <ItemTag.spawner_count> |
Returns | ElementTag(Number) |
Mechanism | ItemTag.spawner_count |
Description | Returns the spawn count for a spawner block item. |
Generated Example |
|
Group | properties |
Source | https://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> |
Returns | ElementTag(Number) |
Mechanism | ItemTag.spawner_max_nearby_entities |
Description | Returns the maximum nearby entities for a spawner block item. |
Generated Example |
|
Group | properties |
Source | https://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> |
Returns | ElementTag(Number) |
Mechanism | ItemTag.spawner_delay_data |
Description | Returns the maximum spawn delay for a spawner block item. |
Generated Example |
|
Group | properties |
Source | https://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> |
Returns | ElementTag(Number) |
Mechanism | ItemTag.spawner_delay_data |
Description | Returns the minimum spawn delay for a spawner block item. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSpawnerDelay.java#L67 |
Name | <ItemTag.spawner_player_range> |
Returns | ElementTag(Number) |
Mechanism | ItemTag.spawner_player_range |
Description | Returns the maximum player range for a spawner block item (ie how close a player must be for this spawner to be active). |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSpawnerPlayerRange.java#L50 |
Name | <ItemTag.spawner_range> |
Returns | ElementTag(Number) |
Mechanism | ItemTag.spawner_range |
Description | Returns the spawn range for a spawner block item (the radius mobs will spawn in). |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSpawnerRange.java#L50 |
Name | <ItemTag.spawner_spawn_delay> |
Returns | ElementTag(Number) |
Mechanism | ItemTag.spawner_delay_data |
Description | Returns the current spawn delay for a spawner block item.
This changes over time between ItemTag.spawner_minimum_spawn_delay and ItemTag.spawner_maximum_spawn_delay. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSpawnerDelay.java#L51 |
Name | <ItemTag.unbreakable> |
Returns | ElementTag(Boolean) |
Mechanism | ItemTag.unbreakable |
Description | Returns whether an item has the unbreakable flag. |
Generated Example |
|
Group | properties |
Source | https://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>]> |
Returns | ItemTag |
Mechanism | ItemTag.flag |
Description | Returns 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]>]> |
Group | properties |
Source | https://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>]> |
Returns | ItemTag |
Mechanism | ItemTag.flag |
Description | Returns 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]> |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemFlags.java#L68 |
Name | <ItemTag.armor_pose> |
Returns | MapTag |
Mechanism | ItemTag.armor_pose |
Description | (Property) Returns the pose of this armor stand item.
Allowed keys: head, body, left_arm, right_arm, left_leg, right_leg |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemArmorPose.java#L20 |
Name | <ItemTag.attribute_modifiers> |
Returns | MapTag |
Mechanism | ItemTag.attribute_modifiers |
Description | (Property) Returns 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 attribute modifiers. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemAttributeModifiers.java#L30 |
Name | <ItemTag.base_color> |
Returns | ElementTag |
Mechanism | ItemTag.base_color |
Description | (Property) Returns 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 |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemBaseColor.java#L12 |
Name | <ItemTag.color> |
Returns | ColorTag |
Mechanism | ItemTag.color |
Description | (Property) Returns the color of a leather armor, potion, filled map, or tipped arrow item.
For potions, will return a white ColorTag if the given item doesn't have a color. For maps, will return null if the given item doesn't have a color. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemColor.java#L15 |
Name | <ItemTag.custom_data> |
Returns | MapTag |
Mechanism | ItemTag.custom_data |
Description | (Property) Returns an item's custom NBT data, if any.
The map is in NBT format, see Raw NBT Encoding. This does not include any normal vanilla data (enchantments, lore, etc.), just extra custom data. This is useful for integrating with items from external systems (such as custom items from plugins), but item flags should be preferred otherwise. |
Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemCustomData.java#L14 |
Name | <ItemTag.instrument> |
Returns | ElementTag |
Mechanism | ItemTag.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 |
|
Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemInstrument.java#L12 |
Name | <ItemTag.inventory_contents> |
Returns | ListTag(ItemTag) |
Mechanism | ItemTag.inventory_contents |
Description | (Property) A container item's inventory contents. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemInventoryContents.java#L28 |
Name | <ItemTag.is_waxed> |
Returns | ElementTag(Boolean) |
Mechanism | ItemTag.is_waxed |
Description | (Property) Returns whether a sign item is waxed (cannot be edited once placed). |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSignIsWaxed.java#L13 |
Name | <ItemTag.spawner_type> |
Returns | EntityTag |
Mechanism | ItemTag.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 |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemSpawnerType.java#L14 |
Name | <ItemTag.trim> |
Returns | MapTag |
Mechanism | ItemTag.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 |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemTrim.java#L16 |
Name | <ItemTag.script> |
Returns | ScriptTag |
Description | Returns the script of the item if it was created by an item script. |
Generated Example |
|
Group | scripts |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemScript.java#L74 |
Name | <ItemTag.full_components_patch> |
Returns | MapTag |
Description | Returns the item's entire internal component patch (see ItemTag.components_patch). |
Generated Example |
|
Warning(s) | Due to this being a direct representation of internal data, compatibility for script usage across versions is not guaranteed. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemComponentsPatch.java#L107 |
Name | <ItemTag.components_patch> |
Returns | MapTag |
Mechanism | ItemTag.components_patch |
Description | (Property) Returns the item's internal component patch. That is, the changes in components on top of the item type's default components.
The map is in Raw NBT Encoding format. This is mainly intended for item data persistence, and scripts should prefer using proper item properties instead of setting raw data directly. If you're trying to control custom data (such as data set by other plugins), use ItemTag.custom_data. Note that this is just data that isn't already controlled by other ItemTag properties, see ItemTag.full_components_patch for the complete component patch. |
Generated Example |
|
Group | Properties |
Warning(s) | Due to this being a direct representation of internal data, compatibility for script usage across versions is not guaranteed. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemComponentsPatch.java#L21 |
Name | <ItemTag.crackshot_weapon> |
Returns | ElementTag |
Description | Returns the CrackShot weapon name for the item. |
Generated Example |
|
Requires | Depenizen, CrackShot |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/crackshot/CrackShotItemProperties.java#L55 |
Name | <ItemTag.essentials_worth> |
Returns | ElementTag(Decimal) |
Mechanism | ItemTag.essentials_worth |
Description | Returns the amount of money one of this item is worth in Essentials. |
Generated Example |
|
Requires | Depenizen, Essentials |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsItemExtensions.java#L16 |
Name | <ItemTag.worth> |
Returns | ElementTag(Decimal) |
Mechanism | ItemTag.essentials_worth |
Description | Deprecated in favor of ItemTag.essentials_worth. |
Generated Example |
|
Requires | Depenizen, Essentials |
Deprecated | Use 'ItemTag.essentials_worth' |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsItemExtensions.java#L33 |
Name | <ItemTag.worth.quantity[<#>]> |
Returns | ElementTag(Decimal) |
Description | Deprecated in favor of ItemTag.essentials_worth. |
Requires | Depenizen, Essentials |
Deprecated | Use 'ItemTag.essentials_worth.mul[<#>]' |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsItemExtensions.java#L50 |
Name | <ItemTag.rarity> |
Returns | ElementTag |
Description | Returns the rarity of an item, as "common", "uncommon", "rare", or "epic". |
Generated Example |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperItemExtensions.java#L10 |
Name | <ItemTag.armor_stand_data> |
Returns | MapTag |
Mechanism | ItemTag.armor_stand_data |
Description | Returns a map of basic armor stand data, with keys matching EntityTag property names.
Keys: base_plate, visible, marker, is_small, arms |
Generated Example |
|
Group | properties |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/ItemArmorStand.java#L67 |
Name | <JavaReflectedObjectTag.field_class_type[<name>]> |
Returns | ElementTag |
Description | Returns the full class name of the field of the given name on this object. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L370 |
Name | <JavaReflectedObjectTag.field_is_final[<name>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the field for the given name on this object is a final field. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L353 |
Name | <JavaReflectedObjectTag.field_is_private[<name>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the field for the given name on this object is a private field. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L302 |
Name | <JavaReflectedObjectTag.field_is_protected[<name>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the field for the given name on this object is a protected field. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L319 |
Name | <JavaReflectedObjectTag.field_is_public[<name>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the field for the given name on this object is a public field. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L285 |
Name | <JavaReflectedObjectTag.field_is_static[<name>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the field for the given name on this object is a static field. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L336 |
Name | <JavaReflectedObjectTag.field_names> |
Returns | ListTag |
Description | Returns a list of all field names on the object (in its current class or any super classes). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L263 |
Name | <JavaReflectedObjectTag.full_class_name> |
Returns | ElementTag |
Description | Returns the full class name of the reflected object with package info included, such as "com.denizenscript.denizencore.objects.core.JavaReflectedObjectTag" |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L183 |
Name | <JavaReflectedObjectTag.hash_code> |
Returns | ElementTag(Number) |
Description | Returns the result of the Java hashCode() call on the object. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L221 |
Name | <JavaReflectedObjectTag.interpret> |
Returns | ObjectTag |
Description | Interprets the object to Denizen object format. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L193 |
Name | <JavaReflectedObjectTag.java_equals[<reflected_object>]> |
Returns | ElementTag(Boolean) |
Description | Returns the result of the Java equals(<object>) call on the object with another JavaReflectedObjectTag. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L235 |
Name | <JavaReflectedObjectTag.memory_equals[<reflected_object>]> |
Returns | ElementTag(Boolean) |
Description | Returns the result of the Java "==" exact memory equality call on the object with another JavaReflectedObjectTag. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L249 |
Name | <JavaReflectedObjectTag.read_field[<name>]> |
Returns | ObjectTag |
Description | Reads the field of the given name on the object and returns the value in its Denizen-valid format.
See also JavaReflectedObjectTag.reflect_field |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L387 |
Name | <JavaReflectedObjectTag.reflect_field[<name>]> |
Returns | JavaReflectedObjectTag |
Description | Reads the field of the given name on the object and returns the value as another reflected tag.
See also JavaReflectedObjectTag.read_field |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L405 |
Name | <JavaReflectedObjectTag.simple_class_name> |
Returns | ElementTag |
Description | Returns the simple/short class name of the reflected object, such as "JavaReflectedObjectTag". |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L157 |
Name | <JavaReflectedObjectTag.super_classes> |
Returns | ListTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L167 |
Name | <JavaReflectedObjectTag.to_string> |
Returns | ElementTag |
Description | Returns the result of the Java toString() call on the object. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L207 |
Name | <ListTag.alphabetical> |
Returns | ListTag |
Description | Returns the list sorted to be in alphabetical order. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2144 |
Name | <ListTag.alphanumeric> |
Returns | ListTag |
Description | Returns the list sorted to be in alphabetical/numerical order. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2129 |
Name | <ListTag.any> |
Returns | ElementTag(Boolean) |
Description | Returns whether the list is not empty. |
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1058 |
Name | <ListTag.average> |
Returns | ElementTag(Decimal) |
Description | Returns the mean average of all numbers in the list. Ignores non-numerical values. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1796 |
Name | <ListTag.closest_to[<text>]> |
Returns | ElementTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2734 |
Name | <ListTag.combine> |
Returns | ListTag |
Description | Returns a list containing the contents of all sublists within this list. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L741 |
Name | <ListTag.comma_separated> |
Returns | ElementTag |
Description | Returns the list in a cleaner format, separated by commas. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L814 |
Name | <ListTag.contains[<element>|...]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the list contains all of the given elements.
See also ListTag.contains_single for safer single-value checks. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2655 |
Name | <ListTag.contains_any[<element>|...]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the list contains any of a list of given elements. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2602 |
Name | <ListTag.contains_any_case_sensitive[<element>|...]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the list contains any of a list of given elements, case-sensitive. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2582 |
Name | <ListTag.contains_case_sensitive[<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the list contains a given element, case-sensitive. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2622 |
Name | <ListTag.contains_match[<matcher>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the list contains an object that matches the specified matcher,
using the system behind Advanced Object Matching. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2675 |
Name | <ListTag.contains_single[<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the list contains the given element. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2639 |
Name | <ListTag.count[<element>]> |
Returns | ElementTag(Number) |
Description | Returns how many times a value in the list occurs. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1736 |
Name | <ListTag.count_matches[<matcher>]> |
Returns | ElementTag(Number) |
Description | Returns how many times a value in the list matches the matcher,
using the system behind Advanced Object Matching, For example: a list of "one|two|three" .count[t*] returns 2. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1756 |
Name | <ListTag.deduplicate> |
Returns | ListTag |
Description | Returns a copy of the list with any duplicate items removed. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1513 |
Name | <ListTag.exclude[...|...]> |
Returns | ListTag |
Description | Returns a new ListTag excluding the items specified. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1311 |
Name | <ListTag.exclude_single[<value>]> |
Returns | ListTag |
Description | Returns 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 |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1286 |
Name | <ListTag.exclude[...|...].max[<#>]> |
Returns | ListTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1326 |
Name | <ListTag.filter[<tag>]> |
Returns | ListTag |
Description | Returns 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 ListTag.filter_tag. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2328 |
Name | <ListTag.filter_tag[<dynamic-boolean>]> |
Returns | ListTag |
Description | Returns 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 |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2428 |
Name | <ListTag.find[<element>]> |
Returns | ElementTag(Number) |
Description | Returns the numbered index of an entry within a list,
or -1 if the list does not contain that item. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1716 |
Name | <ListTag.find_all[<element>]> |
Returns | ListTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1654 |
Name | <ListTag.find_all_matches[<matcher>]> |
Returns | ListTag |
Description | Returns all the numbered indices of elements that match within a list,
using the system behind Advanced Object Matching, or an empty list if the list does not contain that item. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1631 |
Name | <ListTag.find_all_partial[<element>]> |
Returns | ListTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1610 |
Name | <ListTag.find_match[<matcher>]> |
Returns | ElementTag(Number) |
Description | Returns the numbered index of the first match within a list,
using the system behind Advanced Object Matching, or -1 if the list does not contain that item. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1695 |
Name | <ListTag.find_partial[<element>]> |
Returns | ElementTag(Number) |
Description | Returns the numbered index of the first partially matching entry within a list,
or -1 if the list does not contain that item. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1675 |
Name | <ListTag.first[(<#>)]> |
Returns | ObjectTag |
Description | Returns 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 |
|
Example |
|
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1823 |
Name | <ListTag.formatted> |
Returns | ElementTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitListExtensions.java#L20 |
Name | <ListTag.get[<#>|...]> |
Returns | ObjectTag |
Description | Returns 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 listtag |
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1526 |
Name | <ListTag.get_sub_items[<#>]> |
Returns | ListTag |
Description | Returns a list of the specified sub items in the list, as split by the
forward-slash character (/). |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L846 |
Name | <ListTag.get_sub_items[<#>].split_by[<element>]> |
Returns | ListTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L862 |
Name | <ListTag.get[<#>].to[<#>]> |
Returns | ListTag |
Description | Returns all elements in the range from the first index to the second.
Note the index input options described at listtag |
Example |
|
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1566 |
Name | <ListTag.highest[(<tag>)]> |
Returns | ObjectTag |
Description | Returns 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 |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2005 |
Name | <ListTag.highest[(<tag>)].count[<#>]> |
Returns | ListTag |
Description | Returns 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 listtag.sort_by_number |
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2032 |
Name | <ListTag.include[...|...]> |
Returns | ListTag |
Description | Returns a new ListTag including the items specified. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1271 |
Name | <ListTag.include_single[<value>]> |
Returns | ListTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1258 |
Name | <ListTag.insert_single[...|...].at[<#>]> |
Returns | ListTag |
Description | Returns a new ListTag with the single item specified inserted to the specified location.
Note the index input options described at listtag |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1109 |
Name | <ListTag.insert[...|...].at[<#>]> |
Returns | ListTag |
Description | Returns a new ListTag with the items specified inserted to the specified location.
Note the index input options described at listtag |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1076 |
Name | <ListTag.is_empty> |
Returns | ElementTag(Boolean) |
Description | Returns whether the list is empty. |
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1040 |
Name | <ListTag.last[(<#>)]> |
Returns | ObjectTag |
Description | Returns 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 |
|
Example |
|
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1864 |
Name | <ListTag.lowest[(<tag>)]> |
Returns | ObjectTag |
Description | Returns 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 |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1904 |
Name | <ListTag.lowest[(<tag>)].count[<#>]> |
Returns | ListTag |
Description | Returns 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 listtag.sort_by_number |
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1931 |
Name | <ListTag.map_with[<value>|...]> |
Returns | MapTag |
Description | Interprets 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1004 |
Name | <ListTag.merge_maps> |
Returns | MapTag |
Description | If 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L957 |
Name | <ListTag.numerical> |
Returns | ListTag |
Description | Returns the list sorted to be in numerical order. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2103 |
Name | <ListTag.overwrite[...|...].at[<#>]> |
Returns | ListTag |
Description | Returns 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 listtag |
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1213 |
Name | <ListTag.pad_left[<#>]> |
Returns | ListTag |
Description | Returns a ListTag extended to reach a minimum specified length by adding entries to the left side. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2510 |
Name | <ListTag.pad_left[<#>].with[<element>]> |
Returns | ListTag |
Description | Returns a ListTag extended to reach a minimum specified length by adding a specific entry to the left side. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2520 |
Name | <ListTag.pad_right[<#>]> |
Returns | ListTag |
Description | Returns a ListTag extended to reach a minimum specified length by adding entries to the right side. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2537 |
Name | <ListTag.pad_right[<#>].with[<element>]> |
Returns | ListTag |
Description | Returns a ListTag extended to reach a minimum specified length by adding a specific entry to the right side. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2547 |
Name | <ListTag.parse[<tag>]> |
Returns | ListTag |
Description | Returns a copy of the list with all its contents parsed through the given tag.
One should generally prefer ListTag.parse_tag. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2369 |
Name | <ListTag.parse_tag[<parseable-value>]> |
Returns | ListTag |
Description | Returns 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 |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2470 |
Name | <ListTag.random[(<#>)]> |
Returns | ObjectTag |
Description | Gets a random item in the list and returns it.
Optionally, add [<#>] to instead get a list of multiple randomly chosen list entries. |
Example |
|
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2692 |
Name | <ListTag.remove[<#>|...]> |
Returns | ListTag |
Description | Returns a new ListTag excluding the items at the specified index.
Note the index input options described at listtag |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1356 |
Name | <ListTag.remove[<#>].to[<#>]> |
Returns | ListTag |
Description | Returns a new ListTag excluding the items in the specified index range.
Note the index input options described at listtag |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1369 |
Name | <ListTag.replace[(regex:)<element>]> |
Returns | ListTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1434 |
Name | <ListTag.replace[(regex:)<element>].with[<element>]> |
Returns | ListTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1442 |
Name | <ListTag.reverse> |
Returns | ListTag |
Description | Returns a copy of the list, with all items placed in opposite order. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1498 |
Name | <ListTag.separated_by[<text>]> |
Returns | ElementTag |
Description | Returns the list formatted, with each item separated by the defined text. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L798 |
Name | <ListTag.set_single[<value>].at[<#>]> |
Returns | ListTag |
Description | Returns 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 listtag |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1179 |
Name | <ListTag.set[...|...].at[<#>]> |
Returns | ListTag |
Description | Returns 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 listtag |
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1140 |
Name | <ListTag.shared_contents[...|...]> |
Returns | ListTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1413 |
Name | <ListTag.size> |
Returns | ElementTag(Number) |
Description | Returns the size of the list. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1027 |
Name | <ListTag.sort[<procedure>]> |
Returns | ListTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2250 |
Name | <ListTag.sort_by_number[<tag>]> |
Returns | ListTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2196 |
Name | <ListTag.sort_by_value[<tag>]> |
Returns | ListTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2159 |
Name | <ListTag.sort[<procedure>].context[<context>]> |
Returns | ListTag |
Description | Sort a list, with context. See ListTag.sort for general sort details. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2272 |
Name | <ListTag.space_separated> |
Returns | ElementTag |
Description | Returns the list in a cleaner format, separated by spaces. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L782 |
Name | <ListTag.sub_lists[<#>]> |
Returns | ListTag(ListTag) |
Description | Returns a list containing sublists of this list capped to a specific length. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L755 |
Name | <ListTag.sum> |
Returns | ElementTag(Decimal) |
Description | Returns the sum of all numbers in the list. Ignores non-numerical values. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1777 |
Name | <ListTag.to_map[(<separator>)]> |
Returns | MapTag |
Description | Interprets a list of "key/value" pairs as a map, and returns the resulting MapTag.
Optionally specify the map separator symbol, by default '/'. Inverted by MapTag.to_list |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L978 |
Name | <ListTag.to_polygon> |
Returns | PolygonTag |
Description | Converts 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitListExtensions.java#L89 |
Name | <ListTag.unseparated> |
Returns | ElementTag |
Description | Returns the list in a less clean format, separated by nothing. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L830 |
Name | <LocationTag.buried_item> |
Returns | ItemTag |
Mechanism | LocationTag.buried_item |
Description | Returns the item buried in a brushable block (also referred to as "suspicious blocks"). Returns air if there is no item buried. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4422 |
Name | <LocationTag.downfall_type> |
Returns | ElementTag |
Description | Returns 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 BiomeTag.downfall_at. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4268 |
Name | <LocationTag.find.structure[<type>].within[<#.#>]> |
Returns | LocationTag |
Description | Deprecated in favor of LocationTag.find_structure on 1.19+. |
Deprecated | Use 'LocationTag.find_structure' on 1.19+. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3075 |
Name | <LocationTag.find.unexplored_structure[<type>].within[<#.#>]> |
Returns | LocationTag |
Description | Deprecated in favor of LocationTag.find_structure with 'unexplored=true' on 1.19+. |
Deprecated | Use 'LocationTag.find_structure' with 'unexplored=true' on 1.19+. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3100 |
Name | <LocationTag.last_interacted_slot> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.last_interacted_slot |
Description | Returns the last interacted slot of a Chiseled Bookshelf inventory. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4284 |
Name | <LocationTag.sherds> |
Returns | MapTag |
Mechanism | LocationTag.sherds |
Description | Returns a decorated pot's sherds as a map of sides to 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4356 |
Name | <LocationTag.slot[<vector>]> |
Returns | ElementTag(Number) |
Description | Returns 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 EntityTag.bookshelf_slot |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4491 |
Name | <LocationTag.temperature> |
Returns | ElementTag(Decimal) |
Description | Returns 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 BiomeTag.temperature_at. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4251 |
Name | <LocationTag.vector_to_face> |
Returns | ElementTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3304 |
Name | <LocationTag.yaw.simple> |
Returns | ElementTag |
Description | Returns the yaw as 'North', 'South', 'East', or 'West'. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2351 |
Name | <LocationTag.areas[(<matcher>)]> |
Returns | ListTag(AreaObject) |
Description | Returns 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 |
|
Example |
|
Group | areas |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3512 |
Name | <LocationTag.cuboids[(<matcher>)]> |
Returns | ListTag(CuboidTag) |
Description | Returns 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 |
|
Group | areas |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3537 |
Name | <LocationTag.ellipsoids[(<matcher>)]> |
Returns | ListTag(EllipsoidTag) |
Description | Returns 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 |
|
Group | areas |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3558 |
Name | <LocationTag.is_in[<matcher>]> |
Returns | ElementTag(Boolean) |
Description | Returns 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. |
Group | areas |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4098 |
Name | <LocationTag.is_within[<area>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the location is within the specified area (cuboid, ellipsoid, polygon, ...). |
Group | areas |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3437 |
Name | <LocationTag.polygons[(<matcher>)]> |
Returns | ListTag(PolygonTag) |
Description | Returns 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 |
|
Group | areas |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3579 |
Name | <LocationTag.to_cuboid[<location>]> |
Returns | CuboidTag |
Description | Returns a cuboid from this location to the specified location. |
Generated Example |
|
Group | areas |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3485 |
Name | <LocationTag.to_ellipsoid[<size>]> |
Returns | EllipsoidTag |
Description | Returns an ellipsoid centered at this location with the specified size.
Size input is a vector of x,y,z size. |
Group | areas |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3469 |
Name | <LocationTag.find_blocks_flagged[<flag_name>].within[<#>]> |
Returns | ListTag(LocationTag) |
Description | Returns 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. |
Group | finding |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2608 |
Name | <LocationTag.find_blocks[(<matcher>)].within[<#.#>]> |
Returns | ListTag(LocationTag) |
Description | Returns 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). |
Group | finding |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2690 |
Name | <LocationTag.find_entities[(<matcher>)].within[<#.#>]> |
Returns | ListTag(EntityTag) |
Description | Returns 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). |
Group | finding |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2661 |
Name | <LocationTag.find_nearest_biome[<biome>]> |
Returns | LocationTag |
Description | Returns 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 |
|
Group | finding |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2584 |
Name | <LocationTag.find_npcs_within[<#.#>]> |
Returns | ListTag(NPCTag) |
Description | Returns a list of NPCs within a radius.
Result list is sorted by closeness (1 = closest, 2 = next closest, ... last = farthest). |
Generated Example |
|
Group | finding |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2862 |
Name | <LocationTag.find_path[<location>]> |
Returns | ListTag(LocationTag) |
Description | Returns 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 |
|
Group | finding |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3127 |
Name | <LocationTag.find_players_within[<#.#>]> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of players within a radius.
Result list is sorted by closeness (1 = closest, 2 = next closest, ... last = farthest). |
Generated Example |
|
Group | finding |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2839 |
Name | <LocationTag.find_spawnable_blocks_within[<#.#>]> |
Returns | ListTag(LocationTag) |
Description | Returns a list of blocks within a radius, that are safe for spawning, with the same logic as 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 |
|
Group | finding |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2796 |
Name | <LocationTag.find_tile_entities[(<matcher>)].within[<#.#>]> |
Returns | ListTag(LocationTag) |
Description | Returns a list of tile-entity blocks within a radius, with an optional search parameter for the block material.
This can be more efficient that 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). |
Group | finding |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2736 |
Name | <LocationTag.find.living_entities.within[<#.#>]> |
Returns | ListTag(EntityTag) |
Description | Returns 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). |
Group | finding |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3052 |
Name | <LocationTag.find.surface_blocks[(<material>|...)].within[<#.#>]> |
Returns | ListTag(LocationTag) |
Description | Returns a list of matching surface blocks within a radius.
Result list is sorted by closeness (1 = closest, 2 = next closest, ... last = farthest). |
Group | finding |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2941 |
Name | <LocationTag.chunk> |
Returns | ChunkTag |
Description | Returns the chunk that this location belongs to. |
Generated Example |
|
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3207 |
Name | <LocationTag.format[<format>]> |
Returns | ElementTag |
Description | Formats 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 |
|
Example |
|
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3151 |
Name | <LocationTag.formatted> |
Returns | ElementTag |
Description | Returns 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 |
|
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3178 |
Name | <LocationTag.formatted.citizens> |
Returns | ElementTag |
Description | Returns 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 |
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3188 |
Name | <LocationTag.note_name> |
Returns | ElementTag |
Description | Gets the name of a noted LocationTag. If the location isn't noted, this is null. |
Generated Example |
|
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3289 |
Name | <LocationTag.pitch> |
Returns | ElementTag(Decimal) |
Description | Returns the pitch of the object at the location. |
Generated Example |
|
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2303 |
Name | <LocationTag.raw> |
Returns | ElementTag |
Description | Returns the raw representation of this location, without any note name. |
Generated Example |
|
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3218 |
Name | <LocationTag.simple> |
Returns | ElementTag |
Description | Returns 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 |
|
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1693 |
Name | <LocationTag.simple.formatted> |
Returns | ElementTag |
Description | Returns 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' |
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1703 |
Name | <LocationTag.with_pitch[<number>]> |
Returns | LocationTag |
Description | Returns a copy of the location with a changed pitch value. |
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3256 |
Name | <LocationTag.with_pose[<entity>/<pitch>,<yaw>]> |
Returns | LocationTag |
Description | Returns the location with pitch and yaw. |
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2314 |
Name | <LocationTag.with_world[<world>]> |
Returns | LocationTag |
Description | Returns a copy of the location with a changed world value. |
Generated Example |
|
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3272 |
Name | <LocationTag.with_yaw[<number>]> |
Returns | LocationTag |
Description | Returns a copy of the location with a changed yaw value. |
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3240 |
Name | <LocationTag.world> |
Returns | WorldTag |
Description | Returns the world that the location is in. |
Generated Example |
|
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3229 |
Name | <LocationTag.yaw> |
Returns | ElementTag(Decimal) |
Description | Returns the normalized yaw of the object at the location. |
Generated Example |
|
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2343 |
Name | <LocationTag.yaw.raw> |
Returns | ElementTag(Decimal) |
Description | Returns the raw (un-normalized) yaw of the object at the location. |
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2377 |
Name | <LocationTag.above[(<#.#>)]> |
Returns | LocationTag |
Description | Returns the location above this location. Optionally specify a number of blocks to go up.
This just moves straight along the Y axis, equivalent to VectorObject.add with input 0,1,0 (or the input value instead of '1'). |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L893 |
Name | <LocationTag.backward[(<#.#>)]> |
Returns | LocationTag |
Description | Returns the location behind this location based on pitch and yaw. Optionally specify a number of blocks to go backward.
This is equivalent to LocationTag.forward in the opposite direction. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L958 |
Name | <LocationTag.backward_flat[(<#.#>)]> |
Returns | LocationTag |
Description | Returns the location behind this location based on yaw but not pitch. Optionally specify a number of blocks to go backward.
This is equivalent to LocationTag.forward_flat in the opposite direction. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L931 |
Name | <LocationTag.below[(<#.#>)]> |
Returns | LocationTag |
Description | Returns the location below this location. Optionally specify a number of blocks to go down.
This just moves straight along the Y axis, equivalent to VectorObject.sub with input 0,1,0 (or the input value instead of '1'). |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L905 |
Name | <LocationTag.block> |
Returns | LocationTag |
Description | Returns 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 LocationTag.round_down instead. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1061 |
Name | <LocationTag.center> |
Returns | LocationTag |
Description | Returns the location at the center of the block this location is on. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1076 |
Name | <LocationTag.direction[(<location>)]> |
Returns | ElementTag |
Description | Returns 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 |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2156 |
Name | <LocationTag.direction.vector> |
Returns | LocationTag |
Description | Returns the location's direction as a one-length vector. |
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2166 |
Name | <LocationTag.direction[<location>].yaw> |
Returns | ElementTag(Decimal) |
Description | Returns the yaw direction between two locations. |
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2183 |
Name | <LocationTag.distance[<location>]> |
Returns | ElementTag(Decimal) |
Description | Returns the distance between 2 locations. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3347 |
Name | <LocationTag.distance_squared[<location>]> |
Returns | ElementTag(Decimal) |
Description | Returns the distance between 2 locations, squared. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3322 |
Name | <LocationTag.distance[<location>].horizontal> |
Returns | ElementTag(Decimal) |
Description | Returns the horizontal distance between 2 locations. |
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3361 |
Name | <LocationTag.distance[<location>].horizontal.multiworld> |
Returns | ElementTag(Decimal) |
Description | Returns the horizontal distance between 2 multiworld locations. |
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3370 |
Name | <LocationTag.distance[<location>].vertical> |
Returns | ElementTag(Decimal) |
Description | Returns the vertical distance between 2 locations. |
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3389 |
Name | <LocationTag.distance[<location>].vertical.multiworld> |
Returns | ElementTag(Decimal) |
Description | Returns the vertical distance between 2 multiworld locations. |
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3398 |
Name | <LocationTag.down[(<#.#>)]> |
Returns | LocationTag |
Description | Returns the location below this location based on pitch and yaw. Optionally specify a number of blocks to go down.
This is equivalent to LocationTag.forward with a -90 degree rotation to the pitch. To just get the location above this location, use LocationTag.below instead. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1017 |
Name | <LocationTag.face[<location>]> |
Returns | LocationTag |
Description | Returns a location containing a yaw/pitch that point from the current location
to the target location. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2234 |
Name | <LocationTag.facing[<entity>/<location>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the location's yaw is facing another entity or location, within a limit of 45 degrees of yaw. |
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2250 |
Name | <LocationTag.facing[<entity>/<location>].degrees[<#>(,<#>)]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the location's yaw is facing another
entity or location, within a specified degree range. Optionally specify a pitch limit as well. |
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2274 |
Name | <LocationTag.forward[(<#.#>)]> |
Returns | LocationTag |
Description | Returns the location in front of this location based on pitch and yaw. Optionally specify a number of blocks to go forward. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L946 |
Name | <LocationTag.forward_flat[(<#.#>)]> |
Returns | LocationTag |
Description | Returns the location in front of this location based on yaw but not pitch. Optionally specify a number of blocks to go forward. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L917 |
Name | <LocationTag.left[(<#.#>)]> |
Returns | LocationTag |
Description | Returns 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 LocationTag.forward with a +90 degree rotation to the yaw and the pitch set to 0. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L971 |
Name | <LocationTag.line_of_sight[<location>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the specified location is within this location's line of sight. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2132 |
Name | <LocationTag.points_around_x[radius=<#.#>;points=<#>]> |
Returns | ListTag(LocationTag) |
Description | Returns 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]> |
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2448 |
Name | <LocationTag.points_around_y[radius=<#.#>;points=<#>]> |
Returns | ListTag(LocationTag) |
Description | Returns 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]> |
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2470 |
Name | <LocationTag.points_around_z[radius=<#.#>;points=<#>]> |
Returns | ListTag(LocationTag) |
Description | Returns 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]> |
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2492 |
Name | <LocationTag.points_between[<location>]> |
Returns | ListTag(LocationTag) |
Description | Finds all locations between this location and another, separated by 1 block-width each. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2057 |
Name | <LocationTag.points_between[<location>].distance[<#.#>]> |
Returns | ListTag(LocationTag) |
Description | Finds all locations between this location and another, separated by the specified distance each. |
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2070 |
Name | <LocationTag.random_offset[<limit>]> |
Returns | LocationTag |
Description | Returns 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. |
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1099 |
Name | <LocationTag.relative[<location>]> |
Returns | LocationTag |
Description | Returns 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 VectorObject.add instead. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1033 |
Name | <LocationTag.right[(<#.#>)]> |
Returns | LocationTag |
Description | Returns 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 LocationTag.forward with a -90 degree rotation to the yaw and the pitch set to 0. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L986 |
Name | <LocationTag.rotate_around_x[<#.#>]> |
Returns | LocationTag |
Description | Returns 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 |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2391 |
Name | <LocationTag.rotate_around_y[<#.#>]> |
Returns | LocationTag |
Description | Returns 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 |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2410 |
Name | <LocationTag.rotate_around_z[<#.#>]> |
Returns | LocationTag |
Description | Returns 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 |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2429 |
Name | <LocationTag.rotate_pitch[<#.#>]> |
Returns | LocationTag |
Description | Returns the location with the pitch rotated the specified amount. Note that this is capped to +/- 90. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2221 |
Name | <LocationTag.rotate_yaw[<#.#>]> |
Returns | LocationTag |
Description | Returns the location with the yaw rotated the specified amount (eg 180 to face the location backwards). |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2208 |
Name | <LocationTag.round> |
Returns | LocationTag |
Description | Returns 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 LocationTag.round_down. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1586 |
Name | <LocationTag.round_down> |
Returns | LocationTag |
Description | Returns 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 |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1625 |
Name | <LocationTag.round_to[<#>]> |
Returns | LocationTag |
Description | Returns 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 |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1645 |
Name | <LocationTag.round_to_precision[<#.#>]> |
Returns | LocationTag |
Description | Returns 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 |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1669 |
Name | <LocationTag.round_up> |
Returns | LocationTag |
Description | Returns 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 |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1606 |
Name | <LocationTag.simplex_3d> |
Returns | ElementTag(Decimal) |
Description | Returns the 3D simplex noise value (from -1 to 1) for this location's X/Y/Z.
See also util.random_simplex |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1087 |
Name | <LocationTag.up[(<#.#>)]> |
Returns | LocationTag |
Description | Returns the location above this location based on pitch and yaw. Optionally specify a number of blocks to go up.
This is equivalent to LocationTag.forward with a +90 degree rotation to the pitch. To just get the location above this location, use LocationTag.above instead. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1001 |
Name | <LocationTag.age> |
Returns | DurationTag |
Mechanism | LocationTag.age |
Description | Returns the age of an end gateway. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4041 |
Name | <LocationTag.attached_to> |
Returns | LocationTag |
Description | Returns the block this block is attached to.
(For buttons, levers, signs, torches, etc). |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3920 |
Name | <LocationTag.beacon_primary_effect> |
Returns | ElementTag |
Mechanism | LocationTag.beacon_primary_effect |
Description | Returns the primary effect of the beacon. The return is simply a potion effect type name. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3888 |
Name | <LocationTag.beacon_secondary_effect> |
Returns | ElementTag |
Mechanism | LocationTag.beacon_secondary_effect |
Description | Returns the secondary effect of the beacon. The return is simply a potion effect type name. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3904 |
Name | <LocationTag.beacon_tier> |
Returns | ElementTag(Number) |
Description | Returns the tier level of a beacon pyramid (0-4). |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3877 |
Name | <LocationTag.biome> |
Returns | BiomeTag |
Mechanism | LocationTag.biome |
Description | Returns the biome at the location. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3500 |
Name | <LocationTag.block_facing> |
Returns | LocationTag |
Mechanism | LocationTag.block_facing |
Description | Returns 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 |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L845 |
Name | <LocationTag.brewing_fuel_level> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.brewing_fuel_level |
Description | Returns the level of fuel a brewing stand has. Each unit of fuel can power one brewing operation. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3817 |
Name | <LocationTag.brewing_time> |
Returns | DurationTag |
Mechanism | LocationTag.brewing_time |
Description | Returns the brewing time a brewing stand has left. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3805 |
Name | <LocationTag.campfire_items> |
Returns | ListTag(ItemTag) |
Mechanism | LocationTag.campfire_items |
Description | Returns 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 |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4113 |
Name | <LocationTag.command_block> |
Returns | ElementTag |
Mechanism | LocationTag.command_block |
Description | Returns the command a command block is set to. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3790 |
Name | <LocationTag.command_block_name> |
Returns | ElementTag |
Mechanism | LocationTag.command_block_name |
Description | Returns the name a command block is set to. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3775 |
Name | <LocationTag.custom_name> |
Returns | ElementTag |
Mechanism | LocationTag.custom_name |
Description | Returns the custom name of this block.
Only works for nameable blocks, such as chests and dispensers. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3976 |
Name | <LocationTag.drops[(<item>)]> |
Returns | ListTag(ItemTag) |
Description | Returns 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 |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1443 |
Name | <LocationTag.exit_location> |
Returns | LocationTag |
Mechanism | LocationTag.exit_location |
Description | Returns the exit location of an end gateway block. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4077 |
Name | <LocationTag.facing_blocks[(<#>)]> |
Returns | ListTag(LocationTag) |
Description | Finds 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 |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2102 |
Name | <LocationTag.flood_fill[<limit>]> |
Returns | ListTag(LocationTag) |
Description | Returns 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. |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2514 |
Name | <LocationTag.flood_fill[<limit>].types[<matcher>]> |
Returns | ListTag(LocationTag) |
Description | Returns 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. |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2555 |
Name | <LocationTag.furnace_burn_duration> |
Returns | DurationTag |
Mechanism | LocationTag.furnace_burn_duration |
Description | Returns the burn time a furnace has left. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3829 |
Name | <LocationTag.furnace_cook_duration> |
Returns | DurationTag |
Mechanism | LocationTag.furnace_cook_duration |
Description | Returns the cook time a furnace has been cooking its current item for. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3845 |
Name | <LocationTag.furnace_cook_duration_total> |
Returns | DurationTag |
Mechanism | LocationTag.furnace_cook_duration_total |
Description | Returns the total cook time a furnace has left. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3861 |
Name | <LocationTag.has_inventory> |
Returns | ElementTag(Boolean) |
Description | Returns whether the block at the location has an inventory. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1145 |
Name | <LocationTag.has_loot_table> |
Returns | ElementTag(Boolean) |
Mechanism | LocationTag.clear_loot_table |
Description | Returns an element indicating whether the chest at this location has a loot-table set. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3722 |
Name | <LocationTag.head_rotation> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.head_rotation |
Description | Gets the rotation of the head at this location. Can be 1-16. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1220 |
Name | <LocationTag.highest> |
Returns | LocationTag |
Description | Returns the location of the highest solid block at the location. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1133 |
Name | <LocationTag.hive_bee_count> |
Returns | ElementTag(Number) |
Description | Returns the number of bees inside a hive. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1482 |
Name | <LocationTag.hive_max_bees> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.hive_max_bees |
Description | Returns the maximum number of bees allowed inside a hive. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1493 |
Name | <LocationTag.inventory> |
Returns | InventoryTag |
Description | Returns the InventoryTag of the block at the location. If the
block is not a container, returns null. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1156 |
Name | <LocationTag.is_exact_teleport> |
Returns | ElementTag(Boolean) |
Mechanism | LocationTag.is_exact_teleport |
Description | Returns whether an end gateway is 'exact teleport' - if false, the destination will be randomly chosen *near* the destination. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4059 |
Name | <LocationTag.is_liquid> |
Returns | ElementTag(Boolean) |
Description | Returns whether the block at the location is a liquid. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3600 |
Name | <LocationTag.is_lockable> |
Returns | ElementTag(Boolean) |
Mechanism | LocationTag.lock |
Description | Returns whether the container is lockable. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1431 |
Name | <LocationTag.is_locked> |
Returns | ElementTag(Boolean) |
Mechanism | LocationTag.lock |
Description | Returns whether the container is locked. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1416 |
Name | <LocationTag.is_passable> |
Returns | ElementTag(Boolean) |
Description | Returns 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 |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1186 |
Name | <LocationTag.is_spawnable> |
Returns | ElementTag(Boolean) |
Description | Returns 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 |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4136 |
Name | <LocationTag.is_within_border> |
Returns | ElementTag(Boolean) |
Description | Returns whether the location is within the world border. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3426 |
Name | <LocationTag.jukebox_is_playing> |
Returns | ElementTag(Boolean) |
Mechanism | LocationTag.jukebox_play |
Description | Returns whether the jukebox is currently playing a song. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4023 |
Name | <LocationTag.jukebox_record> |
Returns | ItemTag |
Mechanism | LocationTag.jukebox_record |
Description | Returns the record item currently inside the jukebox.
If there's no record, will return air. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4004 |
Name | <LocationTag.lectern_page> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.lectern_page |
Description | Deprecated in favor of LocationTag.page. |
Generated Example |
|
Group | world |
Deprecated | Use 'LocationTag.page' |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3689 |
Name | <LocationTag.light> |
Returns | ElementTag(Number) |
Description | Returns the total amount of light on the location. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3621 |
Name | <LocationTag.light.blocks> |
Returns | ElementTag(Number) |
Description | Returns the amount of light from light blocks that is
on the location. |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3634 |
Name | <LocationTag.light.sky> |
Returns | ElementTag(Number) |
Description | Returns the amount of light from the sky that is
on the location. |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3647 |
Name | <LocationTag.local_difficulty> |
Returns | ElementTag(Decimal) |
Description | Returns the local difficulty (damage scaler) at the location.
This is based internally on multiple factors, including ChunkTag.inhabited_time and WorldTag.difficulty. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3992 |
Name | <LocationTag.lock> |
Returns | ElementTag |
Mechanism | LocationTag.lock |
Description | Returns the password to a locked container. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1400 |
Name | <LocationTag.loot_table_id> |
Returns | ElementTag |
Mechanism | LocationTag.loot_table_id |
Description | Returns an element indicating the minecraft key for the loot-table for the chest at this location (if any). |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3738 |
Name | <LocationTag.map_color> |
Returns | ColorTag |
Description | Returns the color of the block at the location, as seen in a map. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4187 |
Name | <LocationTag.material> |
Returns | MaterialTag |
Description | Returns the material of the block at the location. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1171 |
Name | <LocationTag.other_block> |
Returns | LocationTag |
Description | If 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 |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3955 |
Name | <LocationTag.page> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.page |
Description | Returns the current page on display in the book on this Lectern block. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3707 |
Name | <LocationTag.patterns> |
Returns | ListTag |
Mechanism | LocationTag.patterns |
Description | Lists 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 |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1202 |
Name | <LocationTag.power> |
Returns | ElementTag(Number) |
Description | Returns the current redstone power level of a block. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3668 |
Name | <LocationTag.precise_cursor_on[(<range>)]> |
Returns | LocationTag |
Description | Deprecated in favor of LocationTag.ray_trace with all default settings (no input other than optionally the range). |
Generated Example |
|
Group | world |
Deprecated | use "ray_trace" instead. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1930 |
Name | <LocationTag.precise_cursor_on_block[(<range>)]> |
Returns | LocationTag |
Description | Deprecated in favor of LocationTag.ray_trace with input setting [return=block]. |
Generated Example |
|
Group | world |
Deprecated | use "ray_trace[return=block]" instead. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1909 |
Name | <LocationTag.precise_impact_normal[(<range>)]> |
Returns | LocationTag |
Description | Deprecated in favor of LocationTag.ray_trace with input setting [return=normal]. |
Generated Example |
|
Group | world |
Deprecated | use "ray_trace[return=normal]" instead. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1888 |
Name | <LocationTag.precise_target[(<range>)]> |
Returns | EntityTag |
Description | Returns 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 |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1977 |
Name | <LocationTag.precise_target_list[<range>]> |
Returns | ListTag(EntityTag) |
Description | Returns a list of all entities this location is pointing directly at (using precise ray trace logic), up to a given range limit. |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1951 |
Name | <LocationTag.precise_target_position[(<range>)]> |
Returns | LocationTag |
Description | Deprecated in favor of LocationTag.ray_trace with input of [entities=*] |
Generated Example |
|
Group | world |
Deprecated | use "ray_trace[entities=*]" instead. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2017 |
Name | <LocationTag.precise_target_position[(<range>)].type[<entity_type>|...]> |
Returns | LocationTag |
Description | Deprecated in favor of LocationTag.ray_trace with "entities=" set to your input types as a matcher. |
Group | world |
Deprecated | use "ray_trace[entities=(your_types)]" instead. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2032 |
Name | <LocationTag.precise_target[(<range>)].type[<entity_type>|...]> |
Returns | EntityTag |
Description | Returns 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). |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1991 |
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})]> |
Returns | LocationTag |
Description | Traces 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 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 |
|
Example |
|
Example |
|
Synonyms (Search Aid) | locationtag.raycast, locationtag.raytrace, locationtag.ray_cast |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1728 |
Name | <LocationTag.ray_trace_target[(range=<#.#>/{200});(blocks=<{true}/false>);(fluids=<true/{false}>);(nonsolids=<true/{false}>);(entities=<matcher>);(ignore=<entity>|...);(raysize=<#.#>/{0})]> |
Returns | EntityTag |
Description | Traces a line from this location towards the direction it's facing, returning the first hit entity (if any).
This is similar to LocationTag.precise_target and PlayerTag.target, except offering more options for how the ray trace is performed. For ray tracing locations, see 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 |
|
Example |
|
Example |
|
Synonyms (Search Aid) | locationtag.raycast_target, locationtag.raytrace_target, locationtag.ray_cast_target |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1824 |
Name | <LocationTag.sign_contents> |
Returns | ListTag |
Mechanism | LocationTag.sign_contents |
Description | Returns a list of lines on a sign. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1245 |
Name | <LocationTag.sign_glow_color> |
Returns | ElementTag |
Mechanism | LocationTag.sign_glow_color |
Description | Returns the name of the glow-color of the sign at the location.
See also LocationTag.sign_glowing |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4169 |
Name | <LocationTag.sign_glowing> |
Returns | ElementTag(Boolean) |
Mechanism | LocationTag.sign_glowing |
Description | Returns whether the location is a Sign block that is glowing. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4152 |
Name | <LocationTag.skull_name> |
Returns | ElementTag |
Mechanism | LocationTag.skull_skin |
Description | Returns the name of the skin the skull is displaying. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1521 |
Name | <LocationTag.skull_skin> |
Returns | ElementTag |
Mechanism | LocationTag.skull_skin |
Description | Returns the skin the skull is displaying - just the name or UUID as text, not a player object. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1545 |
Name | <LocationTag.skull_skin.full> |
Returns | ElementTag |
Mechanism | LocationTag.skull_skin |
Description | Returns 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. |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1564 |
Name | <LocationTag.skull_type> |
Returns | ElementTag |
Description | Returns the type of the skull. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1505 |
Name | <LocationTag.spawner_count> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.spawner_count |
Description | Returns the spawn count for the spawner. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1385 |
Name | <LocationTag.spawner_display_entity> |
Returns | EntityTag |
Description | Returns the full "display entity" for the spawner. This can contain more data than just a type. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1278 |
Name | <LocationTag.spawner_max_nearby_entities> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.spawner_max_nearby_entities |
Description | Returns the maximum nearby entities for the spawner (the radius mobs will spawn in). |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1370 |
Name | <LocationTag.spawner_maximum_spawn_delay> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.spawner_delay_data |
Description | Returns the maximum spawn delay for the mob spawner. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1325 |
Name | <LocationTag.spawner_minimum_spawn_delay> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.spawner_delay_data |
Description | Returns the minimum spawn delay for the mob spawner. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1310 |
Name | <LocationTag.spawner_player_range> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.spawner_player_range |
Description | Returns the maximum player range for the spawner (ie how close a player must be for this spawner to be active). |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1340 |
Name | <LocationTag.spawner_range> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.spawner_range |
Description | Returns the spawn range for the spawner (the radius mobs will spawn in). |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1355 |
Name | <LocationTag.spawner_spawn_delay> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.spawner_delay_data |
Description | Returns the current spawn delay for the spawner.
This changes over time between LocationTag.spawner_minimum_spawn_delay and LocationTag.spawner_maximum_spawn_delay. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1294 |
Name | <LocationTag.spawner_type> |
Returns | EntityTag |
Mechanism | LocationTag.spawner_type |
Description | Returns the type of entity spawned by a mob spawner, if any. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1262 |
Name | <LocationTag.structure_block_data> |
Returns | MapTag |
Mechanism | LocationTag.structure_block_data |
Description | Returns 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 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 |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4202 |
Name | <LocationTag.switched> |
Returns | ElementTag(Boolean) |
Description | Returns whether the block at the location is considered to be switched on.
(For buttons, levers, etc.) To change this, see Switch |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1232 |
Name | <LocationTag.tree_distance> |
Returns | ElementTag(Number) |
Description | Deprecated in favor of MaterialTag.distance
Used like <[location].material.distance> |
Generated Example |
|
Group | world |
Deprecated | Use MaterialTag.distance |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3757 |
Name | <LocationTag.waxed> |
Returns | ElementTag(Boolean) |
Mechanism | LocationTag.waxed |
Description | If the location is a sign block, returns whether it is waxed (locked to prevent players editing the text). |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4454 |
Name | <LocationTag.with_facing_direction> |
Returns | LocationTag |
Description | Returns 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 |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L869 |
Name | <LocationTag.xp_drop[(<item>)]> |
Returns | ElementTag(Number) |
Description | Returns 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 |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1464 |
Name | <LocationTag.find_structure[structure=<structure>;radius=<#>(;unexplored=<true/{false}>)]> |
Returns | LocationTag |
Description | Finds the closest structure of the given type within the specified chunk radius (if any), optionally only searching for unexplored ones.
For a list of default structures, see https://minecraft.wiki/w/Structure#ID. Alternatively, you can specify a custom structure from a datapack, plugin, etc. as a namespaced key. See also server.structures for all structures currently available on the server. |
Example |
|
Group | finding |
Warning(s) | See Structure lookups for potential issues/edge cases in structure lookups. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4311 |
Name | <LocationTag.coreprotect_logs[<duration>]> |
Returns | ListTag(MapTag) |
Description | Returns 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 |
|
Requires | Depenizen, CoreProtect |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/coreprotect/CoreProtectLocationProperties.java#L50 |
Name | <LocationTag.faction> |
Returns | FactionTag |
Description | Returns the faction at the location. (Can also be SafeZone, WarZone, or Wilderness) |
Generated Example |
|
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/factions/FactionsLocationProperties.java#L58 |
Name | <LocationTag.griefprevention.claim> |
Returns | GriefPreventionClaimTag |
Description | Returns the GriefPreventionClaim at this location. |
Requires | Depenizen, GriefPrevention |
Source | https://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>)]> |
Returns | ElementTag(Boolean) |
Description | Returns whether there is a GriefPreventionClaim at this location.
Optionally specify an ElementTag(Boolean) for whether to ignore Y axis. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/griefprevention/GriefPreventionLocationProperties.java#L65 |
Name | <LocationTag.has_residence> |
Returns | ElementTag(Boolean) |
Description | Returns whether the location has a Residence. |
Generated Example |
|
Requires | Depenizen, Residence |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/residence/ResidenceLocationExtensions.java#L13 |
Name | <LocationTag.has_town> |
Returns | ElementTag(Boolean) |
Description | Returns whether the location is within a town. |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L88 |
Name | <LocationTag.in_region[(<name>|...)]> |
Returns | ElementTag(Boolean) |
Description | If 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 |
|
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardLocationProperties.java#L89 |
Name | <LocationTag.is_nation_zone> |
Returns | ElementTag(Boolean) |
Description | Returns whether the location is a nation zone. |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L114 |
Name | <LocationTag.is_wilderness> |
Returns | ElementTag(Boolean) |
Description | Returns whether the location is wilderness. |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L125 |
Name | <LocationTag.mcmmo.is_placed> |
Returns | ElementTag(Boolean) |
Description | Returns whether the location is tracked by McMMO as a player-placed block (might only apply to certain block types). |
Requires | Depenizen, mcMMO |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mcmmo/McMMOLocationProperties.java#L61 |
Name | <LocationTag.plotsquared_plot> |
Returns | PlotSquaredPlotTag |
Description | Returns the plot contained by this location. |
Generated Example |
|
Requires | Depenizen, PlotSquared |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/plotsquared/PlotSquaredLocationProperties.java#L57 |
Name | <LocationTag.regions> |
Returns | ListTag(WorldGuardRegionTag) |
Description | Returns a list of regions that the location is in. |
Generated Example |
|
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardLocationProperties.java#L116 |
Name | <LocationTag.residence> |
Returns | ResidenceTag |
Description | Returns the Residence contained by this location. |
Generated Example |
|
Requires | Depenizen, Residence |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/residence/ResidenceLocationExtensions.java#L25 |
Name | <LocationTag.skyblock.has_skyblock> |
Returns | ElementTag(Boolean) |
Description | Returns whether the location has a skyblock. |
Requires | Depenizen, A SkyBlock |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/askyblock/ASkyBlockLocationProperties.java#L64 |
Name | <LocationTag.skyblock.owner> |
Returns | PlayerTag |
Description | Returns the owner of the skyblock at the location. |
Requires | Depenizen, A SkyBlock |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/askyblock/ASkyBlockLocationProperties.java#L75 |
Name | <LocationTag.tc_biome.name> |
Returns | ElementTag |
Description | Returns the TerrainControl biome name at this location, if any. |
Requires | Depenizen, TerrainControl |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/terraincontrol/TCLocationProperties.java#L63 |
Name | <LocationTag.tc_biome.temperature> |
Returns | ElementTag |
Description | Returns the TerrainControl biome temperature at this location, if any. |
Requires | Depenizen, TerrainControl |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/terraincontrol/TCLocationProperties.java#L75 |
Name | <LocationTag.town> |
Returns | TownTag |
Description | Returns the town at the specified location. |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L99 |
Name | <LocationTag.towny_allows_pvp> |
Returns | ElementTag(Boolean) |
Description | Returns whether Towny would allow PVP here. |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L18 |
Name | <LocationTag.towny_resident> |
Returns | PlayerTag |
Description | Returns the resident of a Towny plot at the location, if any. |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L29 |
Name | <LocationTag.towny_type> |
Returns | ElementTag |
Description | Returns the type of the Towny area this location is in.
Can be Default, Shop, Arena, Embassy, Wilds, Inn, Jail, Farm, Bank |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L72 |
Name | <LocationTag.towny.resident> |
Returns | PlayerTag |
Description | Returns the resident of a Towny plot at the location, if any.
Deprecated in favor of LocationTag.towny_resident. |
Requires | Depenizen, Towny |
Deprecated | use 'towny_resident' |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyLocationProperties.java#L50 |
Name | <MapTag.any> |
Returns | ElementTag(Boolean) |
Description | Returns "true" if the map contains any keys, or "false" if it is empty. |
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L408 |
Name | <MapTag.contains[<key>|...]> |
Returns | ElementTag(Boolean) |
Description | Returns 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 |
|
Example |
|
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L539 |
Name | <MapTag.deep_exclude[<key>|...]> |
Returns | MapTag |
Description | Returns a copy of the map with the specified deep key(s) excluded. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L802 |
Name | <MapTag.deep_get[<key>|...]> |
Returns | ObjectTag |
Description | Returns 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 |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L604 |
Name | <MapTag.deep_keys> |
Returns | ListTag |
Description | Returns 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 |
|
Source | https://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>]> |
Returns | MapTag |
Description | Returns a copy of the map, with the specified key set to the specified value, using deep key paths separated by the '.' symbol. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L695 |
Name | <MapTag.default[<key>].as[<value>]> |
Returns | MapTag |
Description | Returns 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 |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L657 |
Name | <MapTag.exclude[<key>|...]> |
Returns | MapTag |
Description | Returns a copy of the map with the specified key(s) excluded. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L825 |
Name | <MapTag.filter_tag[<parseable-boolean>]> |
Returns | MapTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L477 |
Name | <MapTag.get[<key>|...]> |
Returns | ObjectTag |
Description | Returns the object value at the specified key.
If a list is given as input, returns a list of values. |
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L579 |
Name | <MapTag.get_subset[<key>|...]> |
Returns | MapTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L635 |
Name | <MapTag.include[<map>]> |
Returns | MapTag |
Description | Returns a copy of the map with the specified map's contents copied in.
Matching keys will be overridden. |
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L842 |
Name | <MapTag.invert> |
Returns | MapTag |
Description | Returns 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 |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L759 |
Name | <MapTag.is_empty> |
Returns | ElementTag(Boolean) |
Description | Returns "true" if the map is empty (contains no keys), otherwise "false". |
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L388 |
Name | <MapTag.keys> |
Returns | ListTag |
Description | Returns a list of all keys in this map. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L889 |
Name | <MapTag.parse_value[<tag>]> |
Returns | MapTag |
Description | Returns a copy of the map with all its values updated through the given tag.
One should generally prefer MapTag.parse_value_tag. |
Example |
|
Source | https://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>]> |
Returns | MapTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L509 |
Name | <MapTag.reverse> |
Returns | MapTag |
Description | Returns a reversed copy of the map. That is, the last key becomes the first key and vice-versa, akin to ListTag.reverse
Not to be confused with MapTag.invert |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L782 |
Name | <MapTag.size> |
Returns | ElementTag(Number) |
Description | Returns the size of the map - that is, how many key/value pairs are within it. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L375 |
Name | <MapTag.sort_by_value[(<tag>)]> |
Returns | MapTag |
Description | Returns 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 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 ListTag.map_with, like 'map.keys.map_with[map.values.parse[...]]' |
Example |
|
Example |
|
Source | https://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=<#>)]> |
Returns | ElementTag |
Description | Returns a JSON encoding of this map. Primarily useful with interop with other software, such as when use webget or 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L951 |
Name | <MapTag.to_list[(<separator>)]> |
Returns | ListTag |
Description | Returns 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 ListTag.to_map |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L934 |
Name | <MapTag.to_pair_lists> |
Returns | ListTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L915 |
Name | <MapTag.to_yaml> |
Returns | ElementTag |
Description | Returns a YAML encoding of this map. Sometimes useful for debugging or for interop with other software. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L970 |
Name | <MapTag.values> |
Returns | ListTag |
Description | Returns a list of all values in this map. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L902 |
Name | <MapTag.with[<key>].as[<value>]> |
Returns | MapTag |
Description | Returns a copy of the map, with the specified key set to the specified value.
Matching keys will be overridden. |
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L725 |
Name | <MapTag.map_to_nbt> |
Returns | BinaryTag |
Description | Converts the NBT-formatted MapTag to raw binary NBT.
Refer to Raw NBT Encoding |
Example |
|
Group | conversion |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitMapExtensions.java#L16 |
Name | <MaterialTag.block_resistance> |
Returns | ElementTag(Decimal) |
Mechanism | MaterialTag.block_resistance |
Description | Returns the explosion resistance for all blocks of this material type. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L479 |
Name | <MaterialTag.block_sound_data> |
Returns | MapTag |
Description | If 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L635 |
Name | <MaterialTag.block_strength> |
Returns | ElementTag(Decimal) |
Mechanism | MaterialTag.block_strength |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L584 |
Name | <MaterialTag.food_points> |
Returns | ElementTag(Number) |
Description | If the material is an item, returns the amount of hunger it restores when eaten.
See https://minecraft.wiki/w/Food for more information on food mechanics. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L663 |
Name | <MaterialTag.fuel_burn_time> |
Returns | DurationTag |
Description | Returns the duration that a burnable fuel block will burn in a furnace for. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L415 |
Name | <MaterialTag.hardness> |
Returns | ElementTag(Decimal) |
Description | Returns the value representing how hard a material, used as a basis for calculating the time it takes to break. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L494 |
Name | <MaterialTag.has_gravity> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is affected by gravity. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L331 |
Name | <MaterialTag.is_block> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a placeable block. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L341 |
Name | <MaterialTag.is_burnable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a block that can burn away. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L375 |
Name | <MaterialTag.is_edible> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is edible. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L385 |
Name | <MaterialTag.is_enabled[<world>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is enabled in the specified world.
If experimental features are disabled in the given world, and the MaterialTag is an item or block that is only enabled by experimental features, this will return false. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L678 |
Name | <MaterialTag.is_flammable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a block that can catch fire. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L395 |
Name | <MaterialTag.is_fuel> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a block that can be burned in a furnace as fuel. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L405 |
Name | <MaterialTag.is_interactable> |
Returns | ElementTag(Boolean) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L363 |
Name | <MaterialTag.is_item> |
Returns | ElementTag(Boolean) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L351 |
Name | <MaterialTag.is_occluding> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a block that completely blocks vision. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L429 |
Name | <MaterialTag.is_record> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a playable music disc. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L439 |
Name | <MaterialTag.is_solid> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a block that is solid (can be built upon). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L449 |
Name | <MaterialTag.is_transparent> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a block that does not block any light. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L459 |
Name | <MaterialTag.item> |
Returns | ItemTag |
Description | Returns an item of the material. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L543 |
Name | <MaterialTag.max_durability> |
Returns | ElementTag(Number) |
Description | Returns the maximum durability of this material. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L469 |
Name | <MaterialTag.max_stack_size> |
Returns | ElementTag(Number) |
Mechanism | MaterialTag.max_stack_size |
Description | Returns the maximum amount of this material that can be held in a stack. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L508 |
Name | <MaterialTag.name> |
Returns | ElementTag |
Description | Returns the name of the material. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L533 |
Name | <MaterialTag.piston_reaction> |
Returns | ElementTag |
Mechanism | MaterialTag.piston_reaction |
Description | Returns the material's piston reaction. (Only for block materials). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L553 |
Name | <MaterialTag.produced_instrument> |
Returns | ElementTag |
Description | Returns 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 MaterialTag.instrument. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L623 |
Name | <MaterialTag.translated_name> |
Returns | ElementTag |
Description | Returns the localized name of the material.
Note that this is a magic Denizen tool - refer to Denizen Text Formatting. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L519 |
Name | <MaterialTag.vanilla_tags> |
Returns | ListTag |
Mechanism | MaterialTag.vanilla_tags |
Description | Returns a list of vanilla tags that apply to this material. See also https://minecraft.wiki/w/Tag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L608 |
Name | <MaterialTag.bottles> |
Returns | ListTag |
Mechanism | MaterialTag.bottles |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialBrewingStand.java#L41 |
Name | <MaterialTag.count> |
Returns | ElementTag(Number) |
Mechanism | MaterialTag.count |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialCount.java#L53 |
Name | <MaterialTag.count_max> |
Returns | ElementTag(Number) |
Mechanism | MaterialTag.count |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialCount.java#L65 |
Name | <MaterialTag.count_min> |
Returns | ElementTag(Number) |
Mechanism | MaterialTag.count |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialCount.java#L77 |
Name | <MaterialTag.delay> |
Returns | ElementTag(Number) |
Mechanism | MaterialTag.delay |
Description | Returns the current delay of a redstone repeater material. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialDelay.java#L40 |
Name | <MaterialTag.direction> |
Returns | ElementTag |
Mechanism | MaterialTag.direction |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialDirectional.java#L111 |
Name | <MaterialTag.distance> |
Returns | ElementTag(Number) |
Mechanism | MaterialTag.distance |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialDistance.java#L42 |
Name | <MaterialTag.faces> |
Returns | ListTag |
Mechanism | MaterialTag.faces |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialFaces.java#L58 |
Name | <MaterialTag.half> |
Returns | ElementTag |
Mechanism | MaterialTag.half |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialHalf.java#L54 |
Name | <MaterialTag.heights> |
Returns | ListTag |
Mechanism | MaterialTag.heights |
Description | Deprecated in favor of MaterialTag.sides |
Generated Example |
|
Group | properties |
Deprecated | Use 'sides' |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialSides.java#L53 |
Name | <MaterialTag.hinge> |
Returns | ElementTag |
Mechanism | MaterialTag.hinge |
Description | Returns a door's hinge side.
Output is LEFT or RIGHT. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialHinge.java#L40 |
Name | <MaterialTag.instrument> |
Returns | ElementTag |
Mechanism | MaterialTag.instrument |
Description | Returns 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 MaterialTag.produced_instrument. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialInstrument.java#L41 |
Name | <MaterialTag.is_locked> |
Returns | ElementTag(Boolean) |
Mechanism | MaterialTag.is_locked |
Description | Returns whether this redstone repeater material is locked. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialLocked.java#L40 |
Name | <MaterialTag.leaf_size> |
Returns | ElementTag |
Mechanism | MaterialTag.leaf_size |
Description | Returns the size of the leaves for this bamboo block.
Output is SMALL, LARGE, or NONE. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialLeafSize.java#L40 |
Name | <MaterialTag.max_delay> |
Returns | ElementTag(Number) |
Mechanism | MaterialTag.delay |
Description | Returns the maximum delay allowed for the redstone repeater material. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialDelay.java#L52 |
Name | <MaterialTag.max_power> |
Returns | ElementTag(Number) |
Mechanism | MaterialTag.power |
Description | Returns the maximum redstone power an analogue-powerable block can have. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialPower.java#L52 |
Name | <MaterialTag.maximum_age> |
Returns | ElementTag(Number) |
Description | Returns the maximum age for an ageable material. This includes plant growth. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialAge.java#L76 |
Name | <MaterialTag.maximum_level> |
Returns | ElementTag(Number) |
Description | Returns the maximum level for a Levelled material (like water, lava, and cauldrons), cake, beehives, snow, or farmland. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialLevel.java#L73 |
Name | <MaterialTag.min_delay> |
Returns | ElementTag(Number) |
Mechanism | MaterialTag.delay |
Description | Returns the minimum delay allowed for the redstone repeater material. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialDelay.java#L64 |
Name | <MaterialTag.minimum_level> |
Returns | ElementTag(Number) |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialLevel.java#L84 |
Name | <MaterialTag.mode> |
Returns | ElementTag |
Mechanism | MaterialTag.mode |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialMode.java#L60 |
Name | <MaterialTag.note> |
Returns | ElementTag(Number) |
Mechanism | MaterialTag.note |
Description | Returns the note played from this note block, as an ID number from 0 to 24. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialNote.java#L67 |
Name | <MaterialTag.note_octave> |
Returns | ElementTag(Number) |
Mechanism | MaterialTag.note |
Description | Returns the octave of note played from this note block, as 0, 1, or 2. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialNote.java#L41 |
Name | <MaterialTag.note_tone> |
Returns | ElementTag |
Mechanism | MaterialTag.note |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialNote.java#L53 |
Name | <MaterialTag.persistent> |
Returns | ElementTag(Boolean) |
Mechanism | MaterialTag.persistent |
Description | Returns whether this block will decay from being too far away from a tree. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialPersistent.java#L40 |
Name | <MaterialTag.power> |
Returns | ElementTag(Number) |
Mechanism | MaterialTag.power |
Description | Returns the redstone power level of an analogue-powerable block. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialPower.java#L40 |
Name | <MaterialTag.relative_vector> |
Returns | LocationTag |
Mechanism | MaterialTag.half |
Description | Returns a vector location of the other block for a bisected material. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialHalf.java#L73 |
Name | <MaterialTag.shape> |
Returns | ElementTag |
Mechanism | MaterialTag.shape |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialShape.java#L40 |
Name | <MaterialTag.sides> |
Returns | ListTag |
Mechanism | MaterialTag.sides |
Description | Returns 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 |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialSides.java#L62 |
Name | <MaterialTag.snowy> |
Returns | ElementTag(Boolean) |
Mechanism | MaterialTag.snowy |
Description | Returns whether this material is covered in snow or not. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialSnowable.java#L40 |
Name | <MaterialTag.switched> |
Returns | ElementTag(Boolean) |
Mechanism | MaterialTag.switched |
Description | Returns 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 |
|
Synonyms (Search Aid) | materialtag.lit, materialtag.open, materialtag.active |
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialSwitchable.java#L60 |
Name | <MaterialTag.unstable> |
Returns | ElementTag(Boolean) |
Mechanism | MaterialTag.unstable |
Description | Returns whether this TNT block is unstable (explodes when punched). |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialUnstable.java#L40 |
Name | <MaterialTag.valid_directions> |
Returns | ListTag |
Mechanism | MaterialTag.direction |
Description | Returns a list of directions that are valid for a directional material.
See also MaterialTag.direction |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialDirectional.java#L64 |
Name | <MaterialTag.valid_faces> |
Returns | ListTag |
Mechanism | MaterialTag.faces |
Description | Returns a list of faces that are valid for a material that has multiple faces.
See also MaterialTag.faces |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialFaces.java#L41 |
Name | <MaterialTag.waterlogged> |
Returns | ElementTag(Boolean) |
Mechanism | MaterialTag.waterlogged |
Description | Returns whether this block is waterlogged or not. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialWaterlogged.java#L40 |
Name | <MaterialTag.age> |
Returns | ElementTag(Number) |
Mechanism | MaterialTag.age |
Description | (Property) Returns an ageable material's current age. This includes plant growth.
See also MaterialTag.maximum_age. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialAge.java#L18 |
Name | <MaterialTag.attached> |
Returns | ElementTag(Boolean) |
Mechanism | MaterialTag.attached |
Description | (Property) Returns 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 |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialAttached.java#L17 |
Name | <MaterialTag.attachment_face> |
Returns | ElementTag |
Mechanism | MaterialTag.attachment_face |
Description | (Property) Returns 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 |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialAttachmentFace.java#L13 |
Name | <MaterialTag.level> |
Returns | ElementTag(Number) |
Mechanism | MaterialTag.level |
Description | (Property) Returns 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 MaterialTag.maximum_level and MaterialTag.minimum_level. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialLevel.java#L19 |
Name | <MaterialTag.type> |
Returns | ElementTag |
Mechanism | MaterialTag.type |
Description | (Property) Returns 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 |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/material/MaterialBlockType.java#L13 |
Name | <NPCTag.anchor[<name>]> |
Returns | LocationTag |
Description | Returns the location associated with the specified anchor, or null if it doesn't exist. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L599 |
Name | <NPCTag.attack_range> |
Returns | ElementTag(Decimal) |
Mechanism | NPCTag.attack_range |
Description | Returns the NPC's current navigator attack range limit. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1120 |
Name | <NPCTag.attack_strategy> |
Returns | ElementTag |
Description | Returns the NPC's current navigator attack strategy.
Not related to Sentinel combat. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1131 |
Name | <NPCTag.auto_update_skin> |
Returns | ElementTag(Boolean) |
Mechanism | NPCTag.auto_update_skin |
Description | Returns whether the NPC is set to automatically update skins from name. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L903 |
Name | <NPCTag.avoid_water> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC will avoid water. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1162 |
Name | <NPCTag.base_speed> |
Returns | ElementTag(Decimal) |
Description | Returns the NPC's base navigation speed. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1152 |
Name | <NPCTag.citizens_data[<key>]> |
Returns | ElementTag |
Description | Returns the value of a Citizens NPC metadata key. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1250 |
Name | <NPCTag.citizens_data_keys> |
Returns | ListTag |
Description | Returns a list of Citizens NPC metadata keys. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1267 |
Name | <NPCTag.constant[<constant_name>]> |
Returns | ElementTag |
Description | Returns the specified constant from the NPC. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L632 |
Name | <NPCTag.controllable> |
Returns | ElementTag(Boolean) |
Mechanism | NPCTag.controllable |
Description | Returns whether the NPC has controllable enabled. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L966 |
Name | <NPCTag.distance_margin> |
Returns | ElementTag(Decimal) |
Mechanism | NPCTag.distance_margin |
Description | Returns the NPC's current pathfinding distance margin. That is, how close it needs to get to its destination (in block-lengths). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1054 |
Name | <NPCTag.engaged[(<player>)]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC is currently engaged.
See engage |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L789 |
Name | <NPCTag.has_anchors> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC has anchors assigned. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L575 |
Name | <NPCTag.has_nickname> |
Returns | ElementTag(Boolean) |
Description | Returns true if the NPC has a nickname. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L463 |
Name | <NPCTag.has_pose[<name>]> |
Returns | ElementTag(Boolean) |
Description | Returns true if the NPC has the specified pose, otherwise returns false. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L652 |
Name | <NPCTag.has_skin> |
Returns | ElementTag(Boolean) |
Mechanism | NPCTag.skin |
Description | Returns whether the NPC has a custom skin. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L840 |
Name | <NPCTag.has_trait[<trait>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC has a specified trait. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L532 |
Name | <NPCTag.has_trigger[<trigger>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC has a specified trigger. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L558 |
Name | <NPCTag.hologram_direction> |
Returns | ElementTag |
Mechanism | NPCTag.hologram_direction |
Description | Returns the direction of an NPC's hologram as "BOTTOM_UP" or "TOP_DOWN". |
Generated Example |
|
Deprecated | This was removed from Citizens. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L741 |
Name | <NPCTag.hologram_line_height> |
Returns | ElementTag(Decimal) |
Mechanism | NPCTag.hologram_line_height |
Description | Returns the line height for an NPC's hologram. Can be -1, indicating a default value should be used. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L759 |
Name | <NPCTag.hologram_lines> |
Returns | ListTag |
Mechanism | NPCTag.hologram_lines |
Description | Returns the list of hologram lines attached to an NPC. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L726 |
Name | <NPCTag.hologram_npcs> |
Returns | ListTag(NPCTag) |
Description | Returns the list of hologram NPCs attached to an NPC (if any).
Note that these can regenerate at any time. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L703 |
Name | <NPCTag.id> |
Returns | ElementTag(Number) |
Description | Returns the NPC's ID number. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L811 |
Name | <NPCTag.inventory> |
Returns | InventoryTag |
Description | Returns the InventoryTag of the NPC. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L917 |
Name | <NPCTag.invulnerable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC is currently invulnerable.
See vulnerable |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L800 |
Name | <NPCTag.is_fighting> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC is currently targeting an entity for the Citizens internal punching pathfinder.
Not compatible with Sentinel. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1203 |
Name | <NPCTag.is_navigating> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC is currently navigating. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1088 |
Name | <NPCTag.is_protected> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC is protected. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L937 |
Name | <NPCTag.is_sitting> |
Returns | ElementTag(Boolean) |
Description | Returns true if the NPC is sitting. Relates to sit. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L474 |
Name | <NPCTag.is_sleeping> |
Returns | ElementTag(Boolean) |
Description | Returns true if the NPC is sleeping. Relates to sleep. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L485 |
Name | <NPCTag.is_sneaking> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC is currently sneaking. Only works for player-type NPCs. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L774 |
Name | <NPCTag.is_spawned> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC is spawned. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L927 |
Name | <NPCTag.list_anchors> |
Returns | ListTag |
Description | Returns a list of anchor names currently assigned to the NPC. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L585 |
Name | <NPCTag.lookclose> |
Returns | ElementTag(Boolean) |
Mechanism | NPCTag.lookclose |
Description | Returns whether the NPC has lookclose enabled. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L947 |
Name | <NPCTag.name_hologram_npc> |
Returns | NPCTag |
Description | Returns the NPCTag of a hologram attached to this NPC as its nameplate (if any).
Note that this can regenerate at any time. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L684 |
Name | <NPCTag.navigator_look_at> |
Returns | LocationTag |
Mechanism | NPCTag.navigator_look_at |
Description | Returns the location the NPC will currently look at while moving, if any. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1185 |
Name | <NPCTag.nickname> |
Returns | ElementTag |
Description | Returns the NPC's display name, as set by the Nickname trait (or the default NPC name). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L496 |
Name | <NPCTag.owner> |
Returns | PlayerTag |
Mechanism | NPCTag.owner |
Description | Returns the owner of the NPC as a PlayerTag, if any. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L821 |
Name | <NPCTag.path_distance_margin> |
Returns | ElementTag(Decimal) |
Mechanism | NPCTag.path_distance_margin |
Description | Returns the NPC's current pathfinding distance margin. That is, how close it needs to get to individual points along its path. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1065 |
Name | <NPCTag.pose[<name>]> |
Returns | LocationTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L667 |
Name | <NPCTag.previous_location> |
Returns | LocationTag |
Description | Returns the NPC's previous navigated location. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L448 |
Name | <NPCTag.pushable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC is pushable. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L548 |
Name | <NPCTag.range> |
Returns | ElementTag(Decimal) |
Mechanism | NPCTag.range |
Description | Returns the NPC's current maximum pathfinding range. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1109 |
Name | <NPCTag.registry_name> |
Returns | ElementTag |
Description | Returns the name of the registry this NPC came from. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1240 |
Name | <NPCTag.script> |
Returns | ScriptTag |
Description | Deprecated variant of NPCTag.scripts. |
Generated Example |
|
Deprecated | Use 'NPCTag.scripts' (plural) instead. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1009 |
Name | <NPCTag.scripts> |
Returns | ListTag(ScriptTag) |
Description | Returns a list of all assignment scripts on the NPC. Returns null if none. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1032 |
Name | <NPCTag.skin> |
Returns | ElementTag |
Mechanism | NPCTag.skin |
Description | Returns the NPC's custom skin, if any. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L889 |
Name | <NPCTag.skin_blob> |
Returns | ElementTag |
Mechanism | NPCTag.skin_blob |
Description | Returns the NPC's custom skin blob, if any.
In the format: "texture;signature" (two values separated by a semicolon). See also Player Entity Skins (Skin Blobs). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L851 |
Name | <NPCTag.skull_skin> |
Returns | ElementTag |
Description | Returns 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 Player Entity Skins (Skin Blobs). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L873 |
Name | <NPCTag.speed> |
Returns | ElementTag(Decimal) |
Mechanism | NPCTag.speed |
Description | Returns the current speed of the NPC. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1098 |
Name | <NPCTag.speed_modifier> |
Returns | ElementTag(Decimal) |
Description | Returns the NPC's current movement speed modifier (a multiplier applied over their base speed). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1142 |
Name | <NPCTag.target_entity> |
Returns | EntityTag |
Description | Returns the entity being targeted by the NPC's current navigation (if any). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1227 |
Name | <NPCTag.target_location> |
Returns | LocationTag |
Description | Returns the location the NPC is currently navigating towards (if any). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1172 |
Name | <NPCTag.target_type> |
Returns | ElementTag |
Description | Returns the entity type of the NPC's current navigation target (if any). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1214 |
Name | <NPCTag.targetable> |
Returns | ElementTag(Boolean) |
Mechanism | NPCTag.targetable |
Description | Returns whether the NPC is targetable. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L980 |
Name | <NPCTag.teleport_on_stuck> |
Returns | ElementTag(Boolean) |
Mechanism | NPCTag.teleport_on_stuck |
Description | Returns whether the NPC teleports when it is stuck. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L992 |
Name | <NPCTag.traits> |
Returns | ListTag |
Description | Returns a list of all of the NPC's traits. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L518 |
Name | <NPCTag.use_new_finder> |
Returns | ElementTag(Boolean) |
Mechanism | NPCTag.use_new_finder |
Description | If 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1076 |
Name | <NPCTag.wander_delay> |
Returns | DurationTag |
Mechanism | NPCTag.wander_delay |
Description | Returns the delay for the NPC's wander Waypoint Provider, if that provider is in use. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1298 |
Name | <NPCTag.wander_xrange> |
Returns | ElementTag(Number) |
Mechanism | NPCTag.wander_xrange |
Description | Returns the xrange for the NPC's wander Waypoint Provider, if that provider is in use. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1313 |
Name | <NPCTag.wander_yrange> |
Returns | ElementTag(Number) |
Mechanism | NPCTag.wander_yrange |
Description | Returns the yrange for the NPC's wander Waypoint Provider, if that provider is in use. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1328 |
Name | <NPCTag.waypoint_provider> |
Returns | ElementTag |
Mechanism | NPCTag.waypoint_provider |
Description | Returns the NPC's current Waypoint Provider type (default types: linear, wander, guided). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L1283 |
Name | <NPCTag.faction> |
Returns | FactionTag |
Description | Returns the NPC's faction. |
Generated Example |
|
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/factions/FactionsNPCProperties.java#L116 |
Name | <NPCTag.factions.power> |
Returns | ElementTag(Decimal) |
Description | Returns the NPC's power level. |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/factions/FactionsNPCProperties.java#L73 |
Name | <NPCTag.factions.role> |
Returns | ElementTag |
Description | Returns the NPC's role in their faction.
Note: In modern Factions these are called ranks instead of roles. |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/factions/FactionsNPCProperties.java#L86 |
Name | <NPCTag.factions.title> |
Returns | ElementTag |
Description | Returns the NPC's title. |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/factions/FactionsNPCProperties.java#L100 |
Name | <NPCTag.sentinel.accuracy> |
Returns | ElementTag(Decimal) |
Description | Returns the accuracy value of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L519 |
Name | <NPCTag.sentinel.armor> |
Returns | ElementTag(Decimal) |
Description | Returns the current armor value (with calculations if needed) of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L190 |
Name | <NPCTag.sentinel.attack_rate> |
Returns | DurationTag |
Description | Returns the attack rate of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L267 |
Name | <NPCTag.sentinel.attack_rate_ranged> |
Returns | DurationTag |
Description | Returns the attack rate (at range) of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L278 |
Name | <NPCTag.sentinel.autoswitch> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Sentinel NPC will automatically switch weapons. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L494 |
Name | <NPCTag.sentinel.avoid_range> |
Returns | ElementTag(Decimal) |
Description | Returns the avoid range of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L135 |
Name | <NPCTag.sentinel.avoid_return_point> |
Returns | LocationTag |
Description | Returns the avoid return point of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L373 |
Name | <NPCTag.sentinel.avoids> |
Returns | ListTag |
Description | Returns a list of all targets currently avoided by this Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L124 |
Name | <NPCTag.sentinel.chase_range> |
Returns | ElementTag(Decimal) |
Description | Returns the chase range of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L348 |
Name | <NPCTag.sentinel.chasing> |
Returns | EntityTag |
Description | Returns the entity currently being chased by this Sentinel NPC (if any). |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L88 |
Name | <NPCTag.sentinel.close_chase> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Sentinel NPC will chase with close weapons. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L223 |
Name | <NPCTag.sentinel.damage> |
Returns | ElementTag(Decimal) |
Description | Returns the current damage value (with calculations if needed) of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L168 |
Name | <NPCTag.sentinel.drop_chances> |
Returns | ListTag |
Description | Returns a list of drop chances for items that this Sentinel NPC will drop on death. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L402 |
Name | <NPCTag.sentinel.drops> |
Returns | ListTag(ItemTag) |
Description | Returns a list of items that this Sentinel NPC will drop on death. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L387 |
Name | <NPCTag.sentinel.enemy_drops> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Sentinel NPC has enemy-drops enabled. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L417 |
Name | <NPCTag.sentinel.enemy_target_time> |
Returns | DurationTag |
Description | Returns how long a Sentinel NPC will wait before abandoning an unseen target. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L428 |
Name | <NPCTag.sentinel.fightback> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Sentinel NPC will fight back. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L245 |
Name | <NPCTag.sentinel.greet_range> |
Returns | ElementTag(Decimal) |
Description | Returns the greeting range of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L472 |
Name | <NPCTag.sentinel.greet_rate> |
Returns | DurationTag |
Description | Returns the greeting rate of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L483 |
Name | <NPCTag.sentinel.greeting> |
Returns | ElementTag |
Description | Returns the greeting message of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L461 |
Name | <NPCTag.sentinel.guard_distance_minimum> |
Returns | ElementTag(Decimal) |
Description | Returns the minimum-guard-distance value of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L552 |
Name | <NPCTag.sentinel.guard_selection_range> |
Returns | ElementTag(Decimal) |
Description | Returns the guard-selection-range value of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L563 |
Name | <NPCTag.sentinel.guarding> |
Returns | EntityTag |
Description | Returns the entity currently being guarded by this Sentinel NPC (if any). |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L300 |
Name | <NPCTag.sentinel.heal_rate> |
Returns | DurationTag |
Description | Returns the heal rate of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L289 |
Name | <NPCTag.sentinel.health> |
Returns | ElementTag(Decimal) |
Description | Returns the max health of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L201 |
Name | <NPCTag.sentinel.ignores> |
Returns | ListTag |
Description | Returns a list of all targets currently ignored by this Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L113 |
Name | <NPCTag.sentinel.invincible> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Sentinel NPC is invincible. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L234 |
Name | <NPCTag.sentinel.needs_ammo> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Sentinel NPC needs ammo. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L315 |
Name | <NPCTag.sentinel.range> |
Returns | ElementTag(Decimal) |
Description | Returns the range of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L146 |
Name | <NPCTag.sentinel.ranged_chase> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Sentinel NPC will chase with ranged weapons. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L212 |
Name | <NPCTag.sentinel.raw_armor> |
Returns | ElementTag(Decimal) |
Description | Returns the raw armor value (no calculating) of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L179 |
Name | <NPCTag.sentinel.raw_damage> |
Returns | ElementTag(Decimal) |
Description | Returns the raw damage value (no calculating) of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L157 |
Name | <NPCTag.sentinel.reach> |
Returns | ElementTag(Decimal) |
Description | Returns the hand reach value of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L541 |
Name | <NPCTag.sentinel.realistic> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Sentinel NPC is set to realistic targeting mode. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L530 |
Name | <NPCTag.sentinel.respawn_time> |
Returns | DurationTag |
Description | Returns how long a Sentinel NPC will wait after death before respawning. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L337 |
Name | <NPCTag.sentinel.runaway> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Sentinel NPC will run away. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L256 |
Name | <NPCTag.sentinel.safe_shot> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Sentinel NPC has safe-shot enabled. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L326 |
Name | <NPCTag.sentinel.spawn_point> |
Returns | LocationTag |
Description | Returns the respawn point of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L359 |
Name | <NPCTag.sentinel.speed> |
Returns | ElementTag(Decimal) |
Description | Returns the movement speed of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L439 |
Name | <NPCTag.sentinel.squad> |
Returns | ElementTag |
Description | Returns the name of this Sentinel NPC's squad (if any). |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L505 |
Name | <NPCTag.sentinel.targets> |
Returns | ListTag |
Description | Returns a list of all targets currently targeted by this Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L102 |
Name | <NPCTag.sentinel.warning> |
Returns | ElementTag |
Description | Returns the warning message of a Sentinel NPC. |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L450 |
Name | <NPCTag.sentinel.weapon_damage> |
Returns | ListTag |
Description | Returns a list-mapping of custom weapon damage values of a Sentinel NPC.
For example, "stick/5|stone/3" |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L574 |
Name | <NPCTag.sentinel.weapon_redirects> |
Returns | ListTag |
Description | Returns a list-mapping of custom weapon redirect values of a Sentinel NPC.
For example, "stick/bow|stone/diamond_sword" |
Requires | Depenizen, Sentinel |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/sentinel/SentinelNPCProperties.java#L590 |
Name | <NPCTag.worldguard_wander_region> |
Returns | WorldGuardRegionTag |
Mechanism | NPCTag.worldguard_wander_region |
Description | If the NPC's waypoint provider is set to wander (NPCTag.waypoint_provider),
returns the current WorldGuard region that wandering is restricted to, if any. |
Generated Example |
|
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardNPCExtensions.java#L13 |
Name | <ObjectTag.advanced_matches[<matcher>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the object matches some matcher text, using the system described at Advanced Object Matching. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L261 |
Name | <ObjectTag.as[<type>]> |
Returns | ObjectTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L295 |
Name | <ObjectTag.exists> |
Returns | ElementTag(Boolean) |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L116 |
Name | <ObjectTag.if_null[<object>]> |
Returns | ObjectTag |
Description | If 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. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L100 |
Name | <ObjectTag.is_truthy> |
Returns | ElementTag(Boolean) |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L127 |
Name | <ObjectTag.null_if[<tag>]> |
Returns | ObjectTag |
Description | Parses 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 ObjectTag.null_if_tag. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L141 |
Name | <ObjectTag.null_if_tag[<dynamic-boolean>]> |
Returns | ObjectTag |
Description | Parses 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 ObjectTag.null_if_tag. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L176 |
Name | <ObjectTag.object_type> |
Returns | ElementTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L35 |
Name | <ObjectTag.prefix> |
Returns | ElementTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L23 |
Name | <ObjectTag.proc[<procedure_script_name>]> |
Returns | ObjectTag |
Description | Returns the 'determine' result of a procedure script, passing this object in as the context value. |
Source | https://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>|...]> |
Returns | ObjectTag |
Description | Returns the 'determine' result of a procedure script, passing this object in as the first context value, with a list of additional context values. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L77 |
Name | <ObjectTag.reflected_internal_object> |
Returns | JavaReflectedObjectTag |
Description | Returns the reflected internal Java object for a given ObjectTag. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L274 |
Name | <ObjectTag.repeat_as_list[<#>]> |
Returns | ListTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L240 |
Name | <ObjectTag.is[<operator>].than[<object>]> |
Returns | ElementTag(Boolean) |
Description | Takes 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 operator. Equivalent to ObjectTag.is.to |
Group | comparison |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L210 |
Name | <ObjectTag.is[<operator>].to[<object>]> |
Returns | ElementTag(Boolean) |
Description | Takes 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 operator. Equivalent to ObjectTag.is.than |
Group | comparison |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L200 |
Name | <PlayerTag.advancements> |
Returns | ListTag |
Description | Returns a list of the names of all advancements the player has completed. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2128 |
Name | <PlayerTag.ban_created_time> |
Returns | TimeTag |
Description | Returns when the player's ban was created, if they are banned. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1165 |
Name | <PlayerTag.ban_expiration_time> |
Returns | TimeTag |
Description | Returns the expiration of the player's ban, if they are banned.
Potentially can be null. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1119 |
Name | <PlayerTag.ban_reason> |
Returns | ElementTag |
Description | Returns the reason for the player's ban, if they are banned. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1148 |
Name | <PlayerTag.ban_source> |
Returns | ElementTag |
Description | Returns the source of the player's ban, if they are banned. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1193 |
Name | <PlayerTag.bed_spawn> |
Returns | LocationTag |
Mechanism | PlayerTag.bed_spawn_location |
Description | Returns the location of the player's bed spawn location, or null if it doesn't exist.
Works with offline players. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L818 |
Name | <PlayerTag.bossbar_ids> |
Returns | ListTag |
Description | Returns a list of all bossbars from bossbar that this player can see.
Does not list bossbars created by any other source. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2510 |
Name | <PlayerTag.calculate_xp> |
Returns | ElementTag(Number) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2183 |
Name | <PlayerTag.calculated_bed_spawn> |
Returns | LocationTag |
Description | Returns 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 PlayerTag.bed_spawn for the actual spawn location they have set. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L831 |
Name | <PlayerTag.can_fly> |
Returns | ElementTag(Boolean) |
Mechanism | PlayerTag.can_fly |
Description | Returns whether the player is allowed to fly.
Works with offline players. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1903 |
Name | <PlayerTag.chat_history[(<#>)]> |
Returns | ElementTag |
Description | Returns the last thing the player said.
If a number is specified, returns an earlier thing the player said. Works with offline players. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L691 |
Name | <PlayerTag.chat_history_list> |
Returns | ListTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L679 |
Name | <PlayerTag.chunk_loaded[<chunk>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has the chunk loaded on their client. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1882 |
Name | <PlayerTag.client_brand> |
Returns | ElementTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1483 |
Name | <PlayerTag.compass_target> |
Returns | LocationTag |
Description | Returns the location of the player's compass target. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1868 |
Name | <PlayerTag.discovered_recipes> |
Returns | ListTag |
Description | Returns a list of the recipes the player has discovered, in the Namespace:Key format, for example "minecraft:gold_nugget". |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1545 |
Name | <PlayerTag.display_name> |
Returns | ElementTag |
Mechanism | PlayerTag.display_name |
Description | Returns the display name of the player, which may contain prefixes and suffixes, colors, etc. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1457 |
Name | <PlayerTag.enderchest> |
Returns | InventoryTag |
Description | Gets the player's enderchest inventory.
Works with offline players. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1519 |
Name | <PlayerTag.entity> |
Returns | EntityTag |
Description | Returns the EntityTag object of the player.
(Note: This should never actually be needed. PlayerTags are considered valid EntityTags.) |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1797 |
Name | <PlayerTag.exhaustion> |
Returns | ElementTag(Decimal) |
Mechanism | PlayerTag.exhaustion |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L905 |
Name | <PlayerTag.fake_block[<location>]> |
Returns | MaterialTag |
Description | Returns the fake material that the player will see at the input location, as set by showfake or connected commands.
Works best alongside PlayerTag.fake_block_locations. Returns null if the player doesn't have a fake block at the location. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2320 |
Name | <PlayerTag.fake_block_locations> |
Returns | ListTag(LocationTag) |
Description | Returns a list of locations that the player will see a fake block at, as set by showfake or connected commands. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2303 |
Name | <PlayerTag.fake_entities> |
Returns | ListTag(EntityTag) |
Description | Returns a list of fake entities the player can see, as set by fakespawn.
Note that these entities are not being tracked by the server, so many operations may not be possible on them. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2343 |
Name | <PlayerTag.first_played_time> |
Returns | TimeTag |
Description | Returns the time of when the player first logged on to this server.
Works with offline players. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L879 |
Name | <PlayerTag.fish_hook> |
Returns | EntityTag |
Description | Returns the fishing hook a player has cast (if any). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2440 |
Name | <PlayerTag.fly_speed> |
Returns | ElementTag(Decimal) |
Mechanism | PlayerTag.fly_speed |
Description | Returns the speed the player can fly at.
Default value is '0.2'. Works with offline players. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1920 |
Name | <PlayerTag.food_level> |
Returns | ElementTag(Number) |
Mechanism | PlayerTag.food_level |
Description | Returns the current food level (aka hunger) of the player. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2004 |
Name | <PlayerTag.formatted_food_level[(<max>)]> |
Returns | ElementTag |
Mechanism | PlayerTag.food_level |
Description | Returns a 'formatted' value of the player's current food level.
May be 'starving', 'famished', 'parched, 'hungry', or 'healthy'. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1972 |
Name | <PlayerTag.gamemode> |
Returns | ElementTag |
Mechanism | PlayerTag.gamemode |
Description | Returns the name of the gamemode the player is currently set to.
Works with offline players. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2039 |
Name | <PlayerTag.groups[(<world>)]> |
Returns | ListTag |
Description | Returns a list of all groups the player is in.
May work with offline players, depending on permission plugin. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1088 |
Name | <PlayerTag.has_advancement[<advancement>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has completed the specified advancement. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2107 |
Name | <PlayerTag.has_permission[permission.node]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has the specified node.
(May work with offline players, depending on your permissions system.) |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1309 |
Name | <PlayerTag.has_permission[permission.node].global> |
Returns | ElementTag(Boolean) |
Description | Returns 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.) |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1319 |
Name | <PlayerTag.has_permission[permission.node].world[<world>]> |
Returns | ElementTag(Boolean) |
Description | Returns 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.) |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1341 |
Name | <PlayerTag.has_played_before> |
Returns | ElementTag(Boolean) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L894 |
Name | <PlayerTag.health_is_scaled> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player's health bar is currently being scaled. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L937 |
Name | <PlayerTag.health_scale> |
Returns | ElementTag(Decimal) |
Mechanism | PlayerTag.health_scale |
Description | Returns the current scale for the player's health bar. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L947 |
Name | <PlayerTag.held_item_slot> |
Returns | ElementTag(Number) |
Description | Returns the slot location of the player's selected item. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1600 |
Name | <PlayerTag.in_group[<group_name>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is in the specified group.
(May work with offline players, depending on your permissions system.) |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1243 |
Name | <PlayerTag.in_group[<group_name>].global> |
Returns | ElementTag(Boolean) |
Description | Returns 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.) |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1260 |
Name | <PlayerTag.in_group[<group_name>].world[<world>]> |
Returns | ElementTag(Boolean) |
Description | Returns 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.) |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1276 |
Name | <PlayerTag.inventory> |
Returns | InventoryTag |
Description | Returns a InventoryTag of the player's current inventory.
Works with offline players. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1508 |
Name | <PlayerTag.ip> |
Returns | ElementTag |
Description | Returns the player's IP address host name. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1822 |
Name | <PlayerTag.ip_address> |
Returns | ElementTag |
Description | Returns the player's IP address, without port or hostname. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1812 |
Name | <PlayerTag.ip.address> |
Returns | ElementTag |
Description | Returns the player's IP address with port (usually including an rdns host path). |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1841 |
Name | <PlayerTag.ip.address_only> |
Returns | ElementTag |
Description | Returns the player's IP address with port (without triggering an rdns lookup). |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1829 |
Name | <PlayerTag.is_banned> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is banned. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1011 |
Name | <PlayerTag.is_blocking> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is currently blocking. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2054 |
Name | <PlayerTag.is_flying> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is currently flying. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2074 |
Name | <PlayerTag.is_online> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is currently online.
Works with offline players (returns false in that case). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1031 |
Name | <PlayerTag.is_op> |
Returns | ElementTag(Boolean) |
Mechanism | PlayerTag.is_op |
Description | Returns whether the player is a full server operator.
Works with offline players. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1042 |
Name | <PlayerTag.is_sneaking> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is currently sneaking. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2084 |
Name | <PlayerTag.is_sprinting> |
Returns | ElementTag(Boolean) |
Mechanism | PlayerTag.sprinting |
Description | Returns whether the player is currently sprinting. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2096 |
Name | <PlayerTag.item_cooldown[<material>]> |
Returns | DurationTag |
Description | Returns the cooldown duration remaining on player's material. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L865 |
Name | <PlayerTag.item_on_cursor> |
Returns | ItemTag |
Mechanism | PlayerTag.item_on_cursor |
Description | Returns the item on the player's cursor, if any. This includes
chest interfaces, inventories, and hotbars, etc. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1588 |
Name | <PlayerTag.last_action_time> |
Returns | TimeTag |
Description | Returns the time of the last direct input from the player. Internally used with server.idle_timeout. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2468 |
Name | <PlayerTag.last_death_location> |
Returns | LocationTag |
Mechanism | PlayerTag.last_death_location |
Description | Returns the location where the player last died, if any.
Works with offline players. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2576 |
Name | <PlayerTag.last_played_time> |
Returns | TimeTag |
Description | Returns the time of when the player was last seen.
Works with offline players. Not very useful for online players. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1066 |
Name | <PlayerTag.list_name> |
Returns | ElementTag |
Mechanism | PlayerTag.player_list_name |
Description | Returns the name of the player as shown in the player list. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1446 |
Name | <PlayerTag.locale> |
Returns | ElementTag |
Description | Returns the current locale of the player. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1494 |
Name | <PlayerTag.main_hand> |
Returns | ElementTag |
Description | Returns the player's main hand, either LEFT or RIGHT. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1765 |
Name | <PlayerTag.nameplate> |
Returns | ElementTag |
Description | Returns the displayed text in the nameplate of the player. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1854 |
Name | <PlayerTag.open_inventory> |
Returns | InventoryTag |
Description | Gets the inventory the player currently has open. If the player has no open
inventory, this returns the player's inventory. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1534 |
Name | <PlayerTag.packets_received> |
Returns | ElementTag(Number) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2428 |
Name | <PlayerTag.packets_sent> |
Returns | ElementTag(Number) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2416 |
Name | <PlayerTag.ping> |
Returns | ElementTag(Number) |
Description | Returns the player's current ping. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2064 |
Name | <PlayerTag.saturation> |
Returns | ElementTag(Decimal) |
Mechanism | PlayerTag.saturation |
Description | Returns the current food saturation of the player.
Works with offline players. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1955 |
Name | <PlayerTag.scoreboard_id> |
Returns | ElementTag |
Description | Returns the ID of the scoreboard from scoreboard that a player is currently viewing, if any. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2480 |
Name | <PlayerTag.scoreboard_team_name[(<board>)]> |
Returns | ElementTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2494 |
Name | <PlayerTag.selected_npc> |
Returns | NPCTag |
Mechanism | PlayerTag.selected_npc |
Description | Returns the NPCTag that the player currently has selected with '/npc select', null if no NPC selected. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1779 |
Name | <PlayerTag.selected_trade_index> |
Returns | ElementTag(Number) |
Description | Returns the index of the trade the player is currently viewing, if any. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1559 |
Name | <PlayerTag.sidebar_lines> |
Returns | ListTag |
Description | Returns the current lines set on the player's Sidebar via sidebar. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1619 |
Name | <PlayerTag.sidebar_scores> |
Returns | ListTag |
Description | Returns the current scores set on the player's Sidebar via sidebar,
in the same order as PlayerTag.sidebar_lines. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1647 |
Name | <PlayerTag.sidebar_title> |
Returns | ElementTag |
Description | Returns the current title set on the player's Sidebar via sidebar. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1633 |
Name | <PlayerTag.skin_blob> |
Returns | ElementTag |
Mechanism | PlayerTag.skin_blob |
Description | Returns the player's current skin blob.
In the format: "texture;signature" (two values separated by a semicolon). See also Player Entity Skins (Skin Blobs). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1699 |
Name | <PlayerTag.skin_model> |
Returns | ElementTag |
Description | Returns the player's skin model, either CLASSIC or SLIM. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2563 |
Name | <PlayerTag.skull_item> |
Returns | ItemTag |
Description | Returns a Player_Head item with the skin of the player.
See also Player Entity Skins (Skin Blobs). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1729 |
Name | <PlayerTag.skull_skin> |
Returns | ElementTag |
Description | Returns 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 Player Entity Skins (Skin Blobs). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1712 |
Name | <PlayerTag.spawn_forced> |
Returns | ElementTag(Boolean) |
Mechanism | PlayerTag.spawn_forced |
Description | Returns whether the player's bed spawn location is forced (ie still valid even if a bed is missing). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2454 |
Name | <PlayerTag.spectator_target> |
Returns | EntityTag |
Mechanism | PlayerTag.spectator_target |
Description | Returns the entity that a spectator-mode player is currently spectating, if any. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2398 |
Name | <PlayerTag.statistic[<statistic>]> |
Returns | ElementTag(Number) |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1377 |
Name | <PlayerTag.statistic[<statistic>].qualifier[<material>/<entity>]> |
Returns | ElementTag(Number) |
Description | Returns 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 server.statistic_type. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1398 |
Name | <PlayerTag.tab_completions[<command>]> |
Returns | ListTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2527 |
Name | <PlayerTag.target[(<matcher>)]> |
Returns | EntityTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L774 |
Name | <PlayerTag.target[(<matcher>)].within[(<#.#>)]> |
Returns | EntityTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L786 |
Name | <PlayerTag.time> |
Returns | ElementTag(Number) |
Description | Returns the time the player is currently experiencing.
This time could differ from the time that the rest of the world is currently experiencing if time is being used on the player. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2154 |
Name | <PlayerTag.time_asleep> |
Returns | DurationTag |
Description | Returns the time the player has been asleep. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2144 |
Name | <PlayerTag.uuid> |
Returns | ElementTag |
Description | Returns the UUID of the player.
Works with offline players. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1435 |
Name | <PlayerTag.walk_speed> |
Returns | ElementTag(Decimal) |
Mechanism | PlayerTag.walk_speed |
Description | Returns the speed the player can walk at.
Works with offline players. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1938 |
Name | <PlayerTag.weather> |
Returns | ElementTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2165 |
Name | <PlayerTag.whitelisted> |
Returns | ElementTag(Boolean) |
Mechanism | PlayerTag.whitelisted |
Description | Returns whether the player is whitelisted.
Works with offline players. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1054 |
Name | <PlayerTag.xp> |
Returns | ElementTag(Decimal) |
Description | Returns the percentage of experience points to the next level. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2230 |
Name | <PlayerTag.xp_level> |
Returns | ElementTag(Number) |
Description | Returns the number of XP levels the player has.
Works with offline players. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2195 |
Name | <PlayerTag.xp_to_next_level> |
Returns | ElementTag(Number) |
Description | Returns the amount of XP the player needs to get to the next level.
Works with offline players. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2206 |
Name | <PlayerTag.xp_total> |
Returns | ElementTag(Number) |
Description | Returns 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 PlayerTag.calculate_xp. Works with offline players. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2217 |
Name | <PlayerTag.has_clientizen> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has Clientizen running on their client. |
Generated Example |
|
Group | Clientizen |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/clientizen/ClientizenBridge.java#L49 |
Name | <PlayerTag.disguise_to_self[(<player>)]> |
Returns | EntityTag |
Description | Returns 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 disguise. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2361 |
Name | <PlayerTag.areashop.owned> |
Returns | ListTag(AreaShopTag) |
Description | Returns a list of AreaShops the player owns. |
Requires | Depenizen, AreaShop |
Source | https://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>]> |
Returns | ElementTag |
Description | Returns a variable from a BetonQuest package, for the player. |
Requires | Depenizen, BetonQuest |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/betonquest/BetonQuestPlayerProperties.java#L38 |
Name | <PlayerTag.bigdoors> |
Returns | ListTag(BigDoorsDoorTag) |
Description | Returns a list of Big Doors the player is an owner of. |
Generated Example |
|
Requires | Depenizen, Big Doors |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/bigdoors/BigDoorsPlayerProperties.java#L51 |
Name | <PlayerTag.chat_prefix> |
Returns | ElementTag |
Mechanism | PlayerTag.chat_prefix |
Description | Returns the player's chat prefix.
NOTE: May work with offline players. Requires a Vault-compatible chat plugin. |
Generated Example |
|
Requires | Vault |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2255 |
Name | <PlayerTag.chat_suffix> |
Returns | ElementTag |
Mechanism | PlayerTag.chat_suffix |
Description | Returns the player's chat suffix.
NOTE: May work with offline players. Requires a Vault-compatible chat plugin. |
Generated Example |
|
Requires | Vault |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2279 |
Name | <PlayerTag.combat_damage> |
Returns | ElementTag(Decimal) |
Description | Returns the value of the combat damage factor. |
Generated Example |
|
Requires | Depenizen, Vampire |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/vampire/VampirePlayerProperties.java#L93 |
Name | <PlayerTag.combat_infect> |
Returns | ElementTag(Decimal) |
Description | Returns the value of the combat infection risk. |
Generated Example |
|
Requires | Depenizen, Vampire |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/vampire/VampirePlayerProperties.java#L82 |
Name | <PlayerTag.current_jobs> |
Returns | ListTag(JobsJobTag) |
Description | Returns a list of all jobs that the player is in. |
Generated Example |
|
Requires | Depenizen, Jobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/jobs/JobsPlayerExtensions.java#L24 |
Name | <PlayerTag.essentials_homes> |
Returns | MapTag |
Description | Returns a map of the homes of the player, with keys as the home name and values as the home location. |
Generated Example |
|
Requires | Depenizen, Essentials |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsPlayerProperties.java#L130 |
Name | <PlayerTag.faction> |
Returns | FactionTag |
Description | Returns the player's faction. |
Generated Example |
|
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/factions/FactionsPlayerProperties.java#L110 |
Name | <PlayerTag.factions.power> |
Returns | ElementTag(Decimal) |
Description | Returns the player's power level. |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/factions/FactionsPlayerProperties.java#L67 |
Name | <PlayerTag.factions.role> |
Returns | ElementTag |
Description | Returns the player's role in their faction.
Note: In modern Factions these are called ranks instead of roles. |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/factions/FactionsPlayerProperties.java#L80 |
Name | <PlayerTag.factions.title> |
Returns | ElementTag |
Description | Returns the player's title. |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/factions/FactionsPlayerProperties.java#L94 |
Name | <PlayerTag.formatted_money> |
Returns | ElementTag |
Description | Returns the formatted form of the player's money balance in the registered Economy system. |
Generated Example |
|
Requires | Vault |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L715 |
Name | <PlayerTag.god_mode> |
Returns | ElementTag(Boolean) |
Mechanism | PlayerTag.god_mode |
Description | Returns whether the player is currently in god mode. |
Generated Example |
|
Requires | Depenizen, Essentials |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsPlayerProperties.java#L71 |
Name | <PlayerTag.griefprevention.blocks> |
Returns | ElementTag(Number) |
Mechanism | PlayerTag.normal_blocks |
Description | Returns the number of normal claim blocks the player has. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/griefprevention/GriefPreventionPlayerProperties.java#L134 |
Name | <PlayerTag.griefprevention.blocks.bonus> |
Returns | ElementTag(Number) |
Mechanism | PlayerTag.bonus_blocks |
Description | Returns the number of bonus claim blocks the player has. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/griefprevention/GriefPreventionPlayerProperties.java#L110 |
Name | <PlayerTag.griefprevention.blocks.remaining> |
Returns | ElementTag(Number) |
Description | Returns the number of claim blocks the player has left. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/griefprevention/GriefPreventionPlayerProperties.java#L99 |
Name | <PlayerTag.griefprevention.blocks.total> |
Returns | ElementTag(Number) |
Description | Returns the total number of claim blocks the player has. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/griefprevention/GriefPreventionPlayerProperties.java#L122 |
Name | <PlayerTag.griefprevention.claims> |
Returns | ElementTag(Number) |
Description | Returns the number of claims the player has in GriefPrevention. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/griefprevention/GriefPreventionPlayerProperties.java#L85 |
Name | <PlayerTag.griefprevention.list_claims> |
Returns | ListTag(GriefPreventionClaimTag) |
Description | Returns a list of all claims the player has. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/griefprevention/GriefPreventionPlayerProperties.java#L70 |
Name | <PlayerTag.has_home> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has set at least one home. |
Generated Example |
|
Requires | Depenizen, Essentials |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsPlayerProperties.java#L83 |
Name | <PlayerTag.has_main_residence> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has a main Residence. |
Generated Example |
|
Requires | Depenizen, Residence |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/residence/ResidencePlayerExtensions.java#L14 |
Name | <PlayerTag.has_nation> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is part of a nation. |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyPlayerProperties.java#L67 |
Name | <PlayerTag.has_town> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is part of a town. |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyPlayerProperties.java#L78 |
Name | <PlayerTag.ignored_players> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of the ignored players of the player. |
Generated Example |
|
Requires | Depenizen, Essentials |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsPlayerProperties.java#L192 |
Name | <PlayerTag.is_afk> |
Returns | ElementTag(Boolean) |
Mechanism | PlayerTag.is_afk |
Description | Returns whether the player is AFK. |
Generated Example |
|
Requires | Depenizen, Essentials |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsPlayerProperties.java#L94 |
Name | <PlayerTag.is_infected> |
Returns | ElementTag(Boolean) |
Description | Returns true if the player is infected. |
Generated Example |
|
Requires | Depenizen, Vampire |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/vampire/VampirePlayerProperties.java#L71 |
Name | <PlayerTag.is_muted> |
Returns | ElementTag(Boolean) |
Mechanism | PlayerTag.is_muted |
Description | Returns whether the player is muted. |
Generated Example |
|
Requires | Depenizen, Essentials |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsPlayerProperties.java#L106 |
Name | <PlayerTag.is_vampire> |
Returns | ElementTag(Boolean) |
Description | Returns true if the player is a vampire. |
Generated Example |
|
Requires | Depenizen, Vampire |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/vampire/VampirePlayerProperties.java#L60 |
Name | <PlayerTag.is_vanished> |
Returns | ElementTag(Boolean) |
Mechanism | PlayerTag.vanish |
Description | Returns whether the player is vanished. |
Generated Example |
|
Requires | Depenizen, Essentials |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsPlayerProperties.java#L118 |
Name | <PlayerTag.is_vivecraft> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is running on VR or not. |
Generated Example |
|
Requires | Depenizen, ViveCraft |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/vivecraft/ViveCraftPlayerProperties.java#L12 |
Name | <PlayerTag.job[<job>]> |
Returns | JobsJobTag |
Description | Returns the job specified with the player's information attached. |
Requires | Depenizen, Jobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/jobs/JobsPlayerExtensions.java#L13 |
Name | <PlayerTag.list_mails> |
Returns | ListTag |
Description | Returns a list of mail the player currently has. |
Generated Example |
|
Requires | Depenizen, Essentials |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsPlayerProperties.java#L215 |
Name | <PlayerTag.luckperms_primary_group> |
Returns | LuckPermsGroupTag |
Description | Returns a player's primary group. |
Generated Example |
|
Requires | Depenizen, LuckPerms |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/luckperms/LuckPermsPlayerExtensions.java#L51 |
Name | <PlayerTag.luckperms_tracks> |
Returns | ListTag(LuckPermsTrackTag) |
Description | Returns a list of tracks the player is in. |
Generated Example |
|
Requires | Depenizen, LuckPerms |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/luckperms/LuckPermsPlayerExtensions.java#L18 |
Name | <PlayerTag.magicspells.known_spells> |
Returns | ListTag |
Description | Returns a list of spells the player knows, by internal name. |
Requires | Depenizen, MagicSpells |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/magicspells/MagicSpellsPlayerProperties.java#L97 |
Name | <PlayerTag.magicspells.mana> |
Returns | ElementTag(Number) |
Description | Returns the mana of the player. |
Requires | Depenizen, MagicSpells |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/magicspells/MagicSpellsPlayerProperties.java#L65 |
Name | <PlayerTag.magicspells.max_mana> |
Returns | ElementTag(Number) |
Description | Returns the maximum mana of the player. |
Requires | Depenizen, MagicSpells |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/magicspells/MagicSpellsPlayerProperties.java#L81 |
Name | <PlayerTag.main_residence> |
Returns | ResidenceTag |
Description | Returns the player's current main Residence if they have one. |
Generated Example |
|
Requires | Depenizen, Residence |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/residence/ResidencePlayerExtensions.java#L26 |
Name | <PlayerTag.mcmmo.level[(<skill>)]> |
Returns | ElementTag(Number) |
Description | Returns the player's level in a skill.
If no skill is specified, this returns the player's overall level. |
Requires | Depenizen, mcMMO |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mcmmo/McMMOPlayerProperties.java#L64 |
Name | <PlayerTag.mcmmo.party> |
Returns | ElementTag |
Description | Returns the name of the player's party. |
Requires | Depenizen, mcMMO |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mcmmo/McMMOPlayerProperties.java#L95 |
Name | <PlayerTag.mcmmo.rank[(<skill>)]> |
Returns | ElementTag(Number) |
Description | Returns the player's current rank in a skill.
If no skill is specified, this returns the player's overall rank. |
Requires | Depenizen, mcMMO |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mcmmo/McMMOPlayerProperties.java#L168 |
Name | <PlayerTag.mcmmo.xp[<skill>]> |
Returns | ElementTag(Number) |
Description | Returns the player's amount of experience in a skill. |
Requires | Depenizen, mcMMO |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mcmmo/McMMOPlayerProperties.java#L150 |
Name | <PlayerTag.mcmmo.xp[<skill>].level> |
Returns | ElementTag(Number) |
Description | Returns the player's experience level in a skill. |
Requires | Depenizen, mcMMO |
Source | https://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> |
Returns | ElementTag(Number) |
Description | Returns the amount of experience a player needs to level up in a skill. |
Requires | Depenizen, mcMMO |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mcmmo/McMMOPlayerProperties.java#L114 |
Name | <PlayerTag.mobarena.class> |
Returns | ElementTag |
Description | Returns the name of the class the player is using.
NOTE: requires the player to be in an arena. |
Requires | Depenizen, MobArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mobarena/MobArenaPlayerProperties.java#L97 |
Name | <PlayerTag.mobarena.current_arena> |
Returns | MobArenaArenaTag |
Description | Returns the arena the player is in.
NOTE: requires the player to be in an arena. |
Requires | Depenizen, MobArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mobarena/MobArenaPlayerProperties.java#L85 |
Name | <PlayerTag.mobarena.in_arena> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is in an arena. |
Requires | Depenizen, MobArena |
Source | https://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> |
Returns | ElementTag(Number) |
Description | Returns the amount of damage the player has dealt in the arena. |
Requires | Depenizen, MobArena |
Source | https://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> |
Returns | ElementTag(Number) |
Description | Returns the amount of damage the player has taken in the arena. |
Requires | Depenizen, MobArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mobarena/MobArenaPlayerProperties.java#L149 |
Name | <PlayerTag.mobarena.stats[<mobarena>].kills> |
Returns | ElementTag(Number) |
Description | Returns the number of kills the player has in the arena. |
Requires | Depenizen, MobArena |
Source | https://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> |
Returns | ElementTag(Number) |
Description | Returns the wave the player reached in their last match in the arena. |
Requires | Depenizen, MobArena |
Source | https://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> |
Returns | ElementTag(Number) |
Description | Returns the number of times the player has hit an enemy in the arena. |
Requires | Depenizen, MobArena |
Source | https://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> |
Returns | ElementTag(Number) |
Description | Returns the number of times the player has swung their weapon in the arena. |
Requires | Depenizen, MobArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mobarena/MobArenaPlayerProperties.java#L171 |
Name | <PlayerTag.mode_list> |
Returns | ListTag |
Description | Returns the player's towny modes as a list. |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyPlayerProperties.java#L89 |
Name | <PlayerTag.money> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of money the player has with the registered Economy system.
May work offline depending on economy provider. |
Generated Example |
|
Requires | Vault |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L732 |
Name | <PlayerTag.mute_timeout> |
Returns | DurationTag |
Description | Returns how much time is left until the player is unmuted. |
Generated Example |
|
Requires | Depenizen, Essentials |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsPlayerProperties.java#L226 |
Name | <PlayerTag.mythic_variable[<name>]> |
Returns | ElementTag |
Description | Returns the value of a MythicMobs variable for this player. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mythicmobs/MythicMobsPlayerProperties.java#L55 |
Name | <PlayerTag.mythic_variable_map> |
Returns | MapTag |
Mechanism | PlayerTag.mythic_variable_map |
Description | Returns a map of the player's variables. |
Generated Example |
|
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/mythicmobs/MythicMobsPlayerProperties.java#L66 |
Name | <PlayerTag.nation> |
Returns | NationTag |
Description | Returns the player's nation. |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyPlayerProperties.java#L119 |
Name | <PlayerTag.nation_ranks> |
Returns | ListTag |
Description | Returns the player's nation ranks. |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyPlayerProperties.java#L104 |
Name | <PlayerTag.nbs_is_playing> |
Returns | ElementTag(Boolean) |
Description | Returns true if the player is currently listening to a note block song. |
Generated Example |
|
Requires | Depenizen, NoteBlockAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/noteblockapi/NoteBlockAPIPlayerProperties.java#L52 |
Name | <PlayerTag.ncp.infractions> |
Returns | ElementTag(Number) |
Description | Returns the number of infractions this player has with NoCheatPlus
NOTE: Cannot guarantee the accuracy of this tag, due to lack of API in NoCheatPlus. |
Requires | Depenizen, NoCheatPlus |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/nocheatplus/NoCheatPlusPlayerProperties.java#L58 |
Name | <PlayerTag.playerpoints_points> |
Returns | ElementTag(Number) |
Description | Returns the amount of points the player has. Only works on online players. |
Generated Example |
|
Requires | Depenizen, PlayerPoints |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/playerpoints/PlayerPointsPlayerProperties.java#L53 |
Name | <PlayerTag.plotsquared_plots[<WorldTag>]> |
Returns | ListTag(PlotSquaredPlotTag) |
Description | Returns a list of plots a player has in a world. Exclude the context to get plots in all worlds. |
Generated Example |
|
Requires | Depenizen, PlotSquared |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/plotsquared/PlotSquaredPlayerProperties.java#L55 |
Name | <PlayerTag.pvparena.class> |
Returns | ElementTag |
Description | Returns the player's class if they're in an arena. Otherwise, returns null. |
Requires | Depenizen, PvP Arena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/pvparena/PVPArenaPlayerProperties.java#L90 |
Name | <PlayerTag.pvparena.in_arena[<pvparena>]> |
Returns | ElementTag(Boolean) |
Description | Returns true if the player is in the specified arena. If no arena is specified,
this returns true if the player is in any arena. |
Requires | Depenizen, PvP Arena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/pvparena/PVPArenaPlayerProperties.java#L63 |
Name | <PlayerTag.pvparena.is_ready> |
Returns | ElementTag(Boolean) |
Description | Returns true if the player is ready. |
Requires | Depenizen, PvP Arena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/pvparena/PVPArenaPlayerProperties.java#L101 |
Name | <PlayerTag.pvparena.team.name> |
Returns | ElementTag |
Description | Returns the player's team name if they're in an arena. Otherwise, returns null. |
Requires | Depenizen, PvP Arena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/pvparena/PVPArenaPlayerProperties.java#L129 |
Name | <PlayerTag.pvparena.team.player_count> |
Returns | ElementTag(Number) |
Description | Returns the number of players in the team. |
Requires | Depenizen, PvP Arena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/pvparena/PVPArenaPlayerProperties.java#L117 |
Name | <PlayerTag.pvpstats.deaths> |
Returns | ElementTag(Number) |
Description | Returns the number of times the player has died. |
Requires | Depenizen, PvP Stats |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/pvpstats/PVPStatsPlayerProperties.java#L59 |
Name | <PlayerTag.pvpstats.elo> |
Returns | ElementTag(Number) |
Description | Returns the Elo rating of the player. |
Requires | Depenizen, PvP Stats |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/pvpstats/PVPStatsPlayerProperties.java#L70 |
Name | <PlayerTag.pvpstats.kills> |
Returns | ElementTag(Number) |
Description | Returns the number of players the player has killed. |
Requires | Depenizen, PvP Stats |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/pvpstats/PVPStatsPlayerProperties.java#L81 |
Name | <PlayerTag.pvpstats.max_streak> |
Returns | ElementTag(Number) |
Description | Returns the highest kill streak of the player. |
Requires | Depenizen, PvP Stats |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/pvpstats/PVPStatsPlayerProperties.java#L103 |
Name | <PlayerTag.pvpstats.streak> |
Returns | ElementTag(Number) |
Description | Returns the current kill streak of the player. |
Requires | Depenizen, PvP Stats |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/pvpstats/PVPStatsPlayerProperties.java#L92 |
Name | <PlayerTag.quests.active> |
Returns | ElementTag(Number) |
Description | Returns the number of quests the player has active. |
Requires | Depenizen, Quests |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/quests/QuestsPlayerProperties.java#L141 |
Name | <PlayerTag.quests.active_ids> |
Returns | ListTag |
Description | Returns the IDs of quests the player has active. |
Requires | Depenizen, Quests |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/quests/QuestsPlayerProperties.java#L106 |
Name | <PlayerTag.quests.active_names> |
Returns | ListTag |
Description | Returns the names of quests the player has active. |
Requires | Depenizen, Quests |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/quests/QuestsPlayerProperties.java#L118 |
Name | <PlayerTag.quests.completed> |
Returns | ElementTag(Number) |
Description | Returns the number of quests the player has completed. |
Requires | Depenizen, Quests |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/quests/QuestsPlayerProperties.java#L130 |
Name | <PlayerTag.quests.completed_ids> |
Returns | ListTag |
Description | Returns the IDs of quests the player has completed. |
Requires | Depenizen, Quests |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/quests/QuestsPlayerProperties.java#L82 |
Name | <PlayerTag.quests.completed_names> |
Returns | ListTag |
Description | Returns the names of quests the player has completed. |
Requires | Depenizen, Quests |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/quests/QuestsPlayerProperties.java#L94 |
Name | <PlayerTag.quests.points> |
Returns | ElementTag(Number) |
Description | Returns the number of quest points the player has. |
Requires | Depenizen, Quests |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/quests/QuestsPlayerProperties.java#L68 |
Name | <PlayerTag.residences> |
Returns | ListTag(ResidenceTag) |
Description | Returns the player's current list of Residences. |
Generated Example |
|
Requires | Depenizen, Residence |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/residence/ResidencePlayerExtensions.java#L41 |
Name | <PlayerTag.skillapi.class_exp[<class>]> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of experience the player has toward the next level in the specified class. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L152 |
Name | <PlayerTag.skillapi.class_health[<class>]> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of health the player gets from the specified class. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L219 |
Name | <PlayerTag.skillapi.class_level[<class>]> |
Returns | ElementTag(Number) |
Description | Returns the level the player is in the specified class. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L186 |
Name | <PlayerTag.skillapi.class_mana[<class>]> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of mana the player gets from the specified class. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L230 |
Name | <PlayerTag.skillapi.class_maxed[<class>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has hit maximum level in the specified class. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L208 |
Name | <PlayerTag.skillapi.class_points[<class>]> |
Returns | ElementTag(Number) |
Description | Returns the number of skill points the player has in the specified class. |
Requires | Depenizen, SkillAPI |
Source | https://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>]> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of experience the player must receive to get to the next level
in the specified class. |
Requires | Depenizen, SkillAPI |
Source | https://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>]> |
Returns | ElementTag(Decimal) |
Description | Returns the total amount of experience the player has in the specified class. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L175 |
Name | <PlayerTag.skillapi.has_skill[<skill>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has the specified skill. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L102 |
Name | <PlayerTag.skillapi.in_class[<class>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player professes in the specified class. If none is specified, returns
whether the player professes in any class. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L83 |
Name | <PlayerTag.skillapi.main_class> |
Returns | SkillAPIClassTag |
Description | Returns the player's main SkillAPI class. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L69 |
Name | <PlayerTag.skillapi.mana> |
Returns | ElementTag(Decimal) |
Description | Returns the player's current amount of mana. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L113 |
Name | <PlayerTag.skillapi.max_mana> |
Returns | ElementTag(Decimal) |
Description | Returns the player's maximum amount of mana. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L124 |
Name | <PlayerTag.skillapi.skill_bind[<skill>]> |
Returns | MaterialTag |
Description | Returns the material this skill is currently bound to. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L260 |
Name | <PlayerTag.skillapi.skill_cooldown[<skill>]> |
Returns | DurationTag |
Description | Returns the remaining cooldown the player has in the specified skill. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L326 |
Name | <PlayerTag.skillapi.skill_cost[<skill>]> |
Returns | ElementTag(Number) |
Description | Returns the cost the for the player to level up the specified skill. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L304 |
Name | <PlayerTag.skillapi.skill_indicator[<skill>]> |
Returns | ItemTag |
Description | Returns the indicator item for the skill. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L249 |
Name | <PlayerTag.skillapi.skill_level[<skill>]> |
Returns | ElementTag(Number) |
Description | Returns the level the player is in the specified skill. |
Requires | Depenizen, SkillAPI |
Source | https://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>]> |
Returns | ElementTag(Number) |
Description | Returns the level the player must be to level up the specified skill. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L271 |
Name | <PlayerTag.skillapi.skill_maxed[<skill>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has reached max level in the specified skill. |
Requires | Depenizen, SkillAPI |
Source | https://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>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the specified skill is currently on cooldown for the player. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L315 |
Name | <PlayerTag.skillapi.skill_points[<skill>]> |
Returns | ElementTag(Number) |
Description | Returns how many skill points the player has invested in the specified skill. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L293 |
Name | <PlayerTag.skillapi.skill_status[<skill>]> |
Returns | ElementTag |
Description | Returns the player's current status for the specified skill.
Can be: ON_COOLDOWN, MISSING_MANA, or READY |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/skillapi/SkillAPIPlayerProperties.java#L348 |
Name | <PlayerTag.skyblock.center> |
Returns | LocationTag |
Description | Returns the centre of the player's skyblock. |
Requires | Depenizen, A SkyBlock |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/askyblock/ASkyBlockPlayerProperties.java#L84 |
Name | <PlayerTag.skyblock.has_skyblock> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has a skyblock. |
Requires | Depenizen, A SkyBlock |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/askyblock/ASkyBlockPlayerProperties.java#L71 |
Name | <PlayerTag.skyblock.level> |
Returns | ElementTag(Number) |
Description | Returns the level of the player's skyblock. |
Requires | Depenizen, A SkyBlock |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/askyblock/ASkyBlockPlayerProperties.java#L121 |
Name | <PlayerTag.skyblock.members> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of members of the player's skyblock. |
Requires | Depenizen, A SkyBlock |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/askyblock/ASkyBlockPlayerProperties.java#L106 |
Name | <PlayerTag.skyblock.spawn_point> |
Returns | LocationTag |
Description | Returns the spawnpoint of the player's skyblock. |
Requires | Depenizen, A SkyBlock |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/askyblock/ASkyBlockPlayerProperties.java#L95 |
Name | <PlayerTag.socialspy> |
Returns | ElementTag(Boolean) |
Mechanism | PlayerTag.socialspy |
Description | Returns whether the player has SocialSpy enabled. |
Generated Example |
|
Requires | Depenizen, Essentials |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/essentials/EssentialsPlayerProperties.java#L238 |
Name | <PlayerTag.town> |
Returns | TownTag |
Description | Returns the player's town. |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyPlayerProperties.java#L157 |
Name | <PlayerTag.town_ranks> |
Returns | ListTag |
Description | Returns the player's town ranks. |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyPlayerProperties.java#L142 |
Name | <PlayerTag.townychat.channels> |
Returns | ListTag |
Description | Returns a list of all channels the player is in. |
Requires | Depenizen, Towny |
Source | https://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>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has permissions to join the specified channel. |
Requires | Depenizen, Towny |
Source | https://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>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is muted in the specified channel. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyChatPlayerProperties.java#L83 |
Name | <PlayerTag.viaversion> |
Returns | ElementTag(Number) |
Description | Deprecated in favor of PlayerTag.viaversion_protocol. |
Generated Example |
|
Requires | Depenizen, ViaVersion |
Deprecated | Use 'PlayerTag.viaversion_protocol' |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/viaversion/ViaVersionPlayerExtensions.java#L12 |
Name | <PlayerTag.viaversion_protocol> |
Returns | ElementTag(Number) |
Description | Returns the protocol version number of the player's client.
See https://wiki.vg/Protocol_version_numbers as a reference list. See also PlayerTag.viaversion_version |
Generated Example |
|
Requires | Depenizen, ViaVersion |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/viaversion/ViaVersionPlayerExtensions.java#L21 |
Name | <PlayerTag.viaversion_version> |
Returns | ElementTag |
Description | Returns the player's client version ("1.19.4", "1.18.2"...).
See also PlayerTag.viaversion_protocol |
Generated Example |
|
Requires | Depenizen, ViaVersion |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/viaversion/ViaVersionPlayerExtensions.java#L34 |
Name | <PlayerTag.vivecraft> |
Returns | ViveCraftPlayerTag |
Description | Returns the ViveCraftPlayerTag for this player. |
Generated Example |
|
Requires | Depenizen, ViveCraft |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/vivecraft/ViveCraftPlayerProperties.java#L23 |
Name | <PlayerTag.we_brush_info[(<item>)]> |
Returns | ListTag |
Description | Returns 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 |
|
Requires | Depenizen, WorldEdit |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldedit/WorldEditPlayerProperties.java#L81 |
Name | <PlayerTag.we_selection> |
Returns | ObjectTag |
Mechanism | PlayerTag.we_selection |
Description | Returns the player's current block area selection, as a CuboidTag, EllipsoidTag, or PolygonTag. |
Generated Example |
|
Requires | Depenizen, WorldEdit |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldedit/WorldEditPlayerProperties.java#L124 |
Name | <PlayerTag.worldguard.can_build[<location>]> |
Returns | ElementTag(Boolean) |
Description | Whether WorldGuard allows to build at a location. |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardPlayerProperties.java#L77 |
Name | <PlayerTag.worldguard.test_flag[<name>]> |
Returns | ElementTag |
Description | Returns the boolean state of a flag for that player at their location.
For non-state tags, returns the current value of the flag. |
Example |
|
Requires | Depenizen, WorldGuard |
Source | https://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>]> |
Returns | ElementTag |
Description | Returns the boolean state of a flag for that player at the specified location.
For non-state tags, returns the current value of the flag. |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardPlayerProperties.java#L120 |
Name | <PlayerTag.affects_monster_spawning> |
Returns | ElementTag(Boolean) |
Mechanism | PlayerTag.affects_monster_spawning |
Description | Returns whether the player affects monster spawning. When false, no monsters will spawn naturally because of this player. |
Generated Example |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperPlayerExtensions.java#L20 |
Name | <PlayerTag.client_options> |
Returns | MapTag |
Description | Returns the player's client options.
The output map contains the following keys: - 'allow_server_listings' (ElementTag(Boolean)): whether the player allows server listings. Available only on MC 1.19+. - 'chat_colors_enabled' (ElementTag(Boolean)): whether the player has chat colors enabled. - 'chat_visibility' (ElementTag): the player's current chat visibility option. Possible output values are: FULL, SYSTEM, HIDDEN, and UNKNOWN. - 'locale' (ElementTag): the player's current locale. - 'main_hand' (ElementTag): the player's main hand, either LEFT or RIGHT. - 'skin_parts' (MapTag): which skin parts the player has enabled. The output map contains the following keys: - 'cape' (ElementTag(Boolean)): whether the player's cape is enabled. - 'hat' (ElementTag(Boolean)): whether the player's hat is enabled. - 'jacket' (ElementTag(Boolean)): whether the player's jacket is enabled. - 'left_sleeve' (ElementTag(Boolean)): whether the player's left sleeve is enabled. - 'right_sleeve' (ElementTag(Boolean)): whether the player's right sleeve is enabled. - 'left_pants' (ElementTag(Boolean)): whether the player's left pants is enabled. - 'right_pants' (ElementTag(Boolean)): whether the player's right pants is enabled. - 'text_filtering_enabled' (ElementTag(Boolean)): whether the player has text filtering enabled. Available only on MC 1.19+. - 'view_distance' (ElementTag(Number)): the player's current view distance. |
Generated Example |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperPlayerExtensions.java#L33 |
Name | <PlayerTag.flying_fall_damage> |
Returns | ElementTag(Boolean) |
Mechanism | PlayerTag.flying_fall_damage |
Description | Returns whether the player will take fall damage while PlayerTag.can_fly is true. |
Generated Example |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperPlayerExtensions.java#L141 |
Name | <PluginTag.authors> |
Returns | ListTag |
Description | Gets the list of authors for the plugin specified. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PluginTag.java#L183 |
Name | <PluginTag.commands> |
Returns | MapTag(MapTag) |
Description | Gets 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PluginTag.java#L213 |
Name | <PluginTag.depends> |
Returns | ListTag |
Description | Gets the list of hard dependencies for the plugin specified. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PluginTag.java#L193 |
Name | <PluginTag.description> |
Returns | ElementTag |
Description | Gets the description for the plugin specified. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PluginTag.java#L173 |
Name | <PluginTag.name> |
Returns | ElementTag |
Description | Gets the name of this plugin. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PluginTag.java#L153 |
Name | <PluginTag.soft_depends> |
Returns | ListTag |
Description | Gets the list of soft dependencies for the plugin specified. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PluginTag.java#L203 |
Name | <PluginTag.version> |
Returns | ElementTag |
Description | Gets the version for the plugin specified. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PluginTag.java#L163 |
Name | <PolygonTag.blocks_inclusive[(<matcher>)]> |
Returns | ListTag(LocationTag) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L875 |
Name | <PolygonTag.contains_inclusive[<location>]> |
Returns | ElementTag(Boolean) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L859 |
Name | <PolygonTag.corners> |
Returns | ListTag(LocationTag) |
Description | Returns a list of the polygon's corners, as locations with Y coordinate set to the y-min value. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L665 |
Name | <PolygonTag.include_y[<#.#>]> |
Returns | PolygonTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L776 |
Name | <PolygonTag.max_y> |
Returns | ElementTag(Decimal) |
Description | Returns the maximum Y level for this polygon. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L619 |
Name | <PolygonTag.min_y> |
Returns | ElementTag(Decimal) |
Description | Returns the minimum Y level for this polygon. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L633 |
Name | <PolygonTag.note_name> |
Returns | ElementTag |
Description | Gets the name of a noted PolygonTag. If the polygon isn't noted, this is null. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L647 |
Name | <PolygonTag.outline> |
Returns | ListTag(LocationTag) |
Description | Returns a list of locations along the 3D outline of this polygon (roughly a block-width of separation between each). |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L820 |
Name | <PolygonTag.outline_2d[<#.#>]> |
Returns | ListTag(LocationTag) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L800 |
Name | <PolygonTag.shell_inclusive> |
Returns | ListTag(LocationTag) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L901 |
Name | <PolygonTag.shift[<vector>]> |
Returns | PolygonTag |
Description | Returns a copy of the polygon, with all coordinates shifted by the given location-vector. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L682 |
Name | <PolygonTag.with_corner[<location>]> |
Returns | PolygonTag |
Mechanism | PolygonTag.add_corner |
Description | Returns a copy of the polygon, with the specified corner added to the end of the corner list. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L711 |
Name | <PolygonTag.with_y_max[<#.#>]> |
Returns | PolygonTag |
Description | Returns a copy of the polygon, with the specified maximum-Y value. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L756 |
Name | <PolygonTag.with_y_min[<#.#>]> |
Returns | PolygonTag |
Description | Returns a copy of the polygon, with the specified minimum-Y value. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L736 |
Name | <proc[<procedure_script_name>].context[<object>|...]> |
Returns | ObjectTag |
Description | Returns the 'determine' result of a procedure script with the given context. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/ProcedureScriptTagBase.java#L66 |
Name | <QuaternionTag.axis_angle_for[<vector>]> |
Returns | ElementTag(Decimal) |
Description | Returns the angle (in radians) around the specified axis vector created by this quaternion. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L318 |
Name | <QuaternionTag.conjugate> |
Returns | QuaternionTag |
Description | Returns the conjugate of this quaternion.
This is equivalent to (-x, -y, -z, w). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L271 |
Name | <QuaternionTag.inverse> |
Returns | QuaternionTag |
Description | Returns the inverse of this quaternion.
The inverse is the same amount of rotation, in the opposite direction. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L282 |
Name | <QuaternionTag.length> |
Returns | ElementTag(Decimal) |
Description | Returns the length of this quaternion.
This value is not very useful in most cases. |
Generated Example |
|
Synonyms (Search Aid) | quaterniontag.magnitude |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L247 |
Name | <QuaternionTag.length_squared> |
Returns | ElementTag(Decimal) |
Description | Returns the squared length of this quaternion.
This value is not very useful in most cases. |
Generated Example |
|
Synonyms (Search Aid) | quaterniontag.magnitude_squared |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L259 |
Name | <QuaternionTag.mul[<quaternion>]> |
Returns | QuaternionTag |
Description | Returns this quaternion multiplied by another, using quaternion multiplication.
Effectively combines the rotation represented by two quaternions. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L214 |
Name | <QuaternionTag.negative> |
Returns | QuaternionTag |
Description | Returns the negative of this quaternion.
That is, (-x, -y, -z, -w). This is not just making the rotation backwards, for that use QuaternionTag.inverse. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L294 |
Name | <QuaternionTag.normalize> |
Returns | QuaternionTag |
Description | Returns a copy of this quaternion, normalized. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L237 |
Name | <QuaternionTag.plus[<quaternion>]> |
Returns | QuaternionTag |
Description | Returns this quaternion "plus" another, using simple addition.
This is NOT the same as combining quaternions! For that, use QuaternionTag.mul. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L203 |
Name | <QuaternionTag.quaternion_between[<quaternion>]> |
Returns | QuaternionTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L306 |
Name | <QuaternionTag.represented_angle> |
Returns | ElementTag(Decimal) |
Description | Returns the angle (in radians) represented by this quaternion.
Pairs with QuaternionTag.represented_axis. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L346 |
Name | <QuaternionTag.represented_axis> |
Returns | VectorObject |
Description | Returns the axis represented by this quaternion, as a vector.
Pairs with QuaternionTag.represented_angle. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L357 |
Name | <QuaternionTag.scale[<factor>]> |
Returns | QuaternionTag |
Description | Returns this quaternion multiplied by scaling factor.
This does NOT increase rotation angle. |
Source | https://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>]> |
Returns | QuaternionTag |
Description | Returns the spherical linear interpolation ('slerp') between this quaternion and another. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L368 |
Name | <QuaternionTag.transform[<vector>]> |
Returns | VectorObject |
Description | Returns a copy of the given vector, transformed by this quaternion. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L336 |
Name | <QuaternionTag.w> |
Returns | ElementTag(Decimal) |
Description | Returns the raw W value of this quaternion. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L162 |
Name | <QuaternionTag.x> |
Returns | ElementTag(Decimal) |
Description | Returns the raw X value of this quaternion. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L132 |
Name | <QuaternionTag.xyz> |
Returns | ElementTag |
Description | Returns the X, Y, and Z values of this quaternion as a simple "x,y,z" format. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L172 |
Name | <QuaternionTag.xyz_vector> |
Returns | VectorObject |
Description | Returns the X, Y, and Z values of this quaternion as a VectorObject. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L193 |
Name | <QuaternionTag.xyzw> |
Returns | ElementTag |
Description | Returns the X, Y, Z, and W values of this quaternion as a simple "x,y,z,w" format. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L182 |
Name | <QuaternionTag.y> |
Returns | ElementTag(Decimal) |
Description | Returns the raw Y value of this quaternion. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L142 |
Name | <QuaternionTag.z> |
Returns | ElementTag(Decimal) |
Description | Returns the raw Z value of this quaternion. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L152 |
Name | <QueueTag.commands> |
Returns | ListTag |
Description | Returns a list of commands waiting in the queue. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L248 |
Name | <QueueTag.definition[<definition>]> |
Returns | ObjectTag |
Description | Returns the value of the specified definition.
Returns null if the queue lacks the definition. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L306 |
Name | <QueueTag.definition_map> |
Returns | MapTag |
Description | Returns a map of all definitions on the queue. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L296 |
Name | <QueueTag.definitions> |
Returns | ListTag |
Description | Returns the names of all definitions that were added to the current queue. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L286 |
Name | <QueueTag.determination> |
Returns | ListTag |
Description | Returns the values that have been determined via Determine
for this queue, or null if there is none. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L317 |
Name | <QueueTag.id> |
Returns | ElementTag |
Description | Returns the full textual id of the queue. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L147 |
Name | <QueueTag.is_valid> |
Returns | ElementTag(Boolean) |
Description | Returns true if the queue has not yet stopped. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L202 |
Name | <QueueTag.last_command> |
Returns | ElementTag |
Description | Returns the last command executed in this queue (if any). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L267 |
Name | <QueueTag.npc> |
Returns | NPCTag |
Mechanism | QueueTag.linked_npc |
Description | Returns the NPCTag linked to a queue. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitQueueExtensions.java#L13 |
Name | <QueueTag.numeric_id> |
Returns | ElementTag(Number) |
Description | Returns the raw numeric id of the queue. This is an incremental ID one higher than the previous queue's numeric ID. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L157 |
Name | <QueueTag.player> |
Returns | PlayerTag |
Mechanism | QueueTag.linked_player |
Description | Returns the PlayerTag linked to a queue. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitQueueExtensions.java#L34 |
Name | <QueueTag.script> |
Returns | ScriptTag |
Description | Returns the script that started this queue. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L235 |
Name | <QueueTag.size> |
Returns | ElementTag(Number) |
Description | Returns the number of script entries in the queue. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L167 |
Name | <QueueTag.speed> |
Returns | DurationTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L333 |
Name | <QueueTag.started_time> |
Returns | TimeTag |
Description | Returns the time this queue started as a duration. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L177 |
Name | <QueueTag.state> |
Returns | ElementTag |
Description | Returns 'stopping', 'running', 'paused', or 'unknown'. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L212 |
Name | <QueueTag.time_ran> |
Returns | DurationTag |
Description | Returns the time this queue has ran for (the length of time between now and when the queue started) as a duration. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L191 |
Name | <schematic[<name>].block[<location>]> |
Returns | MaterialTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L681 |
Name | <schematic[<name>].blocks> |
Returns | ElementTag(Number) |
Description | Returns the number of blocks in the schematic. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L710 |
Name | <schematic[<name>].cuboid[<origin_location>]> |
Returns | CuboidTag |
Description | Returns a cuboid of where the schematic would be if it was pasted at an origin. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L722 |
Name | <schematic[<name>].exists> |
Returns | ElementTag(Boolean) |
Description | Returns whether the schematic exists. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L633 |
Name | <schematic[<name>].height> |
Returns | ElementTag(Number) |
Description | Returns the height (Y) of the schematic. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L645 |
Name | <schematic[<name>].length> |
Returns | ElementTag(Number) |
Description | Returns the length (Z) of the schematic. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L657 |
Name | <schematic.list> |
Returns | ListTag |
Description | Returns a list of all loaded schematics. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L609 |
Name | <schematic[<name>].origin> |
Returns | LocationTag |
Description | Returns the origin location of the schematic. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L698 |
Name | <schematic[<name>].width> |
Returns | ElementTag(Number) |
Description | Returns the width (X) of the schematic. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L669 |
Name | <ScriptTag.container_type> |
Returns | ElementTag |
Description | Returns the type of script container that is associated with this ScriptTag object. For example: 'task', or
'world'. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L234 |
Name | <ScriptTag.cooldown[(<player>)]> |
Returns | DurationTag |
Description | Returns the time left for the player to cooldown for the script. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitScriptExtensions.java#L36 |
Name | <ScriptTag.cooled_down[(<player>)]> |
Returns | ElementTag(Boolean) |
Description | Returns 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 |
|
Source | https://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>]> |
Returns | ObjectTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L333 |
Name | <ScriptTag.default_step> |
Returns | ElementTag |
Description | Returns the name of the default step of an interact script. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitScriptExtensions.java#L81 |
Name | <ScriptTag.filename> |
Returns | ElementTag |
Description | Returns the absolute filename that contains the script. |
Generated Example |
|
Source | https://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>)]> |
Returns | ListTag |
Description | Returns a list of all keys within a script, searching recursively, with an optional starting-key. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L374 |
Name | <ScriptTag.list_keys[(<start_key>)]> |
Returns | ListTag |
Description | Returns a list of all data keys within a script, with an optional starting-key. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L360 |
Name | <ScriptTag.name> |
Returns | ElementTag |
Description | Returns the name of the script container. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L245 |
Name | <ScriptTag.original_name> |
Returns | ElementTag |
Description | Returns the originally cased script name. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L275 |
Name | <ScriptTag.parsed_key[<key_name>]> |
Returns | ObjectTag |
Description | Returns 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). |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L307 |
Name | <ScriptTag.queues> |
Returns | ListTag(QueueTag) |
Description | Returns all queues which are running for this script. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L416 |
Name | <ScriptTag.relative_filename> |
Returns | ElementTag |
Description | Returns the filename that contains the script, relative to the denizen/ folder. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L255 |
Name | <ScriptTag.step[(<player>)]> |
Returns | ElementTag |
Description | Returns the name of a script step that the player is currently on.
Must be an INTERACT script. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitScriptExtensions.java#L48 |
Name | <ScriptTag.step_expiration[(<player>)]> |
Returns | TimeTag |
Description | Returns the time that an interact script step expires at, if applied by zap with a duration limit. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitScriptExtensions.java#L65 |
Name | <ScriptTag.to_json> |
Returns | ElementTag |
Description | Converts the Script Container to a JSON array.
Best used with 'data' type scripts. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L388 |
Name | <ScriptTag.to_yaml> |
Returns | ElementTag |
Description | Converts the Script Container to raw YAML text.
Best used with 'data' type scripts. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L401 |
Name | <SecretTag.key> |
Returns | ElementTag |
Description | Returns the secret key for this secret object. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/SecretTag.java#L166 |
Name | <server.advancement_types> |
Returns | ListTag |
Description | Returns a list of all registered advancement names.
Generally used with PlayerTag.has_advancement. See also https://minecraft.wiki/w/Advancement. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L685 |
Name | <server.area_notes_debug> |
Returns | MapTag |
Description | Generates a report about noted area tracking.
This tag is strictly for internal debugging reasons. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1855 |
Name | <server.art_types> |
Returns | ListTag |
Description | Returns a list of all known art types.
Generally used with EntityTag.painting and EntityTag.painting. This is only their Bukkit enum names, as seen at https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Art.html. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L675 |
Name | <server.available_processors> |
Returns | ElementTag(Number) |
Description | Deprecated in favor of util.available_processors |
Deprecated | use util.available_processors |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2122 |
Name | <server.ban_info[<address>].created_time> |
Returns | TimeTag |
Description | Returns when the ip address's ban was created, if it is banned. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1510 |
Name | <server.ban_info[<address>].expiration_time> |
Returns | TimeTag |
Description | Returns the expiration of the ip address's ban, if it is banned.
Potentially can be null. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1482 |
Name | <server.ban_info[<address>].reason> |
Returns | ElementTag |
Description | Returns the reason for the ip address's ban, if it is banned. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1499 |
Name | <server.ban_info[<address>].source> |
Returns | ElementTag |
Description | Returns the source of the ip address's ban, if it is banned. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1526 |
Name | <server.banned_addresses> |
Returns | ListTag |
Description | Returns a list of all banned ip addresses. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1447 |
Name | <server.banned_players> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all banned players. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1432 |
Name | <server.biome_types> |
Returns | ListTag(BiomeTag) |
Description | Returns a list of all biomes known to the server, including custom added ones.
Generally used with BiomeTag. See https://minecraft.wiki/w/Biome#List_of_biomes for a list of all default (vanilla) biomes. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L730 |
Name | <server.bossbar_viewers[<bossbar_id>]> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of players that should be able to see the given bossbar ID from bossbar. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1634 |
Name | <server.bukkit_version> |
Returns | ElementTag |
Description | Returns the version of Bukkit currently being used. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1123 |
Name | <server.color_names> |
Returns | ListTag |
Description | Deprecated in favor of util.color_names |
Deprecated | use util.color_names |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2226 |
Name | <server.command_plugin[<name>]> |
Returns | PluginTag |
Description | Returns the plugin that created a command (if known). |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L661 |
Name | <server.commands> |
Returns | ListTag |
Description | Returns a list of all registered command names in Bukkit. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L649 |
Name | <server.current_bossbars> |
Returns | ListTag |
Description | Returns a list of all currently active boss bar IDs from bossbar. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1624 |
Name | <server.current_tick> |
Returns | ElementTag(Number) |
Description | Deprecated in favor of util.current_tick |
Deprecated | use util.current_tick |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2130 |
Name | <server.current_time_millis> |
Returns | ElementTag(Number) |
Description | Deprecated in favor of util.current_time_millis |
Deprecated | use util.current_time_millis |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2154 |
Name | <server.damage_causes> |
Returns | ListTag |
Description | Returns a list of all registered damage causes.
Generally used with 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. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L710 |
Name | <server.debug_enabled> |
Returns | ElementTag(Boolean) |
Description | Deprecated in favor of util.debug_enabled |
Deprecated | use util.debug_enabled |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2218 |
Name | <server.delta_time_since_start> |
Returns | DurationTag |
Description | Deprecated in favor of util.delta_time_since_start |
Deprecated | use util.delta_time_since_start |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2138 |
Name | <server.denizen_version> |
Returns | ElementTag |
Description | Returns the version of Denizen currently being used. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1113 |
Name | <server.disk_free> |
Returns | ElementTag(Number) |
Description | Deprecated in favor of util.disk_free |
Deprecated | use util.disk_free |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2066 |
Name | <server.disk_total> |
Returns | ElementTag(Number) |
Description | Deprecated in favor of util.disk_total |
Deprecated | use util.disk_total |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2074 |
Name | <server.disk_usage> |
Returns | ElementTag(Number) |
Description | Deprecated in favor of util.disk_usage |
Deprecated | use util.disk_usage |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2082 |
Name | <server.effect_types> |
Returns | ListTag |
Description | Returns a list of all 'effect' types known to the server.
Generally used with playeffect. This is only their Bukkit enum names, as seen at https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Effect.html. Refer also to server.particle_types. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L860 |
Name | <server.enchantments> |
Returns | ListTag(EnchantmentTag) |
Description | Returns a list of all enchantments known to the server. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L750 |
Name | <server.entity_types> |
Returns | ListTag |
Description | Returns a list of all entity types known to the server.
Generally used with EntityTag. This is only their Bukkit enum names, as seen at https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/EntityType.html. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L784 |
Name | <server.gamerules> |
Returns | ListTag |
Description | Returns a list of all available gamerules on the server. |
Source | https://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})]> |
Returns | ListTag(ItemTag) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1786 |
Name | <server.group_prefix[<group>]> |
Returns | ElementTag |
Description | Returns an ElementTag of a group's chat prefix. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1153 |
Name | <server.group_prefix[<group>].world[<world>]> |
Returns | ElementTag |
Description | Returns an ElementTag of a group's chat prefix for the specified WorldTag. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1171 |
Name | <server.group_suffix[<group>]> |
Returns | ElementTag |
Description | Returns an ElementTag of a group's chat suffix. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1187 |
Name | <server.group_suffix[<group>].world[<world>]> |
Returns | ElementTag |
Description | Returns an ElementTag of a group's chat suffix for the specified WorldTag. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1205 |
Name | <server.has_file[<name>]> |
Returns | ElementTag(Boolean) |
Description | Deprecated in favor of util.has_file |
Deprecated | use util.has_file |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2162 |
Name | <server.has_permissions> |
Returns | ElementTag(Boolean) |
Description | Returns whether the server has a known permission plugin loaded.
Note: should not be considered incredibly reliable. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1091 |
Name | <server.has_whitelist> |
Returns | ElementTag(Boolean) |
Mechanism | server.has_whitelist |
Description | Returns whether the server's whitelist is active. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L561 |
Name | <server.idle_timeout> |
Returns | DurationTag |
Mechanism | server.idle_timeout |
Description | Returns the server's current idle timeout limit (how long a player can sit still before getting kicked).
Internally used with PlayerTag.last_action_time. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1676 |
Name | <server.is_banned[<address>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the given ip address is banned. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1460 |
Name | <server.java_version> |
Returns | ElementTag |
Description | Deprecated in favor of util.java_version |
Deprecated | use util.java_version |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2178 |
Name | <server.last_reload> |
Returns | TimeTag |
Description | Deprecated in favor of util.last_reload |
Deprecated | use util.last_reload |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2202 |
Name | <server.list_files[<path>]> |
Returns | ListTag |
Description | Deprecated in favor of util.list_files |
Deprecated | use util.list_files |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2170 |
Name | <server.map_cursor_types> |
Returns | ListTag |
Description | Returns a list of all map cursor types known to the server.
Generally used with map and 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. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L925 |
Name | <server.match_offline_player[<name>]> |
Returns | PlayerTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1265 |
Name | <server.match_player[<name>]> |
Returns | PlayerTag |
Description | Returns 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'. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1236 |
Name | <server.material_types> |
Returns | ListTag(MaterialTag) |
Description | Returns a list of all materials known to the server.
Generally used with MaterialTag. This is only types listed in the Bukkit Material enum, as seen at https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html. Note: Some materials might be disabled in specific worlds, check using MaterialTag.is_enabled. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L803 |
Name | <server.max_players> |
Returns | ElementTag(Number) |
Description | Returns the maximum number of players allowed on the server. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1143 |
Name | <server.motd> |
Returns | ElementTag |
Description | Returns the server's current MOTD. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1589 |
Name | <server.nbt_attribute_types> |
Returns | ListTag |
Description | Returns a list of all registered attribute names.
Generally used with EntityTag.has_attribute. This is only their Bukkit enum names, as seen at https://hub.spigotmc.org/javadocs/spigot/org/bukkit/attribute/Attribute.html. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L700 |
Name | <server.notes[<type>]> |
Returns | ListTag |
Description | Deprecated in favor of util.notes |
Deprecated | use util.notes |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2050 |
Name | <server.npc_registries> |
Returns | ListTag |
Description | Returns a list of all NPC registries. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2385 |
Name | <server.npcs[(<registry>)]> |
Returns | ListTag(NPCTag) |
Description | Returns a list of all NPCs. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2399 |
Name | <server.npcs_assigned[<assignment_script>]> |
Returns | ListTag(NPCTag) |
Description | Returns a list of all NPCs assigned to a specified script. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2314 |
Name | <server.npcs_flagged[<flag_name>]> |
Returns | ListTag(NPCTag) |
Description | Returns a list of all NPCs with a specified flag set.
Can use "!<flag_name>" style to only return NPCs *without* the flag. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2360 |
Name | <server.npcs_named[<name>]> |
Returns | ListTag(NPCTag) |
Description | Returns a list of NPCs with a certain name. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2296 |
Name | <server.object_is_valid[<object>]> |
Returns | ElementTag(Boolean) |
Description | Deprecated in favor of ObjectTag.exists or ObjectTag.is_truthy |
Deprecated | Use 'exists' or 'is_truthy' |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L548 |
Name | <server.offline_ops> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all offline ops. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1572 |
Name | <server.offline_players> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all offline players.
This specifically excludes currently online players. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1414 |
Name | <server.online_ops> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all online ops. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1555 |
Name | <server.online_players> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all online players. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1399 |
Name | <server.online_players_flagged[<flag_name>]> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all online players with a specified flag set.
Can use "!<flag_name>" style to only return players *without* the flag. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1302 |
Name | <server.ops> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all ops, online or not. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1540 |
Name | <server.parse_bukkit_item[<serial>]> |
Returns | ItemTag |
Description | Returns the ItemTag resultant from parsing Bukkit item serialization data (under subkey "item"). |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L175 |
Name | <server.particle_types> |
Returns | ListTag |
Description | Returns a list of all particle effect types known to the server.
Generally used with playeffect. This is only their Bukkit enum names, as seen at https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Particle.html. Refer also to server.effect_types. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L849 |
Name | <server.pattern_types> |
Returns | ListTag |
Description | Returns a list of all banner patterns known to the server.
Generally used with ItemTag.patterns. This is only their Bukkit enum names, as seen at https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/banner/PatternType.html. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L871 |
Name | <server.permission_groups> |
Returns | ListTag |
Description | Returns a list of all permission groups on the server. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1221 |
Name | <server.players> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all players that have ever played on the server, online or not. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1383 |
Name | <server.players_flagged[<flag_name>]> |
Returns | ListTag(PlayerTag) |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1327 |
Name | <server.plugins> |
Returns | ListTag(PluginTag) |
Description | Gets a list of currently enabled PluginTags from the server. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1368 |
Name | <server.plugins_handling_event[<bukkit_event>]> |
Returns | ListTag(PluginTag) |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1744 |
Name | <server.port> |
Returns | ElementTag(Number) |
Description | Returns the port that the server is running on. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1666 |
Name | <server.potion_effect_types> |
Returns | ListTag |
Description | Returns a list of all potion effects known to the server.
Can be used with 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 server.potion_types. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L881 |
Name | <server.potion_types> |
Returns | ListTag |
Description | Returns 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 server.potion_effect_types. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L905 |
Name | <server.ram_allocated> |
Returns | ElementTag(Number) |
Description | Deprecated in favor of util.ram_allocated |
Deprecated | use util.ram_allocated |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2090 |
Name | <server.ram_free> |
Returns | ElementTag(Number) |
Description | Deprecated in favor of util.ram_free |
Deprecated | use util.ram_free |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2106 |
Name | <server.ram_max> |
Returns | ElementTag(Number) |
Description | Deprecated in favor of util.ram_max |
Deprecated | use util.ram_max |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2098 |
Name | <server.ram_usage> |
Returns | ElementTag(Number) |
Description | Deprecated in favor of util.ram_usage |
Deprecated | use util.ram_usage |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2114 |
Name | <server.real_time_since_start> |
Returns | DurationTag |
Description | Deprecated in favor of util.real_time_since_start |
Deprecated | use util.real_time_since_start |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2146 |
Name | <server.recent_tps> |
Returns | ListTag |
Description | Returns the 3 most recent ticks per second measurements. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1652 |
Name | <server.recipe_ids[(<type>)]> |
Returns | ListTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L196 |
Name | <server.recipe_items[<id>]> |
Returns | ListTag(ItemTag) |
Description | Returns 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'. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L226 |
Name | <server.recipe_result[<id>]> |
Returns | ItemTag |
Description | Returns the item that a recipe will create when crafted.
Brewing recipes are only supported on Paper, and only custom ones are available. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L334 |
Name | <server.recipe_shape[<id>]> |
Returns | ElementTag |
Description | Returns the shape of a shaped recipe, like '2x2' or '3x3'. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L300 |
Name | <server.recipe_type[<id>]> |
Returns | ElementTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L314 |
Name | <server.scoreboard[<board>].exists> |
Returns | ElementTag(Boolean) |
Description | Returns whether a given scoreboard exists on the server. |
Source | https://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> |
Returns | ElementTag |
Description | Returns the criteria specified for the given objective.
Optionally, specify which scoreboard to use. |
Source | https://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> |
Returns | ElementTag |
Description | Returns the display name specified for the given objective.
Optionally, specify which scoreboard to use. |
Source | https://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> |
Returns | ElementTag |
Description | Returns 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. |
Source | https://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>]> |
Returns | ElementTag(Number) |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L458 |
Name | <server.scoreboard[(<board>)].objectives> |
Returns | ListTag |
Description | Returns a list of all objective names in the scoreboard.
Optionally, specify which scoreboard to use. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L396 |
Name | <server.scoreboard[(<board>)].team_names> |
Returns | ListTag |
Description | Returns a list of the names of all teams within the scoreboard.
Optionally, specify which scoreboard to use. |
Source | https://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> |
Returns | ListTag |
Description | Returns 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. |
Source | https://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> |
Returns | ElementTag |
Description | Returns the team's prefix.
Optionally, specify which scoreboard to use. |
Source | https://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> |
Returns | ElementTag |
Description | Returns the team's suffix.
Optionally, specify which scoreboard to use. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L533 |
Name | <server.scoreboards> |
Returns | ListTag |
Description | Returns a list of scoreboard IDs currently registered on the server. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L356 |
Name | <server.scripts> |
Returns | ListTag(ScriptTag) |
Description | Deprecated in favor of util.scripts |
Deprecated | use util.scripts |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2194 |
Name | <server.selected_npc> |
Returns | NPCTag |
Description | Returns the server's currently selected NPC. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2285 |
Name | <server.slot_id[<slot>]> |
Returns | ElementTag(Number) |
Description | Returns the slot ID number for an input slot (see Slot Inputs). |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L164 |
Name | <server.sound_keys> |
Returns | ListTag |
Description | Returns a list of the keys/names of all sounds known to the server. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L838 |
Name | <server.sound_types> |
Returns | ListTag |
Description | Deprecated in favor of server.sound_keys on MC 1.21+. |
Deprecated | Use 'server.sound_keys' on MC 1.21+. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L821 |
Name | <server.spawned_npcs_flagged[<flag_name>]> |
Returns | ListTag(NPCTag) |
Description | Returns a list of all spawned NPCs with a specified flag set.
Can use "!<flag_name>" style to only return NPCs *without* the flag. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2335 |
Name | <server.sql_connections> |
Returns | ListTag |
Description | Deprecated in favor of util.sql_connections |
Deprecated | use util.sql_connections |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2186 |
Name | <server.stack_trace> |
Returns | ElementTag |
Description | Deprecated in favor of util.stack_trace |
Deprecated | use util.stack_trace |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2210 |
Name | <server.started_time> |
Returns | TimeTag |
Description | Deprecated in favor of util.started_time |
Deprecated | use util.started_time |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2058 |
Name | <server.statistic_type[<statistic>]> |
Returns | ElementTag |
Description | Returns 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 PlayerTag.statistic.qualifier. Refer also to server.statistic_types. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1006 |
Name | <server.statistic_types[(<type>)]> |
Returns | ListTag |
Description | Returns a list of all statistic types known to the server.
Generally used with 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 server.statistic_type. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L954 |
Name | <server.structure_types> |
Returns | ListTag |
Description | Deprecated in favor of server.structures on 1.19+. |
Deprecated | use 'server.structures' on 1.19+. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L976 |
Name | <server.structures> |
Returns | ListTag |
Description | Returns a list of all structures known to the server, including custom ones added by datapacks.
For more information and a list of default structures, see https://minecraft.wiki/w/Structure. For locating specific structures, see Structure lookups. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L993 |
Name | <server.teleport_causes> |
Returns | ListTag |
Description | Returns a list of all registered player teleport causes.
Generally used with entity teleports. See teleport cause for the current list of causes. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L720 |
Name | <server.tree_types> |
Returns | ListTag |
Description | Returns a list of all tree types known to the server.
Generally used with LocationTag.generate_tree. This is only their Bukkit enum names, as seen at https://hub.spigotmc.org/javadocs/spigot/org/bukkit/TreeType.html. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L915 |
Name | <server.vanilla_entity_tags> |
Returns | ListTag |
Description | Returns a list of vanilla tags applicable to entity types. See also https://minecraft.wiki/w/Tag. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1688 |
Name | <server.vanilla_material_tags> |
Returns | ListTag |
Description | Returns a list of vanilla tags applicable to blocks, fluids, or items. See also https://minecraft.wiki/w/Tag. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1716 |
Name | <server.vanilla_tagged_entities[<tag>]> |
Returns | ListTag(EntityTag) |
Description | Returns a list of entity types referred to by the specified vanilla tag. See also https://minecraft.wiki/w/Tag. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1698 |
Name | <server.vanilla_tagged_materials[<tag>]> |
Returns | ListTag(MaterialTag) |
Description | Returns a list of materials referred to by the specified vanilla tag. See also https://minecraft.wiki/w/Tag. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1726 |
Name | <server.version> |
Returns | ElementTag |
Description | Returns the version of the server. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1133 |
Name | <server.view_distance> |
Returns | ElementTag(Number) |
Description | Returns the server's current view distance. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1599 |
Name | <server.whitelisted_players> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all players whitelisted on this server. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L572 |
Name | <server.world_types> |
Returns | ListTag |
Description | Returns a list of all world types known to the server.
Generally used with createworld. This is only their Bukkit enum names, as seen at https://hub.spigotmc.org/javadocs/spigot/org/bukkit/WorldType.html. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L944 |
Name | <server.worlds> |
Returns | ListTag(WorldTag) |
Description | Returns a list of all worlds. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1353 |
Name | <server.economy.currency_name[<#.#>]> |
Returns | ElementTag |
Description | Returns the server's economy currency name (automatically singular or plural based on input value). |
Requires | Vault |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L125 |
Name | <server.economy.currency_plural> |
Returns | ElementTag |
Description | Returns the server's economy currency name (in the plural form, like "Dollars"). |
Requires | Vault |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L137 |
Name | <server.economy.currency_singular> |
Returns | ElementTag |
Description | Returns the server's economy currency name (in the singular form, like "Dollar"). |
Requires | Vault |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L149 |
Name | <server.economy.format[<#.#>]> |
Returns | ElementTag |
Description | Returns the amount of money, formatted according to the server's economy. |
Requires | Vault |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L113 |
Name | <server.has_economy> |
Returns | ElementTag(Boolean) |
Description | Returns whether the server has a known economy plugin loaded. |
Requires | Vault |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1102 |
Name | <server.traits> |
Returns | ListTag |
Description | Returns a list of all available NPC traits on the server. |
Requires | Citizens |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2422 |
Name | <tern[<condition>].pass[<result>].fail[<result>]> |
Returns | ObjectTag |
Description | Returns 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 ElementTag.if_true.if_false |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/TernaryTagBase.java#L23 |
Name | <TimeTag.add[<duration>]> |
Returns | TimeTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L629 |
Name | <TimeTag.day> |
Returns | ElementTag(Number) |
Description | Returns the day-of-month of this TimeTag, starting at 1. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L287 |
Name | <TimeTag.day_of_week> |
Returns | ElementTag(Number) |
Description | Returns the day-of-week of this TimeTag, with Monday as 1 and Sunday as 7 (per ISO standard). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L307 |
Name | <TimeTag.day_of_week_name> |
Returns | ElementTag |
Description | Returns the name of the day-of-week of this TimeTag, like 'MONDAY'. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L317 |
Name | <TimeTag.day_of_year> |
Returns | ElementTag(Number) |
Description | Returns the day-of-year of this TimeTag, from 1 to 365 (or 366 in leap years). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L297 |
Name | <TimeTag.days_in_month> |
Returns | ElementTag(Number) |
Description | Returns the number of days in the month that this TimeTag is within. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L277 |
Name | <TimeTag.duration_since[<time>]> |
Returns | DurationTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L666 |
Name | <TimeTag.epoch_millis> |
Returns | ElementTag(Number) |
Description | Returns the number of milliseconds between this TimeTag and the Unix Epoch (Jan. 1st 1970). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L367 |
Name | <TimeTag.format[(<format>)]> |
Returns | ElementTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L698 |
Name | <TimeTag.from_now> |
Returns | DurationTag |
Description | Returns 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 TimeTag.duration_since. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L651 |
Name | <TimeTag.hour> |
Returns | ElementTag(Number) |
Description | Returns the hour-of-day of this TimeTag, from 1 to 24. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L327 |
Name | <TimeTag.is_after[<time>]> |
Returns | ElementTag(Boolean) |
Description | Returns true if this time object comes after the input time value, or false if it's before (or equal). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L678 |
Name | <TimeTag.is_before[<time>]> |
Returns | ElementTag(Boolean) |
Description | Returns true if this time object comes before the input time value, or false if it's after (or equal). |
Generated Example |
|
Source | https://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>]> |
Returns | TimeTag |
Description | Returns 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. |
Source | https://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>]> |
Returns | TimeTag |
Description | Returns 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. |
Source | https://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>]> |
Returns | TimeTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L447 |
Name | <TimeTag.millisecond> |
Returns | ElementTag(Number) |
Description | Returns the millisecond of this TimeTag, from 0 to 999. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L357 |
Name | <TimeTag.minute> |
Returns | ElementTag(Number) |
Description | Returns the minute-of-hour of this TimeTag, from 0 to 59. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L337 |
Name | <TimeTag.month> |
Returns | ElementTag(Number) |
Description | Returns the month of this TimeTag, where January is 1 and December is 12. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L257 |
Name | <TimeTag.month_name> |
Returns | ElementTag |
Description | Returns the name of the month of this TimeTag, like 'JANUARY'. |
Generated Example |
|
Source | https://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>]> |
Returns | TimeTag |
Description | Returns 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. |
Source | https://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>]> |
Returns | TimeTag |
Description | Returns 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. |
Source | https://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>]> |
Returns | TimeTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L467 |
Name | <TimeTag.second> |
Returns | ElementTag(Number) |
Description | Returns the second-of-minute of this TimeTag, from 0 to 59. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L347 |
Name | <TimeTag.start_of_day> |
Returns | TimeTag |
Description | Returns this time tag, with the hour/minute/second/millisecond zeroed (that is, midnight the morning of the same day). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L619 |
Name | <TimeTag.start_of_month> |
Returns | TimeTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L609 |
Name | <TimeTag.start_of_year> |
Returns | TimeTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L599 |
Name | <TimeTag.sub[<duration>]> |
Returns | TimeTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L640 |
Name | <TimeTag.time_zone_id> |
Returns | ElementTag |
Description | Returns the ID of the time zone of this TimeTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L387 |
Name | <TimeTag.time_zone_name> |
Returns | ElementTag |
Description | Returns the display name of the time zone of this TimeTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L397 |
Name | <TimeTag.time_zone_offset> |
Returns | ElementTag |
Description | Returns the time zone offset (from UTC) of this TimeTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L377 |
Name | <TimeTag.to_local> |
Returns | TimeTag |
Description | Returns a copy of the TimeTag, converted to the local time zone. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L427 |
Name | <TimeTag.to_utc> |
Returns | TimeTag |
Description | Returns a copy of the TimeTag, converted to Universal Coordinated Time. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L437 |
Name | <TimeTag.to_zone[<zone>]> |
Returns | TimeTag |
Description | Returns 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" |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L407 |
Name | <TimeTag.year> |
Returns | ElementTag(Number) |
Description | Returns the year of this TimeTag, like '2020'. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L247 |
Name | <TimeTag.format_discord[(<style>)]> |
Returns | ElementTag |
Description | Returns 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 |
|
Group | extensions |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/properties/DiscordTimeTagExtensions.java#L10 |
Name | <util.available_processors> |
Returns | ElementTag(Number) |
Description | How many virtual processors are available to the server.
(In general, Minecraft only uses one, unfortunately.) |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L783 |
Name | <util.color_names> |
Returns | ListTag |
Description | Returns a list of all color names recognized by ColorTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L430 |
Name | <util.current_tick> |
Returns | ElementTag(Number) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L794 |
Name | <util.current_time_millis> |
Returns | ElementTag(Number) |
Description | Returns the number of milliseconds since Jan 1, 1970.
Note that this can change every time the tag is read! Use util.time_now if you need stable time. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L831 |
Name | <util.debug_enabled> |
Returns | ElementTag(Boolean) |
Description | Returns whether script debug is currently globally enabled. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L996 |
Name | <util.default_encoding> |
Returns | ElementTag |
Description | Returns the name of the default system text encoding charset, such as "UTF-8". |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L611 |
Name | <util.delta_time_since_start> |
Returns | DurationTag |
Description | Returns 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 util.real_time_since_start. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L805 |
Name | <util.disk_free> |
Returns | ElementTag(Number) |
Description | How 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L702 |
Name | <util.disk_total> |
Returns | ElementTag(Number) |
Description | How 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L715 |
Name | <util.disk_usage> |
Returns | ElementTag(Number) |
Description | How 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L727 |
Name | <util.e> |
Returns | ElementTag(Decimal) |
Description | Returns e (Euler's number): 2.7182818284590452354 |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L410 |
Name | <util.empty_list_entries[<#>]> |
Returns | ListTag |
Description | Returns a list of the specified size where each entry is blank (zero characters long). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L315 |
Name | <util.event_stats> |
Returns | ElementTag |
Description | Returns a simple debuggable stats report for all ScriptEvents during this server session. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L591 |
Name | <util.event_stats_data> |
Returns | ListTag(MapTag) |
Description | Returns the raw data for util.event_stats, as a ListTag of MapTags. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L601 |
Name | <util.has_file[<name>]> |
Returns | ElementTag(Boolean) |
Description | Returns true if the specified file exists. The starting path is /plugins/Denizen. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L642 |
Name | <util.int_max> |
Returns | ElementTag(Number) |
Description | Returns the maximum value of a 32 bit signed integer (a java 'int'): 2147483647 |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L350 |
Name | <util.int_min> |
Returns | ElementTag(Number) |
Description | Returns the minimum value of a 32 bit signed integer (a java 'int'): -2147483648 |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L360 |
Name | <util.java_class_context> |
Returns | ListTag |
Description | Returns a list of class names in the current stack history.
More stable than 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L981 |
Name | <util.java_version> |
Returns | ElementTag |
Description | Returns the current Java version of the server. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L632 |
Name | <util.last_reload> |
Returns | TimeTag |
Description | Returns the time that Denizen scripts were last reloaded. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L924 |
Name | <util.list_denizen_commands> |
Returns | ListTag |
Description | Returns a list of all currently loaded Denizen commands. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L420 |
Name | <util.list_files[<path>]> |
Returns | ListTag |
Description | Returns a list of all files (and directories) in the specified directory. The starting path is /plugins/Denizen. |
Source | https://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})]> |
Returns | ListTag |
Description | Returns 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 repeat. |
Example |
|
Example |
|
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L265 |
Name | <util.list_numbers_to[<#>]> |
Returns | ListTag |
Description | Returns 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 repeat. In most cases, there's a better way to do what you're trying to accomplish than using this tag. Consider instead using util.list_numbers |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L297 |
Name | <util.list_tag_bases> |
Returns | ListTag |
Description | Returns a list of all currently loaded Denizen tag bases (including "player", "context", "util", "server", etc). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L440 |
Name | <util.long_max> |
Returns | ElementTag(Number) |
Description | Returns the maximum value of a 64 bit signed integer (a java 'long'): 9223372036854775807 |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L370 |
Name | <util.long_min> |
Returns | ElementTag(Number) |
Description | Returns the minimum value of a 64 bit signed integer (a java 'long'): -9223372036854775808 |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L380 |
Name | <util.mongo_connections> |
Returns | ElementTag |
Description | Returns a list of all Mongo connections opened by mongo. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L902 |
Name | <util.notes[<type>]> |
Returns | ListTag |
Description | Lists 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. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L843 |
Name | <util.parse_yaml[<yaml>]> |
Returns | MapTag |
Description | Parses the input YAML or JSON text into a MapTag. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L566 |
Name | <util.pi> |
Returns | ElementTag(Decimal) |
Description | Returns PI: 3.14159265358979323846 |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L390 |
Name | <util.queues> |
Returns | ListTag(QueueTag) |
Description | Returns a list of all currently running queues on the server. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L581 |
Name | <util.ram_allocated> |
Returns | ElementTag(Number) |
Description | How 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L741 |
Name | <util.ram_free> |
Returns | ElementTag(Number) |
Description | How much RAM is unused but available on the server, in bytes (free memory). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L762 |
Name | <util.ram_max> |
Returns | ElementTag(Number) |
Description | How much RAM is available to the server (total), in bytes (max memory). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L752 |
Name | <util.ram_usage> |
Returns | ElementTag(Number) |
Description | How much RAM is used by the server, in bytes (free memory).
Equivalent to ram_max minus ram_free |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L772 |
Name | <util.random_boolean> |
Returns | ElementTag(Boolean) |
Description | Returns a random boolean (true or false). Essentially a coin flip. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L204 |
Name | <util.random_chance[<percent>]> |
Returns | ElementTag(Boolean) |
Description | Returns a random boolean (true or false) with the given percent chance (from 0 to 100). |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L189 |
Name | <util.random_decimal> |
Returns | ElementTag(Decimal) |
Description | Returns a random decimal number from 0 to 1. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L179 |
Name | <util.random_gauss> |
Returns | ElementTag(Decimal) |
Description | Returns a random decimal number with a gaussian distribution.
70% of all results will be within the range of -1 to 1. |
Generated Example |
|
Source | https://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=<#.#>)]> |
Returns | ElementTag(Decimal) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L235 |
Name | <util.random_uuid> |
Returns | ElementTag |
Description | Returns a random unique ID. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L225 |
Name | <util.random.boolean> |
Returns | ElementTag(Boolean) |
Description | Deprecated in favor of util.random_boolean |
Deprecated | use 'util.random_boolean' with a '_' |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L124 |
Name | <util.random.decimal> |
Returns | ElementTag(Decimal) |
Description | Deprecated in favor of util.random_decimal |
Deprecated | use 'util.random_decimal' with a '_' |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L112 |
Name | <util.random.decimal[<#.#>].to[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Returns a random decimal number between the 2 specified decimal numbers, inclusive. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L85 |
Name | <util.random.duuid[(<source>)]> |
Returns | ElementTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L160 |
Name | <util.random.gauss> |
Returns | ElementTag(Decimal) |
Description | Deprecated in favor of util.random_gauss |
Deprecated | use 'util.random_gauss' with a '_' |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L136 |
Name | <util.random.int[<#>].to[<#>]> |
Returns | ElementTag(Number) |
Description | Returns a random integer number between the 2 specified integer numbers, inclusive. |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L58 |
Name | <util.random.uuid> |
Returns | ElementTag |
Description | Deprecated in favor of util.random_uuid |
Deprecated | use 'util.random_uuid' with a '_' |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L148 |
Name | <util.real_time_since_start> |
Returns | DurationTag |
Description | Returns 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 util.delta_time_since_start is preferable. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L818 |
Name | <util.redis_connections> |
Returns | ListTag |
Description | Returns a list of all Redis connections opened by redis. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L890 |
Name | <util.reflect_class[<name>]> |
Returns | JavaReflectedObjectTag |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L934 |
Name | <util.runlater_ids> |
Returns | ListTag |
Description | Returns a list of all scheduled task IDs for runlater.
Note that usages of runlater that didn't specify an ID will not show up here. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L621 |
Name | <util.scripts> |
Returns | ListTag(ScriptTag) |
Description | Gets a list of all scripts currently loaded into Denizen. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L914 |
Name | <util.short_max> |
Returns | ElementTag(Number) |
Description | Returns the maximum value of a 16 bit signed integer (a java 'short'): 32767 |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L330 |
Name | <util.short_min> |
Returns | ElementTag(Number) |
Description | Returns the minimum value of a 16 bit signed integer (a java 'short'): -32768 |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L340 |
Name | <util.sql_connections> |
Returns | ListTag |
Description | Returns a list of all SQL connections opened by sql. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L866 |
Name | <util.stack_trace> |
Returns | ElementTag |
Description | Generates 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 util.java_class_context |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L967 |
Name | <util.started_time> |
Returns | TimeTag |
Description | Returns the time the server started. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L692 |
Name | <util.tau> |
Returns | ElementTag(Decimal) |
Description | Returns Tau: 6.28318530717958647692 |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L400 |
Name | <util.time_now> |
Returns | TimeTag |
Description | Returns 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 util.current_time_millis if you need sub-tick precision. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L473 |
Name | <ViveCraftPlayerTag.active_hand> |
Returns | ElementTag |
Description | Returns the active hand of the ViveCraftPlayer. Returns either right or left. |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/vivecraft/ViveCraftPlayerTag.java#L126 |
Name | <ViveCraftPlayerTag.is_seated> |
Returns | ElementTag(Boolean) |
Description | Returns whether the ViveCraftPlayer sits or not. |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/vivecraft/ViveCraftPlayerTag.java#L136 |
Name | <ViveCraftPlayerTag.position[head/left/right]> |
Returns | LocationTag |
Description | Returns a LocationTag of the given position. |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/vivecraft/ViveCraftPlayerTag.java#L146 |
Name | <WorldTag.allows_animals> |
Returns | ElementTag(Boolean) |
Description | Returns whether animals can spawn in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L449 |
Name | <WorldTag.allows_monsters> |
Returns | ElementTag(Boolean) |
Description | Returns whether monsters can spawn in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L459 |
Name | <WorldTag.allows_pvp> |
Returns | ElementTag(Boolean) |
Description | Returns whether player versus player combat is allowed in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L469 |
Name | <WorldTag.ambient_spawn_limit> |
Returns | ElementTag(Number) |
Mechanism | WorldTag.ambient_spawn_limit |
Description | Returns the number of ambient mobs that can spawn in a chunk in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L490 |
Name | <WorldTag.animal_spawn_limit> |
Returns | ElementTag(Number) |
Mechanism | WorldTag.animal_spawn_limit |
Description | Returns the number of animals that can spawn in a chunk in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L501 |
Name | <WorldTag.auto_save> |
Returns | ElementTag(Boolean) |
Mechanism | WorldTag.auto_save |
Description | Returns whether the world automatically saves. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L479 |
Name | <WorldTag.biomes> |
Returns | ListTag(BiomeTag) |
Description | Returns a list of all biomes in this world (including custom biomes). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L890 |
Name | <WorldTag.border_center> |
Returns | LocationTag |
Description | Returns the center of the world border in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L748 |
Name | <WorldTag.border_damage> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of damage caused by crossing the world border in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L758 |
Name | <WorldTag.border_damage_buffer> |
Returns | ElementTag(Decimal) |
Description | Returns the damage buffer of the world border in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L768 |
Name | <WorldTag.border_size> |
Returns | ElementTag(Decimal) |
Description | Returns the size of the world border in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L738 |
Name | <WorldTag.border_warning_distance> |
Returns | ElementTag(Number) |
Description | Returns the warning distance of the world border in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L778 |
Name | <WorldTag.border_warning_time> |
Returns | DurationTag |
Description | Returns warning time of the world border in this world as a duration. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L788 |
Name | <WorldTag.can_generate_structures> |
Returns | ElementTag(Boolean) |
Description | Returns whether the world will generate structures. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L344 |
Name | <WorldTag.difficulty> |
Returns | ElementTag |
Mechanism | WorldTag.difficulty |
Description | Returns the name of the difficulty level. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L534 |
Name | <WorldTag.dragon_portal_location> |
Returns | LocationTag |
Description | Returns the location of the ender dragon exit portal, if any (only for end worlds). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L832 |
Name | <WorldTag.duration_since_created> |
Returns | DurationTag |
Mechanism | WorldTag.duration_since_created |
Description | Returns the total duration of time since this world was first created. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L589 |
Name | <WorldTag.ender_dragon> |
Returns | EntityTag |
Description | Returns the ender dragon entity currently fighting in this world, if any (only for end worlds). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L850 |
Name | <WorldTag.enough_deep_sleeping[(<#>)]> |
Returns | ElementTag(Boolean) |
Description | Returns 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 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L953 |
Name | <WorldTag.enough_sleeping[(<#>)]> |
Returns | ElementTag(Boolean) |
Description | Returns whether enough players are sleeping to prepare for the night to advance.
Typically used before checking 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L932 |
Name | <WorldTag.entities[(<matcher>)]> |
Returns | ListTag(EntityTag) |
Description | Returns a list of entities in this world.
Optionally specify an entity type matcher to filter down to. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L252 |
Name | <WorldTag.environment> |
Returns | ElementTag |
Description | Returns the environment of the world: NORMAL, NETHER, or THE_END. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L724 |
Name | <WorldTag.first_dragon_killed> |
Returns | ElementTag(Boolean) |
Mechanism | WorldTag.first_dragon_killed |
Description | Returns whether the ender dragon has been killed in this world before.
Only works if the world is an end world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1012 |
Name | <WorldTag.gamerule[<gamerule>]> |
Returns | ElementTag |
Description | Returns 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. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L798 |
Name | <WorldTag.gamerule_map> |
Returns | MapTag |
Description | Returns a map of all the current values of all gamerules in the world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L815 |
Name | <WorldTag.gateway_locations> |
Returns | ListTag(LocationTag) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L867 |
Name | <WorldTag.hardcore> |
Returns | ElementTag(Boolean) |
Mechanism | WorldTag.hardcore |
Description | Returns whether the world is in hardcore mode. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L545 |
Name | <WorldTag.has_storm> |
Returns | ElementTag(Boolean) |
Description | Returns whether there is currently a storm in this world.
ie, whether it is raining. To check for thunder, use WorldTag.thundering. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L680 |
Name | <WorldTag.is_day> |
Returns | ElementTag(Boolean) |
Description | Returns whether it is considered day in this world. Players are not allowed to sleep at this time.
Note that in certain worlds, this and WorldTag.is_night can both be 'false'! (The nether, for example!) In typical worlds, this is 'true' if WorldTag.sky_darkness is less than 4. To check the current time without storm interference, see WorldTag.time and related tags. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L986 |
Name | <WorldTag.is_night> |
Returns | ElementTag(Boolean) |
Description | Returns whether it is considered night in this world. Players are typically allowed to sleep at this time.
Note that in certain worlds, this and WorldTag.is_day can both be 'false'! (The nether, for example!) In typical worlds, this is 'true' if WorldTag.sky_darkness is 4 or higher. To check the current time without storm interference, see WorldTag.time and related tags. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L999 |
Name | <WorldTag.keep_spawn> |
Returns | ElementTag(Boolean) |
Mechanism | WorldTag.keep_spawn |
Description | Returns whether the world's spawn area should be kept loaded into memory. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L556 |
Name | <WorldTag.living_entities> |
Returns | ListTag(EntityTag) |
Description | Returns a list of living entities in this world.
This includes Players, mobs, NPCs, etc., but excludes dropped items, experience orbs, etc. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L271 |
Name | <WorldTag.loaded_chunks> |
Returns | ListTag(ChunkTag) |
Description | Returns a list of all the currently loaded chunks. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L354 |
Name | <WorldTag.max_height> |
Returns | ElementTag(Number) |
Description | Returns the maximum block height of the world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L379 |
Name | <WorldTag.min_height> |
Returns | ElementTag(Number) |
Description | Returns the minimum block height of the world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L389 |
Name | <WorldTag.monster_spawn_limit> |
Returns | ElementTag(Number) |
Mechanism | WorldTag.monster_spawn_limit |
Description | Returns the number of monsters that can spawn in a chunk in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L512 |
Name | <WorldTag.moon_phase> |
Returns | ElementTag(Number) |
Description | Returns the current phase of the moon, as a number from 1 to 8. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L666 |
Name | <WorldTag.name> |
Returns | ElementTag |
Description | Returns the name of the world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L425 |
Name | <WorldTag.npcs> |
Returns | ListTag(NPCTag) |
Description | Returns a list of all NPCs in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L319 |
Name | <WorldTag.players> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of online players in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L286 |
Name | <WorldTag.sea_level> |
Returns | ElementTag(Number) |
Description | Returns the level of the sea. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L369 |
Name | <WorldTag.seed> |
Returns | ElementTag |
Description | Returns the world seed. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L435 |
Name | <WorldTag.sky_darkness> |
Returns | ElementTag(Number) |
Description | Returns 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 |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L974 |
Name | <WorldTag.spawn_location> |
Returns | LocationTag |
Mechanism | WorldTag.spawn_location |
Description | Returns the spawn location of the world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L399 |
Name | <WorldTag.spawned_npcs> |
Returns | ListTag(NPCTag) |
Description | Returns a list of spawned NPCs in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L302 |
Name | <WorldTag.thunder_duration> |
Returns | DurationTag |
Mechanism | WorldTag.thunder_duration |
Description | Returns the duration of thunder. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L691 |
Name | <WorldTag.thundering> |
Returns | ElementTag(Boolean) |
Mechanism | WorldTag.thundering |
Description | Returns whether it is currently thundering in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L702 |
Name | <WorldTag.ticks_per_animal_spawn> |
Returns | DurationTag |
Mechanism | WorldTag.ticks_per_animal_spawns |
Description | Returns the world's ticks per animal spawn value. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L567 |
Name | <WorldTag.ticks_per_monster_spawn> |
Returns | DurationTag |
Mechanism | WorldTag.ticks_per_monster_spawns |
Description | Returns the world's ticks per monster spawn value. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L578 |
Name | <WorldTag.time> |
Returns | ElementTag(Number) |
Mechanism | WorldTag.time |
Description | Returns the relative in-game time of this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L604 |
Name | <WorldTag.time.duration> |
Returns | DurationTag |
Description | Returns the relative in-game time of this world as a duration. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L612 |
Name | <WorldTag.time.full> |
Returns | DurationTag |
Description | Returns the in-game time of this world. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L623 |
Name | <WorldTag.time.period> |
Returns | ElementTag |
Description | Returns the time as 'day', 'night', 'dawn', or 'dusk'. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L634 |
Name | <WorldTag.water_animal_spawn_limit> |
Returns | ElementTag(Number) |
Mechanism | WorldTag.water_animal_spawn_limit |
Description | Returns the number of water animals that can spawn in a chunk in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L523 |
Name | <WorldTag.weather_duration> |
Returns | DurationTag |
Mechanism | WorldTag.weather_duration |
Description | Returns the duration of storms. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L713 |
Name | <WorldTag.world_type> |
Returns | ElementTag |
Description | Returns the world type of the world.
Can return any enum from: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/WorldType.html |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L410 |
Name | <WorldTag.simulation_distance> |
Returns | ElementTag(Number) |
Mechanism | WorldTag.simulation_distance |
Description | Returns the simulation distance of this world. Chunks inside of this radius to players are ticked and processed.
See also WorldTag.view_distance |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L918 |
Name | <WorldTag.view_distance> |
Returns | ElementTag(Number) |
Mechanism | WorldTag.view_distance |
Description | Returns the view distance of this world. Chunks are visible to players inside this radius.
See also WorldTag.simulation_distance |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L904 |
Name | <WorldTag.bigdoors> |
Returns | ListTag(BigDoorsDoorTag) |
Description | Returns a list of Big Doors doors in the world. |
Generated Example |
|
Requires | Depenizen, Big Doors |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/bigdoors/BigDoorsWorldProperties.java#L48 |
Name | <WorldTag.griefprevention_claims> |
Returns | ListTag(GriefPreventionClaimTag) |
Description | Returns a list of GriefPreventionClaim in this world. |
Generated Example |
|
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/griefprevention/GriefPreventionWorldProperties.java#L49 |
Name | <WorldTag.has_region[<name>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether a region exists in this world for the given name. |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardWorldProperties.java#L75 |
Name | <WorldTag.is_skyblock_world> |
Returns | ElementTag(Boolean) |
Description | Returns whether the world is used by A SkyBlock. |
Generated Example |
|
Requires | Depenizen, A SkyBlock |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/askyblock/ASkyBlockWorldProperties.java#L61 |
Name | <WorldTag.list_regions> |
Returns | ListTag(WorldGuardRegionTag) |
Description | Returns a list of WorldGuard regions in this world. |
Generated Example |
|
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardWorldProperties.java#L60 |
Name | <WorldTag.towny_enabled> |
Returns | ElementTag(Boolean) |
Description | Returns whether this world has Towny enabled. |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyWorldProperties.java#L51 |
Name | <WorldTag.gateway_count> |
Returns | ElementTag(Number) |
Description | Returns the number of end gateway portals.
Only works if the world is an end world. |
Generated Example |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperWorldExtensions.java#L34 |
Name | <WorldTag.healing_crystals> |
Returns | ListTag(EntityTag) |
Description | Returns a ListTag of the healing end crystals located on top of the obsidian towers.
Only works if the world is an end world. |
Generated Example |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperWorldExtensions.java#L52 |
Name | <WorldTag.no_tick_view_distance> |
Returns | ElementTag(Number) |
Mechanism | WorldTag.no_tick_view_distance |
Description | Deprecated: replaced by Minecraft's simulation_distance and view_distance config pairing |
Generated Example |
|
Group | paper |
Requires | Paper |
Deprecated | replaced by Minecraft's simulation_distance and view_distance config pairing |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperWorldExtensions.java#L17 |
Name | <WorldTag.respawn_crystals> |
Returns | ListTag(EntityTag) |
Description | Returns a ListTag of the respawn end crystals located at the end exit portal.
Only works if the world is an end world. |
Generated Example |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperWorldExtensions.java#L70 |
Name | <yaml[<id>].contains[<path>]> |
Returns | ElementTag(Boolean) |
Description | Returns true if the file has the specified path.
Otherwise, returns false. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L722 |
Name | <yaml[<id>].has_changes> |
Returns | ElementTag(Boolean) |
Description | Returns whether this YAML object has had changes since the last save or load. |
Generated Example |
|
Source | https://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>]> |
Returns | ElementTag(Boolean) |
Description | Returns true if the specified path results in a list. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L733 |
Name | <yaml.list> |
Returns | ListTag |
Description | Returns a list of all currently loaded YAML ID's. |
Generated Example |
|
Source | https://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>]> |
Returns | ListTag |
Description | Returns 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. |
Source | https://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>]> |
Returns | ListTag |
Description | Returns 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. |
Source | https://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>]> |
Returns | ElementTag |
Description | Returns 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 yaml.read. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L743 |
Name | <yaml[<id>].read[<path>]> |
Returns | ObjectTag |
Description | Returns the value from a data key on the YAML document as an ElementTag, ListTag, or MapTag. |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L760 |
Name | <yaml[<id>].to_json> |
Returns | ElementTag |
Description | Converts the YAML container to a JSON array. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L842 |
Name | <yaml[<id>].to_text> |
Returns | ElementTag |
Description | Converts the YAML container to raw YAML text. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L852 |
Name | <VectorObject.with_x[<number>]> |
Returns | VectorObject |
Description | Returns a copy of this object with a changed X value. |
Group | identity |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L123 |
Name | <VectorObject.with_y[<number>]> |
Returns | VectorObject |
Description | Returns a copy of this object with a changed Y value. |
Group | identity |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L139 |
Name | <VectorObject.with_z[<number>]> |
Returns | VectorObject |
Description | Returns a copy of this object with a changed Z value. |
Group | identity |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L155 |
Name | <VectorObject.x> |
Returns | ElementTag(Decimal) |
Description | Returns the X coordinate of this object. |
Generated Example |
|
Group | identity |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L77 |
Name | <VectorObject.xyz> |
Returns | ElementTag |
Description | Returns 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 |
|
Group | identity |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L110 |
Name | <VectorObject.y> |
Returns | ElementTag(Decimal) |
Description | Returns the Y coordinate of this object. |
Generated Example |
|
Group | identity |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L88 |
Name | <VectorObject.z> |
Returns | ElementTag(Decimal) |
Description | Returns the Z coordinate of this object. |
Generated Example |
|
Group | identity |
Source | https://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>]> |
Returns | VectorObject |
Description | Returns a copy of this object with the specified coordinates added to it. |
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L171 |
Name | <VectorObject.div[<length>]> |
Returns | VectorObject |
Description | Returns a copy of this object divided by the specified length. |
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L212 |
Name | <VectorObject.mul[<length>]> |
Returns | VectorObject |
Description | Returns a copy of this object multiplied by the specified length. |
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L201 |
Name | <VectorObject.normalize> |
Returns | VectorObject |
Description | Returns a 1-length vector in the same direction as this vector. |
Generated Example |
|
Group | math |
Source | https://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>]> |
Returns | VectorObject |
Description | Returns a copy of this object with the specified coordinates subtracted from it. |
Group | math |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L186 |
Name | <VectorObject.quaternion_between_vectors[<vector>]> |
Returns | QuaternionTag |
Description | Returns a quaternion that represents the rotation from this vector to another. |
Group | VectorObject |
Source | https://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>]> |
Returns | QuaternionTag |
Description | Returns a quaternion that is a rotation around this vector as an axis, by the given angle input (in radians). |
Group | VectorObject |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L272 |
Name | <VectorObject.vector_length> |
Returns | ElementTag(Decimal) |
Description | Returns the 3D length of the vector. |
Generated Example |
|
Synonyms (Search Aid) | vectorobject.magnitude |
Group | VectorObject |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L260 |
Name | <VectorObject.vector_length_squared> |
Returns | ElementTag(Decimal) |
Description | Returns the square of the 3D length of the vector. |
Generated Example |
|
Synonyms (Search Aid) | vectorobject.magnitude_squared |
Group | VectorObject |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L248 |
Name | <PropertyHolderObject.property_map> |
Returns | MapTag |
Description | Returns the object's property map. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/properties/PropertyParser.java#L560 |
Name | <PropertyHolderObject.supports[<property-name>]> |
Returns | ElementTag(Boolean) |
Description | Returns 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. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/properties/PropertyParser.java#L536 |
Name | <PropertyHolderObject.with[<mechanism>=<value>;...]> |
Returns | PropertyHolderObject |
Description | Returns a copy of the object with mechanism adjustments applied.
Be careful with dynamic inputs, they may break from escaping flaws. Consider using PropertyHolderObject.with_single instead. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/properties/PropertyParser.java#L463 |
Name | <PropertyHolderObject.with_map[<property-map>]> |
Returns | PropertyHolderObject |
Description | Returns a copy of the object with the MapTag of mechanism adjustments applied. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/properties/PropertyParser.java#L513 |
Name | <PropertyHolderObject.with_single[<mechanism>=<value>]> |
Returns | PropertyHolderObject |
Description | Returns a copy of the object with a single mechanism adjustment applied.
This avoids the risk of escaping issues. |
Group | properties |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/properties/PropertyParser.java#L490 |
Name | <TradeTag.demand> |
Returns | ElementTag(Number) |
Mechanism | TradeTag.demand |
Description | (Property) Returns the demand level of the trade. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/trade/TradeDemand.java#L9 |
Name | <TradeTag.has_xp> |
Returns | ElementTag(Boolean) |
Mechanism | TradeTag.has_xp |
Description | (Property) Returns whether this trade will reward XP upon successful trading. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/trade/TradeHasXp.java#L9 |
Name | <TradeTag.inputs> |
Returns | ListTag(ItemTag) |
Mechanism | TradeTag.inputs |
Description | (Property) Returns 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 |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/trade/TradeInputs.java#L14 |
Name | <TradeTag.max_uses> |
Returns | ElementTag(Number) |
Mechanism | TradeTag.max_uses |
Description | (Property) Returns the maximum amount of times that the trade can be used. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/trade/TradeMaxUses.java#L9 |
Name | <TradeTag.price_multiplier> |
Returns | ElementTag(Decimal) |
Mechanism | TradeTag.price_multiplier |
Description | (Property) Returns the price multiplier for this trade. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/trade/TradePriceMultiplier.java#L9 |
Name | <TradeTag.result> |
Returns | ItemTag |
Mechanism | TradeTag.result |
Description | (Property) Returns what the trade will give the player. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/trade/TradeResult.java#L9 |
Name | <TradeTag.special_price> |
Returns | ElementTag(Number) |
Mechanism | TradeTag.special_price |
Description | (Property) Returns the special price for this trade. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/trade/TradeSpecialPrice.java#L9 |
Name | <TradeTag.uses> |
Returns | ElementTag(Number) |
Mechanism | TradeTag.uses |
Description | (Property) Returns the amount of times the trade has been used. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/trade/TradeUses.java#L9 |
Name | <TradeTag.villager_xp> |
Returns | ElementTag(Number) |
Mechanism | TradeTag.villager_xp |
Description | (Property) Returns the amount of experience a villager gains from this trade. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/trade/TradeVillagerXP.java#L9 |
Name | <AreaShopTag.groups> |
Returns | ListTag |
Description | Returns a list of groups that control this AreaShop. |
Requires | Depenizen, AreaShop |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/areashop/AreaShopTag.java#L135 |
Name | <AreaShopTag.is_bought> |
Returns | ElementTag(Boolean) |
Description | Returns whether this AreaShop has been bought. |
Requires | Depenizen, AreaShop |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/areashop/AreaShopTag.java#L113 |
Name | <AreaShopTag.is_rented> |
Returns | ElementTag(Boolean) |
Description | Returns whether this AreaShop is being rented. |
Requires | Depenizen, AreaShop |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/areashop/AreaShopTag.java#L124 |
Name | <AreaShopTag.landlord> |
Returns | PlayerTag |
Description | Returns the landlord of the AreaShop. |
Requires | Depenizen, AreaShop |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/areashop/AreaShopTag.java#L146 |
Name | <AreaShopTag.name> |
Returns | ElementTag |
Description | Returns the name of the AreaShop. |
Requires | Depenizen, AreaShop |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/areashop/AreaShopTag.java#L157 |
Name | <AreaShopTag.owner> |
Returns | PlayerTag |
Description | Returns the owner of the AreaShop. |
Requires | Depenizen, AreaShop |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/areashop/AreaShopTag.java#L189 |
Name | <AreaShopTag.price> |
Returns | ElementTag(Decimal) |
Description | Returns the price of the AreaShop. |
Requires | Depenizen, AreaShop |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/areashop/AreaShopTag.java#L168 |
Name | <AreaShopTag.worldguard_region> |
Returns | WorldGuardRegionTag |
Description | Returns the WorldGuardRegionTag that holds the AreaShop. |
Requires | Depenizen, AreaShop |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/areashop/AreaShopTag.java#L200 |
Name | <BigDoorsDoorTag.auto_close> |
Returns | DurationTag |
Mechanism | BigDoorsDoorTag.auto_close |
Description | Returns the auto close time for the door.
Returns 0 if the door does not auto close. |
Requires | Depenizen, Big Doors |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/bigdoors/BigDoorsDoorTag.java#L154 |
Name | <BigDoorsDoorTag.cuboid> |
Returns | CuboidTag |
Description | Returns the cuboid of the door. |
Requires | Depenizen, Big Doors |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/bigdoors/BigDoorsDoorTag.java#L143 |
Name | <BigDoorsDoorTag.door_type> |
Returns | ElementTag |
Description | Returns the type of door. |
Requires | Depenizen, Big Doors |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/bigdoors/BigDoorsDoorTag.java#L193 |
Name | <BigDoorsDoorTag.is_busy> |
Returns | ElementTag(Boolean) |
Description | Returns whether the door is busy (currently animated/opening/closing). |
Requires | Depenizen, Big Doors |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/bigdoors/BigDoorsDoorTag.java#L120 |
Name | <BigDoorsDoorTag.is_loaded> |
Returns | ElementTag(Boolean) |
Description | Returns whether the door is currently loaded (the chunks it sits in are loaded).
If this returns false, the door cannot open or close. |
Requires | Depenizen, Big Doors |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/bigdoors/BigDoorsDoorTag.java#L131 |
Name | <BigDoorsDoorTag.is_locked> |
Returns | ElementTag(Boolean) |
Mechanism | BigDoorsDoorTag.is_locked |
Description | Returns whether the door is locked. |
Requires | Depenizen, Big Doors |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/bigdoors/BigDoorsDoorTag.java#L108 |
Name | <BigDoorsDoorTag.is_open> |
Returns | ElementTag(Boolean) |
Mechanism | BigDoorsDoorTag.is_open |
Description | Returns whether the door is open. |
Requires | Depenizen, Big Doors |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/bigdoors/BigDoorsDoorTag.java#L96 |
Name | <BigDoorsDoorTag.name> |
Returns | ElementTag |
Description | Returns the name of the door (this is not always unique). |
Requires | Depenizen, Big Doors |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/bigdoors/BigDoorsDoorTag.java#L204 |
Name | <BigDoorsDoorTag.owners> |
Returns | ListTag(PlayerTag) |
Description | Returns the list of owners of the door. |
Requires | Depenizen, Big Doors |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/bigdoors/BigDoorsDoorTag.java#L178 |
Name | <BigDoorsDoorTag.power_block> |
Returns | LocationTag |
Description | Returns the location of the power block for the door. |
Requires | Depenizen, Big Doors |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/bigdoors/BigDoorsDoorTag.java#L167 |
Name | <bungee.connected> |
Returns | ElementTag(Boolean) |
Description | Returns whether this server is currently connected to the BungeeCord proxy server. |
Requires | Depenizen, DepenizenBungee, BungeeCord |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bungee/BungeeBridge.java#L296 |
Name | <bungee.list_servers> |
Returns | ListTag |
Description | Returns a list of known bungee server names. |
Requires | Depenizen, DepenizenBungee, BungeeCord |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bungee/BungeeBridge.java#L284 |
Name | <bungee.server> |
Returns | ElementTag |
Description | Returns the name of the current server (according to the Bungee proxy config). |
Requires | Depenizen, DepenizenBungee, BungeeCord |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bungee/BungeeBridge.java#L272 |
Name | <crackshot.weapon[<weapon_name>]> |
Returns | ItemTag |
Description | Returns the ItemTag for the CrackShot weapon title specified, if it exists. https://github.com/Shampaggon/CrackShot/wiki/The-Complete-Guide-to-CrackShot#title |
Requires | Depenizen, CrackShot |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/CrackShotBridge.java#L51 |
Name | <DiscordBotTag.command[<name>]> |
Returns | DiscordCommandTag |
Description | Returns the application command that best matches the input name, or null if there's no match. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordBotTag.java#L194 |
Name | <DiscordBotTag.commands> |
Returns | ListTag(DiscordCommandTag) |
Description | Returns a list of all application commands. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordBotTag.java#L141 |
Name | <DiscordBotTag.group[<name>]> |
Returns | DiscordGroupTag |
Description | Returns the Discord group (aka 'guild' or 'server') that best matches the input name, or null if there's no match. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordBotTag.java#L160 |
Name | <DiscordBotTag.groups> |
Returns | ListTag(DiscordGroupTag) |
Description | Returns a list of all groups (aka 'guilds' or 'servers') that this Discord bot has access to. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordBotTag.java#L122 |
Name | <DiscordBotTag.name> |
Returns | ElementTag |
Description | Returns the name of the bot. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordBotTag.java#L94 |
Name | <DiscordBotTag.self_user> |
Returns | DiscordUserTag |
Description | Returns the bot's own Discord user object. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordBotTag.java#L106 |
Name | <DiscordButtonTag.map> |
Returns | MapTag |
Description | Returns the MapTag internally backing this button tag. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordButtonTag.java#L169 |
Name | <DiscordButtonTag.with_map[<map>]> |
Returns | DiscordButtonTag |
Description | Returns a copy of this Button tag, with the map of keys to values applied.
Refer to DiscordButtonTag.with.as. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordButtonTag.java#L101 |
Name | <DiscordButtonTag.with[<key>].as[<value>]> |
Returns | DiscordButtonTag |
Description | Returns 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 |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordButtonTag.java#L132 |
Name | <DiscordChannelTag.active_threads> |
Returns | ListTag(DiscordChannelTag) |
Description | Returns the list of all current (non-archived) thread channels inside this text channel. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L282 |
Name | <DiscordChannelTag.archived_threads> |
Returns | ListTag(DiscordChannelTag) |
Description | Returns the list of all archived thread channels inside this text channel. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L304 |
Name | <DiscordChannelTag.channel_type> |
Returns | ElementTag |
Description | Returns 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. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L155 |
Name | <DiscordChannelTag.connected_users> |
Returns | ListTag(DiscordUserTag) |
Description | If the channel is a voice channel, returns the users connected to it. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L411 |
Name | <DiscordChannelTag.first_message> |
Returns | DiscordMessageTag |
Description | Returns the first message sent in the channel. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L375 |
Name | <DiscordChannelTag.group> |
Returns | DiscordGroupTag |
Description | Returns the group that owns this channel. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L337 |
Name | <DiscordChannelTag.id> |
Returns | ElementTag(Number) |
Description | Returns the ID number of the channel. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L167 |
Name | <DiscordChannelTag.is_thread> |
Returns | ElementTag(Boolean) |
Description | Returns true if the channel is a thread, or false if it is some other type of channel. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L215 |
Name | <DiscordChannelTag.is_thread_archived> |
Returns | ElementTag(Boolean) |
Mechanism | DiscordChannelTag.is_thread_archived |
Description | Returns true if the thread is archived, or false if it is still open.
Only applicable to thread-channels. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L226 |
Name | <DiscordChannelTag.is_thread_locked> |
Returns | ElementTag(Boolean) |
Mechanism | DiscordChannelTag.is_thread_locked |
Description | Returns true if the thread is locked (cannot be pulled from archive).
Only applicable to thread-channels. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L244 |
Name | <DiscordChannelTag.last_message> |
Returns | DiscordMessageTag |
Description | Returns the last message sent in the channel. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L391 |
Name | <DiscordChannelTag.mention> |
Returns | ElementTag |
Description | Returns the raw mention string for the channel. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L326 |
Name | <DiscordChannelTag.name> |
Returns | ElementTag |
Mechanism | DiscordChannelTag.name |
Description | Returns the name of the channel. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L143 |
Name | <DiscordChannelTag.parent> |
Returns | DiscordChannelTag |
Description | Returns the parent channel of this thread channel (if this channel is a thread). |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L178 |
Name | <DiscordChannelTag.pinned_messages> |
Returns | ListTag(DiscordMessageTag) |
Description | Returns a list of the messages that are pinned in the channel. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L356 |
Name | <DiscordChannelTag.thread_members> |
Returns | ListTag(DiscordUserTag) |
Description | Returns the list of users joined into this thread channel (if this channel is a thread). |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L195 |
Name | <DiscordChannelTag.threads> |
Returns | ListTag(DiscordChannelTag) |
Description | Returns the list of all (archived or not) thread channels inside this text channel. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L262 |
Name | <DiscordChannelTag.topic> |
Returns | ElementTag |
Mechanism | DiscordChannelTag.topic |
Description | Returns the topic for this channel. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordChannelTag.java#L432 |
Name | <DiscordCommandTag.description> |
Returns | ElementTag |
Description | Returns the description of the command. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordCommandTag.java#L199 |
Name | <DiscordCommandTag.id> |
Returns | ElementTag(Number) |
Description | Returns the ID of the command. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordCommandTag.java#L177 |
Name | <DiscordCommandTag.name> |
Returns | ElementTag |
Description | Returns the name of the command. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordCommandTag.java#L188 |
Name | <DiscordCommandTag.options> |
Returns | ListTag(MapTag) |
Description | Returns the option MapTags of the command. This is the same value as the one provided when creating a command, as documented in DiscordCommand. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordCommandTag.java#L210 |
Name | <DiscordEmbedTag.add_field[<title>].value[<value>]> |
Returns | DiscordEmbedTag |
Description | Returns a copy of this Embed tag, with a field added with the given title and value. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L310 |
Name | <DiscordEmbedTag.add_inline_field[<title>].value[<value>]> |
Returns | DiscordEmbedTag |
Description | Returns a copy of this Embed tag, with an inline field added with the given title and value. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L341 |
Name | <DiscordEmbedTag.map> |
Returns | MapTag |
Description | Returns the MapTag internally backing this embed tag. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L299 |
Name | <DiscordEmbedTag.output_length> |
Returns | ElementTag(Number) |
Description | Returns 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 |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L373 |
Name | <DiscordEmbedTag.to_json> |
Returns | ElementTag |
Description | Returns the raw Discord-API-compatible JSON text of this embed. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L387 |
Name | <DiscordEmbedTag.with_map[<map>]> |
Returns | DiscordEmbedTag |
Description | Returns a copy of this Embed tag, with the map of keys to values applied.
Refer to DiscordEmbedTag.with.as. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L210 |
Name | <DiscordEmbedTag.with[<key>].as[<value>]> |
Returns | DiscordEmbedTag |
Description | Returns 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 DiscordEmbedTag.add_field.value and DiscordEmbedTag.add_inline_field.value. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordEmbedTag.java#L247 |
Name | <DiscordGroupTag.banned_members> |
Returns | ListTag(DiscordUserTag) |
Description | Returns a list of all banned users in the group. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L192 |
Name | <DiscordGroupTag.channel[<name>]> |
Returns | DiscordChannelTag |
Description | Returns the channel that best matches the input name, or null if there's no match. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L269 |
Name | <DiscordGroupTag.channels> |
Returns | ListTag(DiscordChannelTag) |
Description | Returns a list of all channels in the group. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L162 |
Name | <DiscordGroupTag.command[<name>]> |
Returns | DiscordCommandTag |
Description | Returns the guild command that best matches the input name, or null if there's no match. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L327 |
Name | <DiscordGroupTag.commands> |
Returns | ListTag(DiscordCommandTag) |
Description | Returns a list of all commands in the group. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L222 |
Name | <DiscordGroupTag.emoji_id[<name>]> |
Returns | ElementTag |
Description | Returns the ID of the emoji that best matches the input name, or null if there's no match. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L371 |
Name | <DiscordGroupTag.emoji_names> |
Returns | ListTag |
Description | Returns a list of emoji names in the group. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L356 |
Name | <DiscordGroupTag.id> |
Returns | ElementTag(Number) |
Description | Returns the ID number of the group. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L151 |
Name | <DiscordGroupTag.member[<name>]> |
Returns | DiscordUserTag |
Description | Returns 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). |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L237 |
Name | <DiscordGroupTag.members> |
Returns | ListTag(DiscordUserTag) |
Description | Returns a list of all users in the group. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L177 |
Name | <DiscordGroupTag.name> |
Returns | ElementTag |
Description | Returns the name of the group. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L140 |
Name | <DiscordGroupTag.role[<name>]> |
Returns | DiscordRoleTag |
Description | Returns the role that best matches the input name, or null if there's no match. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L298 |
Name | <DiscordGroupTag.roles> |
Returns | ListTag(DiscordRoleTag) |
Description | Returns a list of all roles in the group. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L207 |
Name | <DiscordGroupTag.users_with_roles[<role>|...]> |
Returns | ListTag(DiscordUserTag) |
Description | Returns a list of all users in the group who have all the specified roles. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordGroupTag.java#L400 |
Name | <DiscordInteractionTag.channel> |
Returns | DiscordChannelTag |
Description | Returns the channel that the interaction was created in. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordInteractionTag.java#L168 |
Name | <DiscordInteractionTag.id> |
Returns | ElementTag(Number) |
Description | Returns the ID of the interaction. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordInteractionTag.java#L157 |
Name | <DiscordInteractionTag.is_direct> |
Returns | ElementTag(Boolean) |
Description | Returns true if the interaction was sent in a direct (private) channel, or false if in a public channel. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordInteractionTag.java#L179 |
Name | <DiscordInteractionTag.target_message> |
Returns | DiscordMessageTag |
Description | Returns the message being targeted by a MESSAGE application interaction. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordInteractionTag.java#L216 |
Name | <DiscordInteractionTag.target_user> |
Returns | DiscordUserTag |
Description | Returns the user being targeted by a USER application interaction. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordInteractionTag.java#L202 |
Name | <DiscordInteractionTag.user> |
Returns | DiscordUserTag |
Description | Returns the user of the interaction. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordInteractionTag.java#L191 |
Name | <DiscordMessageTag.attachments> |
Returns | ListTag |
Description | Returns 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. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L425 |
Name | <DiscordMessageTag.author> |
Returns | DiscordUserTag |
Description | Returns the author of the message. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L283 |
Name | <DiscordMessageTag.channel> |
Returns | DiscordChannelTag |
Description | Returns the channel that the message was sent to. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L228 |
Name | <DiscordMessageTag.embed> |
Returns | ListTag(DiscordEmbedTag) |
Description | Returns a list of "embed" formatted data on this message. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L343 |
Name | <DiscordMessageTag.id> |
Returns | ElementTag(Number) |
Description | Returns the ID of the message. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L203 |
Name | <DiscordMessageTag.is_direct> |
Returns | ElementTag(Boolean) |
Description | Returns true if the message was sent in a direct (private) channel, or false if in a public channel. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L332 |
Name | <DiscordMessageTag.is_pinned> |
Returns | ElementTag(Boolean) |
Mechanism | DiscordMessageTag.is_pinned |
Description | Returns whether this message is pinned. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L305 |
Name | <DiscordMessageTag.mentioned_users> |
Returns | ListTag(DiscordUserTag) |
Description | Returns a list of users mentioned (pinged) by this message. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L317 |
Name | <DiscordMessageTag.next_messages[<#>]> |
Returns | ListTag(DiscordMessageTag) |
Description | Returns 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. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L391 |
Name | <DiscordMessageTag.previous_messages[<#>]> |
Returns | ListTag(DiscordMessageTag) |
Description | Returns 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. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L373 |
Name | <DiscordMessageTag.reactions> |
Returns | ListTag |
Description | Returns a list of reaction on this message. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L358 |
Name | <DiscordMessageTag.replied_to> |
Returns | DiscordMessageTag |
Description | Returns the message that this message was in reply to (if any). |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L409 |
Name | <DiscordMessageTag.text> |
Returns | ElementTag |
Description | Returns the full text of the message. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L239 |
Name | <DiscordMessageTag.text_display> |
Returns | ElementTag |
Description | Returns the display text of the message (special codes like pings formatted to how they should look for users). |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L261 |
Name | <DiscordMessageTag.text_no_mentions> |
Returns | ElementTag |
Description | Returns the text of the message, with '@' mentions removed. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L272 |
Name | <DiscordMessageTag.text_stripped> |
Returns | ElementTag |
Description | Returns the stripped text of the message (format codes like bold removed). |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L250 |
Name | <DiscordMessageTag.url> |
Returns | ElementTag |
Description | Returns 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. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L214 |
Name | <DiscordMessageTag.was_edited> |
Returns | ElementTag(Boolean) |
Description | Returns whether this message was edited. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordMessageTag.java#L294 |
Name | <DiscordReactionTag.count> |
Returns | ElementTag(Number) |
Description | Returns the amount of times this reaction exists on the message. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordReactionTag.java#L228 |
Name | <DiscordReactionTag.id> |
Returns | ElementTag |
Description | Returns the ID of the reaction emote.
For custom emoji, this is a numeric ID. For default emoji, this is the unicode symbol. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordReactionTag.java#L200 |
Name | <DiscordReactionTag.is_animated> |
Returns | ElementTag |
Description | Returns whether the emote reacted is animated (an "animoji"). |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordReactionTag.java#L253 |
Name | <DiscordReactionTag.message> |
Returns | DiscordMessageTag |
Description | Returns the message this reaction is attached to. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordReactionTag.java#L212 |
Name | <DiscordReactionTag.name> |
Returns | ElementTag |
Description | Returns the name of the emoji. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordReactionTag.java#L242 |
Name | <DiscordReactionTag.reactors> |
Returns | ListTag(DiscordUserTag) |
Description | Returns the list of users that added this reaction to the message. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordReactionTag.java#L264 |
Name | <DiscordRoleTag.color> |
Returns | ColorTag |
Mechanism | DiscordRoleTag.color |
Description | Returns the display color of the role, if any. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L212 |
Name | <DiscordRoleTag.group> |
Returns | DiscordGroupTag |
Description | Returns the group that owns this role. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L201 |
Name | <DiscordRoleTag.id> |
Returns | ElementTag(Number) |
Description | Returns the ID number of the role. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L179 |
Name | <DiscordRoleTag.mention> |
Returns | ElementTag |
Description | Returns the raw mention string of the role. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L190 |
Name | <DiscordRoleTag.name> |
Returns | ElementTag |
Description | Returns the name of the role. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L168 |
Name | <DiscordRoleTag.permissions> |
Returns | ListTag |
Description | Returns 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 |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L243 |
Name | <DiscordRoleTag.users> |
Returns | ListTag(DiscordUserTag) |
Description | Returns a list of all users with this role. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordRoleTag.java#L228 |
Name | <DiscordSelectionTag.map> |
Returns | MapTag |
Description | Returns the MapTag internally backing this selection tag. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordSelectionTag.java#L222 |
Name | <DiscordSelectionTag.with_map[<map>]> |
Returns | DiscordSelectionTag |
Description | Returns a copy of this Selection tag, with the map of keys to values applied.
Refer to DiscordSelectionTag.with.as. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordSelectionTag.java#L152 |
Name | <DiscordSelectionTag.with[<key>].as[<value>]> |
Returns | DiscordSelectionTag |
Description | Returns 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 |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordSelectionTag.java#L183 |
Name | <DiscordTextInputTag.map> |
Returns | MapTag |
Description | Returns the MapTag internally backing this text input tag. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordTextInputTag.java#L193 |
Name | <DiscordTextInputTag.with_map[<map>]> |
Returns | DiscordTextInputTag |
Description | Returns a copy of this TextInput tag, with the map of keys to values applied.
Refer to DiscordTextInputTag.with.as. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordTextInputTag.java#L122 |
Name | <DiscordTextInputTag.with[<key>].as[<value>]> |
Returns | DiscordTextInputTag |
Description | Returns 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 |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordTextInputTag.java#L153 |
Name | <DiscordUserTag.activity_name[<group>]> |
Returns | ElementTag |
Description | Returns the name of the activity of the user, as seen from the given group.
Not present for all users. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L361 |
Name | <DiscordUserTag.activity_type[<group>]> |
Returns | ElementTag |
Description | Returns 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. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L334 |
Name | <DiscordUserTag.activity_url[<group>]> |
Returns | ElementTag |
Description | Returns the stream URL of the activity of the user, as seen from the given group.
Not present for all users. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L387 |
Name | <DiscordUserTag.avatar_url> |
Returns | ElementTag |
Description | Returns the URL to the user's avatar. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L243 |
Name | <DiscordUserTag.discriminator> |
Returns | ElementTag |
Description | Returns the discriminator ID of the user. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L215 |
Name | <DiscordUserTag.display_name> |
Returns | ElementTag |
Description | Returns the global display name of the user, if any.
To obtain a server-specific display name, use DiscordUserTag.nickname. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L416 |
Name | <DiscordUserTag.id> |
Returns | ElementTag(Number) |
Description | Returns the ID number of the user. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L289 |
Name | <DiscordUserTag.is_banned[<group>]> |
Returns | ElementTag(boolean) |
Description | Returns whether the user is banned from a certain group. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L480 |
Name | <DiscordUserTag.is_bot> |
Returns | ElementTag(Boolean) |
Description | Returns a boolean indicating whether the user is a bot. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L229 |
Name | <DiscordUserTag.is_in_group[<group>]> |
Returns | ElementTag(Boolean) |
Description | Returns 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. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L197 |
Name | <DiscordUserTag.is_timed_out[<group>]> |
Returns | ElementTag(boolean) |
Description | Returns whether the user is timed out in a certain group. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L502 |
Name | <DiscordUserTag.is_valid> |
Returns | ElementTag(Boolean) |
Description | Returns 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. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L184 |
Name | <DiscordUserTag.mention> |
Returns | ElementTag |
Description | Returns the raw mention string for the user. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L301 |
Name | <DiscordUserTag.name> |
Returns | ElementTag |
Description | Returns the base username of the user. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L170 |
Name | <DiscordUserTag.nickname[<group>]> |
Returns | ElementTag |
Description | Returns the group-specific nickname of the user (if any). |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L257 |
Name | <DiscordUserTag.permissions[<group>]> |
Returns | ListTag |
Description | Returns 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 |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L455 |
Name | <DiscordUserTag.roles[<group>]> |
Returns | ListTag(DiscordRoleTag) |
Description | Returns a list of all roles the user has in the given group. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L432 |
Name | <DiscordUserTag.status[<group>]> |
Returns | ElementTag |
Description | Returns the status of the user, as seen from the given group.
Can be any of: online, dnd, idle, invisible, offline. |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/objects/DiscordUserTag.java#L312 |
Name | <essentials.list_warps> |
Returns | ListTag |
Description | Returns a list of all Warp names. |
Generated Example |
|
Requires | Depenizen, Essentials |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/EssentialsBridge.java#L53 |
Name | <essentials.warp[<warp_name>]> |
Returns | LocationTag |
Description | Returns the location of the warp name. |
Requires | Depenizen, Essentials |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/EssentialsBridge.java#L33 |
Name | <factions.list_factions> |
Returns | ListTag(FactionTag) |
Description | Returns a list of all current factions. |
Generated Example |
|
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/FactionsBridge.java#L70 |
Name | <FactionTag.balance> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of money the faction currently has. |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L126 |
Name | <FactionTag.claimed_chunks> |
Returns | ListTag(ChunkTag) |
Description | Returns a list of all chunks claimed in the faction. |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L285 |
Name | <FactionTag.id> |
Returns | ElementTag |
Description | Returns the unique ID for this faction. |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L161 |
Name | <FactionTag.is_open> |
Returns | ElementTag(Boolean) |
Description | Returns true if the faction is open. |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L172 |
Name | <FactionTag.is_peaceful> |
Returns | ElementTag(Boolean) |
Description | Returns true if the faction is peaceful. |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L184 |
Name | <FactionTag.is_permanent> |
Returns | ElementTag(Boolean) |
Description | Returns true if the faction is permanent. |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L196 |
Name | <FactionTag.leader> |
Returns | PlayerTag |
Description | Returns the faction's leader as a PlayerTag. |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L208 |
Name | <FactionTag.list_players> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all players in the faction. |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L301 |
Name | <FactionTag.name> |
Returns | ElementTag |
Description | Returns the name of the faction. |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L222 |
Name | <FactionTag.player_count> |
Returns | ElementTag(Number) |
Description | Returns the number of players in the faction. |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L234 |
Name | <FactionTag.power> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of power the faction currently has. |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L246 |
Name | <FactionTag.relation[<faction>]> |
Returns | ElementTag |
Description | Returns the current relation between the faction and another faction. |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L258 |
Name | <FactionTag.size> |
Returns | ElementTag(Number) |
Description | Returns the amount of land the faction has. |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L273 |
Name | <FactionTag.warp[<name>]> |
Returns | LocationTag |
Description | Returns the location of the faction's warp by name, if any.
Note that this was previously named "home" instead of "warp". |
Requires | Depenizen, Factions |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java#L138 |
Name | <griefprevention.list_claims> |
Returns | ListTag(GriefPreventionClaimTag) |
Description | Returns a list of all GriefPrevention claims. |
Generated Example |
|
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/GriefPreventionBridge.java#L49 |
Name | <GriefPreventionClaimTag.accessors> |
Returns | ListTag(PlayerTag) |
Description | Returns the GriefPreventionClaim's accessors. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L212 |
Name | <GriefPreventionClaimTag.builders> |
Returns | ListTag(PlayerTag) |
Description | Returns the GriefPreventionClaim's builders. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L178 |
Name | <GriefPreventionClaimTag.can_siege[<player>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the GriefPreventionClaim can siege the player. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L296 |
Name | <GriefPreventionClaimTag.chunks> |
Returns | ListTag(ChunkTag) |
Description | Returns a list of all chunks in the GriefPreventionClaim. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L281 |
Name | <GriefPreventionClaimTag.containers> |
Returns | ListTag(PlayerTag) |
Description | Returns the GriefPreventionClaim's containers. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L195 |
Name | <GriefPreventionClaimTag.cuboid> |
Returns | CuboidTag |
Description | Returns the GriefPreventionClaim's cuboid area. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L245 |
Name | <GriefPreventionClaimTag.id> |
Returns | ElementTag(Number) |
Description | Returns the GriefPreventionClaim's ID. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L135 |
Name | <GriefPreventionClaimTag.is_adminclaim> |
Returns | ElementTag(Boolean) |
Description | Returns whether GriefPreventionClaim is an Admin Claim. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L270 |
Name | <GriefPreventionClaimTag.is_sieged> |
Returns | ElementTag(Boolean) |
Description | Returns whether the GriefPreventionClaim is currently under siege. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L314 |
Name | <GriefPreventionClaimTag.managers> |
Returns | ListTag(PlayerTag) |
Description | Returns the GriefPreventionClaim's managers. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L146 |
Name | <GriefPreventionClaimTag.owner> |
Returns | ObjectTag |
Mechanism | GriefPreventionClaimTag.owner |
Description | Returns the GriefPreventionClaim's owner.
Can be "Admin" or a PlayerTag. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L229 |
Name | <GriefPreventionClaimTag.trusted> |
Returns | ListTag(PlayerTag) |
Description | Returns the GriefPreventionClaim's trusted. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L161 |
Name | <GriefPreventionClaimTag.world> |
Returns | WorldTag |
Description | Returns the world this GriefPreventionClaim is in. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L259 |
Name | <JobsJobTag.description> |
Returns | ElementTag |
Description | Single line description is deprecated in Jobs. Use JobsJobTag.full_description instead. |
Requires | Depenizen, Jobs |
Deprecated | Use 'JobsJobTag.full_description' |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L148 |
Name | <JobsJobTag.full_description> |
Returns | ListTag |
Description | Returns the full description of the job. |
Requires | Depenizen, Jobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L161 |
Name | <JobsJobTag.level> |
Returns | ElementTag(Number) |
Description | Returns the current level a player has in a specified job. |
Requires | Depenizen, Jobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L251 |
Name | <JobsJobTag.max_xp[(<level>)]> |
Returns | ElementTag(Number) |
Description | Returns the amount of experience required for the specified job level.
If the level is not specified, uses the current level of the player. |
Requires | Depenizen, Jobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L262 |
Name | <JobsJobTag.name> |
Returns | ElementTag |
Description | Returns the name of the job. |
Requires | Depenizen, Jobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L181 |
Name | <JobsJobTag.name.short> |
Returns | ElementTag |
Description | Deprecated in favor of JobsJobTag.short_name. |
Requires | Depenizen, Jobs |
Deprecated | Use 'JobsJobTag.short_name' |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L172 |
Name | <JobsJobTag.player> |
Returns | PlayerTag |
Description | Returns the player the job progression for this tag belongs to. |
Requires | Depenizen, Jobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L280 |
Name | <JobsJobTag.short_name> |
Returns | ElementTag |
Description | Returns the shortened name of the job. |
Requires | Depenizen, Jobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L197 |
Name | <JobsJobTag.xp> |
Returns | ElementTag(Decimal) |
Mechanism | JobsJobTag.xp |
Description | Returns the current experience a player has for the current level in a specified job. |
Requires | Depenizen, Jobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L226 |
Name | <JobsJobTag.xp.level> |
Returns | ElementTag(Number) |
Description | Deprecated in favor of JobsJobTag.level. |
Requires | Depenizen, Jobs |
Deprecated | Use 'JobsJobTag.level' |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L217 |
Name | <JobsJobTag.xp.max> |
Returns | ElementTag(Number) |
Description | Deprecated in favor of JobsJobTag.max_xp. |
Requires | Depenizen, Jobs |
Deprecated | Use 'JobsJobTag.max_xp' |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java#L208 |
Name | <LibsDisguiseTag.disguise_type> |
Returns | ElementTag |
Description | Returns the type of the disguise. |
Requires | Depenizen, LibsDisguises |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/libsdisguises/LibsDisguiseTag.java#L116 |
Name | <LibsDisguiseTag.display_name> |
Returns | ElementTag |
Description | Returns the display name of the disguise. |
Requires | Depenizen, LibsDisguises |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/libsdisguises/LibsDisguiseTag.java#L138 |
Name | <LibsDisguiseTag.entity> |
Returns | EntityTag |
Description | Returns the entity of the disguise. |
Requires | Depenizen, LibsDisguises |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/libsdisguises/LibsDisguiseTag.java#L127 |
Name | <luckperms.list_groups> |
Returns | ListTag(LuckPermsGroupTag) |
Description | Returns a list of all luckperms groups. |
Generated Example |
|
Requires | Depenizen, LuckPerms |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/LuckPermsBridge.java#L49 |
Name | <luckperms.list_tracks> |
Returns | ListTag(LuckPermsTrackTag) |
Description | Returns a list of all tracks. |
Generated Example |
|
Requires | Depenizen, LuckPerms |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/LuckPermsBridge.java#L27 |
Name | <luckperms.track[<track_name>]> |
Returns | LuckPermsTrackTag |
Description | Returns the track from the name given. |
Requires | Depenizen, LuckPerms |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/LuckPermsBridge.java#L38 |
Name | <LuckPermsGroupTag.group_name> |
Returns | ElementTag |
Description | Returns the group's name. |
Requires | Depenizen, LuckPerms |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/luckperms/LuckPermsGroupTag.java#L99 |
Name | <LuckPermsGroupTag.group_prefix> |
Returns | ElementTag |
Description | Returns the group's prefix, if any. |
Requires | Depenizen, LuckPerms |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/luckperms/LuckPermsGroupTag.java#L110 |
Name | <LuckPermsGroupTag.group_suffix> |
Returns | ElementTag |
Description | Returns the group's suffix, if any. |
Requires | Depenizen, LuckPerms |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/luckperms/LuckPermsGroupTag.java#L122 |
Name | <LuckPermsGroupTag.group_weight> |
Returns | ElementTag |
Description | Returns the group's weight, if any. |
Requires | Depenizen, LuckPerms |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/luckperms/LuckPermsGroupTag.java#L134 |
Name | <LuckPermsGroupTag.has_permission[<permission.node>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the group has the specified permission node. |
Requires | Depenizen, LuckPerms |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/luckperms/LuckPermsGroupTag.java#L146 |
Name | <LuckPermsTrackTag.groups[(<player>)]> |
Returns | ListTag |
Description | This returns names of the groups instead of 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. |
Requires | Depenizen, LuckPerms |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/luckperms/LuckPermsTrackTag.java#L149 |
Name | <LuckPermsTrackTag.loaded_groups[(<player>)]> |
Returns | ListTag(LuckPermsGroupTag) |
Description | Returns the list of loaded groups in the track.
If a player input is specified, limits to only the groups that the player is in. |
Requires | Depenizen, LuckPerms |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/luckperms/LuckPermsTrackTag.java#L180 |
Name | <LuckPermsTrackTag.name> |
Returns | ElementTag |
Description | Returns the name of the track. |
Requires | Depenizen, LuckPerms |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/luckperms/LuckPermsTrackTag.java#L138 |
Name | <mobarena.list_arenas> |
Returns | ListTag(MobArenaArenaTag) |
Description | Returns a list of all MobArenas. |
Generated Example |
|
Requires | Depenizen, MobArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/MobArenaBridge.java#L67 |
Name | <MobArenaArenaTag.config_name> |
Returns | ElementTag |
Description | Returns the configuration name of the arena. |
Requires | Depenizen, MobArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L120 |
Name | <MobArenaArenaTag.current_wave> |
Returns | ElementTag(Number) |
Description | Returns the current wave number.
NOTE: Requires the arena to be running. |
Requires | Depenizen, MobArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L154 |
Name | <MobArenaArenaTag.is_enabled> |
Returns | ElementTag(Boolean) |
Description | Returns whether the arena is enabled. |
Requires | Depenizen, MobArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L180 |
Name | <MobArenaArenaTag.is_running> |
Returns | ElementTag(Boolean) |
Description | Returns whether the arena is running. |
Requires | Depenizen, MobArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L131 |
Name | <MobArenaArenaTag.name> |
Returns | ElementTag |
Description | Returns the name of the arena. |
Requires | Depenizen, MobArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L109 |
Name | <MobArenaArenaTag.players> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all players in the arena (including the lobby). |
Requires | Depenizen, MobArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L243 |
Name | <MobArenaArenaTag.players.in_arena> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of players in the arena. |
Requires | Depenizen, MobArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L213 |
Name | <MobArenaArenaTag.players.in_lobby> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of players in the lobby. |
Requires | Depenizen, MobArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L228 |
Name | <MobArenaArenaTag.status> |
Returns | ElementTag |
Description | Returns the status of the arena.
Will return 'closed', 'open', or 'running'. |
Requires | Depenizen, MobArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L191 |
Name | <MobArenaArenaTag.wave_count> |
Returns | ElementTag(Number) |
Description | Returns the number of waves this arena has in total. |
Requires | Depenizen, MobArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L142 |
Name | <MobArenaArenaTag.wave_type> |
Returns | ElementTag |
Description | Returns the type of the current wave.
NOTE: Requires the arena to be running. |
Requires | Depenizen, MobArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L167 |
Name | <mythicmobs.active_mobs> |
Returns | ListTag(MythicMobsMobTag) |
Description | Returns a ListTag of all active MythicMobs on the server. |
Generated Example |
|
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/MythicMobsBridge.java#L151 |
Name | <mythicmobs.spawners> |
Returns | ListTag(MythicSpawnerTag) |
Description | Returns a ListTag of all MythicSpawners. |
Generated Example |
|
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/MythicMobsBridge.java#L166 |
Name | <MythicMobsMobTag.armor> |
Returns | ElementTag(Decimal) |
Description | Returns the armor the MythicMob has. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L227 |
Name | <MythicMobsMobTag.damage> |
Returns | ElementTag(Decimal) |
Description | Returns the damage the MythicMob deals. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L216 |
Name | <MythicMobsMobTag.display_name> |
Returns | ElementTag |
Description | Returns the display name of the MythicMob. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L152 |
Name | <MythicMobsMobTag.entity> |
Returns | EntityTag |
Description | Returns the EntityTag for the MythicMob. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L341 |
Name | <MythicMobsMobTag.global_cooldown> |
Returns | DurationTag |
Mechanism | MythicMobsMobTag.global_cooldown |
Description | Returns the MythicMob's global cooldown. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L352 |
Name | <MythicMobsMobTag.has_target> |
Returns | ElementTag(Boolean) |
Description | Returns whether the MythicMob has a target. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L238 |
Name | <MythicMobsMobTag.has_threat_table> |
Returns | ElementTag(Boolean) |
Description | Returns whether the MythicMob has a threat table. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L265 |
Name | <MythicMobsMobTag.internal_name> |
Returns | ElementTag |
Description | Returns the name MythicMobs identifies the MythicMob with. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L141 |
Name | <MythicMobsMobTag.is_damaging> |
Returns | ElementTag(Boolean) |
Description | Returns whether the MythicMob is using its damaging skill. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L318 |
Name | <MythicMobsMobTag.level> |
Returns | ElementTag(Number) |
Mechanism | MythicMobsMobTag.level |
Description | Returns the level of the MythicMob. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L193 |
Name | <MythicMobsMobTag.mythic_variable[<name>]> |
Returns | ElementTag |
Description | Returns the value of a MythicMobs variable for this MythicMob. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L364 |
Name | <MythicMobsMobTag.mythic_variable_map> |
Returns | MapTag |
Mechanism | MythicMobsMobTag.mythic_variable_map |
Description | Returns a map of the MythicMob's variables. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L375 |
Name | <MythicMobsMobTag.players_killed> |
Returns | ElementTag(Number) |
Description | Returns the number of players the MythicMob has killed. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L205 |
Name | <MythicMobsMobTag.spawner> |
Returns | MythicSpawnerTag |
Description | Returns the MythicSpawnerTag that spawned this mob.
Returns null, if the mob was spawned by something other than a spawner. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L178 |
Name | <MythicMobsMobTag.spawner_name> |
Returns | ElementTag |
Description | Returns 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. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L163 |
Name | <MythicMobsMobTag.stance> |
Returns | ElementTag |
Mechanism | MythicMobsMobTag.stance |
Description | Returns the current stance of the MythicMob. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L329 |
Name | <MythicMobsMobTag.target> |
Returns | EntityTag |
Mechanism | MythicMobsMobTag.target |
Description | Returns the MythicMob's target. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L249 |
Name | <MythicMobsMobTag.threat_table> |
Returns | MapTag |
Description | Returns the MythicMob's threat table, can contain multiple types of entities.
Map is in the formatting of "UUID/Threat|UUID/Threat" |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L276 |
Name | <MythicMobsMobTag.threat_table_players> |
Returns | MapTag |
Description | Returns the MythicMob's threat table, only containing players.
Map is in the formatting of "UUID/Threat|UUID/Threat" |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L296 |
Name | <MythicSpawnerTag.cooldown> |
Returns | DurationTag |
Mechanism | MythicSpawnerTag.cooldown |
Description | Returns the MythicSpawner's configured cooldown. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicSpawnerTag.java#L128 |
Name | <MythicSpawnerTag.group> |
Returns | ElementTag |
Mechanism | MythicSpawnerTag.group |
Description | Returns the MythicSpawner's group, if applicable. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicSpawnerTag.java#L195 |
Name | <MythicSpawnerTag.location> |
Returns | LocationTag |
Mechanism | MythicSpawnerTag.location |
Description | Returns a LocationTag of the MythicSpawner's location. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicSpawnerTag.java#L182 |
Name | <MythicSpawnerTag.mob_type> |
Returns | ElementTag |
Mechanism | MythicSpawnerTag.mob_type |
Description | Returns the internal name the MythicMob mob type spawned. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicSpawnerTag.java#L155 |
Name | <MythicSpawnerTag.mobs> |
Returns | ListTag(EntityTag) |
Description | Returns a ListTag of all active MythicMobs from this spawner. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicSpawnerTag.java#L167 |
Name | <MythicSpawnerTag.mythic_mobs> |
Returns | ListTag(MythicMobsMobTag) |
Description | Returns a ListTag of all active MythicMobs from this spawner. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicSpawnerTag.java#L140 |
Name | <MythicSpawnerTag.name> |
Returns | ElementTag |
Description | Returns the name of the MythicSpawner. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicSpawnerTag.java#L117 |
Name | <NationTag.allies> |
Returns | ListTag(NationTag) |
Description | Returns a list of the nation's allies. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L155 |
Name | <NationTag.assistants> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of the nation's assistants.
Deprecated in favor of NationTag.members_by_rank. |
Requires | Depenizen, Towny |
Deprecated | use 'members_by_rank' |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L170 |
Name | <NationTag.balance> |
Returns | ElementTag(Decimal) |
Description | Returns the current money balance of the nation. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L187 |
Name | <NationTag.capital> |
Returns | TownTag |
Description | Returns the capital city of the nation as a TownTag. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L198 |
Name | <NationTag.enemies> |
Returns | ListTag(NationTag) |
Description | Returns a list of the nation's enemies. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L212 |
Name | <NationTag.is_neutral> |
Returns | ElementTag(Boolean) |
Description | Returns true if the nation is neutral. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L243 |
Name | <NationTag.king> |
Returns | PlayerTag |
Description | Returns the king of the nation. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L254 |
Name | <NationTag.members_by_rank[<rank>]> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of the nation's members with a given rank. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L227 |
Name | <NationTag.name> |
Returns | ElementTag |
Description | Returns the nation's name. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L265 |
Name | <NationTag.player_count> |
Returns | ElementTag(Number) |
Description | Returns the amount of players in the nation. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L276 |
Name | <NationTag.relation[<nation>]> |
Returns | ElementTag |
Description | Returns the nation's current relation with another nation. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L287 |
Name | <NationTag.residents> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of the nation's residents. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L313 |
Name | <NationTag.tag> |
Returns | ElementTag |
Description | Returns the nation's tag. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L328 |
Name | <NationTag.taxes> |
Returns | ElementTag(Decimal) |
Description | Returns the nation's current taxes. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L342 |
Name | <NationTag.town_count> |
Returns | ElementTag(Number) |
Description | Returns the number of towns in the nation. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/NationTag.java#L353 |
Name | <paper.tick_times> |
Returns | ListTag(DurationTag) |
Description | Returns 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 |
|
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/tags/PaperTagBase.java#L20 |
Name | <PartyTag.leader> |
Returns | PlayerTag |
Description | Returns the leader of the party. |
Requires | Depenizen, mcMMO |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mcmmo/PartyTag.java#L124 |
Name | <PartyTag.members> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all party members. |
Requires | Depenizen, mcMMO |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mcmmo/PartyTag.java#L135 |
Name | <PartyTag.name> |
Returns | ElementTag |
Description | Returns the name of the party. |
Requires | Depenizen, mcMMO |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mcmmo/PartyTag.java#L113 |
Name | <placeholder[<name>].player[<player>]> |
Returns | ElementTag |
Description | Returns the value of the placeholder for the specified player. |
Generated Example |
|
Requires | Depenizen, PlaceholderAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/PlaceholderAPIBridge.java#L73 |
Name | <playerpoints.leaders> |
Returns | ListTag(PlayerTag) |
Description | Returns 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 |
|
Requires | Depenizen, PlayerPoints |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/PlayerPointsBridge.java#L59 |
Name | <PlotSquaredPlotTag.all_cuboids> |
Returns | ListTag(CuboidTag) |
Description | Returns all the plot's cuboids in a list. Useful for merged plots. |
Requires | Depenizen, PlotSquared |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L263 |
Name | <PlotSquaredPlotTag.cuboid> |
Returns | CuboidTag |
Description | Returns the plot's cuboid. |
Requires | Depenizen, PlotSquared |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L249 |
Name | <PlotSquaredPlotTag.default_home> |
Returns | LocationTag |
Description | Returns the plot's default home location. |
Requires | Depenizen, PlotSquared |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L166 |
Name | <PlotSquaredPlotTag.denied> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all players denied from the plot. |
Requires | Depenizen, PlotSquared |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L219 |
Name | <PlotSquaredPlotTag.home> |
Returns | LocationTag |
Description | Returns the plot's current home location. |
Requires | Depenizen, PlotSquared |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L154 |
Name | <PlotSquaredPlotTag.id_x> |
Returns | ElementTag(Number) |
Description | Returns the plot's X coordinate portion of its ID. |
Requires | Depenizen, PlotSquared |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L132 |
Name | <PlotSquaredPlotTag.id_Z> |
Returns | ElementTag(Number) |
Description | Returns the plot's Z coordinate portion of its ID. |
Requires | Depenizen, PlotSquared |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L143 |
Name | <PlotSquaredPlotTag.members> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all members of the plot. |
Requires | Depenizen, PlotSquared |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L234 |
Name | <PlotSquaredPlotTag.owners> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all owners of the plot. |
Requires | Depenizen, PlotSquared |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L189 |
Name | <PlotSquaredPlotTag.trusted> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all trusted of the plot. |
Requires | Depenizen, PlotSquared |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L204 |
Name | <PlotSquaredPlotTag.world> |
Returns | WorldTag |
Description | Returns the plot's world. |
Requires | Depenizen, PlotSquared |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L178 |
Name | <pvparena.list_arenas> |
Returns | ListTag(PVPArenaArenaTag) |
Description | Returns a list of all PVPArenas. |
Generated Example |
|
Requires | Depenizen, PVPArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/PVPArenaBridge.java#L61 |
Name | <PVPArenaArenaTag.fighters> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all fighters in the arena. |
Requires | Depenizen, PvPArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/pvparena/PVPArenaArenaTag.java#L113 |
Name | <PVPArenaArenaTag.name> |
Returns | ElementTag |
Description | Returns the name of the arena. |
Requires | Depenizen, PVPArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/pvparena/PVPArenaArenaTag.java#L102 |
Name | <quests.list_quests> |
Returns | ListTag |
Description | Returns a list of all quest IDs from the Quests plugin. |
Generated Example |
|
Requires | Depenizen, Quests |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/QuestsBridge.java#L46 |
Name | <ResidenceTag.area> |
Returns | CuboidTag |
Description | Returns the area of the Residences. |
Generated Example |
|
Requires | Depenizen, Residence |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/residence/ResidenceTag.java#L162 |
Name | <ResidenceTag.is_within[<location>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the specified location is within this Residence. |
Generated Example |
|
Requires | Depenizen, Residence |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/residence/ResidenceTag.java#L174 |
Name | <ResidenceTag.name> |
Returns | ElementTag |
Description | Returns the name of this Residence. |
Generated Example |
|
Requires | Depenizen, Residence |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/residence/ResidenceTag.java#L125 |
Name | <ResidenceTag.owner> |
Returns | PlayerTag |
Description | Returns the owner of the Residence. |
Generated Example |
|
Requires | Depenizen, Residence |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/residence/ResidenceTag.java#L136 |
Name | <ResidenceTag.subzones> |
Returns | ListTag(ResidenceTag) |
Description | Returns a list of subzones in this Residence. |
Generated Example |
|
Requires | Depenizen, Residence |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/residence/ResidenceTag.java#L147 |
Name | <ShopKeeperTag.entity> |
Returns | EntityTag |
Description | Returns the EntityTag for this ShopKeeper, if any. |
Requires | Depenizen, ShopKeepers |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/shopkeepers/ShopKeeperTag.java#L142 |
Name | <ShopKeeperTag.is_active> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Shopkeeper is active (has been spawned and is still valid and present in the world). |
Requires | Depenizen, ShopKeepers |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/shopkeepers/ShopKeeperTag.java#L108 |
Name | <ShopKeeperTag.is_ui_active> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Shopkeeper's UI is currently active (may be false when the UI is about to be closed). |
Requires | Depenizen, ShopKeepers |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/shopkeepers/ShopKeeperTag.java#L119 |
Name | <ShopKeeperTag.owner> |
Returns | PlayerTag |
Description | Returns the player that owns this ShopKeeper, if any. |
Requires | Depenizen, ShopKeepers |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/shopkeepers/ShopKeeperTag.java#L153 |
Name | <ShopKeeperTag.trades> |
Returns | ListTag(ListTag(ItemTag)) |
Description | Returns a ListTag of the Shopkeeper's trades (as sub-lists). |
Requires | Depenizen, ShopKeepers |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/shopkeepers/ShopKeeperTag.java#L131 |
Name | <SkillAPIClassTag.base_health> |
Returns | ElementTag(Decimal) |
Description | Returns the base amount of health for this SkillAPI class. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L211 |
Name | <SkillAPIClassTag.base_mana> |
Returns | ElementTag(Decimal) |
Description | Returns the base amount of mana for this SkillAPI class. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L233 |
Name | <SkillAPIClassTag.class_prefix> |
Returns | ElementTag |
Description | Returns the prefix of this SkillAPI class. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L130 |
Name | <SkillAPIClassTag.group_name> |
Returns | ElementTag |
Description | Returns the name of the group that this SkillAPI class falls into. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L152 |
Name | <SkillAPIClassTag.has_mana_regen> |
Returns | ElementTag(Boolean) |
Description | Returns whether this SkillAPI class has mana regeneration. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L266 |
Name | <SkillAPIClassTag.has_parent> |
Returns | ElementTag(Boolean) |
Description | Returns the whether this SkillAPI class has a parent class. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L167 |
Name | <SkillAPIClassTag.health_scale> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of health gained per level for this SkillAPI class. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L222 |
Name | <SkillAPIClassTag.icon> |
Returns | ItemTag |
Description | Returns the item icon representing this SkillAPI class in menus. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L189 |
Name | <SkillAPIClassTag.mana_name> |
Returns | ElementTag |
Description | Returns the alias for mana that this SkillAPI class uses. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L255 |
Name | <SkillAPIClassTag.mana_regen> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of mana regeneration that this SkillAPI class has. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L277 |
Name | <SkillAPIClassTag.mana_scale> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of mana gained per level for this SkillAPI class. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L244 |
Name | <SkillAPIClassTag.max_level> |
Returns | ElementTag(Number) |
Description | Returns the maximum level that this SkillAPI class can reach. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L200 |
Name | <SkillAPIClassTag.name> |
Returns | ElementTag |
Description | Returns the name of this SkillAPI class. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L108 |
Name | <SkillAPIClassTag.needs_permission> |
Returns | ElementTag(Boolean) |
Description | Returns whether this SkillAPI class requires permission to profess as it. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L141 |
Name | <SkillAPIClassTag.parent> |
Returns | SkillAPIClassTag |
Description | Returns the parent class of this SkillAPI class. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L178 |
Name | <SkillAPIClassTag.prefix_color> |
Returns | ElementTag |
Description | Returns the color of the prefix of this SkillAPI class. |
Requires | Depenizen, SkillAPI |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/skillapi/SkillAPIClassTag.java#L119 |
Name | <skyblock.island_count> |
Returns | ElementTag(Number) |
Description | Returns the number of Skyblock Islands that exist. |
Generated Example |
|
Requires | Depenizen, A SkyBlock |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/ASkyBlockBridge.java#L73 |
Name | <skyblock.island_world> |
Returns | WorldTag |
Description | Returns the world that A Skyblock uses for islands. |
Generated Example |
|
Requires | Depenizen, A SkyBlock |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/ASkyBlockBridge.java#L51 |
Name | <skyblock.nether_world> |
Returns | WorldTag |
Description | Returns the world that A Skyblock uses for the nether. |
Generated Example |
|
Requires | Depenizen, A SkyBlock |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/ASkyBlockBridge.java#L62 |
Name | <TownTag.assistants> |
Returns | ListTag |
Description | Returns 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 TownTag.members_by_rank. |
Requires | Depenizen, Towny |
Deprecated | use 'members_by_rank' |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L194 |
Name | <TownTag.balance> |
Returns | ElementTag(Decimal) |
Mechanism | TownTag.balance |
Description | Returns the current money balance of the object.town. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L207 |
Name | <TownTag.board> |
Returns | ElementTag |
Description | Returns the town's current board. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L219 |
Name | <TownTag.cuboids> |
Returns | ListTag(CuboidTag) |
Description | Returns a list of plot cuboids claimed by the town.
Note that the cuboids may be in separate worlds if the town has outposts. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L506 |
Name | <TownTag.has_explosions> |
Returns | ElementTag(Boolean) |
Description | Returns if the town has explosions turned on. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L416 |
Name | <TownTag.has_firespread> |
Returns | ElementTag(Boolean) |
Description | Returns if the town has firespread turned on. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L449 |
Name | <TownTag.has_mobs> |
Returns | ElementTag(Boolean) |
Description | Returns if the town has mobs turned on. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L427 |
Name | <TownTag.has_pvp> |
Returns | ElementTag(Boolean) |
Description | Returns if the town has PvP turned on. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L438 |
Name | <TownTag.has_taxpercent> |
Returns | ElementTag(Boolean) |
Description | Returns if the town has taxes in percentage. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L460 |
Name | <TownTag.is_open> |
Returns | ElementTag(Boolean) |
Description | Returns true if the town is currently open. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L241 |
Name | <TownTag.is_public> |
Returns | ElementTag(Boolean) |
Description | Returns true if the town is currently public. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L252 |
Name | <TownTag.mayor> |
Returns | PlayerTag |
Description | Returns the mayor of the object.town. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L263 |
Name | <TownTag.members_by_rank[<rank>]> |
Returns | ListTag |
Description | Returns 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. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L230 |
Name | <TownTag.name> |
Returns | ElementTag |
Description | Returns the town's name. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L281 |
Name | <TownTag.nation> |
Returns | NationTag |
Description | Returns the nation that the town belongs to. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L292 |
Name | <TownTag.outlaws> |
Returns | ListTag |
Description | Returns a list of the town's outlaws. Players will be valid PlayerTag instances, non-players will be plaintext of the name. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L308 |
Name | <TownTag.outposts> |
Returns | ListTag(LocationTag) |
Description | Returns a list of the town's outpost locations. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L401 |
Name | <TownTag.player_count> |
Returns | ElementTag(Number) |
Description | Returns the number of players in the object.town. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L319 |
Name | <TownTag.plot_object_group_names> |
Returns | ListTag |
Description | Returns a list of the names of town plot object groups. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L471 |
Name | <TownTag.plotprice> |
Returns | ElementTag(Decimal) |
Description | Returns the price of a plot. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L533 |
Name | <TownTag.plots> |
Returns | ListTag(ChunkTag) |
Description | Returns 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 TownTag.cuboids instead. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L489 |
Name | <TownTag.plottax> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of taxes collected from plots. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L522 |
Name | <TownTag.residents> |
Returns | ListTag |
Description | Returns a list of the town's residents. Players will be valid PlayerTag instances, non-players will be plaintext of the name. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L330 |
Name | <TownTag.size> |
Returns | ElementTag(Number) |
Description | Returns the number of blocks the town owns. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L352 |
Name | <TownTag.spawn> |
Returns | LocationTag |
Description | Returns the spawn point of the object.town. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L363 |
Name | <TownTag.tag> |
Returns | ElementTag |
Description | Returns the town's tag. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L379 |
Name | <TownTag.taxes> |
Returns | ElementTag(Decimal) |
Description | Returns the town's current taxes. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L390 |
Name | <towny.list_towns[(<world>)]> |
Returns | ListTag(TownTag) |
Description | Returns a list of all towns. Optionally specify a world name. |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/TownyBridge.java#L68 |
Name | <towny.nations> |
Returns | ListTag(NationTag) |
Description | Returns a list of all nations. |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/TownyBridge.java#L95 |
Name | <WorldGuardRegionTag.children> |
Returns | ListTag(WorldGuardRegionTag) |
Description | Gets a list of all children of this region. |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L208 |
Name | <WorldGuardRegionTag.id> |
Returns | ElementTag |
Description | Gets the ID name of the region. |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L185 |
Name | <WorldGuardRegionTag.members> |
Returns | ListTag(PlayerTag) |
Description | Gets a list of all members of a region. (Members are permitted to build, etc.) |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L226 |
Name | <WorldGuardRegionTag.owners> |
Returns | ListTag(PlayerTag) |
Description | Gets a list of all owners of a region. (Owners are permitted to build, edit settings, etc.) |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L241 |
Name | <WorldGuardRegionTag.parent> |
Returns | WorldGuardRegionTag |
Description | Gets the parent region of this region (if any). |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L196 |
Name | <WorldGuardRegionTag.world> |
Returns | WorldTag |
Description | Gets the WorldTag this region is in. |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L256 |
Name | <WorldGuardRegionTag.area> |
Returns | AreaObject |
Description | Returns the region's block area as a CuboidTag or PolygonTag. |
Group | conversion |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L151 |