Denizen Script Tags


Tags are always written with a <between these marks>, and are critical to scripts, as the primary way to read data.
Learn about how tags work in The Beginner's Guide.


Showing all 596 tags...

Categories:

Base | BinaryTag | client | ColorTag | DurationTag | ElementTag | EntityTag | FlaggableObject | ImageTag | JavaReflectedObjectTag | ListTag | LocationTag | MapTag | ModTag | ObjectTag | proc | QuaternionTag | QueueTag | ScriptTag | SecretTag | tern | TimeTag | util | yaml | VectorObject | MaterialTag | PropertyHolderObject | ItemTag



Category: Base


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name<color[<color>]>
ReturnsColorTag
DescriptionReturns a color object constructed from the input value.
Refer to ObjectType:ColorTag.
Generated Example
- narrate "<&color[<color[green]>]>hello there!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectFetcher.java#L83

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



Category: BinaryTag


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

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

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

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

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

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

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

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

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

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

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

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

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



Category: client


Name<client.all_mods>
ReturnsListTag(ModTag)
DescriptionReturns a list of all currently loaded Fabric mods, including mods-within-mods and built-in mods.
Generated Example
- foreach <client.all_mods> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L69

Name<client.chat_scale>
ReturnsElementTag(Number)
DescriptionReturns the client's chat scale, which is a multiplier for text's size.
Example
# Use to get the width text would have if displayed in the chat HUD.
- narrate "The text would be <[text].text_width.mul[<client.chat_scale>]> pixels wide."
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L213

Name<client.chat_width>
ReturnsElementTag(Number)
DescriptionReturns the width of the client's chat HUD, in pixels.
Example
# Use to check if a line of text can fit in the chat HUD without splitting into multiple lines.
- if <[text].text_width.mul[<client.chat_scale>]> <= <client.chat_width>:
  - narrate <[text]>
- else:
  - narrate "Too long!"
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L197

Name<client.climbing_speed>
ReturnsElementTag(Decimal)
Mechanismclient.climbing_speed
DescriptionReturns the client's climbing speed.
Generated Example
- narrate "the decimal value is <client.climbing_speed>"
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L171

Name<client.cursor_on>
ReturnsLocationTag
DescriptionReturns the location of the block the client is currently looking at, if any.
Generated Example
- narrate "The location is <client.cursor_on>!"
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L91

Name<client.cursor_on_precise>
ReturnsLocationTag
DescriptionReturns the precise location the client is currently looking at, if any.
Generated Example
- narrate "The location is <client.cursor_on_precise>!"
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L101

Name<client.flag[<flag_name>]>
ReturnsObjectTag
DescriptionSee Tag:FlaggableObject.flag
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L131

Name<client.flag_expiration[<flag_name>]>
ReturnsTimeTag
DescriptionSee Tag:FlaggableObject.flag_expiration
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L141

Name<client.flag_map[<name>|...]>
ReturnsMapTag
DescriptionSee Tag:FlaggableObject.flag_map
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L161

Name<client.has_flag[<flag>]>
ReturnsElementTag(Boolean)
DescriptionSee Tag:FlaggableObject.has_flag.
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L121

Name<client.list_flags>
ReturnsListTag
DescriptionSee Tag:FlaggableObject.list_flags
Generated Example
- foreach <client.list_flags> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L151

Name<client.loaded_entities[(<matcher>)]>
ReturnsListTag(EntityTag)
DescriptionReturns a list of all entities currently loaded by the client.
Optionally specify an EntityTag matcher to filter by.
Generated Example
- foreach <client.loaded_entities> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L37

