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 | <&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 | <&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 | <&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 | <&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 | <>> |
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 | <&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 | < > |
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 | <&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 | <&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 | <&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 | <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 | <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 | <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 | <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 | <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 | <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 | <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 | <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 | <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 | <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#L17 |
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 | <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 | <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 | <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 | <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 | <client.all_mods> |
Returns | ListTag(ModTag) |
Description | Returns a list of all currently loaded Fabric mods, including mods-within-mods and built-in mods. |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L69 |
Name | <client.chat_scale> |
Returns | ElementTag(Number) |
Description | Returns the client's chat scale, which is a multiplier for text's size. |
Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L213 |
Name | <client.chat_width> |
Returns | ElementTag(Number) |
Description | Returns the width of the client's chat HUD, in pixels. |
Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L197 |
Name | <client.climbing_speed> |
Returns | ElementTag(Decimal) |
Mechanism | client.climbing_speed |
Description | Returns the client's climbing speed. |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L171 |
Name | <client.cursor_on> |
Returns | LocationTag |
Description | Returns the location of the block the client is currently looking at, if any. |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L91 |
Name | <client.cursor_on_precise> |
Returns | LocationTag |
Description | Returns the precise location the client is currently looking at, if any. |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L101 |
Name | <client.list_flags> |
Returns | ListTag |
Description | See FlaggableObject.list_flags |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L151 |
Name | <client.loaded_entities[(<matcher>)]> |
Returns | ListTag(EntityTag) |
Description | Returns a list of all entities currently loaded by the client.
Optionally specify an EntityTag matcher to filter by. |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L37 |
Name | <client.mods> |
Returns | ListTag(ModTag) |
Description | Returns a list of all currently loaded Fabric mods (this doesn't include things like mods-within-mods or built-in mods). |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L56 |
Name | <client.self_entity> |
Returns | EntityTag |
Description | Returns an EntityTag of the client's own player entity. |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L111 |
Name | <client.target> |
Returns | EntityTag |
Description | Returns the entity the client is currently looking at, if any. |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L79 |
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.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 | <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#L2497 |
Name | <ElementTag.split_lines_by_width[<#>]> |
Returns | ListTag |
Description | Returns the element split into multiple lines, with each line being less (or just as) wide as the specified pixel width. |
Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/extensions/ClientizenElementExtensions.java#L28 |
Name | <ElementTag.text_width> |
Returns | ElementTag(Number) |
Description | Returns an element's width in pixels, using the client's text rendering. |
Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/extensions/ClientizenElementExtensions.java#L13 |
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#L2523 |
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#L443 |
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#L508 |
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#L539 |
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#L570 |
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#L519 |
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#L469 |
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#L495 |
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#L456 |
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#L482 |
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#L558 |
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#L594 |
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#L701 |
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#L609 |
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#L743 |
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#L582 |
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#L673 |
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#L687 |
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#L652 |
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#L729 |
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#L715 |
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#L2310 |
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#L2297 |
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#L2323 |
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#L757 |
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#L2393 |
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#L2379 |
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#L2263 |
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#L771 |
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#L2281 |
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#L2507 |
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#L2245 |
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#L813 |
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#L787 |
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#L2356 |
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#L2460 |
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#L630 |
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#L799 |
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#L2425 |
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#L2407 |
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#L2341 |
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#L1056 |
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#L1128 |
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#L924 |
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#L906 |
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#L841 |
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#L859 |
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#L877 |
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#L889 |
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#L830 |
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#L942 |
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#L954 |
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#L2477 |
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#L1102 |
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#L1005 |
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#L1115 |
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#L1022 |
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#L2443 |
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#L1033 |
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#L1068 |
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#L965 |
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#L976 |
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#L1091 |
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#L1080 |
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#L1193 |
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#L1175 |
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#L1229 |
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#L1211 |
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#L1293 |
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#L1498 |
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#L1395 |
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#L1378 |
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#L1603 |
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#L1614 |
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#L1635 |
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#L1646 |
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#L1154 |
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#L1247 |
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#L1255 |
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#L1562 |
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#L1550 |
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#L1364 |
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#L1583 |
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#L1515 |
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#L1338 |
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#L1424 |
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#L1477 |
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#L1463 |
Name | <ElementTag.to_titlecase> |
Returns | ElementTag |
Description | Returns The Value Of An ElementTag In Title Case (The First Letter Of Each Word Is Capitalized, Based On 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#L1436 |
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#L1412 |
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#L1353 |
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#L1668 |
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#L1987 |
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#L1786 |
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#L1719 |
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#L1972 |
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#L2002 |
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#L2017 |
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#L2033 |
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#L1809 |
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#L1736 |
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#L2078 |
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#L1939 |
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#L1923 |
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#L1685 |
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#L1702 |
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#L1832 |
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#L1857 |
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#L1752 |
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#L1955 |
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#L2230 |
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#L2143 |
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#L2196 |
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#L2158 |
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#L2178 |
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#L2128 |
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#L2213 |
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#L2048 |
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#L1903 |
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#L1880 |
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#L1769 |
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#L2063 |
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#L2098 |
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#L2113 |
Name | <EntityTag.glow_color_override> |
Returns | ColorTag |
Mechanism | EntityTag.glow_color_override |
Description | Returns the entity's glow color override, if any.
Note that this is Clientizen data, see Client-side entity data for more information. |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/EntityTag.java#L253 |
Name | <EntityTag.is_rendering> |
Returns | ElementTag(Boolean) |
Description | Returns whether an entity is being rendered by the client.
This does not mean the entity will always be visible, but within the camera's viewing frustum. |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/EntityTag.java#L242 |
Name | <EntityTag.entity_type> |
Returns | ElementTag |
Description | Returns an entity's type. |
Generated Example |
|
Group | data |
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/EntityTag.java#L209 |
Name | <EntityTag.eye_location> |
Returns | LocationTag |
Description | Returns the entity's eye location. |
Generated Example |
|
Group | location |
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/EntityTag.java#L231 |
Name | <EntityTag.location> |
Returns | LocationTag |
Description | Returns an entity's location. |
Generated Example |
|
Group | location |
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/EntityTag.java#L220 |
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. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/entity/EntitySneaking.java#L11 |
Name | <EntityTag.is_sprinting> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.is_sprinting |
Description | (Property) Returns whether an entity is sprinting. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/entity/EntitySprinting.java#L11 |
Name | <EntityTag.sheared> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.sheared |
Description | (Property) Whether a sheep is sheared. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/entity/EntitySheared.java#L10 |
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 | <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.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.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.find_entities[within=<#>;(match=<matcher>)]> |
Returns | ListTag(EntityTag) |
Description | Returns a list of all entities within range, sorted by closeness (first entity is the closest, last entity is the farthest).
Optionally specify an EntityTag matcher to filter by. |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L350 |
Name | <LocationTag.pitch> |
Returns | ElementTag(Decimal) |
Description | Returns the location's pitch. |
Generated Example |
|
Group | identity |
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L183 |
Name | <LocationTag.raw_yaw> |
Returns | ElementTag(Decimal) |
Description | Returns the location's raw (un-normalized) yaw. |
Generated Example |
|
Group | identity |
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L172 |
Name | <LocationTag.world> |
Returns | ElementTag |
Description | Returns the name of the world the location is in, if any. |
Generated Example |
|
Group | identity |
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L194 |
Name | <LocationTag.yaw> |
Returns | ElementTag(Decimal) |
Description | Returns the location's normalized yaw. |
Generated Example |
|
Group | identity |
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L161 |
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/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L234 |
Name | <LocationTag.backward[(<#.#>)]> |
Returns | LocationTag |
Description | Returns the location behind this location based on yaw and pitch. 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/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L271 |
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/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L246 |
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/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L205 |
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/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L324 |
Name | <LocationTag.forward[(<#.#>)]> |
Returns | LocationTag |
Description | Returns the location in front of this location based on yaw and pitch. Optionally specify a number of blocks to go forward.
This is equivalent to LocationTag.backward in the opposite direction. |
Generated Example |
|
Group | math |
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L258 |
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/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L284 |
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/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L297 |
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/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L220 |
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/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L310 |
Name | <LocationTag.material> |
Returns | MaterialTag |
Description | Returns the material of the block at the location. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L339 |
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 | <ModTag.authors> |
Returns | MapTag |
Description | Returns a mod's authors, as a map of author name to their contact information.
The contact information is a map of contact platforms to identification on that platform. Note that mods can provide anything here, although most mods will obviously provide valid info. |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L117 |
Name | <ModTag.contact_info> |
Returns | MapTag |
Description | Returns a mod's contact information, as a map of contact platforms to identification on that platform.
Some common examples are: "repo", "website", "issues", etc. Note that mods can provide anything here, although most mods will obviously provide valid info. |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L141 |
Name | <ModTag.contained_mods> |
Returns | ListTag(ModTag) |
Description | Returns a list of mods contained by this mod (for mods that include libraries, for example). |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L185 |
Name | <ModTag.containing_mod> |
Returns | ModTag |
Description | Returns the mod that contains this mod, if any (for things like library mods included by other mods). |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L175 |
Name | <ModTag.contributors> |
Returns | MapTag |
Description | Returns a mod's contributors, as a map of contributor name to their contact information.
The contact information is a map of contact platforms to identification on that platform. Note that mods can provide anything here, although most mods will obviously provide valid info. |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L129 |
Name | <ModTag.description> |
Returns | ElementTag |
Description | Returns a mod's description. |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L97 |
Name | <ModTag.display_name> |
Returns | ElementTag |
Description | Returns a mod's display name. |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L87 |
Name | <ModTag.id> |
Returns | ElementTag |
Description | Returns a mod's id. |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L77 |
Name | <ModTag.licenses> |
Returns | ListTag |
Description | Returns a list of a mod's licenses. |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L153 |
Name | <ModTag.type> |
Returns | ElementTag |
Description | Returns a mod's type, either:
'fabric' - a regular Fabric mod, either directly installed or included by another mod. 'builtin' - a built-in mod, generally used for internal mods included by Fabric itself. |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L163 |
Name | <ModTag.version> |
Returns | ElementTag |
Description | Returns a mod's version. |
Generated Example |
|
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L107 |
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 | <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#L45 |
Name | <proc[<procedure_script_name>].context_map[<map>]> |
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#L57 |
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.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.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 | <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.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.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.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 | <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 | <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 | <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 | <MaterialTag.maximum_level> |
Returns | ElementTag(Number) |
Description | Returns the maximum level for a "levelled" material (see MaterialTag.level). |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/material/MaterialLevel.java#L35 |
Name | <MaterialTag.minimum_level> |
Returns | ElementTag(Number) |
Description | Returns the minimum level for a "levelled" material (see MaterialTag.level). |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/material/MaterialLevel.java#L27 |
Name | <MaterialTag.half> |
Returns | ElementTag |
Mechanism | MaterialTag.half |
Description | (Property) The current half for a bisected material (like a door, double-plant, chest, or a bed).
Output for "double" (2 block tall) 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/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/material/MaterialHalf.java#L10 |
Name | <MaterialTag.instrument> |
Returns | ElementTag |
Mechanism | MaterialTag.instrument |
Description | (Property) The instrument played by a note block, see https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Instrument.html |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/material/MaterialInstrument.java#L9 |
Name | <MaterialTag.level> |
Returns | ElementTag(Number) |
Mechanism | MaterialTag.level |
Description | (Property) The current level for a "levelled" material:
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. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/material/MaterialLevel.java#L11 |
Name | <MaterialTag.switched> |
Returns | ElementTag(Boolean) |
Mechanism | MaterialTag.switched |
Description | (Property) Whether a material is 'switched on', which has different semantic meaning depending on the material type.
More specifically, this is 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 |
|
Group | Properties |
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/material/MaterialSwitched.java#L9 |
Name | <MaterialTag.waterlogged> |
Returns | ElementTag(Boolean) |
Mechanism | MaterialTag.waterlogged |
Description | (Property) Whether a block is waterlogged. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/material/MaterialWaterlogged.java#L9 |
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 | <ItemTag.durability> |
Returns | ElementTag(Number) |
Mechanism | ItemTag.durability |
Description | (Property) The amount of durability an item lost. |
Generated Example |
|
Group | Properties |
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/item/ItemDurability.java#L9 |
Name | <ItemTag.server_script> |
Returns | ElementTag |
Description | Returns the name of an item's server-side item script, if it has one. |
Generated Example |
|
Group | scripts |
Source | https://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/item/ItemServerScript.java#L10 |