Name<client.mods>
ReturnsListTag(ModTag)
DescriptionReturns a list of all currently loaded Fabric mods (this doesn't include things like mods-within-mods or built-in mods).
Generated Example
- foreach <client.mods> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L56

Name<client.self_entity>
ReturnsEntityTag
DescriptionReturns an EntityTag of the client's own player entity.
Generated Example
- narrate "The entity is <client.self_entity>!"
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L111

Name<client.target>
ReturnsEntityTag
DescriptionReturns the entity the client is currently looking at, if any.
Generated Example
- narrate "The entity is <client.target>!"
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/tags/ClientTagBase.java#L79



Category: ColorTag


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



Category: DurationTag


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



Category: ElementTag


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

Name<ElementTag.split_lines_by_width[<#>]>
ReturnsListTag
DescriptionReturns the element split into multiple lines, with each line being less (or just as) wide as the specified pixel width.
Example
# Use to split text into lines, with each line's width being no more than 30 pixels.
- foreach <[text].split_lines_by_width[30]> as:line:
  - narrate <[line]>
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/extensions/ClientizenElementExtensions.java#L28

Name<ElementTag.text_width>
ReturnsElementTag(Number)
DescriptionReturns an element's width in pixels, using the client's text rendering.
Example
# Use to check if a message is too wide.
- if <[message].text_width> > 30:
  - narrate "That message is too wide!"
  - stop
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/extensions/ClientizenElementExtensions.java#L13

Name<ElementTag.unaccented>
ReturnsElementTag
DescriptionReturns 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
# Narrates "TqaaCwIMรฆ"
- narrate <element[โ“‰โ“ รคแบฏร‡แบ˜โ„‘โ„ณรฆ].unaccented>
Example
# Narrates "these characters have diacritics: eac"
- narrate <element[these characters have diacritics: รฉร รง].unaccented>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2523

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name<ElementTag.millis_to_time>
ReturnsTimeTag
DescriptionReturns a TimeTag constructed from the given number of milliseconds after the Unix Epoch (Jan. 1st 1970).
See also Tag:util.current_time_millis and Tag:TimeTag.epoch_millis.
Example
# Takes an arbitrary unix timestamp from an external source, and formats it for a user-friendly date/time display message.
- define some_unix_timestamp <util.time_now.epoch_millis>
- narrate "The timestamp was <[some_unix_timestamp].millis_to_time.format>"
Groupconversion
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L2507

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

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

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

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

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

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

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

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

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

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

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

Name<ElementTag.char_at[<#>]>
ReturnsElementTag
DescriptionReturns 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
# Narrates 'l'.
- narrate <element[apple].char_at[-2]>
# Narrates 'a'.
- narrate <element[apple].char_at[1]>
Groupelement checking
Sourcehttps://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>|...]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the element contains all of the specified elements, case sensitive.
Groupelement checking
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L924

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name<ElementTag.to_titlecase>
ReturnsElementTag
DescriptionReturns The Value Of An ElementTag In Title Case (The First Letter Of Each Word Is Capitalized, Based On Spaces).
Generated Example
- narrate <element[hello_world].to_titlecase>
Groupelement manipulation
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1436

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



Category: EntityTag


Name<EntityTag.glow_color_override>
ReturnsColorTag
MechanismEntityTag.glow_color_override
DescriptionReturns the entity's glow color override, if any.
Note that this is Clientizen data, see Language:Client-side entity data for more information.
Generated Example
- inventory adjust slot:hand color:<client.self_entity.glow_color_override>
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/EntityTag.java#L253

Name<EntityTag.is_rendering>
ReturnsElementTag(Boolean)
DescriptionReturns 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
- if <client.self_entity.is_rendering>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/EntityTag.java#L242

Name<EntityTag.entity_type>
ReturnsElementTag
DescriptionReturns an entity's type.
Generated Example
- narrate <client.self_entity.entity_type>
Groupdata
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/EntityTag.java#L209

Name<EntityTag.eye_location>
ReturnsLocationTag
DescriptionReturns the entity's eye location.
Generated Example
- narrate "The location is <client.self_entity.eye_location>!"
Grouplocation
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/EntityTag.java#L231

Name<EntityTag.location>
ReturnsLocationTag
DescriptionReturns an entity's location.
Generated Example
- narrate "The location is <client.self_entity.location>!"
Grouplocation
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/EntityTag.java#L220

Name<EntityTag.is_sneaking>
ReturnsElementTag(Boolean)
MechanismEntityTag.is_sneaking
Description(Property) Whether an entity is sneaking.
For most entities this just makes the name tag less visible, and doesn't actually update the pose.
Generated Example
- if <client.self_entity.is_sneaking>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
GroupProperties
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/entity/EntitySneaking.java#L11

Name<EntityTag.is_sprinting>
ReturnsElementTag(Boolean)
MechanismEntityTag.is_sprinting
Description(Property) Returns whether an entity is sprinting.
Generated Example
- if <client.self_entity.is_sprinting>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
GroupProperties
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/entity/EntitySprinting.java#L11

Name<EntityTag.sheared>
ReturnsElementTag(Boolean)
MechanismEntityTag.sheared
Description(Property) Whether a sheep is sheared.
Generated Example
- if <client.self_entity.sheared>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
GroupProperties
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/entity/EntitySheared.java#L10



Category: FlaggableObject


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

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

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

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

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



Category: ImageTag


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

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

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

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

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

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



Category: JavaReflectedObjectTag


Name<JavaReflectedObjectTag.field_class_type[<name>]>
ReturnsElementTag
DescriptionReturns the full class name of the field of the given name on this object.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L370

Name<JavaReflectedObjectTag.field_is_final[<name>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the field for the given name on this object is a final field.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L353

Name<JavaReflectedObjectTag.field_is_private[<name>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the field for the given name on this object is a private field.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L302

Name<JavaReflectedObjectTag.field_is_protected[<name>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the field for the given name on this object is a protected field.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L319

Name<JavaReflectedObjectTag.field_is_public[<name>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the field for the given name on this object is a public field.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L285

Name<JavaReflectedObjectTag.field_is_static[<name>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the field for the given name on this object is a static field.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L336

Name<JavaReflectedObjectTag.field_names>
ReturnsListTag
DescriptionReturns a list of all field names on the object (in its current class or any super classes).
Generated Example
- foreach <reflected[some_reflected_obj].field_names> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L263

Name<JavaReflectedObjectTag.full_class_name>
ReturnsElementTag
DescriptionReturns the full class name of the reflected object with package info included, such as "com.denizenscript.denizencore.objects.core.JavaReflectedObjectTag"
Generated Example
- narrate <reflected[some_reflected_obj].full_class_name>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L183

Name<JavaReflectedObjectTag.hash_code>
ReturnsElementTag(Number)
DescriptionReturns the result of the Java hashCode() call on the object.
Generated Example
- narrate "the number value is <reflected[some_reflected_obj].hash_code>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L221

Name<JavaReflectedObjectTag.interpret>
ReturnsObjectTag
DescriptionInterprets the object to Denizen object format.
Generated Example
- narrate "debug - the object is: <reflected[some_reflected_obj].interpret>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L193

Name<JavaReflectedObjectTag.java_equals[<reflected_object>]>
ReturnsElementTag(Boolean)
DescriptionReturns the result of the Java equals(<object>) call on the object with another JavaReflectedObjectTag.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L235

Name<JavaReflectedObjectTag.memory_equals[<reflected_object>]>
ReturnsElementTag(Boolean)
DescriptionReturns the result of the Java "==" exact memory equality call on the object with another JavaReflectedObjectTag.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L249

Name<JavaReflectedObjectTag.read_field[<name>]>
ReturnsObjectTag
DescriptionReads the field of the given name on the object and returns the value in its Denizen-valid format.
See also Tag:JavaReflectedObjectTag.reflect_field
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L387

Name<JavaReflectedObjectTag.reflect_field[<name>]>
ReturnsJavaReflectedObjectTag
DescriptionReads the field of the given name on the object and returns the value as another reflected tag.
See also Tag:JavaReflectedObjectTag.read_field
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L405

Name<JavaReflectedObjectTag.simple_class_name>
ReturnsElementTag
DescriptionReturns the simple/short class name of the reflected object, such as "JavaReflectedObjectTag".
Generated Example
- narrate <reflected[some_reflected_obj].simple_class_name>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L157

Name<JavaReflectedObjectTag.super_classes>
ReturnsListTag
DescriptionReturns the list of super classes of this object, in order, starting with its primary class's super, down to Object, as a ListTag of full class names.
Generated Example
- foreach <reflected[some_reflected_obj].super_classes> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L167

Name<JavaReflectedObjectTag.to_string>
ReturnsElementTag
DescriptionReturns the result of the Java toString() call on the object.
Generated Example
- narrate <reflected[some_reflected_obj].to_string>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/JavaReflectedObjectTag.java#L207



Category: ListTag


Name<ListTag.alphabetical>
ReturnsListTag
DescriptionReturns the list sorted to be in alphabetical order.
Example
# Narrates a list of 'a|c|d|g|q'
- narrate "<list[c|d|q|a|g].alphabetical>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2144

Name<ListTag.alphanumeric>
ReturnsListTag
DescriptionReturns the list sorted to be in alphabetical/numerical order.
Example
# Narrates a list of 'a1|a10|b|c'
- narrate "<list[b|c|a10|a1].alphanumeric>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2129

Name<ListTag.any>
ReturnsElementTag(Boolean)
DescriptionReturns whether the list is not empty.
Example
- if <list.any>:
    - narrate "never shows"
- else:
    - narrate "ain't got any"
Example
- if <list[something].any>:
    - narrate "something's here!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1058

Name<ListTag.average>
ReturnsElementTag(Decimal)
DescriptionReturns the mean average of all numbers in the list. Ignores non-numerical values.
Example
# Narrates "3"
- narrate <list[1|2|4|5].average>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1796

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

Name<ListTag.combine>
ReturnsListTag
DescriptionReturns a list containing the contents of all sublists within this list.
Generated Example
- foreach <list[one|two].combine> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L741

Name<ListTag.comma_separated>
ReturnsElementTag
DescriptionReturns the list in a cleaner format, separated by commas.
Example
# Narrates "one, two, three"
- narrate <list[one|two|three].comma_separated>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L814

Name<ListTag.contains[<element>|...]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the list contains all of the given elements.
See also Tag:ListTag.contains_single for safer single-value checks.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2655

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

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

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

Name<ListTag.contains_match[<matcher>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the list contains an object that matches the specified matcher,
using the system behind Language:Advanced Object Matching.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2675

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

Name<ListTag.count[<element>]>
ReturnsElementTag(Number)
DescriptionReturns how many times a value in the list occurs.
Example
# Narrates "2"
- narrate <list[one|two|two|three].count[two]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1736

Name<ListTag.count_matches[<matcher>]>
ReturnsElementTag(Number)
DescriptionReturns how many times a value in the list matches the matcher,
using the system behind Language:Advanced Object Matching,
For example: a list of "one|two|three" .count[t*] returns 2.
Example
# Narrates "2"
- narrate <list[one|two|two|three].count_matches[t*]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1756

Name<ListTag.deduplicate>
ReturnsListTag
DescriptionReturns a copy of the list with any duplicate items removed.
Example
# Narrates a list of "one|two|three"
- narrate <list[one|one|two|three].deduplicate>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1513

Name<ListTag.exclude[...|...]>
ReturnsListTag
DescriptionReturns a new ListTag excluding the items specified.
Example
# Narrates a list of "one|three"
- narrate <list[one|two|three|four|two].exclude[two|four]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1311

Name<ListTag.exclude_single[<value>]>
ReturnsListTag
DescriptionReturns a new ListTag excluding the items specified.
If your list contains sub-lists, this tag can cleanly remove them.
Note that the "_single" refers to not taking a list of removables, it does still remove more than once instance of the value if present in the list.
Example
# Narrates a list of "one|two|three|four", note how it does not remove anything here, as "two|three" does not appear as a *single* value in the list.
- narrate <list[one|two|three|four].exclude_single[two|three]>
Example
# Narrates a list of "three|four", with the single-entry "one|two" value removed.
- narrate <list_single[one|two].include[three|four].exclude_single[one|two]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1286

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

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

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

Name<ListTag.find[<element>]>
ReturnsElementTag(Number)
DescriptionReturns the numbered index of an entry within a list,
or -1 if the list does not contain that item.
Example
# Narrates "2"
- narrate <list[one|two|three].find[two]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1716

Name<ListTag.find_all[<element>]>
ReturnsListTag
DescriptionReturns all the numbered indices of all entries that match the text within a list,
or an empty list if the list does not contain that item.
Example
# Narrates a list of "2|4"
- narrate <list[one|two|three|two].find_all[two]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1654

Name<ListTag.find_all_matches[<matcher>]>
ReturnsListTag
DescriptionReturns all the numbered indices of elements that match within a list,
using the system behind Language:Advanced Object Matching,
or an empty list if the list does not contain that item.
Example
# Narrates a list of "2|3"
- narrate <list[one|two|three].find_all_matches[t*]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1631

Name<ListTag.find_all_partial[<element>]>
ReturnsListTag
DescriptionReturns all the numbered locations of elements that contain the text within a list,
or an empty list if the list does not contain that item.
Example
# Narrates a list of "2|4"
- narrate <list[one|two|three|two].find_all_partial[tw]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1610

Name<ListTag.find_match[<matcher>]>
ReturnsElementTag(Number)
DescriptionReturns the numbered index of the first match within a list,
using the system behind Language:Advanced Object Matching,
or -1 if the list does not contain that item.
Example
# Narrates "2"
- narrate <list[one|two|three].find_match[t*]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1695

Name<ListTag.find_partial[<element>]>
ReturnsElementTag(Number)
DescriptionReturns the numbered index of the first partially matching entry within a list,
or -1 if the list does not contain that item.
Example
# Narrates "2"
- narrate <list[one|two|three].find_partial[tw]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1675

Name<ListTag.first[(<#>)]>
ReturnsObjectTag
DescriptionReturns the first element in the list.
If the list is empty, returns null instead.
Effectively equivalent to .get[1]
Optionally, specify a number of entries to get, which will return the # first entries, equivalent to .get[1].to[#]
Example
# Narrates "one"
- narrate <list[one|two|three].first>
Example
# Narrates a list of "one" and "two"
- narrate <list[one|two|three].first[2]>
Example
# Narrates a list of "one", "two", and "three"
- narrate <list[one|two|three].first[5]>
Example
# Causes an error, as the list is empty.
- narrate <list.first>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1823

Name<ListTag.get[<#>|...]>
ReturnsObjectTag
DescriptionReturns an element of the value specified by the supplied context.
Specify more than one index to get a list of results.
Note the index input options described at ObjectType:listtag
Example
# Narrates "one"
- narrate <list[one|two|three].get[1]>
Example
# Narrates a list of "one|three"
- narrate <list[one|two|three].get[1|3]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1526

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

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

Name<ListTag.get[<#>].to[<#>]>
ReturnsListTag
DescriptionReturns all elements in the range from the first index to the second.
Note the index input options described at ObjectType:listtag
Example
# Narrates a list of "one|two|three"
- narrate <list[one|two|three|four].get[1].to[3]>
Example
# Narrates a list of "three|four"
- narrate <list[one|two|three|four].get[3].to[last]>
Example
# Narrates a list of "three|four"
- narrate <list[one|two|three|four].get[-2].to[-1]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1566

Name<ListTag.highest[(<tag>)]>
ReturnsObjectTag
DescriptionReturns the highest value in a list of decimal numbers.
Optionally specify a tag to run on each list entry that returns the numeric value for that entry.
Example
# Narrates '10'
- narrate "<list[3|2|1|10].highest>
Example
# Narrates the name of the player with the most money currently online
- narrate <server.online_players.highest[money].name>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2005

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

Name<ListTag.include[...|...]>
ReturnsListTag
DescriptionReturns a new ListTag including the items specified.
Example
# Narrates a list of "one|two|three|four"
- narrate <list[one|two].include[three|four]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1271

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

Name<ListTag.insert_single[...|...].at[<#>]>
ReturnsListTag
DescriptionReturns a new ListTag with the single item specified inserted to the specified location.
Note the index input options described at ObjectType:listtag
Example
# Narrates a list with 3 values: "one", "two|alsotwo", "three"
- narrate <list[one|three].insert_single[two|alsotwo].at[2]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1109

Name<ListTag.insert[...|...].at[<#>]>
ReturnsListTag
DescriptionReturns a new ListTag with the items specified inserted to the specified location.
Note the index input options described at ObjectType:listtag
Example
# Narrates a list of "one|two|three|four"
- narrate <list[one|four].insert[two|three].at[2]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1076

Name<ListTag.is_empty>
ReturnsElementTag(Boolean)
DescriptionReturns whether the list is empty.
Example
- if <list[something].is_empty>:
    - narrate "never shows"
- else:
    - narrate "it ain't empty!"
Example
- if <list.is_empty>:
    - narrate "it empty!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1040

Name<ListTag.last[(<#>)]>
ReturnsObjectTag
DescriptionReturns the last element in the list.
If the list is empty, returns null instead.
Effectively equivalent to .get[<[list].size>]
Optionally, specify a number of entries to get, which will return the # first entries, equivalent to .get[<[size].sub[#]>].to[last]
Example
# Narrates "three"
- narrate <list[one|two|three].last>
Example
# Narrates a list of "two" and "three"
- narrate <list[one|two|three].last[2]>
Example
# Narrates a list of "one", "two", and "three"
- narrate <list[one|two|three].last[5]>
Example
# Causes an error, as the list is empty.
- narrate <list.last>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1864

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

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

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

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

Name<ListTag.numerical>
ReturnsListTag
DescriptionReturns the list sorted to be in numerical order.
Example
# Narrates a list of '1|2|3|10'
- narrate "<list[3|2|1|10].numerical>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2103

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

Name<ListTag.pad_left[<#>]>
ReturnsListTag
DescriptionReturns a ListTag extended to reach a minimum specified length by adding entries to the left side.
Generated Example
- foreach <list[one|two].pad_left[3]> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2510

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

Name<ListTag.pad_right[<#>]>
ReturnsListTag
DescriptionReturns a ListTag extended to reach a minimum specified length by adding entries to the right side.
Generated Example
- foreach <list[one|two].pad_right[2]> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2537

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

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

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

Name<ListTag.random[(<#>)]>
ReturnsObjectTag
DescriptionGets a random item in the list and returns it.
Optionally, add [<#>] to instead get a list of multiple randomly chosen list entries.
Example
# Narrates EITHER "one" OR "two" - different each time!
- narrate "<list[one|two].random>
Example
# Could narrate "one|two", "two|three", OR "one|three" - different each time!
- narrate "<list[one|two|three].random[2]>
Example
# Could narrate "one|two|three", "one|three|two", "two|one|three", "two|three|one", "three|two|one", OR "three|one|two" - different each time!
- narrate "<list[one|two|three].random[9999]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L2692

Name<ListTag.remove[<#>|...]>
ReturnsListTag
DescriptionReturns a new ListTag excluding the items at the specified index.
Note the index input options described at ObjectType:listtag
Example
# Narrates a list of "one|three|four"
- narrate <list[one|two|three|four].remove[2]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1356

Name<ListTag.remove[<#>].to[<#>]>
ReturnsListTag
DescriptionReturns a new ListTag excluding the items in the specified index range.
Note the index input options described at ObjectType:listtag
Example
# Narrates a list of "one|five"
- narrate <list[one|two|three|four|five].remove[2].to[4]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1369

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

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

Name<ListTag.reverse>
ReturnsListTag
DescriptionReturns a copy of the list, with all items placed in opposite order.
Example
# Narrates a list of "three|two|one"
- narrate <list[one|two|three].reverse>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1498

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

Name<ListTag.set_single[<value>].at[<#>]>
ReturnsListTag
DescriptionReturns a new ListTag with the single item specified inserted to the specified location, replacing the object already at that location.
Note the index input options described at ObjectType:listtag
Example
# Narrates a list with 3 values: "one", "potato|taco", "three"
- narrate <list[one|two|three].set_single[potato|taco].at[2]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1179

Name<ListTag.set[...|...].at[<#>]>
ReturnsListTag
DescriptionReturns a new ListTag with the items specified inserted to the specified location, replacing the object already at that location.
Note the index input options described at ObjectType:listtag
Example
# Narrates a list of "one|potato|three"
- narrate <list[one|two|three].set[potato].at[2]>
Example
# Narrates a list of "one|potato|taco|hotdog|three"
- narrate <list[one|two|three].set[potato|taco|hotdog].at[2]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1140

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

Name<ListTag.size>
ReturnsElementTag(Number)
DescriptionReturns the size of the list.
Example
# Narrates '3'
- narrate <list[one|two|three].size>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1027

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

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

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

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

Name<ListTag.space_separated>
ReturnsElementTag
DescriptionReturns the list in a cleaner format, separated by spaces.
Example
# Narrates "one two three"
- narrate <list[one|two|three].space_separated>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L782

Name<ListTag.sub_lists[<#>]>
ReturnsListTag(ListTag)
DescriptionReturns a list containing sublists of this list capped to a specific length.
Example
# Narrates "a|b", then "c|d", then "e|f"
- foreach <list[a|b|c|d|e|f].sub_lists[2]> as:sublist:
    - narrate <[sublist]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L755

Name<ListTag.sum>
ReturnsElementTag(Decimal)
DescriptionReturns the sum of all numbers in the list. Ignores non-numerical values.
Example
# Narrates "6"
- narrate <list[1|2|3].sum>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L1777

Name<ListTag.to_map[(<separator>)]>
ReturnsMapTag
DescriptionInterprets a list of "key/value" pairs as a map, and returns the resulting MapTag.
Optionally specify the map separator symbol, by default '/'.
Inverted by Tag:MapTag.to_list
Generated Example
- foreach <list[one|two].to_map> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L978

Name<ListTag.unseparated>
ReturnsElementTag
DescriptionReturns the list in a less clean format, separated by nothing.
Example
# Narrates "onetwothree"
- narrate <list[one|two|three].unseparated>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ListTag.java#L830



Category: LocationTag


Name<LocationTag.find_entities[within=<#>;(match=<matcher>)]>
ReturnsListTag(EntityTag)
DescriptionReturns 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
- foreach <client.cursor_on.find_entities> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L350

Name<LocationTag.pitch>
ReturnsElementTag(Decimal)
DescriptionReturns the location's pitch.
Generated Example
- narrate "the decimal value is <client.cursor_on.pitch>"
Groupidentity
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L183

Name<LocationTag.raw_yaw>
ReturnsElementTag(Decimal)
DescriptionReturns the location's raw (un-normalized) yaw.
Generated Example
- narrate "the decimal value is <client.cursor_on.raw_yaw>"
Groupidentity
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L172

Name<LocationTag.world>
ReturnsElementTag
DescriptionReturns the name of the world the location is in, if any.
Generated Example
- narrate <client.cursor_on.world>
Groupidentity
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L194

Name<LocationTag.yaw>
ReturnsElementTag(Decimal)
DescriptionReturns the location's normalized yaw.
Generated Example
- narrate "the decimal value is <client.cursor_on.yaw>"
Groupidentity
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L161

Name<LocationTag.above[(<#.#>)]>
ReturnsLocationTag
DescriptionReturns the location above this location. Optionally specify a number of blocks to go up.
This just moves straight along the Y axis, equivalent to Tag:VectorObject.add with input 0,1,0 (or the input value instead of '1').
Generated Example
- narrate "The location is <client.cursor_on.above>!"
Groupmath
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L234

Name<LocationTag.backward[(<#.#>)]>
ReturnsLocationTag
DescriptionReturns the location behind this location based on yaw and pitch. Optionally specify a number of blocks to go backward.
This is equivalent to Tag:LocationTag.forward in the opposite direction.
Generated Example
- narrate "The location is <client.cursor_on.backward>!"
Groupmath
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L271

Name<LocationTag.below[(<#.#>)]>
ReturnsLocationTag
DescriptionReturns the location below this location. Optionally specify a number of blocks to go down.
This just moves straight along the Y axis, equivalent to Tag:VectorObject.sub with input 0,1,0 (or the input value instead of '1').
Generated Example
- narrate "The location is <client.cursor_on.below>!"
Groupmath
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L246

Name<LocationTag.block>
ReturnsLocationTag
DescriptionReturns the location of the block this location is on,
i.e. returns a location without decimals or direction.
Note that you almost never actually need this tag. This does not "get the block", this just rounds coordinates down.
If you have this in a script, it is more likely to be a mistake than actually needed.
Consider using Tag:LocationTag.round_down instead.
Generated Example
- narrate "The location is <client.cursor_on.block>!"
Groupmath
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L205

Name<LocationTag.down[(<#.#>)]>
ReturnsLocationTag
DescriptionReturns the location below this location based on pitch and yaw. Optionally specify a number of blocks to go down.
This is equivalent to Tag:LocationTag.forward with a -90 degree rotation to the pitch.
To just get the location above this location, use Tag:LocationTag.below instead.
Generated Example
- narrate "The location is <client.cursor_on.down>!"
Groupmath
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L324

Name<LocationTag.forward[(<#.#>)]>
ReturnsLocationTag
DescriptionReturns 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 Tag:LocationTag.backward in the opposite direction.
Generated Example
- narrate "The location is <client.cursor_on.forward>!"
Groupmath
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L258

Name<LocationTag.left[(<#.#>)]>
ReturnsLocationTag
DescriptionReturns the location to the left of this location based on pitch and yaw. Optionally specify a number of blocks to go left.
This is equivalent to Tag:LocationTag.forward with a +90 degree rotation to the yaw and the pitch set to 0.
Generated Example
- narrate "The location is <client.cursor_on.left>!"
Groupmath
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L284

Name<LocationTag.right[(<#.#>)]>
ReturnsLocationTag
DescriptionReturns the location to the right of this location based on pitch and yaw. Optionally specify a number of blocks to go right.
This is equivalent to Tag:LocationTag.forward with a -90 degree rotation to the yaw and the pitch set to 0.
Generated Example
- narrate "The location is <client.cursor_on.right>!"
Groupmath
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L297

Name<LocationTag.round_down>
ReturnsLocationTag
DescriptionReturns a rounded-downward version of the LocationTag's coordinates.
That is, each component (X, Y, Z, Yaw, Pitch) is rounded downward
(eg, 0.1 becomes 0.0, 0.5 becomes 0.0, 0.9 becomes 0.0).
This is equivalent to the block coordinates of the location.
Generated Example
- narrate "The location is <client.cursor_on.round_down>!"
Groupmath
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L220

Name<LocationTag.up[(<#.#>)]>
ReturnsLocationTag
DescriptionReturns the location above this location based on pitch and yaw. Optionally specify a number of blocks to go up.
This is equivalent to Tag:LocationTag.forward with a +90 degree rotation to the pitch.
To just get the location above this location, use Tag:LocationTag.above instead.
Generated Example
- narrate "The location is <client.cursor_on.up>!"
Groupmath
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L310

Name<LocationTag.material>
ReturnsMaterialTag
DescriptionReturns the material of the block at the location.
Generated Example
- narrate "The material is <client.cursor_on.material>!"
Groupworld
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/LocationTag.java#L339



Category: MapTag


Name<MapTag.any>
ReturnsElementTag(Boolean)
DescriptionReturns "true" if the map contains any keys, or "false" if it is empty.
Example
- if <map[a=1;b=2].any>:
    - narrate "This will show! The map has stuff in it!"
- else:
    - narrate "This won't show"
Example
- if <map.any>:
    - narrate "This won't show"
- else:
    - narrate "This will show! That map is empty!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L408

Name<MapTag.contains[<key>|...]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the map contains the specified key.
If a list is given as input, returns whether the map contains all of the specified keys.
Example
- if <map[a=1;b=2].contains[a]>:
    - narrate "Yep it sure does have 'a' as a key!"
Example
- if <map[a=1;b=2].contains[c]>:
    - narrate "This won't show"
- else:
    - narrate "No it doesn't have 'c'"
Example
# Narrates 'true'
- narrate <map[a=1;b=2].contains[a|b]>
Example
# Narrates 'false'
- narrate <map[a=1;b=2].contains[a|b|c]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L539

Name<MapTag.deep_exclude[<key>|...]>
ReturnsMapTag
DescriptionReturns a copy of the map with the specified deep key(s) excluded.
Example
- definemap mymap:
    root:
        first: kept
        second: lost
# Will narrate the initial map of '[root=[first=kept;second=lost]]'
- narrate <[mymap]>
# Demonstrates deep_exclude of 'second', narrating a new map of '[root=[first=kept]]' without 'second' in it
- narrate <[mymap].deep_exclude[root.second]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L802

Name<MapTag.deep_get[<key>|...]>
ReturnsObjectTag
DescriptionReturns the object value at the specified key, using deep key paths separated by the '.' symbol.
If a list is given as input, returns a list of values.
Example
# Narrates 'myvalue'
- narrate <map.with[root].as[<map[leaf=myvalue]>].deep_get[root.leaf]>
Example
# Narrates 'myvalue'
- definemap mymap:
    root:
        leaf: myvalue
- narrate <[mymap].deep_get[root.leaf]>
# The below will also get the same result ('myvalue') using the definition tag's special automatic deep get syntax:
- narrate <[mymap.root.leaf]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L604

Name<MapTag.deep_keys>
ReturnsListTag
DescriptionReturns a list of all keys in this map, including keys in any sub-maps (map values that are in turn MapTags), using deep key paths separated by the '.' symbol.
No returned key value will refer to a MapTag instance.
Example
- definemap mymap:
    root:
        first: 1
        second: 2
# Will narrate a list of 'root.first' and 'root.second'
# Note that 'root' itself is not in the output list, as it is a map, not a leaf value.
- narrate <[mymap].deep_keys>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L861

Name<MapTag.deep_with[<key>].as[<value>]>
ReturnsMapTag
DescriptionReturns a copy of the map, with the specified key set to the specified value, using deep key paths separated by the '.' symbol.
Example
# Narrates a map of '[root=[leaf=myvalue]]', such that <[that].get[root]> itself returns a map of '[leaf=myvalue]'
- narrate <map.deep_with[root.leaf].as[myvalue]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L695

Name<MapTag.default[<key>].as[<value>]>
ReturnsMapTag
DescriptionReturns a copy of the map, with the specified key defaulted to the specified value.
If the map does not already have the specified key, this is equivalent to the 'with[key].as[value]' tag.
If the map already has the specified key, this will return the original map, unmodified.
Example
# Narrates a map of '[a=1;b=2;c=3;d=4]'
- narrate <map[a=1;b=2;c=3].default[d].as[4]>
Example
# Demonstrates matching keys not being replaced - narrates a map of '[a=1;b=2;c=3]'
- narrate <map[a=1;b=2;c=3].default[c].as[4]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L657

Name<MapTag.exclude[<key>|...]>
ReturnsMapTag
DescriptionReturns a copy of the map with the specified key(s) excluded.
Example
# Narrates a map of '[a=1;c=3]'
- narrate <map[a=1;b=2;c=3].exclude[b]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L825

Name<MapTag.filter_tag[<parseable-boolean>]>
ReturnsMapTag
DescriptionReturns a copy of the map with all its contents parsed through the given input tag and only including ones that returned 'true'.
This requires a fully formed tag as input, making use of the 'filter_key' and 'filter_value' definition.
Example
# Narrates a map of '[c=3;d=4;e=5]'
- narrate <map[a=1;b=2;c=3;d=4;e=5].filter_tag[<[filter_value].is[or_more].than[3]>]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L477

Name<MapTag.get[<key>|...]>
ReturnsObjectTag
DescriptionReturns the object value at the specified key.
If a list is given as input, returns a list of values.
Example
# Narrates '2'
- narrate <map[a=1;b=2;c=3].get[b]>
Example
# Demonstrates that list input gives list output - narrates '2' then '3'
- foreach <map[a=1;b=2;c=3].get[b|c]> as:value:
    - narrate "One of the values is <[value]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L579

Name<MapTag.get_subset[<key>|...]>
ReturnsMapTag
DescriptionReturns the subset of the map represented by the given keys, ordered based on the input list.
Keys that aren't present in the original map will be ignored.
Example
# Narrates a map of '[b=2;a=1]'
- narrate <map[a=1;b=2;c=3].get_subset[b|a]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L635

Name<MapTag.include[<map>]>
ReturnsMapTag
DescriptionReturns a copy of the map with the specified map's contents copied in.
Matching keys will be overridden.
Example
# Narrates a map of '[a=1;b=2;c=3;d=4;e=5]'
- narrate <map[a=1;b=2;c=3].include[d=4;e=5]>
Example
# Demonstrates matching keys overriding - Narrates a map of '[a=1;b=4;c=5]'
- narrate <map[a=1;b=2;c=3].include[b=4;c=5]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L842

Name<MapTag.invert>
ReturnsMapTag
DescriptionReturns an inverted copy of the map. That is, keys become values and values become keys.
All values in the result will be ElementTags.
Note that the size of the result is not guaranteed to be the same as the input (as duplicate keys are not allowed, but duplicate values are).
In the case of duplicate new-keys, the last instance of the new-key will be preserved.
Example
# Narrates a map of '[1=a;2=b;3=c]'
- narrate <map[a=1;b=2;c=3].invert>
Example
# Demonstrates how duplicate values in the input become a single key in the output - narrates a map of '[1=a;2=c]'
- narrate <map[a=1;b=2;c=2].invert>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L759

Name<MapTag.is_empty>
ReturnsElementTag(Boolean)
DescriptionReturns "true" if the map is empty (contains no keys), otherwise "false".
Example
- if <map[a=1;b=2].is_empty>:
    - narrate "This won't show"
- else:
    - narrate "This will show! The map has stuff in it!"
Example
- if <map.is_empty>:
    - narrate "This will show! That map is empty!"
- else:
    - narrate "This won't show"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L388

Name<MapTag.keys>
ReturnsListTag
DescriptionReturns a list of all keys in this map.
Example
# Narrates a list of 'a|b|c|'
- narrate <map[a=1;b=2;c=3].keys>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L889

Name<MapTag.parse_value[<tag>]>
ReturnsMapTag
DescriptionReturns a copy of the map with all its values updated through the given tag.
One should generally prefer Tag:MapTag.parse_value_tag.
Example
# Narrates a map of '[alpha=ONE;beta=TWO]'
- narrate <map[alpha=one;bravo=two].parse_value[to_uppercase]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L987

Name<MapTag.parse_value_tag[<parseable-value>]>
ReturnsMapTag
DescriptionReturns a copy of the map with all its values updated through the given tag.
This requires a fully formed tag as input, making use of the 'parse_key' and 'parse_value' definition.
Example
# Narrates a map of '[alpha=ONE;bravo=TWO]'
- narrate <map[alpha=one;bravo=two].parse_value_tag[<[parse_value].to_uppercase>]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L509

Name<MapTag.reverse>
ReturnsMapTag
DescriptionReturns a reversed copy of the map. That is, the last key becomes the first key and vice-versa, akin to Tag:ListTag.reverse
Not to be confused with Tag:MapTag.invert
Example
# Narrates a map of '[c=3;b=2;a=1]'
- narrate <map[a=1;b=2;c=3].reverse>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L782

Name<MapTag.size>
ReturnsElementTag(Number)
DescriptionReturns the size of the map - that is, how many key/value pairs are within it.
Example
# Narrates '2'
- narrate <map[a=1;b=2].size>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L375

Name<MapTag.sort_by_value[(<tag>)]>
ReturnsMapTag
DescriptionReturns a copy of the map, sorted alphanumerically by the value under each key.
Optionally, specify a tag to apply to the value.
To sort by key, use Tag:MapTag.get_subset with list sort tags, like 'map.get_subset[map.keys.sort_by_value[...]]'.
This also lets you apply list filters or similar to the keyset.
To apply a '.parse' to the values, use Tag:ListTag.map_with, like 'map.keys.map_with[map.values.parse[...]]'
Example
# Narrates a map of [a=1;b=2;c=3]
- narrate <map[c=3;a=1;b=2].sort_by_value>
Example
# Narrates a map of [c=3;b=2;a=1]
- narrate <map[c=3;a=1;b=2].sort_by_value[mul[-1]]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L428

Name<MapTag.to_json[(native_types=<true/false>);(indent=<#>)]>
ReturnsElementTag
DescriptionReturns a JSON encoding of this map. Primarily useful with interop with other software, such as when use Command:webget or Command:webserver.
Optionally specify configuration input with:
'native_types' (defaults to false) if 'true' will attempt to convert 'true' or 'false' to booleans, and numbers to raw numbers.
'indent' (defaults to 0) to specify the indentation level of the JSON text output. 0 means no spacing or newlines at all.
Example
# Narrates {"a":"1","b":"2"}
- narrate <map[a=1;b=2].to_json>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L951

Name<MapTag.to_list[(<separator>)]>
ReturnsListTag
DescriptionReturns a list of all key/value pairs in this map, separated by the specified separator symbol. If none is given, uses the slash '/' symbol.
Note that there is no escaping of the separator, so maps that have the separator in their keys will not be possible to convert back to a map.
Inverted by Tag:ListTag.to_map
Example
# Narrates "a/1", then "b/2", then "c/3"
- foreach <map[a=1;b=2;c=3].to_list> as:slashed:
    - narrate "<[slashed]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L934

Name<MapTag.to_pair_lists>
ReturnsListTag
DescriptionReturns a list of all key/value pairs in this map, where each entry in the list is itself a list with 2 entries: the key, then the value.
Example
# Narrates "a is set to 1", then "b is set to 2", then "c is set to 3"
- foreach <map[a=1;b=2;c=3].to_pair_lists> as:pair:
    - narrate "<[pair].get[1]> is set to <[pair].get[2]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L915

Name<MapTag.to_yaml>
ReturnsElementTag
DescriptionReturns a YAML encoding of this map. Sometimes useful for debugging or for interop with other software.
Example
# Narrates multiple lines, as follows:
# a: '1'
# b: '2'
- narrate <map[a=1;b=2].to_yaml>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L970

Name<MapTag.values>
ReturnsListTag
DescriptionReturns a list of all values in this map.
Example
# Narrates a list of '1|2|3|'
- narrate <map[a=1;b=2;c=3].values>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L902

Name<MapTag.with[<key>].as[<value>]>
ReturnsMapTag
DescriptionReturns a copy of the map, with the specified key set to the specified value.
Matching keys will be overridden.
Example
# Narrates a map of '[a=1;b=2;c=3;d=4]'
- narrate <map[a=1;b=2;c=3].with[d].as[4]>
Example
# Demonstrates matching key overriding - narrates a map of '[a=1;b=2;c=4]'
- narrate <map[a=1;b=2;c=3].with[c].as[4]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/MapTag.java#L725



Category: ModTag


Name<ModTag.authors>
ReturnsMapTag
DescriptionReturns 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
- foreach <mod[clientizen].authors> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L117

Name<ModTag.contact_info>
ReturnsMapTag
DescriptionReturns 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
- foreach <mod[clientizen].contact_info> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L141

Name<ModTag.contained_mods>
ReturnsListTag(ModTag)
DescriptionReturns a list of mods contained by this mod (for mods that include libraries, for example).
Generated Example
- foreach <mod[clientizen].contained_mods> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L185

Name<ModTag.containing_mod>
ReturnsModTag
DescriptionReturns the mod that contains this mod, if any (for things like library mods included by other mods).
Generated Example
- narrate "The mod is <mod[clientizen].containing_mod>!"
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L175

Name<ModTag.contributors>
ReturnsMapTag
DescriptionReturns 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
- foreach <mod[clientizen].contributors> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L129

Name<ModTag.description>
ReturnsElementTag
DescriptionReturns a mod's description.
Generated Example
- narrate <mod[clientizen].description>
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L97

Name<ModTag.display_name>
ReturnsElementTag
DescriptionReturns a mod's display name.
Generated Example
- narrate <mod[clientizen].display_name>
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L87

Name<ModTag.id>
ReturnsElementTag
DescriptionReturns a mod's id.
Generated Example
- narrate <mod[clientizen].id>
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L77

Name<ModTag.licenses>
ReturnsListTag
DescriptionReturns a list of a mod's licenses.
Generated Example
- foreach <mod[clientizen].licenses> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L153

Name<ModTag.type>
ReturnsElementTag
DescriptionReturns 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
- narrate <mod[clientizen].type>
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L163

Name<ModTag.version>
ReturnsElementTag
DescriptionReturns a mod's version.
Generated Example
- narrate <mod[clientizen].version>
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/ModTag.java#L107



Category: ObjectTag


Name<ObjectTag.advanced_matches[<matcher>]>
ReturnsElementTag(Boolean)
DescriptionReturns whether the object matches some matcher text, using the system described at Language:Advanced Object Matching.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L261

Name<ObjectTag.as[<type>]>
ReturnsObjectTag
DescriptionReturns the object, automatically converted to the named object type.
Type names can be of the long form, like "ListTag", "MapTag", "ElementTag", ... or the short form, like "List", "Map", "Element", ...
Type name input is not case-sensitive, so "List" or "list" are the same.
Example
my_example:
    type: task
    # Some input can be any raw object type, but will be forced to a list using 'as[list]' below
    definitions: some_input
    script:
    - narrate "Input list has size <[some_input].as[list].size>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L295

Name<ObjectTag.exists>
ReturnsElementTag(Boolean)
DescriptionReturns true if the object exists (is non-null). Returns false if the object doesn't exist, is null, or the tag errored.
This functions as a fallback - meaning, if the tag up to this point errors, that error will be hidden.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L116

Name<ObjectTag.if_null[<object>]>
ReturnsObjectTag
DescriptionIf the object is null (or the tag errors), this will return the input object.
If the object isn't null, the input won't be parsed, and the original object will be returned.
For example, "<player.if_null[<npc>]>" will return the player if there is a player, and otherwise will return the NPC.
This functions as a fallback - meaning, if the tag up to this point errors, that error will be hidden.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L100

Name<ObjectTag.is_truthy>
ReturnsElementTag(Boolean)
DescriptionReturns true if the object is 'truthy'. An object is 'truthy' if it exists and is valid, and does not represent a concept like emptiness.
An empty list or an air item will return 'false'. Plaintext "null" or "false", an empty element, or a numeric zero will return 'false' as well.
Some object types may have their own logical implementations, for examples an EntityTag value is 'truthy' only if the entity it represents is spawned.
Errored/broken/invalid tags are also considered 'false' by this logic.
This functions as a fallback - meaning, if the tag up to this point errors, that error will be hidden.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L127

Name<ObjectTag.null_if[<tag>]>
ReturnsObjectTag
DescriptionParses the given tag on the object, expecting a boolean return.
If the return is 'true', the 'null_if' tag returns null.
If the return is 'false', the 'null_if' tag returns the original object.
Consider also Tag:ObjectTag.null_if_tag.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L141

Name<ObjectTag.null_if_tag[<dynamic-boolean>]>
ReturnsObjectTag
DescriptionParses the given tag on the object, expecting a boolean return.
This requires a fully formed tag as input, making use of the 'null_if_value' definition.
If the return is 'true', the 'null_if' tag returns null.
If the return is 'false', the 'null_if' tag returns the original object.
Consider also Tag:ObjectTag.null_if_tag.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L176

Name<ObjectTag.object_type>
ReturnsElementTag
DescriptionReturns the short-form name of the tag type that is processing this tag, like 'List'.
This tag is made available to help you debug script issues, for example if you think an object isn't processing its own type correctly.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L35

Name<ObjectTag.prefix>
ReturnsElementTag
DescriptionReturns the prefix of the tag type that is processing this tag, like 'List'.
Prefixes are generally only used for debugging (for example, command execution reports show them).
This tag should not be relied on or expected to return any specific value. It may change arbitrarily or even be removed at any time.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L23

Name<ObjectTag.proc[<procedure_script_name>]>
ReturnsObjectTag
DescriptionReturns the 'determine' result of a procedure script, passing this object in as the context value.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L46

Name<ObjectTag.proc[<procedure_script_name>].context[<object>|...]>
ReturnsObjectTag
DescriptionReturns the 'determine' result of a procedure script, passing this object in as the first context value, with a list of additional context values.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L77

Name<ObjectTag.reflected_internal_object>
ReturnsJavaReflectedObjectTag
DescriptionReturns the reflected internal Java object for a given ObjectTag.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L274

Name<ObjectTag.repeat_as_list[<#>]>
ReturnsListTag
DescriptionReturns a list contained the input number of entries, each of which is an exact copy of the object.
For example, element[hello].repeat_as_list[3] returns a ListTag of "hello|hello|hello|"
An input value or zero or a negative number will result in an empty list.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L240

Name<ObjectTag.is[<operator>].than[<object>]>
ReturnsElementTag(Boolean)
DescriptionTakes an operator, and compares the first object to the given second object.
Returns the outcome of the comparable, either true or false. For information on operators, see Language:operator.
Equivalent to Tag:ObjectTag.is.to
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L210

Name<ObjectTag.is[<operator>].to[<object>]>
ReturnsElementTag(Boolean)
DescriptionTakes an operator, and compares the first object to the given second object.
Returns the outcome of the comparable, either true or false. For information on operators, see Language:operator.
Equivalent to Tag:ObjectTag.is.than
Groupcomparison
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/CoreObjectTags.java#L200



Category: proc


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

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



Category: QuaternionTag


Name<QuaternionTag.axis_angle_for[<vector>]>
ReturnsElementTag(Decimal)
DescriptionReturns the angle (in radians) around the specified axis vector created by this quaternion.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L318

Name<QuaternionTag.conjugate>
ReturnsQuaternionTag
DescriptionReturns the conjugate of this quaternion.
This is equivalent to (-x, -y, -z, w).
Generated Example
- narrate "TODO: Placeholder: quaternion is <quaternion[identity].conjugate>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L271

Name<QuaternionTag.inverse>
ReturnsQuaternionTag
DescriptionReturns the inverse of this quaternion.
The inverse is the same amount of rotation, in the opposite direction.
Generated Example
- narrate "TODO: Placeholder: quaternion is <quaternion[identity].inverse>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L282

Name<QuaternionTag.length>
ReturnsElementTag(Decimal)
DescriptionReturns the length of this quaternion.
This value is not very useful in most cases.
Generated Example
- narrate "the decimal value is <quaternion[identity].length>"
Synonyms (Search Aid)quaterniontag.magnitude
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L247

Name<QuaternionTag.length_squared>
ReturnsElementTag(Decimal)
DescriptionReturns the squared length of this quaternion.
This value is not very useful in most cases.
Generated Example
- narrate "the decimal value is <quaternion[identity].length_squared>"
Synonyms (Search Aid)quaterniontag.magnitude_squared
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L259

Name<QuaternionTag.mul[<quaternion>]>
ReturnsQuaternionTag
DescriptionReturns this quaternion multiplied by another, using quaternion multiplication.
Effectively combines the rotation represented by two quaternions.
Generated Example
- narrate "TODO: Placeholder: quaternion is <quaternion[identity].mul[identity]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L214

Name<QuaternionTag.negative>
ReturnsQuaternionTag
DescriptionReturns the negative of this quaternion.
That is, (-x, -y, -z, -w).
This is not just making the rotation backwards, for that use Tag:QuaternionTag.inverse.
Generated Example
- narrate "TODO: Placeholder: quaternion is <quaternion[identity].negative>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L294

Name<QuaternionTag.normalize>
ReturnsQuaternionTag
DescriptionReturns a copy of this quaternion, normalized.
Generated Example
- narrate "TODO: Placeholder: quaternion is <quaternion[identity].normalize>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L237

Name<QuaternionTag.plus[<quaternion>]>
ReturnsQuaternionTag
DescriptionReturns this quaternion "plus" another, using simple addition.
This is NOT the same as combining quaternions! For that, use Tag:QuaternionTag.mul.
Generated Example
- narrate "TODO: Placeholder: quaternion is <quaternion[identity].plus[identity]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L203

Name<QuaternionTag.quaternion_between[<quaternion>]>
ReturnsQuaternionTag
DescriptionReturns the quaternion representing the rotation between this quaternion and another.
Equivalent to '[a].mul[<[b].conjugate>]'.
Returns a result such that b == a.mul[result].
Generated Example
- narrate "TODO: Placeholder: quaternion is <quaternion[identity].quaternion_between[identity]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L306

Name<QuaternionTag.represented_angle>
ReturnsElementTag(Decimal)
DescriptionReturns the angle (in radians) represented by this quaternion.
Pairs with Tag:QuaternionTag.represented_axis.
Generated Example
- narrate "the decimal value is <quaternion[identity].represented_angle>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L346

Name<QuaternionTag.represented_axis>
ReturnsVectorObject
DescriptionReturns the axis represented by this quaternion, as a vector.
Pairs with Tag:QuaternionTag.represented_angle.
Generated Example
- adjust <player> velocity:<quaternion[identity].represented_axis>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L357

Name<QuaternionTag.scale[<factor>]>
ReturnsQuaternionTag
DescriptionReturns this quaternion multiplied by scaling factor.
This does NOT increase rotation angle.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L225

Name<QuaternionTag.slerp[end=<quaternion>;amount=<amount>]>
ReturnsQuaternionTag
DescriptionReturns the spherical linear interpolation ('slerp') between this quaternion and another.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L368

Name<QuaternionTag.transform[<vector>]>
ReturnsVectorObject
DescriptionReturns a copy of the given vector, transformed by this quaternion.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L336

Name<QuaternionTag.w>
ReturnsElementTag(Decimal)
DescriptionReturns the raw W value of this quaternion.
Generated Example
- narrate "the decimal value is <quaternion[identity].w>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L162

Name<QuaternionTag.x>
ReturnsElementTag(Decimal)
DescriptionReturns the raw X value of this quaternion.
Generated Example
- narrate "the decimal value is <quaternion[identity].x>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L132

Name<QuaternionTag.xyz>
ReturnsElementTag
DescriptionReturns the X, Y, and Z values of this quaternion as a simple "x,y,z" format.
Generated Example
- narrate <quaternion[identity].xyz>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L172

Name<QuaternionTag.xyz_vector>
ReturnsVectorObject
DescriptionReturns the X, Y, and Z values of this quaternion as a ObjectType:VectorObject.
Generated Example
- adjust <player> velocity:<quaternion[identity].xyz_vector>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L193

Name<QuaternionTag.xyzw>
ReturnsElementTag
DescriptionReturns the X, Y, Z, and W values of this quaternion as a simple "x,y,z,w" format.
Generated Example
- narrate <quaternion[identity].xyzw>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L182

Name<QuaternionTag.y>
ReturnsElementTag(Decimal)
DescriptionReturns the raw Y value of this quaternion.
Generated Example
- narrate "the decimal value is <quaternion[identity].y>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L142

Name<QuaternionTag.z>
ReturnsElementTag(Decimal)
DescriptionReturns the raw Z value of this quaternion.
Generated Example
- narrate "the decimal value is <quaternion[identity].z>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QuaternionTag.java#L152



Category: QueueTag


Name<QueueTag.commands>
ReturnsListTag
DescriptionReturns a list of commands waiting in the queue.
Generated Example
- foreach <queue.commands> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L248

Name<QueueTag.definition[<definition>]>
ReturnsObjectTag
DescriptionReturns the value of the specified definition.
Returns null if the queue lacks the definition.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L306

Name<QueueTag.definition_map>
ReturnsMapTag
DescriptionReturns a map of all definitions on the queue.
Generated Example
- foreach <queue.definition_map> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L296

Name<QueueTag.definitions>
ReturnsListTag
DescriptionReturns the names of all definitions that were added to the current queue.
Generated Example
- foreach <queue.definitions> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L286

Name<QueueTag.determination>
ReturnsListTag
DescriptionReturns the values that have been determined via Command:Determine
for this queue, or null if there is none.
Generated Example
- foreach <queue.determination> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L317

Name<QueueTag.id>
ReturnsElementTag
DescriptionReturns the full textual id of the queue.
Generated Example
- narrate <queue.id>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L147

Name<QueueTag.is_valid>
ReturnsElementTag(Boolean)
DescriptionReturns true if the queue has not yet stopped.
Generated Example
- if <queue.is_valid>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L202

Name<QueueTag.last_command>
ReturnsElementTag
DescriptionReturns the last command executed in this queue (if any).
Generated Example
- narrate <queue.last_command>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L267

Name<QueueTag.numeric_id>
ReturnsElementTag(Number)
DescriptionReturns the raw numeric id of the queue. This is an incremental ID one higher than the previous queue's numeric ID.
Generated Example
- narrate "the number value is <queue.numeric_id>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L157

Name<QueueTag.script>
ReturnsScriptTag
DescriptionReturns the script that started this queue.
Generated Example
- narrate <queue.script>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L235

Name<QueueTag.size>
ReturnsElementTag(Number)
DescriptionReturns the number of script entries in the queue.
Generated Example
- narrate "the number value is <queue.size>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L167

Name<QueueTag.speed>
ReturnsDurationTag
DescriptionReturns the speed of the queue as a Duration. A return of '0' implies it is 'instant'.
This is largely considered historical - most queues now default to instant.
Generated Example
- ratelimit <player> <queue.speed>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L333

Name<QueueTag.started_time>
ReturnsTimeTag
DescriptionReturns the time this queue started as a duration.
Generated Example
- flag server myflag expire:<queue.started_time>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L177

Name<QueueTag.state>
ReturnsElementTag
DescriptionReturns 'stopping', 'running', 'paused', or 'unknown'.
Generated Example
- narrate <queue.state>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L212

Name<QueueTag.time_ran>
ReturnsDurationTag
DescriptionReturns the time this queue has ran for (the length of time between now and when the queue started) as a duration.
Generated Example
- ratelimit <player> <queue.time_ran>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L191



Category: ScriptTag


Name<ScriptTag.container_type>
ReturnsElementTag
DescriptionReturns the type of script container that is associated with this ScriptTag object. For example: 'task', or
'world'.
Generated Example
- narrate <script.container_type>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L234

Name<ScriptTag.data_key[<key_name>]>
ReturnsObjectTag
DescriptionReturns the value from a data key on the script as an ElementTag, ListTag, or MapTag.
For example, "script.data_key[type]" on a task script will return "task".
Custom keys should usually go in a 'data' script container, or under a key labeled 'data' for other script containers.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L333

Name<ScriptTag.filename>
ReturnsElementTag
DescriptionReturns the absolute filename that contains the script.
Generated Example
- narrate <script.filename>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L265

Name<ScriptTag.list_deep_keys[(<start_key>)]>
ReturnsListTag
DescriptionReturns a list of all keys within a script, searching recursively, with an optional starting-key.
Generated Example
- foreach <script.list_deep_keys> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L374

Name<ScriptTag.list_keys[(<start_key>)]>
ReturnsListTag
DescriptionReturns a list of all data keys within a script, with an optional starting-key.
Generated Example
- foreach <script.list_keys> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L360

Name<ScriptTag.name>
ReturnsElementTag
DescriptionReturns the name of the script container.
Generated Example
- narrate <script.name>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L245

Name<ScriptTag.original_name>
ReturnsElementTag
DescriptionReturns the originally cased script name.
Generated Example
- narrate <script.original_name>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L275

Name<ScriptTag.parsed_key[<key_name>]>
ReturnsObjectTag
DescriptionReturns the value from a data key on the script as an ElementTag, ListTag, or MapTag.
Will automatically parse any tags contained within the value of the key, preserving key data structure
(meaning, a tag that returns a ListTag, inside a data list, will insert a ListTag inside the returned ListTag, as you would expect).
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L307

Name<ScriptTag.queues>
ReturnsListTag(QueueTag)
DescriptionReturns all queues which are running for this script.
Generated Example
- foreach <script.queues> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L416

Name<ScriptTag.relative_filename>
ReturnsElementTag
DescriptionReturns the filename that contains the script, relative to the denizen/ folder.
Generated Example
- narrate <script.relative_filename>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L255

Name<ScriptTag.to_json>
ReturnsElementTag
DescriptionConverts the Script Container to a JSON array.
Best used with 'data' type scripts.
Generated Example
- narrate <script.to_json>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L388

Name<ScriptTag.to_yaml>
ReturnsElementTag
DescriptionConverts the Script Container to raw YAML text.
Best used with 'data' type scripts.
Generated Example
- narrate <script.to_yaml>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L401



Category: SecretTag


Name<SecretTag.key>
ReturnsElementTag
DescriptionReturns the secret key for this secret object.
Generated Example
- narrate <secret[my_secret_key].key>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/SecretTag.java#L166



Category: tern


Name<tern[<condition>].pass[<result>].fail[<result>]>
ReturnsObjectTag
DescriptionReturns either the 'pass' input, or 'fail' input depending on the outcome of the condition.
The 'pass' input will be returned when the condition returns 'true', otherwise the 'fail' input will be returned.
Example: '<tern[<player.is_spawned>].pass[Player is spawned!].fail[Player is not spawned!]>'
Consider instead using Tag:ElementTag.if_true.if_false
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/TernaryTagBase.java#L23



Category: TimeTag


Name<TimeTag.add[<duration>]>
ReturnsTimeTag
DescriptionReturns the time that is this TimeTag plus a duration.
For example, a TimeTag on Monday, '.add[1d]', will return a time on Tuesday.
Generated Example
- flag server myflag expire:<util.time_now.add[5m]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L629

Name<TimeTag.day>
ReturnsElementTag(Number)
DescriptionReturns the day-of-month of this TimeTag, starting at 1.
Generated Example
- narrate "the number value is <util.time_now.day>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L287

Name<TimeTag.day_of_week>
ReturnsElementTag(Number)
DescriptionReturns the day-of-week of this TimeTag, with Monday as 1 and Sunday as 7 (per ISO standard).
Generated Example
- narrate "the number value is <util.time_now.day_of_week>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L307

Name<TimeTag.day_of_week_name>
ReturnsElementTag
DescriptionReturns the name of the day-of-week of this TimeTag, like 'MONDAY'.
Generated Example
- narrate <util.time_now.day_of_week_name>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L317

Name<TimeTag.day_of_year>
ReturnsElementTag(Number)
DescriptionReturns the day-of-year of this TimeTag, from 1 to 365 (or 366 in leap years).
Generated Example
- narrate "the number value is <util.time_now.day_of_year>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L297

Name<TimeTag.days_in_month>
ReturnsElementTag(Number)
DescriptionReturns the number of days in the month that this TimeTag is within.
Generated Example
- narrate "the number value is <util.time_now.days_in_month>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L277

Name<TimeTag.duration_since[<time>]>
ReturnsDurationTag
DescriptionReturns the DurationTag that passed between the input time and this time.
That is, a.duration_since[b] returns (a - b).
For example, a time on Monday, .duration_since[a time on Sunday], will return '1d'.
Generated Example
- flag server myflag expire:<util.time_now.duration_since[<util.time_now>]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L666

Name<TimeTag.epoch_millis>
ReturnsElementTag(Number)
DescriptionReturns the number of milliseconds between this TimeTag and the Unix Epoch (Jan. 1st 1970).
Generated Example
- narrate "the number value is <util.time_now.epoch_millis>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L367

Name<TimeTag.format[(<format>)]>
ReturnsElementTag
DescriptionReturns the time, formatted to the date format specification given.
If no format input is given, uses "yyyy/MM/dd HH:mm:ss".
The optional input to this tag uses semi-standard date format symbols, such as 'yyyy' to mean a 4-digit year or 'MM' to mean a 2-digit month.
There are a variety of additional symbols accepted, as listed under "Patterns for Formatting and Parsing" on 🔗https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html.
Generated Example
- narrate <util.time_now.format>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L698

Name<TimeTag.from_now>
ReturnsDurationTag
DescriptionReturns the DurationTag between this time object and the real current system time.
The value will always be positive.
This is equivalent to the absolute value of ".duration_since[<util.time_now>]", and exists primarily as a convenience tag.
For example, a TimeTag for Tuesday will return a DurationTag of '1d' when the tag is used on a Monday.
A TimeTag for Sunday will also return a DurationTag of '1d' when used on a Monday.
If positive/negative differences are required, consider instead using Tag:TimeTag.duration_since.
Generated Example
- ratelimit <player> <util.time_now.from_now>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L651

Name<TimeTag.hour>
ReturnsElementTag(Number)
DescriptionReturns the hour-of-day of this TimeTag, from 1 to 24.
Generated Example
- narrate "the number value is <util.time_now.hour>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L327

Name<TimeTag.is_after[<time>]>
ReturnsElementTag(Boolean)
DescriptionReturns true if this time object comes after the input time value, or false if it's before (or equal).
Generated Example
- if <util.time_now.is_after[<util.time_now>]>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L678

Name<TimeTag.is_before[<time>]>
ReturnsElementTag(Boolean)
DescriptionReturns true if this time object comes before the input time value, or false if it's after (or equal).
Generated Example
- if <util.time_now.is_before[<util.time_now>]>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L688

Name<TimeTag.last_day_of_month[<day>]>
ReturnsTimeTag
DescriptionReturns the timetag of the last occurrence of the specified day-of-month.
This can either be in the same month, or the previous month.
For example, last_day_of_month[3] on a TimeTag on February 1st will return the 3rd of January.
The hour/minute/second/millisecond will be zeroed.
Be careful with inputs of 29/30/31, as only some months contain those days.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L543

Name<TimeTag.last_day_of_week[<day>]>
ReturnsTimeTag
DescriptionReturns the timetag of the previous day of the specified input day-of-week (like 'sunday').
The hour/minute/second/millisecond will be zeroed.
If the TimeTag is on the input day, will return a day 7 days before then.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L487

Name<TimeTag.last_hour_of_day[<hour>]>
ReturnsTimeTag
DescriptionReturns the timetag that represents the previous time the specified hour number was hit.
For example, if the input hour is '14', and the original TimeTag is 5 AM, the return will be 2 PM yesterday.
If the input is '14' and the TimeTag is 5 PM, the return will be 2 PM today.
The minute/second/millisecond will be zeroed.
If the input hour is 5, and the TimeTag is at 5 AM, will return the same day.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L447

Name<TimeTag.millisecond>
ReturnsElementTag(Number)
DescriptionReturns the millisecond of this TimeTag, from 0 to 999.
Generated Example
- narrate "the number value is <util.time_now.millisecond>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L357

Name<TimeTag.minute>
ReturnsElementTag(Number)
DescriptionReturns the minute-of-hour of this TimeTag, from 0 to 59.
Generated Example
- narrate "the number value is <util.time_now.minute>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L337

Name<TimeTag.month>
ReturnsElementTag(Number)
DescriptionReturns the month of this TimeTag, where January is 1 and December is 12.
Generated Example
- narrate "the number value is <util.time_now.month>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L257

Name<TimeTag.month_name>
ReturnsElementTag
DescriptionReturns the name of the month of this TimeTag, like 'JANUARY'.
Generated Example
- narrate <util.time_now.month_name>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L267

Name<TimeTag.next_day_of_month[<day>]>
ReturnsTimeTag
DescriptionReturns the timetag of the next occurrence of the specified day-of-month.
This can either be in the same month, or the next month.
For example, next_day_of_month[1] on a TimeTag on January 3rd will return the 1st of February.
The hour/minute/second/millisecond will be zeroed.
Be careful with inputs of 29/30/31, as only some months contain those days.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L571

Name<TimeTag.next_day_of_week[<day>]>
ReturnsTimeTag
DescriptionReturns the timetag of the next day of the specified input day-of-week (like 'thursday').
The hour/minute/second/millisecond will be zeroed.
If the TimeTag is on the input day, will return a day 7 days from then.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L515

Name<TimeTag.next_hour_of_day[<hour>]>
ReturnsTimeTag
DescriptionReturns the timetag that represents the next time the specified hour number will be hit.
For example, if the input hour is '14', and the original TimeTag is 5 AM, the return will be 2 PM today.
If the input is '14' and the TimeTag is 5 PM, the return will be 2 PM tomorrow.
The minute/second/millisecond will be zeroed.
If the input hour is 5, and the TimeTag is at 5 AM, will return the next day.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L467

Name<TimeTag.second>
ReturnsElementTag(Number)
DescriptionReturns the second-of-minute of this TimeTag, from 0 to 59.
Generated Example
- narrate "the number value is <util.time_now.second>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L347

Name<TimeTag.start_of_day>
ReturnsTimeTag
DescriptionReturns this time tag, with the hour/minute/second/millisecond zeroed (that is, midnight the morning of the same day).
Generated Example
- flag server myflag expire:<util.time_now.start_of_day>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L619

Name<TimeTag.start_of_month>
ReturnsTimeTag
DescriptionReturns this time tag, with the day/hour/minute/second/millisecond zeroed (that is, midnight the morning of the first day of the same month).
Generated Example
- flag server myflag expire:<util.time_now.start_of_month>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L609

Name<TimeTag.start_of_year>
ReturnsTimeTag
DescriptionReturns this time tag, with the month/day/hour/minute/second/millisecond zeroed (that is, midnight the morning of the first day of the same year).
Generated Example
- flag server myflag expire:<util.time_now.start_of_year>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L599

Name<TimeTag.sub[<duration>]>
ReturnsTimeTag
DescriptionReturns the time that is this TimeTag minus a duration.
For example, a TimeTag on Monday, '.sub[1d]', will return a time on Sunday.
Generated Example
- flag server myflag expire:<util.time_now.sub[12h]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L640

Name<TimeTag.time_zone_id>
ReturnsElementTag
DescriptionReturns the ID of the time zone of this TimeTag.
Generated Example
- narrate <util.time_now.time_zone_id>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L387

Name<TimeTag.time_zone_name>
ReturnsElementTag
DescriptionReturns the display name of the time zone of this TimeTag.
Generated Example
- narrate <util.time_now.time_zone_name>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L397

Name<TimeTag.time_zone_offset>
ReturnsElementTag
DescriptionReturns the time zone offset (from UTC) of this TimeTag.
Generated Example
- narrate <util.time_now.time_zone_offset>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L377

Name<TimeTag.to_local>
ReturnsTimeTag
DescriptionReturns a copy of the TimeTag, converted to the local time zone.
Generated Example
- flag server myflag expire:<util.time_now.to_local>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L427

Name<TimeTag.to_utc>
ReturnsTimeTag
DescriptionReturns a copy of the TimeTag, converted to Universal Coordinated Time.
Generated Example
- flag server myflag expire:<util.time_now.to_utc>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L437

Name<TimeTag.to_zone[<zone>]>
ReturnsTimeTag
DescriptionReturns a copy of the TimeTag, converted to the specified time zone.
The hour (and when relevant: day/month/year) of this TimeTag will automatically be converted from the value for the original TimeTag's timezone to the new timezone.
For some zones, the minute might also change.
Zone input can be like 'UTC-5' or like 'America/New_York'
You can find a list of named zones here: 🔗https://en.wikipedia.org/wiki/List_of_tz_database_time_zones using the "TZ database name"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L407

Name<TimeTag.year>
ReturnsElementTag(Number)
DescriptionReturns the year of this TimeTag, like '2020'.
Generated Example
- narrate "the number value is <util.time_now.year>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L247



Category: util


Name<util.available_processors>
ReturnsElementTag(Number)
DescriptionHow many virtual processors are available to the server.
(In general, Minecraft only uses one, unfortunately.)
Generated Example
- narrate "the number value is <util.available_processors>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L783

Name<util.color_names>
ReturnsListTag
DescriptionReturns a list of all color names recognized by ObjectType:ColorTag.
Generated Example
- foreach <util.color_names> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L430

Name<util.current_tick>
ReturnsElementTag(Number)
DescriptionReturns the number of ticks since the server was started.
Note that this is NOT an accurate indicator for real server uptime, as ticks fluctuate based on server lag.
Generated Example
- narrate "the number value is <util.current_tick>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L794

Name<util.current_time_millis>
ReturnsElementTag(Number)
DescriptionReturns the number of milliseconds since Jan 1, 1970.
Note that this can change every time the tag is read!
Use Tag:util.time_now if you need stable time.
Generated Example
- narrate "the number value is <util.current_time_millis>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L831

Name<util.debug_enabled>
ReturnsElementTag(Boolean)
DescriptionReturns whether script debug is currently globally enabled.
Generated Example
- if <util.debug_enabled>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L996

Name<util.default_encoding>
ReturnsElementTag
DescriptionReturns the name of the default system text encoding charset, such as "UTF-8".
Generated Example
- narrate <util.default_encoding>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L611

Name<util.delta_time_since_start>
ReturnsDurationTag
DescriptionReturns the duration of delta time since the server started.
Note that this is delta time, not real time, meaning it is calculated based on the server tick,
which may change longer or shorter than expected due to lag or other influences.
If you want real time instead of delta time, use Tag:util.real_time_since_start.
Generated Example
- flag server myflag expire:<util.delta_time_since_start>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L805

Name<util.disk_free>
ReturnsElementTag(Number)
DescriptionHow much remaining disk space is available to this server, in bytes.
This counts only the drive the server folder is on, not any other drives.
This may be limited below the actual drive capacity by operating system settings.
Generated Example
- narrate "the number value is <util.disk_free>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L702

Name<util.disk_total>
ReturnsElementTag(Number)
DescriptionHow much total disk space is on the drive containing this server, in bytes.
This counts only the drive the server folder is on, not any other drives.
Generated Example
- narrate "the number value is <util.disk_total>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L715

Name<util.disk_usage>
ReturnsElementTag(Number)
DescriptionHow much space on the drive is already in use, in bytes.
This counts only the drive the server folder is on, not any other drives.
This is approximately equivalent to "disk_total" minus "disk_free", but is not always exactly the same,
as this tag will not include space "used" by operating system settings that simply deny the server write access.
Generated Example
- narrate "the number value is <util.disk_usage>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L727

Name<util.e>
ReturnsElementTag(Decimal)
DescriptionReturns e (Euler's number): 2.7182818284590452354
Generated Example
- narrate "the decimal value is <util.e>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L410

Name<util.empty_list_entries[<#>]>
ReturnsListTag
DescriptionReturns a list of the specified size where each entry is blank (zero characters long).
Generated Example
- foreach <util.empty_list_entries[3]> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L315

Name<util.event_stats>
ReturnsElementTag
DescriptionReturns a simple debuggable stats report for all ScriptEvents during this server session.
Generated Example
- narrate <util.event_stats>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L591

Name<util.event_stats_data>
ReturnsListTag(MapTag)
DescriptionReturns the raw data for Tag:util.event_stats, as a ListTag of MapTags.
Generated Example
- foreach <util.event_stats_data> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L601

Name<util.has_file[<name>]>
ReturnsElementTag(Boolean)
DescriptionReturns true if the specified file exists. The starting path is /plugins/Denizen.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L642

Name<util.int_max>
ReturnsElementTag(Number)
DescriptionReturns the maximum value of a 32 bit signed integer (a java 'int'): 2147483647
Generated Example
- narrate "the number value is <util.int_max>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L350

Name<util.int_min>
ReturnsElementTag(Number)
DescriptionReturns the minimum value of a 32 bit signed integer (a java 'int'): -2147483648
Generated Example
- narrate "the number value is <util.int_min>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L360

Name<util.java_class_context>
ReturnsListTag
DescriptionReturns a list of class names in the current stack history.
More stable than Tag:util.stack_trace
This contains a lot of stray content, the first 4 to 20 or so classes in this list are likely irrelevant to what you're searching for.
Each entry in the list is a raw class name, like "com.denizenscript.denizencore.tags.core.UtilTagBase".
Class names may appear multiple times in a row if that class contains methods that call each other.
Generated Example
- foreach <util.java_class_context> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L981

Name<util.java_version>
ReturnsElementTag
DescriptionReturns the current Java version of the server.
Generated Example
- narrate <util.java_version>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L632

Name<util.last_reload>
ReturnsTimeTag
DescriptionReturns the time that Denizen scripts were last reloaded.
Generated Example
- flag server myflag expire:<util.last_reload>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L924

Name<util.list_denizen_commands>
ReturnsListTag
DescriptionReturns a list of all currently loaded Denizen commands.
Generated Example
- foreach <util.list_denizen_commands> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L420

Name<util.list_files[<path>]>
ReturnsListTag
DescriptionReturns a list of all files (and directories) in the specified directory. The starting path is /plugins/Denizen.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L663

Name<util.list_numbers[to=<#>;(from=<#>/{1});(every=<#>/{1})]>
ReturnsListTag
DescriptionReturns a list of integer numbers in the specified range.
You must specify at least the 'to' input, you can optionally specify 'from' (default 1), and 'every' (default 1).
Note that this generally should not be used as input to the 'foreach' command. Instead, use Command:repeat.
Example
# Narrates "1, 2, and 3"
- narrate <util.list_numbers[to=3].formatted>
Example
# Narrates "3, 4, and 5"
- narrate <util.list_numbers[from=3;to=5].formatted>
Example
# Narrates "4, 8, and 12"
- narrate <util.list_numbers[from=4;to=12;every=4].formatted>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L265

Name<util.list_numbers_to[<#>]>
ReturnsListTag
DescriptionReturns a list of integer numbers from 1 to the specified input number (inclusive).
Note that you should NEVER use this as the input to a "foreach" command. Instead, use Command:repeat.
In most cases, there's a better way to do what you're trying to accomplish than using this tag.
Consider instead using Tag:util.list_numbers
Generated Example
- foreach <util.list_numbers_to[1]> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L297

Name<util.list_tag_bases>
ReturnsListTag
DescriptionReturns a list of all currently loaded Denizen tag bases (including "player", "context", "util", "server", etc).
Generated Example
- foreach <util.list_tag_bases> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L440

Name<util.long_max>
ReturnsElementTag(Number)
DescriptionReturns the maximum value of a 64 bit signed integer (a java 'long'): 9223372036854775807
Generated Example
- narrate "the number value is <util.long_max>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L370

Name<util.long_min>
ReturnsElementTag(Number)
DescriptionReturns the minimum value of a 64 bit signed integer (a java 'long'): -9223372036854775808
Generated Example
- narrate "the number value is <util.long_min>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L380

Name<util.mongo_connections>
ReturnsElementTag
DescriptionReturns a list of all Mongo connections opened by Command:mongo.
Generated Example
- narrate <util.mongo_connections>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L902

Name<util.notes[<type>]>
ReturnsListTag
DescriptionLists all saved notable objects of a specific type currently on the server.
Valid types: locations, cuboids, ellipsoids, inventories, polygons
This is primarily intended for debugging purposes, and it's best to avoid using this in a live script if possible.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L843

Name<util.parse_yaml[<yaml>]>
ReturnsMapTag
DescriptionParses the input YAML or JSON text into a MapTag.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L566

Name<util.pi>
ReturnsElementTag(Decimal)
DescriptionReturns PI: 3.14159265358979323846
Generated Example
- narrate "the decimal value is <util.pi>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L390

Name<util.queues>
ReturnsListTag(QueueTag)
DescriptionReturns a list of all currently running queues on the server.
Generated Example
- foreach <util.queues> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L581

Name<util.ram_allocated>
ReturnsElementTag(Number)
DescriptionHow much RAM is allocated to the server, in bytes (total memory).
This is how much of the system memory is reserved by the Java process, NOT how much is actually in use by the minecraft server.
Generated Example
- narrate "the number value is <util.ram_allocated>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L741

Name<util.ram_free>
ReturnsElementTag(Number)
DescriptionHow much RAM is unused but available on the server, in bytes (free memory).
Generated Example
- narrate "the number value is <util.ram_free>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L762

Name<util.ram_max>
ReturnsElementTag(Number)
DescriptionHow much RAM is available to the server (total), in bytes (max memory).
Generated Example
- narrate "the number value is <util.ram_max>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L752

Name<util.ram_usage>
ReturnsElementTag(Number)
DescriptionHow much RAM is used by the server, in bytes (free memory).
Equivalent to ram_max minus ram_free
Generated Example
- narrate "the number value is <util.ram_usage>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L772

Name<util.random_boolean>
ReturnsElementTag(Boolean)
DescriptionReturns a random boolean (true or false). Essentially a coin flip.
Generated Example
- if <util.random_boolean>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L204

Name<util.random_chance[<percent>]>
ReturnsElementTag(Boolean)
DescriptionReturns a random boolean (true or false) with the given percent chance (from 0 to 100).
Example
- if <util.random_chance[25]>:
    - narrate "This happens 25% of the time"
- else:
    - narrate "This happens 75% of the time"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L189

Name<util.random_decimal>
ReturnsElementTag(Decimal)
DescriptionReturns a random decimal number from 0 to 1.
Generated Example
- narrate "the decimal value is <util.random_decimal>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L179

Name<util.random_gauss>
ReturnsElementTag(Decimal)
DescriptionReturns a random decimal number with a gaussian distribution.
70% of all results will be within the range of -1 to 1.
Generated Example
- narrate "the decimal value is <util.random_gauss>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L214

Name<util.random_simplex[x=<#.#>;(y=<#.#>);(z=<#.#>);(w=<#.#>)]>
ReturnsElementTag(Decimal)
DescriptionReturns a pseudo-random decimal number from -1 to 1, based on a Simplex Noise algorithm. See 🔗https://en.wikipedia.org/wiki/Simplex_noise
Input map is like "x=1.0", or "x=1.0;y=2.0", or "x=1.0;y=2.0;z=3" or "x=1;y=2;z=3;w=4"
(That is: 1d, 2d, 3d, or 4d).
Generated Example
- narrate "the decimal value is <util.random_simplex>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L235

Name<util.random_uuid>
ReturnsElementTag
DescriptionReturns a random unique ID.
Generated Example
- narrate <util.random_uuid>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L225

Name<util.random.boolean>
ReturnsElementTag(Boolean)
DescriptionDeprecated in favor of Tag:util.random_boolean
Deprecateduse 'util.random_boolean' with a '_'
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L124

Name<util.random.decimal>
ReturnsElementTag(Decimal)
DescriptionDeprecated in favor of Tag:util.random_decimal
Deprecateduse 'util.random_decimal' with a '_'
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L112

Name<util.random.decimal[<#.#>].to[<#.#>]>
ReturnsElementTag(Decimal)
DescriptionReturns a random decimal number between the 2 specified decimal numbers, inclusive.
Example
# Will narrate '1.5', or '1.75', or '1.01230123', or any other decimal in range.
- narrate <util.random.decimal[1].to[2]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L85

Name<util.random.duuid[(<source>)]>
ReturnsElementTag
DescriptionReturns a random 'denizen' unique ID, which is made of a randomly generated sentence.
Optionally specify the source context to base the value on.
There is no guarantee of format or content of the returned value - generally, use any other random tag instead of this.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L160

Name<util.random.gauss>
ReturnsElementTag(Decimal)
DescriptionDeprecated in favor of Tag:util.random_gauss
Deprecateduse 'util.random_gauss' with a '_'
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L136

Name<util.random.int[<#>].to[<#>]>
ReturnsElementTag(Number)
DescriptionReturns a random integer number between the 2 specified integer numbers, inclusive.
Example
# Will narrate '1', '2', or '3'
- narrate <util.random.int[1].to[3]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L58

Name<util.random.uuid>
ReturnsElementTag
DescriptionDeprecated in favor of Tag:util.random_uuid
Deprecateduse 'util.random_uuid' with a '_'
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L148

Name<util.real_time_since_start>
ReturnsDurationTag
DescriptionReturns the duration of real time since the server started.
Note that this is real time, not delta time, meaning that the it is accurate to the system clock, not the server's tick.
System clock changes may cause this value to become inaccurate.
In many cases Tag:util.delta_time_since_start is preferable.
Generated Example
- ratelimit <player> <util.real_time_since_start>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L818

Name<util.redis_connections>
ReturnsListTag
DescriptionReturns a list of all Redis connections opened by Command:redis.
Generated Example
- foreach <util.redis_connections> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L890

Name<util.reflect_class[<name>]>
ReturnsJavaReflectedObjectTag
DescriptionReturns a reflected reference to the class of the given full class name.
Note that the class-name input is case-sensitive.
This can be used like having an object of that class, but cannot read non-static fields.
Example
# Narrates the current NMS version known to Denizen, for example "v1_19"
- narrate <util.reflect_class[com.denizenscript.denizen.nms.NMSHandler].read_field[version]>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L934

Name<util.runlater_ids>
ReturnsListTag
DescriptionReturns a list of all scheduled task IDs for Command:runlater.
Note that usages of runlater that didn't specify an ID will not show up here.
Generated Example
- foreach <util.runlater_ids> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L621

Name<util.scripts>
ReturnsListTag(ScriptTag)
DescriptionGets a list of all scripts currently loaded into Denizen.
Generated Example
- foreach <util.scripts> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L914

Name<util.short_max>
ReturnsElementTag(Number)
DescriptionReturns the maximum value of a 16 bit signed integer (a java 'short'): 32767
Generated Example
- narrate "the number value is <util.short_max>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L330

Name<util.short_min>
ReturnsElementTag(Number)
DescriptionReturns the minimum value of a 16 bit signed integer (a java 'short'): -32768
Generated Example
- narrate "the number value is <util.short_min>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L340

Name<util.sql_connections>
ReturnsListTag
DescriptionReturns a list of all SQL connections opened by Command:sql.
Generated Example
- foreach <util.sql_connections> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L866

Name<util.stack_trace>
ReturnsElementTag
DescriptionGenerates and shows a stack trace for the current context.
This tag is strictly for internal debugging reasons.
WARNING: Different Java versions generate different stack trace formats and details.
WARNING: Java internally limits stack trace generation in a variety of ways. This tag cannot be relied on to output anything.
For gathering stable context, prefer Tag:util.java_class_context
Generated Example
- narrate <util.stack_trace>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L967

Name<util.started_time>
ReturnsTimeTag
DescriptionReturns the time the server started.
Generated Example
- flag server myflag expire:<util.started_time>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L692

Name<util.tau>
ReturnsElementTag(Decimal)
DescriptionReturns Tau: 6.28318530717958647692
Generated Example
- narrate "the decimal value is <util.tau>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L400

Name<util.time_now>
ReturnsTimeTag
DescriptionReturns the current system date/time.
This value may be wrong if a server is currently heavily lagging, as it only updates once each tick.
Use Tag:util.current_time_millis if you need sub-tick precision.
Generated Example
- flag server myflag expire:<util.time_now>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L473



Category: yaml


Name<yaml[<id>].contains[<path>]>
ReturnsElementTag(Boolean)
DescriptionReturns true if the file has the specified path.
Otherwise, returns false.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L722

Name<yaml[<id>].has_changes>
ReturnsElementTag(Boolean)
DescriptionReturns whether this YAML object has had changes since the last save or load.
Generated Example
- if <yaml.has_changes>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L832

Name<yaml[<id>].is_list[<path>]>
ReturnsElementTag(Boolean)
DescriptionReturns true if the specified path results in a list.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L733

Name<yaml.list>
ReturnsListTag
DescriptionReturns a list of all currently loaded YAML ID's.
Generated Example
- foreach <yaml.list> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L703

Name<yaml[<id>].list_deep_keys[<path>]>
ReturnsListTag
DescriptionReturns a ListTag of all the keys at the path and all subpaths.
Use empty path input to represent the root of the yaml document tree.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L774

Name<yaml[<id>].list_keys[<path>]>
ReturnsListTag
DescriptionReturns a ListTag of all the keys at the path (and not sub-keys).
Use empty path input to represent the root of the yaml document tree.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L803

Name<yaml[<id>].parsed_key[<path>]>
ReturnsElementTag
DescriptionReturns the value from a data key on the YAML document as an ElementTag, ListTag, or MapTag.
Will automatically parse any tags contained within the value of the key, preserving key data structure
(meaning, a tag that returns a ListTag, inside a data list, will insert a ListTag inside the returned ListTag, as you would expect).
Generally, prefer to use Tag:yaml.read.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L743

Name<yaml[<id>].read[<path>]>
ReturnsObjectTag
DescriptionReturns the value from a data key on the YAML document as an ElementTag, ListTag, or MapTag.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L760

Name<yaml[<id>].to_json>
ReturnsElementTag
DescriptionConverts the YAML container to a JSON array.
Generated Example
- narrate <yaml.to_json>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L842

Name<yaml[<id>].to_text>
ReturnsElementTag
DescriptionConverts the YAML container to raw YAML text.
Generated Example
- narrate <yaml.to_text>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L852



Category: VectorObject


Name<VectorObject.with_x[<number>]>
ReturnsVectorObject
DescriptionReturns a copy of this object with a changed X value.
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L123

Name<VectorObject.with_y[<number>]>
ReturnsVectorObject
DescriptionReturns a copy of this object with a changed Y value.
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L139

Name<VectorObject.with_z[<number>]>
ReturnsVectorObject
DescriptionReturns a copy of this object with a changed Z value.
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L155

Name<VectorObject.x>
ReturnsElementTag(Decimal)
DescriptionReturns the X coordinate of this object.
Generated Example
- narrate "the decimal value is <location[1,2,3].x>"
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L77

Name<VectorObject.xyz>
ReturnsElementTag
DescriptionReturns the basic vector in "x,y,z" format.
For example: 1,2,3
Other values, such as world, yaw, and pitch will be excluded from this output.
Generated Example
- narrate <location[1,2,3].xyz>
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L110

Name<VectorObject.y>
ReturnsElementTag(Decimal)
DescriptionReturns the Y coordinate of this object.
Generated Example
- narrate "the decimal value is <location[1,2,3].y>"
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L88

Name<VectorObject.z>
ReturnsElementTag(Decimal)
DescriptionReturns the Z coordinate of this object.
Generated Example
- narrate "the decimal value is <location[1,2,3].z>"
Groupidentity
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L99

Name<VectorObject.add[<vector/location/x,y,z>]>
ReturnsVectorObject
DescriptionReturns a copy of this object with the specified coordinates added to it.
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L171

Name<VectorObject.div[<length>]>
ReturnsVectorObject
DescriptionReturns a copy of this object divided by the specified length.
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L212

Name<VectorObject.mul[<length>]>
ReturnsVectorObject
DescriptionReturns a copy of this object multiplied by the specified length.
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L201

Name<VectorObject.normalize>
ReturnsVectorObject
DescriptionReturns a 1-length vector in the same direction as this vector.
Generated Example
- adjust <player> velocity:<location[1,2,3].normalize>
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L228

Name<VectorObject.sub[<vector/location/x,y,z>]>
ReturnsVectorObject
DescriptionReturns a copy of this object with the specified coordinates subtracted from it.
Groupmath
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L186

Name<VectorObject.quaternion_between_vectors[<vector>]>
ReturnsQuaternionTag
DescriptionReturns a quaternion that represents the rotation from this vector to another.
GroupVectorObject
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L285

Name<VectorObject.to_axis_angle_quaternion[<angle>]>
ReturnsQuaternionTag
DescriptionReturns a quaternion that is a rotation around this vector as an axis, by the given angle input (in radians).
GroupVectorObject
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L272

Name<VectorObject.vector_length>
ReturnsElementTag(Decimal)
DescriptionReturns the 3D length of the vector.
Generated Example
- narrate "the decimal value is <location[1,2,3].vector_length>"
Synonyms (Search Aid)vectorobject.magnitude
GroupVectorObject
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L260

Name<VectorObject.vector_length_squared>
ReturnsElementTag(Decimal)
DescriptionReturns the square of the 3D length of the vector.
Generated Example
- narrate "the decimal value is <location[1,2,3].vector_length_squared>"
Synonyms (Search Aid)vectorobject.magnitude_squared
GroupVectorObject
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L248



Category: MaterialTag


Name<MaterialTag.maximum_level>
ReturnsElementTag(Number)
DescriptionReturns the maximum level for a "levelled" material (see Property:MaterialTag.level).
Generated Example
- narrate "the number value is <material[stone].maximum_level>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/material/MaterialLevel.java#L35

Name<MaterialTag.minimum_level>
ReturnsElementTag(Number)
DescriptionReturns the minimum level for a "levelled" material (see Property:MaterialTag.level).
Generated Example
- narrate "the number value is <material[stone].minimum_level>"
Groupproperties
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/material/MaterialLevel.java#L27

Name<MaterialTag.half>
ReturnsElementTag
MechanismMaterialTag.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
- narrate <material[stone].half>
GroupProperties
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/material/MaterialHalf.java#L10

Name<MaterialTag.instrument>
ReturnsElementTag
MechanismMaterialTag.instrument
Description(Property) The instrument played by a note block, see 🔗https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Instrument.html
Generated Example
- narrate <material[stone].instrument>
GroupProperties
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/material/MaterialInstrument.java#L9

Name<MaterialTag.level>
ReturnsElementTag(Number)
MechanismMaterialTag.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
- narrate "the number value is <material[stone].level>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/material/MaterialLevel.java#L11

Name<MaterialTag.switched>
ReturnsElementTag(Boolean)
MechanismMaterialTag.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
- if <material[stone].switched>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
GroupProperties
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/material/MaterialSwitched.java#L9

Name<MaterialTag.waterlogged>
ReturnsElementTag(Boolean)
MechanismMaterialTag.waterlogged
Description(Property) Whether a block is waterlogged.
Generated Example
- if <material[stone].waterlogged>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
GroupProperties
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/material/MaterialWaterlogged.java#L9



Category: PropertyHolderObject


Name<PropertyHolderObject.property_map>
ReturnsMapTag
DescriptionReturns the object's property map.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/properties/PropertyParser.java#L560

Name<PropertyHolderObject.supports[<property-name>]>
ReturnsElementTag(Boolean)
DescriptionReturns true if the property named is supported by the object.
This does not necessarily mean it has a valid current value, just that it's supported at all.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/properties/PropertyParser.java#L536

Name<PropertyHolderObject.with[<mechanism>=<value>;...]>
ReturnsPropertyHolderObject
DescriptionReturns a copy of the object with mechanism adjustments applied.
Be careful with dynamic inputs, they may break from escaping flaws.
Consider using Tag:PropertyHolderObject.with_single instead.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/properties/PropertyParser.java#L463

Name<PropertyHolderObject.with_map[<property-map>]>
ReturnsPropertyHolderObject
DescriptionReturns a copy of the object with the MapTag of mechanism adjustments applied.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/properties/PropertyParser.java#L513

Name<PropertyHolderObject.with_single[<mechanism>=<value>]>
ReturnsPropertyHolderObject
DescriptionReturns a copy of the object with a single mechanism adjustment applied.
This avoids the risk of escaping issues.
Groupproperties
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/properties/PropertyParser.java#L490



Category: ItemTag


Name<ItemTag.durability>
ReturnsElementTag(Number)
MechanismItemTag.durability
Description(Property) The amount of durability an item lost.
Generated Example
- narrate "the number value is <client.self_entity.item_in_hand.durability>"
GroupProperties
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/item/ItemDurability.java#L9

Name<ItemTag.server_script>
ReturnsElementTag
DescriptionReturns the name of an item's server-side item script, if it has one.
Generated Example
- narrate <client.self_entity.item_in_hand.server_script>
Groupscripts
Sourcehttps://github.com/DenizenScript/Clientizen/blob/master/src/main/java/com/denizenscript/clientizen/objects/properties/item/ItemServerScript.java#L10