Name | <DurationTag.in_years> |
Returns | ElementTag(Decimal) |
Description | returns the number of years in the Duration.
|
Name | <DurationTag.in_weeks> |
Returns | ElementTag(Decimal) |
Description | returns the number of weeks in the Duration.
|
Name | <DurationTag.in_days> |
Returns | ElementTag(Decimal) |
Description | returns the number of days in the Duration.
|
Name | <DurationTag.in_hours> |
Returns | ElementTag(Decimal) |
Description | returns the number of hours in the Duration.
|
Name | <DurationTag.in_minutes> |
Returns | ElementTag(Decimal) |
Description | returns the number of minutes in the Duration.
|
Name | <DurationTag.in_seconds> |
Returns | ElementTag(Decimal) |
Description | returns the number of seconds in the Duration.
|
Name | <DurationTag.in_milliseconds> |
Returns | ElementTag(Decimal) |
Description | returns the number of milliseconds in the Duration.
|
Name | <DurationTag.in_ticks> |
Returns | ElementTag(Number) |
Description | returns the number of ticks in the Duration. (20t/second)
|
Name | <DurationTag.sub[<duration>]> |
Returns | ElementTag(Number) |
Description | returns this duration minus another.
|
Name | <DurationTag.add[<duration>]> |
Returns | ElementTag(Number) |
Description | returns this duration plus another.
|
Name | <DurationTag.time> |
Returns | ElementTag |
Description | returns the date-time specified by the duration object.
|
Name | <DurationTag.time.year> |
Returns | ElementTag(Number) |
Description | Returns the current year of the time specified by the duration object.
|
Name | <DurationTag.time.month> |
Returns | ElementTag(Number) |
Description | Returns the current month of the time specified by the duration object.
|
Name | <DurationTag.time.day> |
Returns | ElementTag(Number) |
Description | Returns the current day of the time specified by the duration object.
|
Name | <DurationTag.time.day_of_week> |
Returns | ElementTag(Number) |
Description | Returns the current day-of-the-week of the time specified by the duration object.
|
Name | <DurationTag.time.hour> |
Returns | ElementTag(Number) |
Description | Returns the current hour of the time specified by the duration object.
|
Name | <DurationTag.time.minute> |
Returns | ElementTag(Number) |
Description | Returns the current minute of the time specified by the duration object.
|
Name | <DurationTag.time.second> |
Returns | ElementTag(Number) |
Description | Returns the current second of the time specified by the duration object.
|
Name | <DurationTag.type> |
Returns | ElementTag |
Description | Always returns 'Duration' for DurationTag objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Name | <DurationTag.formatted> |
Returns | ElementTag |
Description | returns the value of the duration in an easily readable
format like 2h 30m, where minutes are only shown if there is less than a day left and seconds are only shown if there are less than 10 minutes left. |
Name | <ElementTag.is[<operator>].to[<element>]> |
Returns | ElementTag(Boolean) |
Description | Takes an operator, and compares the value of the element to the supplied
element. Returns the outcome of the comparable, either true or false. For information on operators, see language/operator. Equivalent to tag/ElementTag.is[operator].than[element] |
Group | comparison |
Name | <ElementTag.is[<operator>].than[<element>]> |
Returns | ElementTag(Boolean) |
Description | Takes an operator, and compares the value of the element to the supplied
element. Returns the outcome of the comparable, either true or false. For information on operators, see language/operator. Equivalent to tag/ElementTag.is[operator].to[element] |
Group | comparison |
Name | <ElementTag.is_boolean> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element is a boolean ('true' or 'false').
|
Group | comparison |
Name | <ElementTag.is_integer> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element is an integer number (a number without a decimal point).
|
Group | comparison |
Name | <ElementTag.is_decimal> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element is a valid decimal number (the decimal point is optional).
|
Group | comparison |
Name | <ElementTag.is_odd> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element is an odd-valued decimal number. Returns 'false' for non-numbers.
|
Group | comparison |
Name | <ElementTag.is_even> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element is an even-valued decimal number. Returns 'false' for non-numbers.
|
Group | comparison |
Name | <ElementTag.as_element> |
Returns | ElementTag |
Description | Returns the element as itself.
For use in special cases, generally not very useful. |
Group | conversion |
Name | <ElementTag.as_boolean> |
Returns | ElementTag(Boolean) |
Description | Returns the element as true/false.
|
Group | conversion |
Name | <ElementTag.as_decimal> |
Returns | ElementTag(Decimal) |
Description | Returns the element as a decimal number, or shows an error.
|
Group | conversion |
Name | <ElementTag.truncate> |
Returns | ElementTag(Number) |
Description | Returns the element as a number without a decimal by way of stripping the decimal value off the end.
That is, rounds towards zero. |
Group | conversion |
Name | <ElementTag.as_money> |
Returns | ElementTag(Decimal) |
Description | Returns the element as a number with two decimal places.
|
Group | conversion |
Name | <ElementTag.as_list> |
Returns | ListTag |
Description | Returns the element as a ListTag.
|
Group | conversion |
Name | <ElementTag.as_custom> |
Returns | CustomObject |
Description | Returns the element as a custom object.
|
Group | conversion |
Name | <ElementTag.as_script> |
Returns | ScriptTag |
Description | Returns the element as a ScriptTag.
Note: the value must be a valid script. |
Group | conversion |
Name | <ElementTag.as_queue> |
Returns | QueueTag |
Description | Returns the element as a ScriptQueue.
Note: the value must be a valid ScriptQueue. |
Group | conversion |
Name | <ElementTag.as_duration> |
Returns | DurationTag |
Description | Returns the element as a Duration.
Note: the value must be a valid Duration. |
Group | conversion |
Name | <ElementTag.escaped> |
Returns | ElementTag |
Description | Returns the element, escaped for safe reuse.
Inverts tag/ElementTag.unescaped See language/property escaping |
Group | conversion |
Name | <ElementTag.sql_escaped> |
Returns | ElementTag |
Description | Returns the element, escaped for safe use in SQL.
|
Group | conversion |
Name | <ElementTag.unescaped> |
Returns | ElementTag |
Description | Returns the element, unescaped.
Inverts tag/ElementTag.escaped See language/property escaping |
Group | conversion |
Name | <ElementTag.parsed> |
Returns | ElementTag |
Description | Returns the element, with any contained tags parsed.
WARNING: THIS TAG IS DANGEROUS TO USE, DO NOT USE IT UNLESS YOU KNOW WHAT YOU ARE DOING. USE AT YOUR OWN RISK. |
Group | conversion |
Name | <ElementTag.difference[<element>]> |
Returns | ElementTag(Number) |
Description | Returns a number representing the difference between the two elements. (Uses Levenshtein logic).
|
Group | element checking |
Name | <ElementTag.contains_any_case_sensitive_text[<element>|...]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element contains any of a list of specified elements, case sensitive.
|
Group | element checking |
Name | <ElementTag.contains_any_text[<element>|...]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element contains any of a list of specified elements, case insensitive.
|
Group | element checking |
Name | <ElementTag.contains_case_sensitive_text[<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element contains a specified element, case sensitive.
|
Group | element checking |
Name | <ElementTag.contains_text[<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element contains a specified element, case insensitive. Can use
regular expression by prefixing the element with regex: |
Group | element checking |
Name | <ElementTag.contains_all_text[<element>|...]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element contains all of the specified strings, case insensitive.
|
Group | element checking |
Name | <ElementTag.contains_all_case_sensitive_text[<element>|...]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element contains all of the specified strings, case sensitive.
|
Group | element checking |
Name | <ElementTag.ends_with[<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element ends with a specified element.
|
Group | element checking |
Name | <ElementTag.equals_case_sensitive[<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element matches another element, case-sensitive.
|
Group | element checking |
Name | <ElementTag.matches[<regex>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element matches a regex input.
|
Group | element checking |
Name | <ElementTag.regex[<regex>].group[<group>]> |
Returns | ElementTag |
Description | Returns the specific group from a regex match.
Specify group 0 for the whole match. For example, <element[hello5world].regex[.*(\d).*].group[1]> returns '5'. |
Group | element checking |
Name | <ElementTag.length> |
Returns | ElementTag(Number) |
Description | Returns the length of the element.
|
Group | element checking |
Name | <ElementTag.not> |
Returns | ElementTag(Boolean) |
Description | Returns the opposite of the element
IE, true returns false and false returns true. |
Group | element checking |
Name | <ElementTag.and[<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether both the element and the second element are true.
|
Group | element checking |
Name | <ElementTag.or[<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether either the element or the second element are true.
|
Group | element checking |
Name | <ElementTag.xor[<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element and the second element are true and false (exclusive or).
|
Group | element checking |
Name | <ElementTag.starts_with[<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the element starts with a specified element.
|
Group | element checking |
Name | <ElementTag.index_of[<element>]> |
Returns | ElementTag(Number) |
Description | Returns the index of the first occurrence of a specified element.
Returns 0 if the element never occurs within the element. |
Group | element checking |
Name | <ElementTag.last_index_of[<element>]> |
Returns | ElementTag(Number) |
Description | Returns the index of the last occurrence of a specified element.
Returns 0 if the element never occurs within the element. |
Group | element checking |
Name | <ElementTag.char_at[<#>]> |
Returns | ElementTag |
Description | Returns the character at a specified index.
Returns null if the index is outside the range of the element. |
Group | element checking |
Name | <ElementTag.after_last[<element>]> |
Returns | ElementTag |
Description | Returns the portion of an element after the last occurrence of a specified element.
For example: abcabc .after_last[b] returns c. |
Group | element manipulation |
Name | <ElementTag.after[<element>]> |
Returns | ElementTag |
Description | Returns the portion of an element after the first occurrence of a specified element.
For example: HelloWorld .after[Hello] returns World. |
Group | element manipulation |
Name | <ElementTag.before_last[<element>]> |
Returns | ElementTag |
Description | Returns the portion of an element before the last occurrence of a specified element.
For example: abcabc .before_last[b] returns abca. |
Group | element manipulation |
Name | <ElementTag.before[<element>]> |
Returns | ElementTag |
Description | Returns the portion of an element before the first occurrence of specified element.
For example: abcd .before[c] returns ab. |
Group | element manipulation |
Name | <ElementTag.replace[((first)regex:)<element>]> |
Returns | ElementTag |
Description | Returns the element with all instances of a element removed.
|
Group | element manipulation |
Name | <ElementTag.replace[((first)regex:)<element>].with[<element>]> |
Returns | ElementTag |
Description | Returns the element with all instances of a element replaced with another.
Specify regex: at the start of the replace element to use Regex replacement. Specify firstregex: at the start of the replace element to Regex 'replaceFirst' |
Group | element manipulation |
Name | <ElementTag.replace_text[((first)regex:)<element>]> |
Returns | ElementTag |
Description | Returns the element with all instances of a element removed.
|
Group | element manipulation |
Name | <ElementTag.replace_text[((first)regex:)<element>].with[<element>]> |
Returns | ElementTag |
Description | Returns the element with all instances of a element replaced with another.
Specify regex: at the start of the replace element to use Regex replacement. Specify firstregex: at the start of the replace element to Regex 'replaceFirst' |
Group | element manipulation |
Name | <ElementTag.format_number> |
Returns | ElementTag |
Description | Returns a number reformatted for easier reading.
For example: 1234567 will become 1,234,567. |
Group | element manipulation |
Name | <ElementTag.to_list> |
Returns | ListTag |
Description | Returns a ListTag of each letter in the element.
|
Group | element manipulation |
Name | <ElementTag.trim> |
Returns | ElementTag |
Description | Returns the value of an element minus any leading or trailing whitespace.
|
Group | element manipulation |
Name | <ElementTag.to_uppercase> |
Returns | ElementTag |
Description | Returns the value of an element in all uppercase letters.
|
Group | element manipulation |
Name | <ElementTag.to_lowercase> |
Returns | ElementTag |
Description | Returns the value of an element in all lowercase letters.
|
Group | element manipulation |
Name | <ElementTag.to_titlecase> |
Returns | ElementTag |
Description | Returns The Value Of An ElementTag In Title Case.
|
Group | element manipulation |
Name | <ElementTag.substring[<#>(,<#>)]> |
Returns | ElementTag |
Description | Returns the portion of an element between two element indices.
If no second index is specified, it will return the portion of an element after the specified index. |
Group | element manipulation |
Name | <ElementTag.split[(regex:)<string>]> |
Returns | ListTag |
Description | Returns a list of portions of this element, split by the specified string.
If a split string is unspecified, splits by space. |
Group | element manipulation |
Name | <ElementTag.split[(regex:)<string>].limit[<#>]> |
Returns | ListTag |
Description | Returns a list of portions of this element, split by the specified string,
and capped at the specified number of max list items. If a split string is unspecified, splits by space. |
Group | element manipulation |
Name | <ElementTag.pad_left[<#>]> |
Returns | ElementTag |
Description | Returns the value of an element extended to reach a minimum specified length
by adding spaces to the left side. |
Group | element manipulation |
Name | <ElementTag.pad_left[<#>].with[<element>]> |
Returns | ElementTag |
Description | Returns the value of an element extended to reach a minimum specified length
by adding a specific symbol to the left side. |
Group | element manipulation |
Name | <ElementTag.pad_right[<#>]> |
Returns | ElementTag |
Description | Returns the value of an element extended to reach a minimum specified length
by adding spaces to the right side. |
Group | element manipulation |
Name | <ElementTag.pad_right[<#>].with[<element>]> |
Returns | ElementTag |
Description | Returns the value of an element extended to reach a minimum specified length
by adding a specific symbol to the right side. |
Group | element manipulation |
Name | <ElementTag.abs> |
Returns | ElementTag(Decimal) |
Description | Returns the absolute value of the element.
|
Group | math |
Name | <ElementTag.max[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Returns the higher number: this element or the specified one.
|
Group | math |
Name | <ElementTag.min[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Returns the lower number: this element or the specified one.
|
Group | math |
Name | <ElementTag.add_int[<#>]> |
Returns | ElementTag(Number) |
Description | Returns the element plus a number, using integer math.
|
Group | math |
Name | <ElementTag.div_int[<#>]> |
Returns | ElementTag(Number) |
Description | Returns the element divided by a number.
|
Group | math |
Name | <ElementTag.mul_int[<#>]> |
Returns | ElementTag(Number) |
Description | Returns the element multiplied by a number.
|
Group | math |
Name | <ElementTag.sub_int[<#>]> |
Returns | ElementTag(Number) |
Description | Returns the element minus a number.
|
Group | math |
Name | <ElementTag.add[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Returns the element plus a number.
|
Group | math |
Name | <ElementTag.div[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Returns the element divided by a number.
|
Group | math |
Name | <ElementTag.mod[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Returns the remainder of the element divided by a number.
|
Group | math |
Name | <ElementTag.mul[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Returns the element multiplied by a number.
|
Group | math |
Name | <ElementTag.sub[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Returns the element minus a number.
|
Group | math |
Name | <ElementTag.sqrt> |
Returns | ElementTag(Decimal) |
Description | Returns the square root of the element.
|
Group | math |
Name | <ElementTag.log[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Returns the logarithm of the element, with the base of the specified number.
|
Group | math |
Name | <ElementTag.ln> |
Returns | ElementTag(Decimal) |
Description | Returns the natural logarithm of the element.
|
Group | math |
Name | <ElementTag.power[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Returns the element to the power of a number.
|
Group | math |
Name | <ElementTag.asin> |
Returns | ElementTag(Decimal) |
Description | Returns the arc-sine of the element.
|
Group | math |
Name | <ElementTag.acos> |
Returns | ElementTag(Decimal) |
Description | Returns the arc-cosine of the element.
|
Group | math |
Name | <ElementTag.atan> |
Returns | ElementTag(Decimal) |
Description | Returns the arc-tangent of the element.
|
Group | math |
Name | <ElementTag.atan2[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Interprets the element to be a Y value and the input value to be an X value (meaning: <Y.atan2[X]>),
and returns an angle representing the vector of (X,Y). |
Group | math |
Name | <ElementTag.cos> |
Returns | ElementTag(Decimal) |
Description | Returns the cosine of the element.
|
Group | math |
Name | <ElementTag.sin> |
Returns | ElementTag(Decimal) |
Description | Returns the sine of the element.
|
Group | math |
Name | <ElementTag.tan> |
Returns | ElementTag(Decimal) |
Description | Returns the tangent of the element.
|
Group | math |
Name | <ElementTag.factorial> |
Returns | ElementTag(Number) |
Description | Returns the factorial of the element. This should only be used for small values (generally: less than 20), and will become ridiculous/unusable at larger values.
|
Group | math |
Name | <ElementTag.to_degrees> |
Returns | ElementTag(Decimal) |
Description | Converts the element from radians to degrees.
|
Group | math |
Name | <ElementTag.to_radians> |
Returns | ElementTag(Decimal) |
Description | Converts the element from degrees to radians.
|
Group | math |
Name | <ElementTag.round_up> |
Returns | ElementTag(Number) |
Description | Rounds a decimal upward.
|
Group | math |
Name | <ElementTag.round_down> |
Returns | ElementTag(Number) |
Description | Rounds a decimal downward.
|
Group | math |
Name | <ElementTag.round_to[<#>]> |
Returns | ElementTag(Decimal) |
Description | Rounds a decimal to the specified place.
For example, 0.12345 .round_to[3] returns "0.123". |
Group | math |
Name | <ElementTag.round> |
Returns | ElementTag(Number) |
Description | Rounds a decimal.
|
Group | math |
Name | <ElementTag.round_to_precision[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Rounds a decimal to the specified precision.
For example, 0.12345 .round_to_precision[0.005] returns "0.125". |
Group | math |
Name | <ElementTag.round_down_to_precision[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Rounds a decimal downward to the specified precision.
|
Group | math |
Name | <ElementTag.round_up_to_precision[<#.#>]> |
Returns | ElementTag(Decimal) |
Description | Rounds a decimal upward to the specified precision.
|
Group | math |
Name | <ElementTag.base64_encode> |
Returns | ElementTag |
Description | Encodes the element using Base64 encoding.
|
Group | conversion |
Name | <ElementTag.base64_decode> |
Returns | ElementTag |
Description | Decodes the element using Base64 encoding. Must be valid Base64 input.
|
Group | conversion |
Name | <ElementTag.hex_encode> |
Returns | ElementTag |
Description | Encodes the element using hexadecimal encoding.
|
Group | conversion |
Name | <ElementTag.hex_decode> |
Returns | ElementTag |
Description | Decodes the element using hexadecimal encoding. Must be valid hexadecimal input.
|
Group | conversion |
Name | <ElementTag.url_encode> |
Returns | ElementTag |
Description | Encodes the element using URL encoding.
|
Group | conversion |
Name | <ElementTag.url_decode> |
Returns | ElementTag |
Description | Decodes the element using URL encoding. Must be valid URL-encoded input.
|
Group | conversion |
Name | <ElementTag.type> |
Returns | ElementTag |
Description | Always returns 'Element' for ElementTag objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Name | <ListTag.combine> |
Returns | ListTag |
Description | returns a list containing the contents of all sublists within this list.
|
Name | <ListTag.space_separated> |
Returns | ElementTag |
Description | returns the list in a cleaner format, separated by spaces.
For example: a list of "one|two|three" will return "one two three". |
Name | <ListTag.separated_by[<text>]> |
Returns | ElementTag |
Description | returns the list formatted, with each item separated by the defined text.
For example: <li@bob|joe|john.separated_by[ and ]> will return "bob and joe and john". |
Name | <ListTag.comma_separated> |
Returns | ElementTag |
Description | returns the list in a cleaner format, separated by commas.
For example: a list of "one|two|three" will return "one, two, three". |
Name | <ListTag.unseparated> |
Returns | ElementTag |
Description | returns the list in a less clean format, separated by nothing.
For example: a list of "one|two|three" will return "onetwothree". |
Name | <ListTag.get_sub_items[<#>]> |
Returns | ListTag |
Description | returns a list of the specified sub items in the list, as split by the
forward-slash character (/). For example: .get_sub_items[1] on a list of "one/alpha|two/beta" will return "one|two". |
Name | <ListTag.get_sub_items[<#>].split_by[<element>]> |
Returns | ListTag |
Description | returns a list of the specified sub item in the list, allowing you to specify a
character in which to split the sub items by. WARNING: When setting your own split character, make note that it is CASE SENSITIVE. For example: .get_sub_items[1].split_by[-] on a list of "one-alpha|two-beta" will return "one|two". |
Name | <ListTag.map_get[<element>|...]> |
Returns | ListTag or ElementTag |
Description | Interprets a list of "key/value" pairs as a map, and returns the value for the given key.
For example: li@one/a|two/b.map_get[one] returns a. Optionally, specify a list of keys to get a list back. If any listed keys are not present, will give null. |
Name | <ListTag.map_get[<element>|...].split_by[<element>]> |
Returns | ListTag or ElementTag |
Description | Interprets a list of "key" + "value" pairs split by the input symbol as a map, and returns the value for the given key.
For example: li@one/a|two/b.map_get[one].split_by[/] returns a. Optionally, specify a list of keys to get a list back. If any listed keys are not present, will give null. |
Name | <ListTag.map_find_key[<element>]> |
Returns | ElementTag |
Description | Interprets a list of "key/value" pairs as a map, and returns the key for the given value.
For example: li@one/a|two/b.map_find_key[a] returns one. |
Name | <ListTag.map_find_key[<element>].split_by[<element>]> |
Returns | ElementTag |
Description | Interprets a list of "key" + "value" pairs split by the input symbol as a map, and returns the value for the given key.
For example: li@one/a|two/b.map_find_key[a].split_by[/] returns one. |
Name | <ListTag.size> |
Returns | ElementTag(Number) |
Description | returns the size of the list.
For example: a list of "one|two|three" will return "3". |
Name | <ListTag.is_empty> |
Returns | ElementTag(Boolean) |
Description | returns whether the list is empty.
For example: a list of "" returns true, while "one" returns false. |
Name | <ListTag.insert[...|...].at[<#>]> |
Returns | ListTag |
Description | returns a new ListTag with the items specified inserted to the specified location.
For example: .insert[two|three].at[2] on a list of "one|four" will return "one|two|three|four". |
Name | <ListTag.set[...|...].at[<#>]> |
Returns | ListTag |
Description | returns a new ListTag with the items specified inserted to the specified location, replacing the element
already at that location. For example: .set[potato].at[2] on a list of "one|two|three" will return "one|potato|three". |
Name | <ListTag.include[...|...]> |
Returns | ListTag |
Description | returns a new ListTag including the items specified.
For example: .include[three|four] on a list of "one|two" will return "one|two|three|four". |
Name | <ListTag.exclude[...|...]> |
Returns | ListTag |
Description | returns a new ListTag excluding the items specified.
For example: .exclude[two|four] on a list of "one|two|three|four" will return "one|three". |
Name | <ListTag.remove[<#>|...]> |
Returns | ListTag |
Description | returns a new ListTag excluding the items at the specified index.
For example: .remove[2] on a list of "one|two|three|four" will return "one|three|four". Also supports [first] and [last] values. |
Name | <ListTag.replace[(regex:)<element>]> |
Returns | ElementTag |
Description | Returns the list with all instances of an element removed.
Specify regex: at the start of the replace element to replace elements that match the Regex. |
Name | <ListTag.replace[(regex:)<element>].with[<element>]> |
Returns | ListTag |
Description | Returns the list with all instances of an element replaced with another.
Specify regex: at the start of the replace element to replace elements that match the Regex. |
Name | <ListTag.reverse> |
Returns | ListTag |
Description | returns a copy of the list, with all items placed in opposite order.
For example: a list of "one|two|three" will become "three|two|one". |
Name | <ListTag.deduplicate> |
Returns | ListTag |
Description | returns a copy of the list with any duplicate items removed.
For example: a list of "one|one|two|three" will become "one|two|three". |
Name | <ListTag.get[<#>|...]> |
Returns | ObjectTag |
Description | returns an element of the value specified by the supplied context.
For example: .get[1] on a list of "one|two" will return "one", and .get[2] will return "two" Specify more than one index to get a list of results. |
Name | <ListTag.get[<#>].to[<#>]> |
Returns | ListTag |
Description | returns all elements in the range from the first index to the second.
For example: .get[1].to[3] on a list of "one|two|three|four" will return "one|two|three" |
Name | <ListTag.find_all_partial[<element>]> |
Returns | ListTag(ElementTag(Number)) |
Description | returns all the numbered locations of elements that contain the text within a list,
or an empty list if the list does not contain that item. For example: .find_all_partial[tw] on a list of "one|two|three|two" will return "2|4". TODO: Take multiple inputs? Or a regex? |
Name | <ListTag.find_all[<element>]> |
Returns | ListTag(ElementTag(Number)) |
Description | returns all the numbered locations of elements that match the text within a list,
or an empty list if the list does not contain that item. For example: .find_all[two] on a list of "one|two|three|two" will return "2|4". TODO: Take multiple inputs? Or a regex? |
Name | <ListTag.find_partial[<element>]> |
Returns | ElementTag(Number) |
Description | returns the numbered location of the first partially matching element within a list,
or -1 if the list does not contain that item. For example: .find_partial[tw] on a list of "one|two|three" will return "2". TODO: Take multiple inputs? Or a regex? |
Name | <ListTag.find[<element>]> |
Returns | ElementTag(Number) |
Description | returns the numbered location of an element within a list,
or -1 if the list does not contain that item. For example: .find[two] on a list of "one|two|three" will return "2". TODO: Take multiple inputs? Or a regex? |
Name | <ListTag.count[<element>]> |
Returns | ElementTag(Number) |
Description | returns how many times in the sub-list occurs.
For example: a list of "one|two|two|three" .count[two] returns 2. |
Name | <ListTag.sum> |
Returns | ElementTag(Number) |
Description | returns the sum of all numbers in the list. Ignores non-numerical values.
|
Name | <ListTag.average> |
Returns | ElementTag(Number) |
Description | returns the average of all numbers in the list. Ignores non-numerical values.
|
Name | <ListTag.first> |
Returns | ObjectTag |
Description | returns the first element in the list.
If the list is empty, returns null instead. For example: a list of "one|two|three" will return "one". Effectively equivalent to .get[1] |
Name | <ListTag.last> |
Returns | ObjectTag |
Description | returns the last element in the list.
If the list is empty, returns null instead. For example: a list of "one|two|three" will return "three". Effectively equivalent to .get[<list.size>] |
Name | <ListTag.lowest> |
Returns | ElementTag(Decimal) |
Description | returns the smallest value in a list of decimal numbers.
For example: a list of "3|2|1|10" will return "1". |
Name | <ListTag.highest> |
Returns | ElementTag(Decimal) |
Description | returns the highest value in a list of decimal numbers.
For example: a list of "3|2|1|10" will return "10". |
Name | <ListTag.numerical> |
Returns | ListTag |
Description | returns the list sorted to be in numerical order.
For example: a list of "3|2|1|10" will return "1|2|3|10". |
Name | <ListTag.alphanumeric> |
Returns | ElementTag |
Description | returns the list sorted to be in alphabetical/numerical order.
For example: a list of "b|c|a10|a1" will return "a1|a10|b|c". |
Name | <ListTag.alphabetical> |
Returns | ElementTag |
Description | returns the list sorted to be in alphabetical order.
For example: a list of "c|d|q|a|g" will return "a|c|d|g|q". |
Name | <ListTag.sort_by_value[<tag>]> |
Returns | ListTag |
Description | returns a copy of the list, sorted alphanumerically.
Rather than sorting based on the item itself, it sorts based on a tag attribute read from within the object being read. For example, you might sort a list of players based on their names, via .sort_by_value[name] on the list of valid players. |
Name | <ListTag.sort_by_number[<tag>]> |
Returns | ListTag |
Description | returns a copy of the list, sorted such that the lower numbers appear first, and the higher numbers appear last.
Rather than sorting based on the item itself, it sorts based on a tag attribute read from within the object being read. For example, you might sort a list of players based on the amount of money they have, via .sort_by_number[money] on the list of valid players. Non-numerical input is considered an error, and the result is not guaranteed. |
Name | <ListTag.sort[<procedure>]> |
Returns | ListTag |
Description | returns a list sorted according to the return values of a procedure.
The <procedure> should link a procedure script that takes two definitions each of which will be an item in the list, and returns -1, 0, or 1 based on whether the second item should be added. EG, if a procedure with definitions "one" and "two" returned -1, it would place "two" after "one". Note that this uses some complex internal sorting code that could potentially throw errors if the procedure does not return consistently - EG, if "one" and "two" returned 1, but "two" and "one" returned 1 as well - obviously, "two" can not be both before AND after "one"! Note that the script should ALWAYS return -1, 0, or 1, or glitches could happen! Note that if two inputs are exactly equal, the procedure should always return 0. |
Name | <ListTag.sort[<procedure>].context[<context>]> |
Returns | ElementTag |
Description | Sort a list, with context. See tag/ListTag.sort[procedure] for general sort details.
|
Name | <ListTag.filter[<tag>]> |
Returns | ListTag |
Description | returns a copy of the list with all its contents parsed through the given tag and only including ones that returned 'true'.
For example: a list of '1|2|3|4|5' .filter[is[or_more].than[3]] returns a list of '3|4|5'. |
Name | <ListTag.parse[<tag>]> |
Returns | ListTag |
Description | returns a copy of the list with all its contents parsed through the given tag.
For example: a list of 'one|two' .parse[to_uppercase] returns a list of 'ONE|TWO'. |
Name | <ListTag.pad_left[<#>]> |
Returns | ListTag |
Description | Returns a ListTag extended to reach a minimum specified length
by adding entries to the left side. |
Name | <ListTag.pad_left[<#>].with[<element>]> |
Returns | ListTag |
Description | Returns a ListTag extended to reach a minimum specified length
by adding a specific entry to the left side. |
Name | <ListTag.pad_right[<#>]> |
Returns | ListTag |
Description | Returns a ListTag extended to reach a minimum specified length
by adding entries to the right side. |
Name | <ListTag.pad_right[<#>].with[<element>]> |
Returns | ListTag |
Description | Returns a ListTag extended to reach a minimum specified length
by adding a specific entry to the right side. |
Name | <ListTag.escape_contents> |
Returns | ListTag |
Description | returns a copy of the list with all its contents escaped.
Inverts tag/ListTag.unescape_contents. See language/property escaping. |
Name | <ListTag.unescape_contents> |
Returns | ListTag |
Description | returns a copy of the list with all its contents unescaped.
Inverts tag/ListTag.escape_contents. See language/property escaping. |
Name | <ListTag.contains_any_case_sensitive[<element>|...]> |
Returns | ElementTag(Boolean) |
Description | returns whether the list contains any of a list of given elements, case-sensitive.
|
Name | <ListTag.contains_any[<element>|...]> |
Returns | ElementTag(Boolean) |
Description | returns whether the list contains any of a list of given elements.
|
Name | <ListTag.contains_case_sensitive[<element>]> |
Returns | ElementTag(Boolean) |
Description | returns whether the list contains a given element, case-sensitive.
|
Name | <ListTag.contains[<element>|...]> |
Returns | ElementTag(Boolean) |
Description | returns whether the list contains all of the given elements.
|
Name | <ListTag.random[<#>]> |
Returns | ObjectTag |
Description | Gets a random item in the list and returns it as an Element.
Optionally, add [<#>] to get a list of multiple randomly chosen elements. For example: .random on a list of "one|two" could return EITHER "one" or "two" - different each time! For example: .random[2] on a list of "one|two|three" could return "one|two", "two|three", OR "one|three" - different each time! For example: .random[9999] on a list of "one|two|three" could return "one|two|three", "one|three|two", "two|one|three", "two|three|one", "three|two|one", OR "three|one|two" - different each time! |
Name | <ListTag.closest_to[<text>]> |
Returns | ElementTag |
Description | Returns the item in the list that seems closest to the given value.
Particularly useful for command handlers, "<li@c1|c2|c3|[...].closest_to[<argument>]>" to get the best option as "did you mean" suggestion. For example, "<li@dance|quit|spawn.closest_to[spwn]>" returns "spawn". Be warned that this will always return /something/, excluding the case of an empty list, which will return an empty element. Uses the logic of tag "ElementTag.difference"! You can use that tag to add an upper limit on how different the strings can be. |
Name | <ListTag.type> |
Returns | ElementTag |
Description | Always returns 'List' for ListTag objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Name | <QueueTag.id> |
Returns | ElementTag |
Description | Returns the id of the queue.
|
Name | <QueueTag.size> |
Returns | ElementTag |
Description | Returns the number of script entries in the queue.
|
Name | <QueueTag.start_time> |
Returns | DurationTag |
Description | Returns the time this queue started as a duration.
|
Name | <QueueTag.time_ran> |
Returns | DurationTag |
Description | Returns the time this queue has ran for (the length of time between now and when the queue started) as a duration.
|
Name | <QueueTag.state> |
Returns | ElementTag |
Description | Returns 'stopping', 'running', 'paused', or 'unknown'.
|
Name | <QueueTag.script> |
Returns | ScriptTag |
Description | Returns the script that started this queue.
|
Name | <QueueTag.commands> |
Returns | ListTag |
Description | Returns a list of commands waiting in the queue.
|
Name | <QueueTag.definitions> |
Returns | ListTag |
Description | Returns the names of all definitions that were passed to the current queue.
|
Name | <QueueTag.definition[<definition>]> |
Returns | ObjectTag |
Description | Returns the value of the specified definition.
Returns null if the queue lacks the definition. |
Name | <QueueTag.determination> |
Returns | ListTag |
Description | Returns the values that have been determined via command/Determine
for this queue, or null if there is none. |
Name | <QueueTag.speed> |
Returns | DurationTag |
Description | Returns the speed of the queue as a Duration. A return of '0' implies it is 'instant'.
|
Name | <ScriptTag.container_type> |
Returns | ElementTag |
Description | Returns the type of script container that is associated with this ScriptTag object. For example: 'task', or
'world'. |
Name | <ScriptTag.name> |
Returns | ElementTag |
Description | Returns the name of the script container.
|
Name | <ScriptTag.relative_filename> |
Returns | ElementTag |
Description | Returns the filename that contains the script, relative to the denizen/ folder.
|
Name | <ScriptTag.filename> |
Returns | ElementTag |
Description | Returns the absolute filename that contains the script.
|
Name | <ScriptTag.original_name> |
Returns | ElementTag |
Description | Returns the originally cased script name.
|
Name | <ScriptTag.constant[<constant_name>]> |
Returns | ElementTag or ListTag |
Description | Returns the value of the constant as either an ElementTag or ListTag.
A constant is a script key under the 'default constants' node. For example: myscript: type: task default constants: myconstant: myvalue |
Name | <ScriptTag.yaml_key[<constant_name>]> |
Returns | ObjectTag |
Description | Returns the value of the script's YAML as either an ElementTag or ListTag.
|
Name | <ScriptTag.list_keys[<constant_name>]> |
Returns | ListTag |
Description | Returns a list of all keys within a script.
|
Name | <ScriptTag.list_deep_keys[<constant_name>]> |
Returns | ListTag |
Description | Returns a list of all keys within a script, searching recursively.
|
Name | <ScriptTag.to_json> |
Returns | ElementTag |
Description | Converts the YAML Script Container to a JSON array.
Best used with 'yaml data' type scripts. |
Name | <ScriptTag.to_text> |
Returns | ElementTag |
Description | Converts the YAML Script Container to raw YAML text.
Best used with 'yaml data' type scripts. |
Name | <ScriptTag.type> |
Returns | ElementTag |
Description | Always returns 'Script' for ScriptTag objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Name | <ScriptTag.list_queues> |
Returns | ListTag(Queue) |
Description | Returns all queues which are running for this script.
|
Name | <yaml.list> |
Returns | ListTag |
Description | Returns a list of all currently loaded YAML ID's.
|
Name | <yaml[<id>].contains[<path>]> |
Returns | ElementTag(Boolean) |
Description | Returns true if the file has the specified path.
Otherwise, returns false. |
Name | <yaml[<id>].is_list[<path>]> |
Returns | ElementTag(Boolean) |
Description | Returns true if the specified path results in a list.
|
Name | <yaml[<id>].read[<path>]> |
Returns | ElementTag |
Description | Returns the value of the key at the path.
If the key is a list, returns a ListTag instead. |
Name | <yaml[<id>].list_deep_keys[<path>]> |
Returns | ListTag |
Description | Returns a ListTag of all the keys at the path and all subpaths.
|
Name | <yaml[<id>].list_keys[<path>]> |
Returns | ListTag |
Description | Returns a ListTag of all the keys at the path.
|
Name | <yaml[<id>].to_json> |
Returns | ElementTag |
Description | Converts the YAML container to a JSON array.
|
Name | <yaml[<id>].to_text> |
Returns | ElementTag |
Description | Converts the YAML container to raw YAML text.
|
Name | <definition[<name>]> |
Returns | ObjectTag |
Description | Returns a definition from the current queue.
The object will be returned as the most-valid type based on the input. |
Name | <definition[<name>].exists> |
Returns | ElementTag(Boolean) |
Description | Returns whether a definition exists for the given definition name.
|
Name | <duration[<duration>]> |
Returns | DurationTag |
Description | Returns a duration object constructed from the input value.
|
Name | <element[<element>]> |
Returns | ElementTag |
Description | Returns an element constructed from the input value.
|
Name | <list[<list>]> |
Returns | ListTag |
Description | Returns a list object constructed from the input value.
|
Name | <proc[ProcedureScript].context[<element>|...]> |
Returns | ObjectTag |
Description | Returns the 'determine' result of a procedure script with the given context.
|
Name | <proc[ProcedureScript]> |
Returns | ObjectTag |
Description | Returns the 'determine' result of a procedure script.
|
Name | <queue[(<queue>)]> |
Returns | QueueTag |
Description | Returns a queue object constructed from the input value.
If no input is given, returns the current queue. |
Name | <queue.exists[<queue_id>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the specified queue exists.
|
Name | <queue.stats> |
Returns | ElementTag |
Description | Returns stats for all queues during this server session
|
Name | <queue.list> |
Returns | ListTag(Queue) |
Description | Returns a list of all currently running queues on the server.
|
Name | <script[<script>]> |
Returns | ScriptTag |
Description | Returns a script object constructed from the input value.
|
Name | <tern[<condition>].pass[<result>].fail[<result>]> |
Returns | ObjectTag |
Description | Returns either the 'pass' input, or 'fail' input depending on the outcome of the condition.
The 'pass' input will be returned when the condition returns 'true', otherwise the 'fail' input will be returned. Example: '<tern[<player.is_spawned>].pass[Player is spawned!].fail[Player is not spawned!]>' |
Name | <util.random.int[<#>].to[<#>]> |
Returns | ElementTag(Number) |
Description | Returns a random number between the 2 specified numbers, inclusive.
For example: random.int[1].to[3] could return 1, 2, or 3. |
Name | <util.random.decimal[<#>].to[<#>]> |
Returns | ElementTag(Decimal) |
Description | Returns a random number between the 2 specified numbers, inclusive.
For example: random.decimal[1].to[2] could return 1.5, 1.75, or a massive number of other options. |
Name | <util.random.decimal> |
Returns | ElementTag |
Description | Returns a random decimal number from 0 to 1
|
Name | <util.random.gauss> |
Returns | ElementTag |
Description | Returns a random decimal number with a gaussian distribution.
70% of all results will be within the range of -1 to 1. |
Name | <util.random.uuid> |
Returns | ElementTag |
Description | Returns a random unique ID.
|
Name | <util.random.duuid[(<source>)]> |
Returns | ElementTag |
Description | Returns a random 'denizen' unique ID, which is made of a randomly generated sentence.
Optionally specify the source context to base the value on. |
Name | <util.pi> |
Returns | ElementTag |
Description | Returns PI: 3.14159265358979323846
|
Name | <util.tau> |
Returns | ElementTag |
Description | Returns Tau: 6.28318530717958647692
|
Name | <util.e> |
Returns | ElementTag |
Description | Returns e: 2.7182818284590452354
|
Name | <util.list_denizen_commands> |
Returns | ListTag |
Description | Returns a list of all currently loaded Denizen commands.
|
Name | <util.list_tag_bases> |
Returns | ListTag |
Description | Returns a list of all currently loaded Denizen tag bases (including "player", "context", "util", "server", etc).
|
Name | <util.time_at[<year>/<month>/<day> (<hour>:<minute>:<second>(:<millisecond>))]> |
Returns | DurationTag |
Description | Returns the DurationTag time object for the input date/time.
Specify input as y/m/d, or as y/m/d h:m:s, or as y/m/d h:m:s:ms All input values must be numbers (including the month, as a number from 1 to 12). Note that unspecified hour:minute:second will be handled as 00:00:00 Note that 00:00:00 is midnight, the morning of the date given. Day is day of month (from 1 to 28-31 depending on month). Hour is hour of day, from 0 (midnight) to 23 (11 PM). Be cautious with potential inconsistencies due to time zone variation. |
Name | <util.date> |
Returns | ElementTag |
Description | Returns the current system date.
|
Name | <util.date.time> |
Returns | ElementTag |
Description | Returns the current system time.
|
Name | <util.date.time.twentyfour_hour> |
Returns | ElementTag |
Description | Returns the current system time in 24-hour format.
|
Name | <util.date.time.year> |
Returns | ElementTag(Number) |
Description | Returns the current year of the system time.
|
Name | <util.date.time.month> |
Returns | ElementTag(Number) |
Description | Returns the current month of the system time.
|
Name | <util.date.time.week> |
Returns | ElementTag(Number) |
Description | Returns the current week of the system time.
|
Name | <util.date.time.day_of_week> |
Returns | ElementTag(Number) |
Description | Returns the current day-of-the-week of the system time.
|
Name | <util.date.time.day> |
Returns | ElementTag(Number) |
Description | Returns the current day of the system time.
|
Name | <util.date.time.hour> |
Returns | ElementTag(Number) |
Description | Returns the current hour of the system time.
|
Name | <util.date.time.minute> |
Returns | ElementTag(Number) |
Description | Returns the current minute of the system time.
|
Name | <util.date.time.second> |
Returns | ElementTag(Number) |
Description | Returns the current second of the system time.
|
Name | <util.date.time.duration> |
Returns | DurationTag |
Description | Returns the current system time as a duration.
To get the exact millisecond count, use tag/server.current_time_millis. |
Name | <util.date.time.zone> |
Returns | ElementTag |
Description | Returns the abbreviated timezone of the server.
|
Name | <util.date.time.formatted_zone> |
Returns | ElementTag |
Description | Returns the timezone of the server.
|
Name | <util.date.format[<format>]> |
Returns | ElementTag |
Description | Returns the current system time, formatted as specified
Example format: [EEE, MMM d, yyyy K:mm a] will become "Mon, Jan 1, 2112 0:01 AM" |
Name | <EntityTag.can_tick> |
Returns | ElementTag(Boolean) |
Description | If the entity is an armor stand, returns whether the armor stand can tick.
|
Mechanism | This tag can be modified using mechanism/EntityTag.can_tick |
Note | This tag requires the plugin(s) Paper! |
Group | properties |
Name | <BiomeTag.downfall_type> |
Returns | ElementTag |
Description | Returns this biome's downfall type for when a world has weather.
This can be RAIN, SNOW, or NONE. |
Name | <BiomeTag.name> |
Returns | ElementTag |
Description | Returns this biome's name.
|
Name | <BiomeTag.humidity> |
Returns | ElementTag(Decimal) |
Description | Returns the humidity of this biome.
|
Mechanism | This tag can be modified using mechanism/BiomeTag.humidity |
Name | <BiomeTag.temperature> |
Returns | ElementTag(Decimal) |
Description | Returns the temperature of this biome.
|
Mechanism | This tag can be modified using mechanism/BiomeTag.temperature |
Name | <BiomeTag.spawnable_entities> |
Returns | ListTag(EntityTag) |
Description | Returns all entities that spawn naturally in this biome.
|
Name | <BiomeTag.spawnable_entities.ambient> |
Returns | ListTag(EntityTag) |
Description | Returns the entities that spawn naturally in ambient locations.
Default examples: BAT |
Name | <BiomeTag.spawnable_entities.creatures> |
Returns | ListTag(EntityTag) |
Description | Returns the entities that spawn naturally in creature locations.
Default examples: PIG, COW, CHICKEN... |
Name | <BiomeTag.spawnable_entities.monsters> |
Returns | ListTag(EntityTag) |
Description | Returns the entities that spawn naturally in monster locations.
Default examples: CREEPER, ZOMBIE, SKELETON... |
Name | <BiomeTag.spawnable_entities.water> |
Returns | ListTag(EntityTag) |
Description | Returns the entities that spawn naturally in underwater locations.
Default examples: SQUID |
Name | <BiomeTag.type> |
Returns | ElementTag |
Description | Always returns 'Biome' for BiomeTag objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Name | <ChunkTag.add[<#>,<#>]> |
Returns | ChunkTag |
Description | Returns the chunk with the specified coordinates added to it.
|
Name | <ChunkTag.sub[<#>,<#>]> |
Returns | ChunkTag |
Description | Returns the chunk with the specified coordinates subtracted from it.
|
Name | <ChunkTag.is_loaded> |
Returns | ElementTag(Boolean) |
Description | Returns true if the chunk is currently loaded into memory.
|
Name | <ChunkTag.x> |
Returns | ElementTag(Number) |
Description | Returns the x coordinate of the chunk.
|
Name | <ChunkTag.z> |
Returns | ElementTag(Number) |
Description | Returns the z coordinate of the chunk.
|
Name | <ChunkTag.world> |
Returns | WorldTag |
Description | Returns the world associated with the chunk.
|
Name | <ChunkTag.cuboid> |
Returns | CuboidTag |
Description | Returns a cuboid of this chunk.
|
Name | <ChunkTag.tile_entities> |
Returns | ListTag(LocationTag) |
Description | Returns a list of tile entity locations in the chunk.
|
Name | <ChunkTag.entities> |
Returns | ListTag(EntityTag) |
Description | Returns a list of entities in the chunk.
|
Name | <ChunkTag.living_entities> |
Returns | ListTag(EntityTag) |
Description | Returns a list of living entities in the chunk. This includes Players, mobs, NPCs, etc., but excludes
dropped items, experience orbs, etc. |
Name | <ChunkTag.players> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of players in the chunk.
|
Name | <ChunkTag.height_map> |
Returns | ListTag |
Description | Returns a list of the height of each block in the chunk.
|
Name | <ChunkTag.average_height> |
Returns | ElementTag(Decimal) |
Description | Returns the average height of the blocks in the chunk.
|
Name | <ChunkTag.is_flat[(<#>)]> |
Returns | ElementTag(Boolean) |
Description | scans the heights of the blocks to check variance between them. If no number is supplied, is_flat will return
true if all the blocks are less than 2 blocks apart in height. Specifying a number will modify the number criteria for determining if it is flat. |
Name | <ChunkTag.surface_blocks> |
Returns | ListTag(LocationTag) |
Description | Returns a list of the highest non-air surface blocks in the chunk.
|
Name | <ChunkTag.spawn_slimes> |
Returns | ListTag(LocationTag) |
Description | Returns whether the chunk is a specially located 'slime spawner' chunk.
|
Name | <ChunkTag.inhabited_time> |
Returns | Duration |
Description | Returns the total time the chunk has been inhabited for.
This is a primary deciding factor in the "local difficulty" setting. |
Mechanism | This tag can be modified using mechanism/ChunkTag.inhabited_time |
Name | <ChunkTag.type> |
Returns | ElementTag |
Description | Always returns 'Chunk' for ChunkTag objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Name | <ColorTag.red> |
Returns | ElementTag(Number) |
Description | Returns the red value of this color.
|
Name | <ColorTag.green> |
Returns | ElementTag(Number) |
Description | Returns the green value of this color.
|
Name | <ColorTag.blue> |
Returns | ElementTag(Number) |
Description | Returns the blue value of this color.
|
Name | <ColorTag.rgb> |
Returns | ElementTag |
Description | Returns the RGB value of this color.
EG, 255,0,255 |
Name | <ColorTag.hue> |
Returns | ElementTag(Number) |
Description | Returns the hue value of this color.
|
Name | <ColorTag.saturation> |
Returns | ElementTag(Number) |
Description | Returns the saturation value of this color.
|
Name | <ColorTag.brightness> |
Returns | ElementTag(Number) |
Description | Returns the brightness value of this color.
|
Name | <ColorTag.hsv> |
Returns | ElementTag |
Description | Returns the HSV value of this color.
EG, 100,100,255 |
Name | <ColorTag.name> |
Returns | ElementTag |
Description | Returns the name of this color (or red,green,blue if none).
|
Name | <ColorTag.mix[<color>]> |
Returns | ColorTag |
Description | Returns the color that results if you mix this color with another.
|
Name | <ColorTag.to_particle_offset> |
Returns | LocationTag |
Description | Returns the color as a particle offset, for use with PlayEffect.
|
Name | <ColorTag.type> |
Returns | ElementTag |
Description | Always returns 'Color' for ColorTag objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Name | <CuboidTag.blocks[<material>|...]> |
Returns | ListTag(LocationTag) |
Description | Returns each block location within the CuboidTag.
Optionally, specify a list of materials to only return locations with that block type. |
Name | <CuboidTag.members_size> |
Returns | ElementTag(Number) |
Description | Returns the number of cuboids defined in the CuboidTag.
|
Name | <CuboidTag.spawnable_blocks[<Material>|...]> |
Returns | ListTag(LocationTag) |
Description | Returns each LocationTag within the CuboidTag that is
safe for players or similar entities to spawn in. Optionally, specify a list of materials to only return locations with that block type. |
Name | <CuboidTag.shell> |
Returns | ListTag(LocationTag) |
Description | Returns each block location on the shell of the CuboidTag.
|
Name | <CuboidTag.outline> |
Returns | ListTag(LocationTag) |
Description | Returns each block location on the outline of the CuboidTag.
|
Name | <CuboidTag.filter> |
Returns | ListTag(LocationTag) |
Description | Returns the block locations from the CuboidTag's filter.
|
Name | <CuboidTag.intersects[<cuboid>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether this cuboid and another intersect.
|
Name | <CuboidTag.contains_location[<location>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether this cuboid contains a location.
|
Name | <CuboidTag.is_within[<cuboid>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether this cuboid is fully inside another cuboid.
|
Name | <CuboidTag.list_members> |
Returns | ListTag(CuboidTag) |
Description | Returns a list of all sub-cuboids in this CuboidTag (for cuboids that contain multiple sub-cuboids).
|
Name | <CuboidTag.get[<index>]> |
Returns | CuboidTag |
Description | Returns a cuboid representing the one component of this cuboid (for cuboids that contain multiple sub-cuboids).
|
Name | <CuboidTag.set[<cuboid>].at[<index>]> |
Returns | CuboidTag |
Description | Returns a modified copy of this cuboid, with the specific sub-cuboid index changed to hold the input cuboid.
|
Name | <CuboidTag.add_member[<cuboid>]> |
Returns | CuboidTag |
Description | Returns a modified copy of this cuboid, with the input cuboid added at the end.
|
Mechanism | This tag can be modified using mechanism/CuboidTag.add_member |
Name | <CuboidTag.add_member[<cuboid>].at[<index>]> |
Returns | CuboidTag |
Description | Returns a modified copy of this cuboid, with the input cuboid added at the specified index.
|
Mechanism | This tag can be modified using mechanism/CuboidTag.add_member |
Name | <CuboidTag.remove_member[<#>]> |
Returns | CuboidTag |
Description | Returns a modified copy of this cuboid, with member at the input index removed.
|
Mechanism | This tag can be modified using mechanism/CuboidTag.remove_member |
Name | <CuboidTag.center> |
Returns | LocationTag |
Description | Returns the location of the exact center of the cuboid.
|
Name | <CuboidTag.volume> |
Returns | ElementTag(Number) |
Description | Returns the volume of the cuboid.
Effectively equivalent to: (size.x * size.y * size.z). |
Name | <CuboidTag.size> |
Returns | LocationTag |
Description | Returns the size of the cuboid.
Effectively equivalent to: (max - min) + (1,1,1) |
Name | <CuboidTag.max> |
Returns | LocationTag |
Description | Returns the highest-numbered (maximum) corner location.
|
Name | <CuboidTag.min> |
Returns | LocationTag |
Description | Returns the lowest-numbered (minimum) corner location.
|
Name | <CuboidTag.include[<location>]> |
Returns | CuboidTag |
Description | Expands the first member of the CuboidTag to contain the given location, and returns the expanded cuboid.
|
Name | <CuboidTag.include_x[<number>]> |
Returns | CuboidTag |
Description | Expands the first member of the CuboidTag to contain the given X value, and returns the expanded cuboid.
|
Name | <CuboidTag.include_y[<number>]> |
Returns | CuboidTag |
Description | Expands the first member of the CuboidTag to contain the given Y value, and returns the expanded cuboid.
|
Name | <CuboidTag.include_z[<number>]> |
Returns | CuboidTag |
Description | Expands the first member of the CuboidTag to contain the given Z value, and returns the expanded cuboid.
|
Name | <CuboidTag.with_min[<location>]> |
Returns | CuboidTag |
Description | Changes the first member of the CuboidTag to have the given minimum location, and returns the changed cuboid.
If values in the new min are higher than the existing max, the output max will contain the new min values, and the output min will contain the old max values. Note that this is equivalent to constructing a cuboid with the input value and the original cuboids max value. |
Name | <CuboidTag.with_max[<location>]> |
Returns | CuboidTag |
Description | Changes the first member of the CuboidTag to have the given maximum location, and returns the changed cuboid.
If values in the new max are lower than the existing min, the output min will contain the new max values, and the output max will contain the old min values. Note that this is equivalent to constructing a cuboid with the input value and the original cuboids min value. |
Name | <CuboidTag.list_players> |
Returns | ListTag(PlayerTag) |
Description | Gets a list of all players currently within the CuboidTag.
|
Name | <CuboidTag.list_npcs> |
Returns | ListTag(NPCTag) |
Description | Gets a list of all NPCs currently within the CuboidTag.
|
Name | <CuboidTag.list_entities[<entity>|...]> |
Returns | ListTag(EntityTag) |
Description | Gets a list of all entities currently within the CuboidTag, with
an optional search parameter for the entity type. |
Name | <CuboidTag.list_living_entities> |
Returns | ListTag(EntityTag) |
Description | Gets a list of all living entities currently within the CuboidTag.
|
Name | <CuboidTag.list_chunks> |
Returns | ListTag(ChunkTag) |
Description | Gets a list of all chunks entirely within the CuboidTag.
|
Name | <CuboidTag.list_partial_chunks> |
Returns | ListTag(ChunkTag) |
Description | Gets a list of all chunks partially or entirely within the CuboidTag.
|
Name | <CuboidTag.notable_name> |
Returns | ElementTag |
Description | Gets the name of a Notable CuboidTag. If the cuboid isn't noted,
this is null. |
Name | <CuboidTag.full> |
Returns | ElementTag |
Description | Returns a full reusable identification for this cuboid, with extra, generally useless data.
|
Group | conversion |
Name | <CuboidTag.type> |
Returns | ElementTag |
Description | Always returns 'Cuboid' for CuboidTag objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Name | <EllipsoidTag.blocks[<material>|...]> |
Returns | ListTag(LocationTag) |
Description | Returns each block location within the EllipsoidTag.
Optionally, specify a list of materials to only return locations with that block type. |
Name | <EllipsoidTag.location> |
Returns | LocationTag |
Description | Returns the location of the ellipsoid.
|
Name | <EllipsoidTag.size> |
Returns | LocationTag |
Description | Returns the size of the ellipsoid.
|
Name | <EllipsoidTag.type> |
Returns | ElementTag |
Description | Always returns 'Ellipsoid' for EllipsoidTag objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Name | <EntityTag.type> |
Returns | ElementTag |
Description | Always returns 'Entity' for EntityTag objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Name | <EntityTag.entity_type> |
Returns | ElementTag |
Description | Returns the type of the entity.
|
Group | data |
Name | <EntityTag.is_spawned> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is spawned.
|
Group | data |
Name | <EntityTag.eid> |
Returns | ElementTag(Number) |
Description | Returns the entity's temporary server entity ID.
|
Group | data |
Name | <EntityTag.uuid> |
Returns | ElementTag |
Description | Returns the permanent unique ID of the entity.
Works with offline players. |
Group | data |
Name | <EntityTag.script> |
Returns | ElementTag |
Description | Returns the entity script that spawned this entity, if any.
|
Group | data |
Name | <EntityTag.scriptname> |
Returns | ElementTag |
Description | Returns the name of the entity script that spawned this entity, if any.
Generally prefer tag/entity.script, but this tag may be useful if an entity script was renamed after this entity was spawned. |
Group | data |
Name | <EntityTag.has_flag[<flag_name>]> |
Returns | ElementTag(Boolean) |
Description | Returns true if the entity has the specified flag, otherwise returns false.
|
Name | <EntityTag.flag[<flag_name>]> |
Returns | Flag ListTag |
Description | Returns the specified flag from the entity.
|
Name | <EntityTag.flag[<flag_name>].is_expired> |
Returns | ElementTag(Boolean) |
Description | returns true if the flag is expired or does not exist, false if it is not yet expired or has no expiration.
|
Name | <EntityTag.flag[<flag_name>].expiration> |
Returns | DurationTag |
Description | Returns a DurationTag of the time remaining on the flag, if it has an expiration.
|
Name | <EntityTag.list_flags[(regex:)<search>]> |
Returns | ListTag |
Description | Returns a list of an entity's flag names, with an optional search for
names containing a certain pattern. |
Name | <EntityTag.custom_id> |
Returns | ScriptTag/Element |
Description | If the entity has a script ID, returns the ScriptTag of that ID.
Otherwise, returns the name of the entity type. |
Group | data |
Name | <EntityTag.name> |
Returns | ElementTag |
Description | Returns the name of the entity.
This can be a player name, an NPC name, a custom_name, or the entity type. Works with offline players. |
Group | data |
Name | <EntityTag.saddle> |
Returns | ItemTag |
Description | If the entity is a horse or pig, returns the saddle as a ItemTag, or air if none.
|
Group | inventory |
Name | <EntityTag.horse_armor> |
Returns | ItemTag |
Description | If the entity is a horse, returns the item equipped as the horses armor, or air if none.
|
Group | inventory |
Name | <EntityTag.has_saddle> |
Returns | ElementTag(Boolean) |
Description | If the entity s a pig or horse, returns whether it has a saddle equipped.
|
Group | inventory |
Name | <EntityTag.item_in_hand> |
Returns | ItemTag |
Description | Returns the item the entity is holding, or air if none.
|
Mechanism | This tag can be modified using mechanism/EntityTag.item_in_hand |
Group | inventory |
Name | <EntityTag.item_in_offhand> |
Returns | ItemTag |
Description | Returns the item the entity is holding in their off hand, or air if none.
|
Mechanism | This tag can be modified using mechanism/EntityTag.item_in_offhand |
Group | inventory |
Name | <EntityTag.is_trading> |
Returns | ElementTag(Boolean) |
Description | Returns whether the villager entity is trading.
|
Name | <EntityTag.trading_with> |
Returns | PlayerTag |
Description | Returns the player who is trading with the villager entity, or null if it is not trading.
|
Name | <EntityTag.map_trace> |
Returns | LocationTag |
Description | Returns a 2D location indicating where on the map the entity's looking at.
Each coordinate is in the range of 0 to 128. |
Group | location |
Name | <EntityTag.can_see[<entity>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity can see the specified other entity (has an uninterrupted line-of-sight).
|
Group | location |
Name | <EntityTag.eye_location> |
Returns | LocationTag |
Description | Returns the location of the entity's eyes.
|
Group | location |
Name | <EntityTag.eye_height> |
Returns | ElementTag(Boolean) |
Description | Returns the height of the entity's eyes above its location.
|
Group | location |
Name | <EntityTag.cursor_on[(<range>)]> |
Returns | ElementTag(Boolean) |
Description | Returns the location of the block the entity is looking at.
Optionally, specify a maximum range to find the location from. This uses logic equivalent to tag/LocationTag.precise_cursor_on_block[(range)]. Note that this will return null if there is no solid block in range. |
Group | location |
Name | <EntityTag.location> |
Returns | LocationTag |
Description | Returns the location of the entity.
For living entities, this is at the center of their feet. For eye location, use tag/EntityTag.eye_location Works with offline players. |
Group | location |
Name | <EntityTag.location.standing_on> |
Returns | LocationTag |
Description | Returns the location of what the entity is standing on.
Works with offline players. |
Group | location |
Name | <EntityTag.body_yaw> |
Returns | ElementTag(Decimal) |
Description | Returns the entity's body yaw (separate from head yaw).
|
Group | location |
Name | <EntityTag.velocity> |
Returns | LocationTag |
Description | Returns the movement velocity of the entity.
Note: Does not accurately calculate player clientside movement velocity. |
Mechanism | This tag can be modified using mechanism/EntityTag.velocity |
Group | location |
Name | <EntityTag.world> |
Returns | WorldTag |
Description | Returns the world the entity is in. Works with offline players.
|
Group | location |
Name | <EntityTag.can_pickup_items> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity can pick up items.
|
Mechanism | This tag can be modified using mechanism/EntityTag.can_pickup_items |
Group | attributes |
Name | <EntityTag.fallingblock_material> |
Returns | MaterialTag |
Description | Returns the material of a fallingblock-type entity.
|
Group | attributes |
Name | <EntityTag.fall_distance> |
Returns | ElementTag(Decimal) |
Description | Returns how far the entity has fallen.
|
Mechanism | This tag can be modified using mechanism/EntityTag.fall_distance |
Group | attributes |
Name | <EntityTag.fire_time> |
Returns | DurationTag |
Description | Returns the duration for which the entity will remain on fire
|
Mechanism | This tag can be modified using mechanism/EntityTag.fire_time |
Group | attributes |
Name | <EntityTag.on_fire> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is currently ablaze or not.
|
Group | attributes |
Name | <EntityTag.leash_holder> |
Returns | EntityTag |
Description | Returns the leash holder of entity.
|
Mechanism | This tag can be modified using mechanism/EntityTag.leash_holder |
Group | attributes |
Name | <EntityTag.passengers> |
Returns | ListTag(EntityTag) |
Description | Returns a list of the entity's passengers, if any.
|
Mechanism | This tag can be modified using mechanism/EntityTag.passengers |
Group | attributes |
Name | <EntityTag.passenger> |
Returns | EntityTag |
Description | Returns the entity's passenger, if any.
|
Mechanism | This tag can be modified using mechanism/EntityTag.passenger |
Group | attributes |
Name | <EntityTag.shooter> |
Returns | EntityTag |
Description | Returns the entity's shooter, if any.
|
Mechanism | This tag can be modified using mechanism/EntityTag.shooter |
Group | attributes |
Name | <EntityTag.left_shoulder> |
Returns | EntityTag |
Description | Returns the entity on the entity's left shoulder.
Only applies to player-typed entities. NOTE: The returned entity will not be spawned within the world, so most operations are invalid unless the entity is first spawned in. |
Mechanism | This tag can be modified using mechanism/EntityTag.left_shoulder |
Name | <EntityTag.right_shoulder> |
Returns | EntityTag |
Description | Returns the entity on the entity's right shoulder.
Only applies to player-typed entities. NOTE: The returned entity will not be spawned within the world, so most operations are invalid unless the entity is first spawned in. |
Mechanism | This tag can be modified using mechanism/EntityTag.right_shoulder |
Name | <EntityTag.vehicle> |
Returns | EntityTag |
Description | If the entity is in a vehicle, returns the vehicle as a EntityTag.
|
Group | attributes |
Name | <EntityTag.can_breed> |
Returns | ElementTag(Boolean) |
Description | Returns whether the animal entity is capable of mating with another of its kind.
|
Mechanism | This tag can be modified using mechanism/EntityTag.can_breed |
Group | attributes |
Name | <EntityTag.breeding> |
Returns | ElementTag(Boolean) |
Description | Returns whether the animal entity is trying to with another of its kind.
|
Group | attributes |
Name | <EntityTag.has_passenger> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity has a passenger.
|
Mechanism | This tag can be modified using mechanism/EntityTag.passenger |
Group | attributes |
Name | <EntityTag.is_empty> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity does not have a passenger.
|
Group | attributes |
Name | <EntityTag.is_inside_vehicle> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is inside a vehicle.
|
Group | attributes |
Name | <EntityTag.is_leashed> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is leashed.
|
Group | attributes |
Name | <EntityTag.is_sheared> |
Returns | ElementTag(Boolean) |
Description | Returns whether a sheep is sheared.
|
Group | attributes |
Name | <EntityTag.is_on_ground> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is supported by a block.
|
Group | attributes |
Name | <EntityTag.is_persistent> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity will not be removed completely when far away from players.
|
Group | attributes |
Name | <EntityTag.is_collidable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is collidable.
|
Mechanism | This tag can be modified using mechanism/EntityTag.collidable |
Group | attributes |
Name | <EntityTag.killer> |
Returns | PlayerTag |
Description | Returns the player that last killed the entity.
|
Group | attributes |
Name | <EntityTag.last_damage.amount> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of the last damage taken by the entity.
|
Group | attributes |
Name | <EntityTag.last_damage.cause> |
Returns | ElementTag |
Description | Returns the cause of the last damage taken by the entity.
|
Group | attributes |
Name | <EntityTag.last_damage.duration> |
Returns | DurationTag |
Description | Returns the duration of the last damage taken by the entity.
|
Mechanism | This tag can be modified using mechanism/EntityTag.no_damage_duration |
Group | attributes |
Name | <EntityTag.last_damage.max_duration> |
Returns | DurationTag |
Description | Returns the maximum duration of the last damage taken by the entity.
|
Mechanism | This tag can be modified using mechanism/EntityTag.max_no_damage_duration |
Group | attributes |
Name | <EntityTag.max_oxygen> |
Returns | DurationTag |
Description | Returns the maximum duration of oxygen the entity can have.
Works with offline players. |
Group | attributes |
Name | <EntityTag.oxygen> |
Returns | DurationTag |
Description | Returns the duration of oxygen the entity has left.
Works with offline players. |
Group | attributes |
Name | <EntityTag.remove_when_far> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity despawns when away from players.
|
Group | attributes |
Name | <EntityTag.target> |
Returns | EntityTag |
Description | Returns the target entity of the creature, if any.
Note: use <NPCTag.navigator.target_entity> for NPC's. |
Group | attributes |
Name | <EntityTag.precise_target[<range>]> |
Returns | EntityTag |
Description | Returns the entity this entity is looking at, using precise ray trace logic.
Optionally, specify a maximum range to find the entity from (defaults to 200). |
Name | <EntityTag.precise_target_position[<range>]> |
Returns | LocationTag |
Description | Returns the location this entity is looking at, using precise ray trace (against entities) logic.
Optionally, specify a maximum range to find the target from (defaults to 200). |
Name | <EntityTag.time_lived> |
Returns | DurationTag |
Description | Returns how long the entity has lived.
|
Mechanism | This tag can be modified using mechanism/EntityTag.time_lived |
Group | attributes |
Name | <EntityTag.pickup_delay> |
Returns | DurationTag |
Description | Returns how long before the item-type entity can be picked up by a player.
|
Mechanism | This tag can be modified using mechanism/EntityTag.pickup_delay |
Group | attributes |
Name | <EntityTag.is_in_block> |
Returns | ElementTag(Boolean) |
Description | Returns whether or not the arrow/trident entity is in a block.
|
Group | attributes |
Name | <EntityTag.attached_block> |
Returns | LocationTag |
Description | Returns the location of the block that the arrow/trident or hanging entity is attached to.
|
Group | attributes |
Name | <EntityTag.gliding> |
Returns | ElementTag(Boolean) |
Description | Returns whether this entity is gliding.
|
Mechanism | This tag can be modified using mechanism/EntityTag.gliding |
Group | attributes |
Name | <EntityTag.swimming> |
Returns | ElementTag(Boolean) |
Description | Returns whether this entity is swimming.
|
Mechanism | This tag can be modified using mechanism/EntityTag.swimming |
Group | attributes |
Name | <EntityTag.glowing> |
Returns | ElementTag(Boolean) |
Description | Returns whether this entity is glowing.
|
Mechanism | This tag can be modified using mechanism/EntityTag.glowing |
Group | attributes |
Name | <EntityTag.is_living> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is a living-type entity (eg a cow or a player or anything else that lives, as specifically opposed to non-living entities like paintings, etc).
Not to be confused with the idea of being alive - see tag/EntityTag.is_spawned. |
Group | data |
Name | <EntityTag.is_monster> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is a hostile monster.
|
Group | data |
Name | <EntityTag.is_mob> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is a mob (Not a player or NPC).
|
Group | data |
Name | <EntityTag.is_npc> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is a Citizens NPC.
|
Group | data |
Name | <EntityTag.is_player> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is a player.
Works with offline players. |
Group | data |
Name | <EntityTag.is_projectile> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is a projectile.
|
Group | data |
Name | <EntityTag.tameable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is tameable.
If this returns true, it will enable access to: mechanism/EntityTag.tame, mechanism/EntityTag.owner, tag/EntityTag.is_tamed, and tag/EntityTag.owner |
Group | properties |
Name | <EntityTag.ageable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is ageable.
If this returns true, it will enable access to: mechanism/EntityTag.age, mechanism/EntityTag.age_lock, tag/EntityTag.is_baby, tag/EntityTag.age, and tag/EntityTag.is_age_locked |
Group | properties |
Name | <EntityTag.colorable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity can be colored.
If this returns true, it will enable access to: mechanism/EntityTag.color and tag/EntityTag.color |
Group | properties |
Name | <EntityTag.experience> |
Returns | ElementTag(Number) |
Description | Returns the experience value of this experience orb entity.
|
Mechanism | This tag can be modified using mechanism/EntityTag.experience |
Group | properties |
Name | <EntityTag.fuse_ticks> |
Returns | ElementTag(Number) |
Description | Returns the number of ticks until the explosion of the primed TNT.
|
Mechanism | This tag can be modified using mechanism/EntityTag.fuse_ticks |
Group | properties |
Name | <EntityTag.dragon_phase> |
Returns | ElementTag |
Description | Returns the phase an EnderDragon is currently in.
Valid phases: url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/EnderDragon.Phase.html |
Mechanism | This tag can be modified using mechanism/EntityTag.dragon_phase |
Group | properties |
Name | <EntityTag.weapon_damage[(<entity>)]> |
Returns | ElementTag(Number) |
Description | Returns the amount of damage the entity will do based on its held item.
Optionally, specify a target entity to test how much damage will be done to that specific target (modified based on enchantments and that entity's armor/status/etc). Note that the result will not always be completely exact, as it doesn't take into account some specific factors (eg sweeping vs single-hit, etc). |
Group | properties |
Name | <EntityTag.describe> |
Returns | ElementTag |
Description | Returns the entity's full description, including all properties.
|
Group | properties |
Name | <InventoryTag.empty_slots> |
Returns | ElementTag(Number) |
Description | Returns the number of empty slots in an inventory.
|
Name | <InventoryTag.can_fit[<item>|...]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory can fit an item.
|
Name | <InventoryTag.can_fit[<item>].count> |
Returns | ElementTag(Number) |
Description | Returns the total count of how many times an item can fit into an inventory.
|
Name | <InventoryTag.can_fit[<item>].quantity[<#>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory can fit a certain quantity of an item.
|
Name | <InventoryTag.include[<item>]> |
Returns | InventoryTag |
Description | Returns a copy of the InventoryTag with an item added.
|
Name | <InventoryTag.include[<item>].quantity[<#>]> |
Returns | InventoryTag |
Description | Returns the InventoryTag with a certain quantity of an item added.
|
Name | <InventoryTag.is_empty> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory is empty.
|
Name | <InventoryTag.is_full> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory is completely full.
|
Name | <InventoryTag.contains[<item>|...]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory contains all of the specified items.
|
Name | <InventoryTag.contains.display[(strict:)<element>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory contains an item with the specified display name.
Use 'strict:' in front of the search element to ensure the display name is EXACTLY the search element, otherwise the searching will only check if the search element is contained in the display name. |
Name | <InventoryTag.contains.display[(strict:)<element>].quantity[<#>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory contains a certain quantity of an item with the specified display name.
Use 'strict:' in front of the search element to ensure the display name is EXACTLY the search element, otherwise the searching will only check if the search element is contained in the display name. |
Name | <InventoryTag.contains.lore[(strict:)<element>|...]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory contains an item with the specified lore.
Use 'strict:' in front of the search elements to ensure all lore lines are EXACTLY the search elements, otherwise the searching will only check if the search elements are contained in the lore. |
Name | <InventoryTag.contains.lore[(strict:)<element>|...].quantity[<#>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory contains a certain quantity of an item with the specified lore.
Use 'strict:' in front of the search elements to ensure all lore lines are EXACTLY the search elements, otherwise the searching will only check if the search elements are contained in the lore. |
Name | <InventoryTag.contains.scriptname[<scriptname>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory contains an item with the specified scriptname.
|
Name | <InventoryTag.contains.scriptname[<scriptname>].quantity[<#>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory contains a certain quantity of an item with the specified scriptname.
|
Name | <InventoryTag.contains.nbt[<key>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory contains an item with the specified key.
|
Name | <InventoryTag.contains.nbt[<key>].quantity[<#>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory contains a certain quantity of an item with the specified key.
|
Name | <InventoryTag.contains.material[<material>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory contains an item with the specified material.
|
Name | <InventoryTag.contains.material[<material>].quantity[<#>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory contains a certain quantity of an item with the specified material.
|
Name | <InventoryTag.contains[<item>|...].quantity[<#>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory contains a certain quantity of all of the specified items.
|
Name | <InventoryTag.contains_any[<item>|...]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory contains any of the specified items.
|
Name | <InventoryTag.contains_any[<item>|...].quantity[<#>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory contains a certain quantity of any of the specified items.
|
Name | <InventoryTag.first_empty> |
Returns | ElementTag(Number) |
Description | Returns the location of the first empty slot.
Returns -1 if the inventory is full. |
Name | <InventoryTag.find[<item>]> |
Returns | ElementTag(Number) |
Description | Returns the location of the first slot that contains the item.
Returns -1 if there's no match. |
Name | <InventoryTag.find.material[<material>]> |
Returns | ElementTag(Number) |
Description | Returns the location of the first slot that contains the material.
Returns -1 if there's no match. |
Name | <InventoryTag.find.scriptname[<item>]> |
Returns | ElementTag(Number) |
Description | Returns the location of the first slot that contains the item with the specified script name.
Returns -1 if there's no match. |
Name | <InventoryTag.find_imperfect[<item>]> |
Returns | ElementTag(Number) |
Description | Returns the location of the first slot that contains the item.
Returns -1 if there's no match. Will match item script to item script, even if one is edited. |
Name | <InventoryTag.id_type> |
Returns | ElementTag |
Description | Returns Denizen's type ID for this inventory (player, location, etc.).
|
Name | <InventoryTag.notable_name> |
Returns | ElementTag |
Description | Gets the name of a Notable InventoryTag. If the inventory isn't noted, this is null.
|
Name | <InventoryTag.location> |
Returns | LocationTag |
Description | Returns the location of this inventory's holder.
|
Name | <InventoryTag.quantity[(<item>)]> |
Returns | ElementTag(Number) |
Description | Returns the combined quantity of itemstacks that match an item if one is specified,
or the combined quantity of all itemstacks if one is not. |
Name | <InventoryTag.quantity.scriptname[<script>]> |
Returns | ElementTag(Number) |
Description | Returns the combined quantity of itemstacks that have the specified script name.
|
Name | <InventoryTag.quantity.material[<material>]> |
Returns | ElementTag(Number) |
Description | Returns the combined quantity of itemstacks that have the specified material.
|
Name | <InventoryTag.stacks[(<item>)]> |
Returns | ElementTag(Number) |
Description | Returns the number of itemstacks that match an item if one is specified, or the number of all itemstacks if one is not.
|
Name | <InventoryTag.slot[<#>|...]> |
Returns | ItemTag or ListTag(ItemTag) |
Description | If one slot is specified, returns the item in the specified slot.
If more than what slot is specified, returns a list of the item in each given slot. |
Name | <InventoryTag.inventory_type> |
Returns | ElementTag |
Description | Returns the type of the inventory (e.g. "PLAYER", "CRAFTING", "HORSE").
|
Name | <InventoryTag.equipment> |
Returns | ListTag(ItemTag) |
Description | Returns the equipment of an inventory as a list of items.
For players, the order is boots|leggings|chestplate|helmet. For horses, the order is saddle|armor. |
Name | <InventoryTag.matrix> |
Returns | ListTag(ItemTag) |
Description | Returns the items currently in a crafting inventory's matrix.
|
Mechanism | This tag can be modified using mechanism/InventoryTag.matrix |
Name | <InventoryTag.result> |
Returns | ItemTag |
Description | Returns the item currently in the result section of a crafting inventory or furnace inventory.
|
Mechanism | This tag can be modified using mechanism/InventoryTag.result |
Name | <InventoryTag.anvil_repair_cost> |
Returns | ElementTag(Number) |
Description | Returns the current repair cost on an anvil.
|
Mechanism | This tag can be modified using mechanism/InventoryTag.anvil_repair_cost |
Name | <InventoryTag.anvil_max_repair_cost> |
Returns | ElementTag(Number) |
Description | Returns the maximum repair cost on an anvil.
|
Mechanism | This tag can be modified using mechanism/InventoryTag.anvil_max_repair_cost |
Name | <InventoryTag.anvil_rename_text> |
Returns | Element |
Description | Returns the current entered renaming text on an anvil.
|
Name | <InventoryTag.fuel> |
Returns | ItemTag |
Description | Returns the item currently in the fuel section of a furnace or brewing stand inventory.
|
Mechanism | This tag can be modified using mechanism/InventoryTag.fuel |
Name | <InventoryTag.input> |
Returns | ItemTag |
Description | Returns the item currently in the smelting slot of a furnace inventory, or the ingredient slot of a brewing stand inventory.
|
Mechanism | This tag can be modified using mechanism/InventoryTag.input |
Name | <InventoryTag.type> |
Returns | ElementTag |
Description | Always returns 'Inventory' for InventoryTag objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Name | <ItemTag.with[<mechanism>=<value>;...]> |
Returns | ItemTag |
Description | Returns a copy of the item with mechanism adjustments applied.
|
Group | properties |
Name | <ItemTag.repairable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the item can be repaired.
If this returns true, it will enable access to: mechanism/ItemTag.durability, tag/ItemTag.max_durability, and tag/ItemTag.durability. |
Group | properties |
Name | <ItemTag.is_crop> |
Returns | ElementTag(Boolean) |
Description | Returns whether the item is a growable crop.
If this returns true, it will enable access to: mechanism/ItemTag.plant_growth and tag/ItemTag.plant_growth. |
Group | properties |
Name | <ItemTag.is_book> |
Returns | ElementTag(Boolean) |
Description | Returns whether the item is considered an editable book.
If this returns true, it will enable access to: mechanism/ItemTag.book, tag/ItemTag.book_author, tag/ItemTag.book_title, and tag/ItemTag.book_pages. |
Group | properties |
Name | <ItemTag.is_colorable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the item can have a custom color.
If this returns true, it will enable access to: mechanism/ItemTag.color, and tag/ItemTag.color. |
Group | properties |
Name | <ItemTag.is_firework> |
Returns | ElementTag(Boolean) |
Description | Returns whether the item is a firework.
If this returns true, it will enable access to: mechanism/ItemTag.firework, and tag/ItemTag.firework. |
Group | properties |
Name | <ItemTag.has_inventory> |
Returns | ElementTag(Boolean) |
Description | Returns whether the item has an inventory.
If this returns true, it will enable access to: mechanism/ItemTag.inventory, and tag/ItemTag.inventory. |
Group | properties |
Name | <ItemTag.is_lockable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the item is lockable.
If this returns true, it will enable access to: mechanism/ItemTag.lock, and tag/ItemTag.lock. |
Group | properties |
Name | <ItemTag.material> |
Returns | MaterialTag |
Description | Returns the MaterialTag that is the basis of the item.
EG, a stone with lore and a display name, etc. will return only "m@stone". |
Mechanism | This tag can be modified using mechanism/ItemTag.material |
Group | conversion |
Name | <ItemTag.json> |
Returns | ElementTag |
Description | Returns the item converted to a raw JSON object with one layer of escaping for network transmission.
EG, via /tellraw. Generally, prefer tags like tag/ElementTag.on_hover.type with type 'show_item'. |
Group | conversion |
Name | <ItemTag.bukkit_serial> |
Returns | ElementTag |
Description | Returns a YAML text section representing the Bukkit serialization of the item, under subkey "item".
|
Group | conversion |
Name | <ItemTag.full> |
Returns | ElementTag |
Description | Returns a full reusable item identification for this item, with extra, generally useless data.
Irrelevant on modern (1.13+) servers. |
Group | conversion |
Name | <ItemTag.simple> |
Returns | ElementTag |
Description | Returns a simple reusable item identification for this item, with minimal extra data.
|
Group | conversion |
Name | <ItemTag.recipe_ids[(<type>)]> |
Returns | ListTag |
Description | If the item is a scripted item, returns a list of all recipe IDs created by the item script.
Others, returns a list of all recipe IDs that the server lists as capable of crafting the item. Returns a list in the Namespace:Key format, for example "minecraft:gold_nugget". Optionally, specify a recipe type (CRAFTING, FURNACE, COOKING, BLASTING, SHAPED, SHAPELESS, SMOKING, STONECUTTING) to limit to just recipes of that type. |
Name | <ItemTag.notable_name> |
Returns | ElementTag |
Description | Gets the name of a Notable ItemTag. If the item isn't noted,
this is null. |
Name | <ItemTag.formatted> |
Returns | ElementTag |
Description | Returns the formatted material name of the item to be used in a sentence.
Correctly uses singular and plural forms of item names, among other things. |
Group | formatting |
Name | <ItemTag.type> |
Returns | ElementTag |
Description | Always returns 'Item' for ItemTag objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Name | <LocationTag.block_facing> |
Returns | LocationTag |
Description | Returns the relative location vector of where this block is facing.
Only works for block types that have directionality (such as signs, chests, stairs, etc.). This can return for example "1,0,0" to mean the block is facing towards the positive X axis. You can use <some_block_location.add[<some_block_location.block_facing>]> to get the block directly in front of this block (based on its facing direction). |
Mechanism | This tag can be modified using mechanism/LocationTag.block_facing |
Name | <LocationTag.above[(<#.#>)]> |
Returns | LocationTag |
Description | Returns the location above this location. Optionally specify a number of blocks to go up.
This just moves straight along the Y axis, equivalent to tag/LocationTag.add with input 0,1,0 (or the input value instead of '1'). |
Name | <LocationTag.below[(<#.#>)]> |
Returns | LocationTag |
Description | Returns the location below this location. Optionally specify a number of blocks to go down.
This just moves straight along the Y axis, equivalent to tag/LocationTag.sub with input 0,1,0 (or the input value instead of '1'). |
Name | <LocationTag.forward_flat[(<#.#>)]> |
Returns | LocationTag |
Description | Returns the location in front of this location based on yaw but not pitch. Optionally specify a number of blocks to go forward.
|
Name | <LocationTag.backward_flat[(<#.#>)]> |
Returns | LocationTag |
Description | Returns the location behind this location based on yaw but not pitch. Optionally specify a number of blocks to go backward.
This is equivalent to tag/LocationTag.forward_flat in the opposite direction. |
Name | <LocationTag.forward[(<#.#>)]> |
Returns | LocationTag |
Description | Returns the location in front of this location based on pitch and yaw. Optionally specify a number of blocks to go forward.
|
Name | <LocationTag.backward[(<#.#>)]> |
Returns | LocationTag |
Description | Returns the location behind this location based on pitch and yaw. Optionally specify a number of blocks to go backward.
This is equivalent to tag/LocationTag.forward in the opposite direction. |
Name | <LocationTag.left[(<#.#>)]> |
Returns | LocationTag |
Description | Returns the location to the left of this location based on pitch and yaw. Optionally specify a number of blocks to go left.
This is equivalent to tag/LocationTag.forward with a +90 degree rotation to the yaw and the pitch set to 0. |
Name | <LocationTag.right[(<#.#>)]> |
Returns | LocationTag |
Description | Returns the location to the right of this location based on pitch and yaw. Optionally specify a number of blocks to go right.
This is equivalent to tag/LocationTag.forward with a -90 degree rotation to the yaw and the pitch set to 0. |
Name | <LocationTag.up[(<#.#>)]> |
Returns | LocationTag |
Description | Returns the location above this location based on pitch and yaw. Optionally specify a number of blocks to go up.
This is equivalent to tag/LocationTag.forward with a +90 degree rotation to the pitch. |
Name | <LocationTag.down[(<#.#>)]> |
Returns | LocationTag |
Description | Returns the location below this location based on pitch and yaw. Optionally specify a number of blocks to go down.
This is equivalent to tag/LocationTag.forward with a -90 degree rotation to the pitch. |
Name | <LocationTag.relative[<location>]> |
Returns | LocationTag |
Description | Returns the location relative to this location. Input is a vector location of the form left,up,forward.
For example, input -1,1,1 will return a location 1 block to the right, 1 block up, and 1 block forward. |
Name | <LocationTag.block> |
Returns | LocationTag |
Description | Returns the location of the block this location is on,
i.e. returns a location without decimals or direction. |
Name | <LocationTag.center> |
Returns | LocationTag |
Description | Returns the location at the center of the block this location is on.
|
Name | <LocationTag.highest> |
Returns | LocationTag |
Description | Returns the location of the highest solid block at the location.
|
Name | <LocationTag.base_color> |
Returns | ElementTag |
Description | Returns the base color of the banner at this location.
For the list of possible colors, see url/http://bit.ly/1dydq12. As of 1.13+, this tag is no longer relevant. |
Mechanism | This tag can be modified using mechanism/LocationTag.base_color |
Name | <LocationTag.has_inventory> |
Returns | ElementTag(Boolean) |
Description | Returns whether the block at the location has an inventory.
|
Name | <LocationTag.inventory> |
Returns | InventoryTag |
Description | Returns the InventoryTag of the block at the location. If the
block is not a container, returns null. |
Name | <LocationTag.material> |
Returns | MaterialTag |
Description | Returns the material of the block at the location.
|
Name | <LocationTag.patterns> |
Returns | ListTag |
Description | Lists the patterns of the banner at this location in the form "li@COLOR/PATTERN|COLOR/PATTERN" etc.
For the list of possible colors, see url/http://bit.ly/1dydq12. For the list of possible patterns, see url/http://bit.ly/1MqRn7T. |
Mechanism | This tag can be modified using mechanism/LocationTag.patterns |
Group | properties |
Name | <LocationTag.head_rotation> |
Returns | ElementTag(Number) |
Description | Gets the rotation of the head at this location. Can be 1-16.
|
Mechanism | This tag can be modified using mechanism/LocationTag.head_rotation |
Name | <LocationTag.switched> |
Returns | ElementTag(Boolean) |
Description | Returns whether the block at the location is considered to be switched on.
(For buttons, levers, etc.) To change this, see command/Switch |
Name | <LocationTag.sign_contents> |
Returns | ListTag |
Description | Returns a list of lines on a sign.
|
Mechanism | This tag can be modified using mechanism/LocationTag.sign_contents |
Name | <LocationTag.spawner_type> |
Returns | EntityTag |
Description | Returns the type of entity spawned by a mob spawner.
|
Mechanism | This tag can be modified using mechanism/LocationTag.spawner_type |
Name | <LocationTag.lock> |
Returns | ElementTag |
Description | Returns the password to a locked container.
|
Mechanism | This tag can be modified using mechanism/LocationTag.lock |
Name | <LocationTag.is_locked> |
Returns | ElementTag(Boolean) |
Description | Returns whether the container is locked.
|
Mechanism | This tag can be modified using mechanism/LocationTag.lock |
Name | <LocationTag.is_lockable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the container is lockable.
|
Mechanism | This tag can be modified using mechanism/LocationTag.lock |
Name | <LocationTag.drops[(<item>)]> |
Returns | ListTag(ItemTag) |
Description | Returns what items the block at the location would drop if broken naturally.
Optionally specifier a breaker item. |
Name | <LocationTag.flowerpot_contents> |
Returns | ElementTag |
Description | Returns the flower pot contents at the location.
NOTE: Replaced by materials (such as POTTED_CACTUS) in 1.13 and above. |
Mechanism | This tag can be modified using mechanism/LocationTag.flowerpot_contents |
Name | <LocationTag.skull_type> |
Returns | ElementTag |
Description | Returns the type of the skull.
|
Name | <LocationTag.skull_name> |
Returns | ElementTag |
Description | Returns the name of the skin the skull is displaying.
|
Mechanism | This tag can be modified using mechanism/LocationTag.skull_skin |
Name | <LocationTag.skull_skin> |
Returns | ElementTag |
Description | Returns the skin the skull is displaying - just the name or UUID as text, not a player object.
|
Mechanism | This tag can be modified using mechanism/LocationTag.skull_skin |
Name | <LocationTag.skull_skin.full> |
Returns | ElementTag|Element |
Description | Returns the skin the skull item is displaying - just the name or UUID as text, not a player object,
along with the permanently cached texture property. |
Mechanism | This tag can be modified using mechanism/LocationTag.skull_skin |
Name | <LocationTag.simple> |
Returns | ElementTag |
Description | Returns a simple version of the LocationTag's block coordinates.
In the format: x,y,z,world For example: 1,2,3,world_nether |
Name | <LocationTag.simple.formatted> |
Returns | ElementTag |
Description | Returns the formatted simple version of the LocationTag's block coordinates.
In the format: X 'x', Y 'y', Z 'z', in world 'world' For example, X '1', Y '2', Z '3', in world 'world_nether' |
Name | <LocationTag.precise_impact_normal[(<range>)]> |
Returns | LocationTag |
Description | Returns the exact impact normal at the location this location is pointing at.
Optionally, specify a maximum range to find the location from (defaults to 200). |
Name | <LocationTag.precise_cursor_on_block[(<range>)]> |
Returns | LocationTag |
Description | Returns the block location this location is pointing at.
Optionally, specify a maximum range to find the location from (defaults to 200). |
Name | <LocationTag.precise_cursor_on[(<range>)]> |
Returns | LocationTag |
Description | Returns the exact location this location is pointing at.
Optionally, specify a maximum range to find the location from (defaults to 200). |
Name | <LocationTag.precise_target[(<range>)]> |
Returns | EntityTag |
Description | Returns the entity this location is pointing at, using precise ray trace logic.
Optionally, specify a maximum range to find the entity from (defaults to 200). |
Name | <LocationTag.precise_target_position[(<range>)]> |
Returns | LocationTag |
Description | Returns the precise location this location is pointing at, when tracing against entities.
Optionally, specify a maximum range to find the entity from (defaults to 200). |
Name | <LocationTag.points_between[<location>]> |
Returns | ListTag(LocationTag) |
Description | Finds all locations between this location and another, separated by 1 block-width each.
|
Name | <LocationTag.points_between[<location>].distance[<#.#>]> |
Returns | ListTag(LocationTag) |
Description | Finds all locations between this location and another, separated by the specified distance each.
|
Name | <LocationTag.facing_blocks[(<#>)]> |
Returns | ListTag(LocationTag) |
Description | Finds all block locations in the direction this location is facing,
optionally with a custom range (default is 100). For example a location at 0,0,0 facing straight up will include 0,1,0 0,2,0 and so on. |
Name | <LocationTag.line_of_sight[<location>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the specified location is within this location's
line of sight. |
Name | <LocationTag.direction[<location>]> |
Returns | ElementTag |
Description | Returns the compass direction between two locations.
If no second location is specified, returns the direction of the location. Example returns include "north", "southwest", ... |
Name | <LocationTag.direction.vector> |
Returns | LocationTag |
Description | Returns the location's direction as a one-length vector.
|
Name | <LocationTag.direction[<location>].yaw> |
Returns | ElementTag(Decimal) |
Description | Returns the yaw direction between two locations.
|
Name | <LocationTag.face[<location>]> |
Returns | LocationTag |
Description | Returns a location containing a yaw/pitch that point from the current location
to the target location. |
Name | <LocationTag.facing[<entity>/<location>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the location's yaw is facing another entity or location, within a limit of 45 degrees of yaw.
|
Name | <LocationTag.facing[<entity>/<location>].degrees[<#>(,<#>)]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the location's yaw is facing another
entity or location, within a specified degree range. Optionally specify a pitch limit as well. |
Name | <LocationTag.pitch> |
Returns | ElementTag(Decimal) |
Description | Returns the pitch of the object at the location.
|
Name | <LocationTag.with_pose[<entity>/<pitch>,<yaw>]> |
Returns | LocationTag |
Description | Returns the location with pitch and yaw.
|
Name | <LocationTag.yaw> |
Returns | ElementTag(Decimal) |
Description | Returns the normalized yaw of the object at the location.
|
Name | <LocationTag.yaw.simple> |
Returns | ElementTag |
Description | Returns the yaw as 'North', 'South', 'East', or 'West'.
|
Name | <LocationTag.yaw.raw> |
Returns | ElementTag(Decimal) |
Description | Returns the raw yaw of the object at the location.
|
Name | <LocationTag.rotate_around_x[<#.#>]> |
Returns | LocationTag |
Description | Returns the location rotated around the x axis by a specified angle in radians.
|
Name | <LocationTag.rotate_around_y[<#.#>]> |
Returns | LocationTag |
Description | Returns the location rotated around the y axis by a specified angle in radians.
|
Name | <LocationTag.rotate_around_z[<#.#>]> |
Returns | LocationTag |
Description | Returns the location rotated around the z axis by a specified angle in radians.
|
Name | <LocationTag.find.blocks[<block>|...].within[<#>]> |
Returns | ListTag |
Description | Returns a list of matching blocks within a radius.
Note: current implementation measures the center of nearby block's distance from the exact given location. |
Name | <LocationTag.find.surface_blocks[<block>|...].within[<#.#>]> |
Returns | ListTag |
Description | Returns a list of matching surface blocks within a radius.
|
Name | <LocationTag.find.players.within[<#.#>]> |
Returns | ListTag |
Description | Returns a list of players within a radius.
|
Name | <LocationTag.find.npcs.within[<#.#>]> |
Returns | ListTag |
Description | Returns a list of NPCs within a radius.
|
Name | <LocationTag.find.entities[<entity>|...].within[<#.#>]> |
Returns | ListTag |
Description | Returns a list of entities within a radius, with an optional search parameter
for the entity type. |
Name | <LocationTag.find.living_entities.within[<#.#>]> |
Returns | ListTag |
Description | Returns a list of living entities within a radius.
|
Name | <LocationTag.find_path[<location>]> |
Returns | ListTag(LocationTag) |
Description | Returns a full list of points along the path from this location to the given location.
Uses a max range of 100 blocks from the start. |
Name | <LocationTag.formatted> |
Returns | ElementTag |
Description | Returns the formatted version of the LocationTag.
In the format: X 'x.x', Y 'y.y', Z 'z.z', in world 'world' For example: X '1.0', Y '2.0', Z '3.0', in world 'world_nether' |
Name | <LocationTag.formatted.citizens> |
Returns | ElementTag |
Description | Returns the location formatted for a Citizens command.
In the format: x.x:y.y:z.z:world For example: 1.0:2.0:3.0:world_nether |
Name | <LocationTag.chunk> |
Returns | ChunkTag |
Description | Returns the chunk that this location belongs to.
|
Name | <LocationTag.raw> |
Returns | LocationTag |
Description | Returns the raw representation of this location,
ignoring any notables it might match. |
Name | <LocationTag.world> |
Returns | WorldTag |
Description | Returns the world that the location is in.
|
Name | <LocationTag.x> |
Returns | ElementTag(Decimal) |
Description | Returns the X coordinate of the location.
|
Name | <LocationTag.y> |
Returns | ElementTag(Decimal) |
Description | Returns the Y coordinate of the location.
|
Name | <LocationTag.z> |
Returns | ElementTag(Decimal) |
Description | Returns the Z coordinate of the location.
|
Name | <LocationTag.xyz> |
Returns | ElementTag |
Description | Returns the location in "x,y,z" format.
For example: 1,2,3 World, yaw, and pitch will be excluded from this output. |
Name | <LocationTag.with_x[<number>]> |
Returns | LocationTag |
Description | Returns a copy of the location with a changed X value.
|
Name | <LocationTag.with_y[<number>]> |
Returns | LocationTag |
Description | Returns a copy of the location with a changed Y value.
|
Name | <LocationTag.with_z[<number>]> |
Returns | LocationTag |
Description | Returns a copy of the location with a changed Z value.
|
Name | <LocationTag.with_yaw[<number>]> |
Returns | LocationTag |
Description | Returns a copy of the location with a changed yaw value.
|
Name | <LocationTag.with_pitch[<number>]> |
Returns | LocationTag |
Description | Returns a copy of the location with a changed pitch value.
|
Name | <LocationTag.with_world[<world>]> |
Returns | LocationTag |
Description | Returns a copy of the location with a changed world value.
|
Name | <LocationTag.notable_name> |
Returns | ElementTag |
Description | Gets the name of a Notable LocationTag. If the location isn't noted,
this is null. |
Name | <LocationTag.add[<location>]> |
Returns | LocationTag |
Description | Returns the location with the specified coordinates added to it.
|
Name | <LocationTag.sub[<location>]> |
Returns | LocationTag |
Description | Returns the location with the specified coordinates subtracted from it.
|
Name | <LocationTag.mul[<length>]> |
Returns | LocationTag |
Description | Returns the location multiplied by the specified length.
|
Name | <LocationTag.div[<length>]> |
Returns | LocationTag |
Description | Returns the location divided by the specified length.
|
Name | <LocationTag.normalize> |
Returns | LocationTag |
Description | Returns a 1-length vector in the same direction as this vector location.
|
Name | <LocationTag.vector_length> |
Returns | ElementTag(Decimal) |
Description | Returns the 3D length of the vector/location.
|
Name | <LocationTag.vector_to_face> |
Returns | ElementTag |
Description | Returns the name of the BlockFace represented by a vector.
Result can be any of the following: NORTH, EAST, SOUTH, WEST, UP, DOWN, NORTH_EAST, NORTH_WEST, SOUTH_EAST, SOUTH_WEST, WEST_NORTH_WEST, NORTH_NORTH_WEST, NORTH_NORTH_EAST, EAST_NORTH_EAST, EAST_SOUTH_EAST, SOUTH_SOUTH_EAST, SOUTH_SOUTH_WEST, WEST_SOUTH_WEST, SELF |
Name | <LocationTag.distance_squared[<location>]> |
Returns | ElementTag(Decimal) |
Description | Returns the distance between 2 locations, squared.
|
Name | <LocationTag.distance[<location>]> |
Returns | ElementTag(Decimal) |
Description | Returns the distance between 2 locations.
|
Name | <LocationTag.distance[<location>].horizontal> |
Returns | ElementTag(Decimal) |
Description | Returns the horizontal distance between 2 locations.
|
Name | <LocationTag.distance[<location>].horizontal.multiworld> |
Returns | ElementTag(Decimal) |
Description | Returns the horizontal distance between 2 multiworld locations.
|
Name | <LocationTag.distance[<location>].vertical> |
Returns | ElementTag(Decimal) |
Description | Returns the vertical distance between 2 locations.
|
Name | <LocationTag.distance[<location>].vertical.multiworld> |
Returns | ElementTag(Decimal) |
Description | Returns the vertical distance between 2 multiworld locations.
|
Name | <LocationTag.is_within_border> |
Returns | ElementTag(Boolean) |
Description | Returns whether the location is within the world border.
|
Name | <LocationTag.is_within[<cuboid>/<ellipsoid>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the location is within the cuboid or ellipsoid.
|
Name | <LocationTag.biome> |
Returns | BiomeTag |
Description | Returns the biome at the location.
|
Mechanism | This tag can be modified using mechanism/LocationTag.biome |
Name | <LocationTag.cuboids> |
Returns | ListTag(CuboidTag) |
Description | Returns a ListTag of all notable CuboidTags that include this location.
|
Name | <LocationTag.ellipsoids> |
Returns | ListTag(CuboidTag) |
Description | Returns a ListTag of all notable EllipsoidTags that include this location.
|
Name | <LocationTag.is_liquid> |
Returns | ElementTag(Boolean) |
Description | Returns whether the block at the location is a liquid.
|
Name | <LocationTag.light> |
Returns | ElementTag(Number) |
Description | Returns the total amount of light on the location.
|
Name | <LocationTag.light.blocks> |
Returns | ElementTag(Number) |
Description | Returns the amount of light from light blocks that is
on the location. |
Name | <LocationTag.light.sky> |
Returns | ElementTag(Number) |
Description | Returns the amount of light from the sky that is
on the location. |
Name | <LocationTag.power> |
Returns | ElementTag(Number) |
Description | Returns the current redstone power level of a block.
|
Name | <LocationTag.tree_distance> |
Returns | ElementTag(Number) |
Description | Returns a number of how many blocks away from a connected tree leaves are.
Defaults to 7 if not connected to a tree. |
Group | properties |
Name | <LocationTag.command_block_name> |
Returns | ElementTag |
Description | Returns the name a command block is set to.
|
Mechanism | This tag can be modified using mechanism/LocationTag.command_block_name |
Name | <LocationTag.command_block> |
Returns | ElementTag |
Description | Returns the command a command block is set to.
|
Mechanism | This tag can be modified using mechanism/LocationTag.command_block |
Name | <LocationTag.brewing_time> |
Returns | DurationTag |
Description | Returns the brewing time a brewing stand has left.
|
Mechanism | This tag can be modified using mechanism/LocationTag.brewing_time |
Name | <LocationTag.brewing_fuel_level> |
Returns | ElementTag(Number) |
Description | Returns the level of fuel a brewing stand has. Each unit of fuel can power one brewing operation.
|
Mechanism | This tag can be modified using mechanism/LocationTag.brewing_fuel_level |
Name | <LocationTag.furnace_burn_time> |
Returns | ElementTag(Number) |
Description | Returns the burn time a furnace has left.
|
Mechanism | This tag can be modified using mechanism/LocationTag.furnace_burn_time |
Name | <LocationTag.furnace_cook_time> |
Returns | ElementTag(Number) |
Description | Returns the cook time a furnace has been cooking its current item for.
|
Mechanism | This tag can be modified using mechanism/LocationTag.furnace_cook_time |
Name | <LocationTag.furnace_cook_time_total> |
Returns | ElementTag(Number) |
Description | Returns the total cook time a furnace has left.
|
Mechanism | This tag can be modified using mechanism/LocationTag.furnace_cook_time_total |
Name | <LocationTag.beacon_tier> |
Returns | ElementTag(Number) |
Description | Returns the tier level of a beacon pyramid (0-4).
|
Name | <LocationTag.beacon_primary_effect> |
Returns | ElementTag |
Description | Returns the primary effect of the beacon. The return is simply a potion effect type name.
|
Mechanism | This tag can be modified using mechanism/LocationTag.beacon_primary_effect |
Name | <LocationTag.beacon_secondary_effect> |
Returns | ElementTag |
Description | Returns the secondary effect of the beacon. The return is simply a potion effect type name.
|
Mechanism | This tag can be modified using mechanism/LocationTag.beacon_secondary_effect |
Name | <LocationTag.attached_to> |
Returns | LocationTag |
Description | Returns the block this block is attached to.
(Only if it is a lever or button!) |
Name | <LocationTag.other_block> |
Returns | LocationTag |
Description | If the location is part of a double-block structure (double chests, double plants, doors, beds, etc),
returns the location of the other block in the double-block structure. You can test if this will be valid with tag/MaterialTag.is_bisected. |
Name | <LocationTag.custom_name> |
Returns | ElementTag |
Description | Returns the custom name of this block.
Only works for nameable blocks, such as chests and dispensers. |
Mechanism | This tag can be modified using mechanism/LocationTag.custom_name |
Name | <LocationTag.local_difficulty> |
Returns | ElementTag(Decimal) |
Description | Returns the local difficulty (damage scaler) at the location.
This is based internally on multiple factors, including tag/ChunkTag.inhabited_time and tag/WorldTag.difficulty. |
Name | <LocationTag.type> |
Returns | ElementTag |
Description | Always returns 'Location' for LocationTag objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Name | <MaterialTag.is_ageable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is an ageable material.
When this returns true, tag/MaterialTag.age, tag/MaterialTag.maximum_age, and mechanism/MaterialTag.age are accessible. |
Group | properties |
Name | <MaterialTag.is_directional> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a directional material.
When this returns true, tag/MaterialTag.direction, tag/MaterialTag.valid_directions, and mechanism/MaterialTag.direction are accessible. |
Group | properties |
Name | <MaterialTag.has_multiple_faces> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a material that has multiple faces.
When this returns true, tag/MaterialTag.faces, tag/MaterialTag.valid_faces, and mechanism/MaterialTag.faces are accessible. |
Group | properties |
Name | <MaterialTag.is_bisected> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a bisected material (doors, beds, double chests, double plants, ...).
When this returns true, tag/MaterialTag.half, tag/MaterialTag.relative_vector and mechanism/MaterialTag.half are accessible. |
Group | properties |
Name | <MaterialTag.is_leaves> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a leaves material.
When this returns true, tag/LocationTag.tree_distance, tag/MaterialTag.persistent, and mechanism/MaterialTag.persistent are accessible. |
Group | properties |
Name | <MaterialTag.is_slab> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a slab.
When this returns true, tag/MaterialTag.slab_type, and mechanism/MaterialTag.slab_type are accessible. |
Group | properties |
Name | <MaterialTag.is_levelable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a levelable material.
When this returns true, tag/MaterialTag.level, tag/MaterialTag.maximum_level, and mechanism/MaterialTag.level are accessible. |
Group | properties |
Name | <MaterialTag.is_lightable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a lightable material.
When this returns true, tag/MaterialTag.lit, and mechanism/MaterialTag.lit are accessible. |
Group | properties |
Name | <MaterialTag.has_gravity> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is affected by gravity.
|
Name | <MaterialTag.is_block> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a placeable block.
|
Name | <MaterialTag.is_item> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a holdable item.
Note that most blocks are valid items as well. This only returns "false" for certain non-holdable "special" blocks, like Fire. |
Name | <MaterialTag.is_burnable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a block that can burn away.
|
Name | <MaterialTag.is_edible> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is edible.
|
Name | <MaterialTag.is_flammable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a block that can catch fire.
|
Name | <MaterialTag.is_occluding> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a block that completely blocks vision.
|
Name | <MaterialTag.is_record> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a playable music disc.
|
Name | <MaterialTag.is_solid> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a block that is solid (cannot be walked through).
|
Name | <MaterialTag.is_transparent> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is a block that does not block any light.
|
Name | <MaterialTag.max_durability> |
Returns | ElementTag(Number) |
Description | Returns the maximum durability of this material.
|
Name | <MaterialTag.block_resistance> |
Returns | ElementTag(Decimal) |
Description | Returns the explosion resistance for all blocks of this material type.
|
Mechanism | This tag can be modified using mechanism/MaterialTag.block_resistance |
Name | <MaterialTag.hardness> |
Returns | ElementTag(Decimal) |
Description | Returns the value representing how hard a material, used as a basis for calculating the time it takes to break.
|
Name | <MaterialTag.max_stack_size> |
Returns | ElementTag(Number) |
Description | Returns the maximum amount of this material that can be held in a stack.
|
Name | <MaterialTag.is_made_of[<material>]> |
Returns | ElementTag(Boolean) |
Description | Returns true if the material is a variety of the specified material.
Example: <m@red_wool.is_made_of[m@wool]> will return true. Invalid for 1.13+ servers. |
Name | <MaterialTag.bukkit_enum> |
Returns | ElementTag |
Description | Returns the bukkit Material enum value. For example: <m@birch_sapling.bukkit_enum>
will return 'sapling' Unneeded for 1.13+ servers. |
Name | <MaterialTag.name> |
Returns | ElementTag |
Description | Returns the name of the material.
|
Name | <MaterialTag.full> |
Returns | ElementTag |
Description | Returns the material's full identification.
Irrelevant on modern (1.13+) servers. |
Name | <MaterialTag.item> |
Returns | ItemTag |
Description | Returns an item of the material.
|
Name | <MaterialTag.piston_reaction> |
Returns | ElementTag |
Description | Returns the material's piston reaction. (Only for block materials).
|
Mechanism | This tag can be modified using mechanism/MaterialTag.piston_reaction |
Name | <MaterialTag.block_strength> |
Returns | ElementTag(Decimal) |
Description | Returns the material's strength level. (Only for block materials).
This is a representation of how much time mining is needed to break a block. |
Mechanism | This tag can be modified using mechanism/MaterialTag.block_strength |
Name | <MaterialTag.type> |
Returns | ElementTag |
Description | Always returns 'Material' for MaterialTag objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Name | <MaterialTag.with[<mechanism>=<value>;...]> |
Returns | MaterialTag |
Description | Returns a copy of the material with mechanism adjustments applied.
|
Group | properties |
Name | <NPCTag.previous_location> |
Returns | LocationTag |
Description | Returns the NPC's previous navigated location.
|
Name | <NPCTag.has_nickname> |
Returns | ElementTag(Boolean) |
Description | Returns true if the NPC has a nickname.
|
Name | <NPCTag.nickname> |
Returns | ElementTag |
Description | Returns the NPC's display name, as set by the Nickname trait (or the default NPC name).
|
Name | <NPCTag.list_traits> |
Returns | ListTag |
Description | Returns a list of all of the NPC's traits.
|
Name | <NPCTag.has_trait[<trait>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC has a specified trait.
|
Name | <NPCTag.pushable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC is pushable.
|
Name | <NPCTag.has_trigger[<trigger>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC has a specified trigger.
|
Name | <NPCTag.has_anchors> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC has anchors assigned.
|
Name | <NPCTag.list_anchors> |
Returns | ListTag |
Description | Returns a list of anchor names currently assigned to the NPC.
|
Name | <NPCTag.anchor[<name>]> |
Returns | LocationTag |
Description | Returns the location associated with the specified anchor, or null if it doesn't exist.
|
Name | <NPCTag.has_flag[<flag_name>]> |
Returns | ElementTag(Boolean) |
Description | Returns true if the NPC has the specified flag, otherwise returns false.
|
Name | <NPCTag.flag[<flag_name>]> |
Returns | Flag ListTag |
Description | Returns the specified flag from the NPC.
|
Name | <NPCTag.flag[<flag_name>].is_expired> |
Returns | ElementTag(Boolean) |
Description | returns true if the flag is expired or does not exist, false if it is not yet expired or has no expiration.
|
Name | <NPCTag.flag[<flag_name>].expiration> |
Returns | DurationTag |
Description | Returns a DurationTag of the time remaining on the flag, if it has an expiration.
|
Name | <NPCTag.list_flags[(regex:)<search>]> |
Returns | ListTag |
Description | Returns a list of an NPC's flag names, with an optional search for
names containing a certain pattern. |
Name | <NPCTag.constant[<constant_name>]> |
Returns | ElementTag |
Description | Returns the specified constant from the NPC.
|
Name | <NPCTag.has_pose[<name>]> |
Returns | ElementTag(Boolean) |
Description | Returns true if the NPC has the specified pose, otherwise returns false.
|
Name | <NPCTag.pose[<name>]> |
Returns | LocationTag |
Description | Returns the pose as a LocationTag with x, y, and z set to 0, and the world set to the first
possible available world Bukkit knows about. |
Name | <NPCTag.is_sneaking> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC is currently sneaking. Only works for player-type NPCs.
|
Name | <NPCTag.is_engaged> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC is currently engaged.
See command/engage |
Name | <NPCTag.invulnerable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC is currently invulnerable.
See command/vulnerable |
Name | <NPCTag.id> |
Returns | ElementTag(Number) |
Description | Returns the NPC's ID number.
|
Name | <NPCTag.owner> |
Returns | PlayerTag/Element |
Description | Returns the owner of the NPC as a PlayerTag if it's a player, otherwise as just the name.
|
Mechanism | This tag can be modified using mechanism/NPCTag.owner |
Name | <NPCTag.has_skin> |
Returns | ElementTag |
Description | Returns whether the NPC has a custom skinskin.
|
Mechanism | This tag can be modified using mechanism/NPCTag.skin |
Name | <NPCTag.skin_blob> |
Returns | ElementTag |
Description | Returns the NPC's custom skin blob, if any.
|
Mechanism | This tag can be modified using mechanism/NPCTag.skin_blob |
Name | <NPCTag.skin> |
Returns | ElementTag |
Description | Returns the NPC's custom skin, if any.
|
Mechanism | This tag can be modified using mechanism/NPCTag.skin |
Name | <NPCTag.inventory> |
Returns | InventoryTag |
Description | Returns the InventoryTag of the NPC.
|
Name | <NPCTag.is_spawned> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC is spawned.
|
Name | <NPCTag.is_protected> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC is protected.
|
Name | <NPCTag.lookclose> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC has lookclose enabled.
|
Mechanism | This tag can be modified using mechanism/NPCTag.lookclose |
Name | <NPCTag.teleport_on_stuck> |
Returns | LocationTag |
Description | Returns whether the NPC teleports when it is stuck.
|
Mechanism | This tag can be modified using mechanism/NPCTag.teleport_on_stuck |
Name | <NPCTag.has_script> |
Returns | ElementTag(Boolean) |
Description | Returns true if the NPC has an assignment script.
|
Name | <NPCTag.script> |
Returns | ScriptTag |
Description | Returns the NPC's assigned script.
|
Name | <NPCTag.distance_margin> |
Returns | ElementTag(Decimal) |
Description | Returns the NPC's current pathfinding distance margin. That is, how close it needs to get to its destination (in block-lengths).
|
Mechanism | This tag can be modified using mechanism/NPCTag.distance_margin |
Name | <NPCTag.path_distance_margin> |
Returns | ElementTag(Decimal) |
Description | Returns the NPC's current pathfinding distance margin. That is, how close it needs to get to individual points along its path.
|
Mechanism | This tag can be modified using mechanism/NPCTag.path_distance_margin |
Name | <NPCTag.is_navigating> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC is currently navigating.
|
Name | <NPCTag.speed> |
Returns | ElementTag(Decimal) |
Description | Returns the current speed of the NPC.
|
Mechanism | This tag can be modified using mechanism/NPCTag.speed |
Name | <NPCTag.range> |
Returns | ElementTag(Decimal) |
Description | Returns the NPC's current maximum pathfinding range.
|
Mechanism | This tag can be modified using mechanism/NPCTag.range |
Name | <NPCTag.attack_range> |
Returns | ElementTag(Decimal) |
Description | Returns the NPC's current navigator attack range limit.
|
Mechanism | This tag can be modified using mechanism/NPCTag.attack_range |
Name | <NPCTag.attack_strategy> |
Returns | ElementTag |
Description | Returns the NPC's current navigator attack strategy.
|
Name | <NPCTag.speed_modifier> |
Returns | ElementTag(Decimal) |
Description | Returns the NPC's current movement speed modifier (a multiplier applied over their base speed).
|
Name | <NPCTag.base_speed> |
Returns | ElementTag(Decimal) |
Description | Returns the NPC's base navigation speed.
|
Name | <NPCTag.avoid_water> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC will avoid water.
|
Name | <NPCTag.target_location> |
Returns | LocationTag |
Description | Returns the location the NPC is currently navigating towards (if any).
|
Name | <NPCTag.is_fighting> |
Returns | ElementTag(Boolean) |
Description | Returns whether the NPC is in combat.
|
Name | <NPCTag.target_type> |
Returns | ElementTag |
Description | Returns the entity type of the NPC's current navigation target (if any).
|
Name | <NPCTag.target_entity> |
Returns | EntityTag |
Description | Returns the entity being targeted by the NPC's current navigation (if any).
|
Name | <NPCTag.type> |
Returns | ElementTag |
Description | Always returns 'NPC' for NPCTag objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Name | <PlayerTag.chat_history_list> |
Returns | ListTag |
Description | Returns a list of the last 10 things the player has said, less if the player hasn't said all that much.
Works with offline players. |
Name | <PlayerTag.chat_history[<#>]> |
Returns | ElementTag |
Description | Returns the last thing the player said.
If a number is specified, returns an earlier thing the player said. Works with offline players. |
Name | <PlayerTag.flag[<flag_name>]> |
Returns | Flag ListTag |
Description | Returns the specified flag from the player.
Works with offline players. |
Name | <PlayerTag.flag[<flag_name>].is_expired> |
Returns | ElementTag(Boolean) |
Description | returns true if the flag is expired or does not exist, false if it is not yet expired or has no expiration.
Works with offline players. |
Name | <PlayerTag.flag[<flag_name>].expiration> |
Returns | DurationTag |
Description | Returns a DurationTag of the time remaining on the flag, if it has an expiration.
Works with offline players. |
Name | <PlayerTag.has_flag[<flag_name>]> |
Returns | ElementTag(Boolean) |
Description | Returns true if the Player has the specified flag, otherwise returns false.
Works with offline players. |
Name | <PlayerTag.list_flags[(regex:)<search>]> |
Returns | ListTag |
Description | Returns a list of a player's flag names, with an optional search for
names containing a certain pattern. Works with offline players. |
Name | <PlayerTag.formatted_money> |
Returns | ElementTag |
Description | Returns the formatted form of the player's money balance in the registered Economy system.
|
Note | This tag requires the plugin(s) Vault! |
Name | <PlayerTag.money> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of money the player has with the registered Economy system.
May work offline depending on economy provider. |
Mechanism | This tag can be modified using mechanism/PlayerTag.money |
Note | This tag requires the plugin(s) Vault! |
Name | <PlayerTag.target[(<entity>|...)]> |
Returns | EntityTag |
Description | Returns the entity that the player is looking at, within a maximum range of 50 blocks,
or null if the player is not looking at an entity. Optionally, specify a list of entities, entity types, or 'npc' to only count those targets. |
Name | <PlayerTag.target[(<entity>|...)].within[(<#>)]> |
Returns | EntityTag |
Description | Returns the living entity that the player is looking at within the specified range limit,
or null if the player is not looking at an entity. Optionally, specify a list of entities, entity types, or 'npc' to only count those targets. |
Name | <PlayerTag.type> |
Returns | ElementTag |
Description | Always returns 'Player' for PlayerTag objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Name | <PlayerTag.save_name> |
Returns | ElementTag |
Description | Returns the ID used to save the player in Denizen's saves.yml file.
Works with offline players. |
Name | <PlayerTag.bed_spawn> |
Returns | LocationTag |
Description | Returns the location of the player's bed spawn location, null if
it doesn't exist. Works with offline players. |
Mechanism | This tag can be modified using mechanism/PlayerTag.bed_spawn_location |
Name | <PlayerTag.item_cooldown[<material>]> |
Returns | DurationTag |
Description | Returns the cooldown duration remaining on player's material.
|
Name | <PlayerTag.first_played> |
Returns | DurationTag |
Description | Returns the millisecond time of when the player first logged on to this server.
Works with offline players. |
Name | <PlayerTag.has_played_before> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has played before.
Works with offline players. Note: This will just always return true. |
Name | <PlayerTag.absorption_health> |
Returns | ElementTag(Decimal) |
Description | Returns the player's absorption health.
|
Mechanism | This tag can be modified using mechanism/PlayerTag.absorption_health |
Name | <PlayerTag.exhaustion> |
Returns | ElementTag(Decimal) |
Description | Returns how fast the food level drops (exhaustion).
|
Mechanism | This tag can be modified using mechanism/PlayerTag.exhaustion |
Name | <PlayerTag.health_is_scaled> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player's health bar is currently being scaled.
|
Name | <PlayerTag.health_scale> |
Returns | ElementTag(Decimal) |
Description | Returns the current scale for the player's health bar
|
Mechanism | This tag can be modified using mechanism/PlayerTag.health_scale |
Name | <PlayerTag.is_banned> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is banned.
|
Name | <PlayerTag.is_online> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is currently online.
Works with offline players (returns false in that case). |
Name | <PlayerTag.is_op> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is a full server operator.
Works with offline players. |
Mechanism | This tag can be modified using mechanism/PlayerTag.is_op |
Name | <PlayerTag.is_whitelisted> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is whitelisted.
Works with offline players. |
Mechanism | This tag can be modified using mechanism/PlayerTag.is_whitelisted |
Name | <PlayerTag.last_played> |
Returns | DurationTag |
Description | Returns the datestamp of when the player was last seen in duration.
Works with offline players. |
Name | <PlayerTag.groups> |
Returns | ListTag |
Description | Returns a list of all groups the player is in.
May work with offline players, depending on permission plugin. |
Name | <PlayerTag.ban_expiration> |
Returns | DurationTag |
Description | Returns the expiration of the player's ban, if they are banned.
Potentially can be null. |
Name | <PlayerTag.ban_reason> |
Returns | ElementTag |
Description | Returns the reason for the player's ban, if they are banned.
|
Name | <PlayerTag.ban_created> |
Returns | DurationTag |
Description | Returns when the player's ban was created as a Duration time tag, if they are banned.
|
Name | <PlayerTag.ban_source> |
Returns | ElementTag |
Description | Returns the source of the player's ban, if they are banned.
|
Name | <PlayerTag.in_group[<group_name>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is in the specified group.
(May work with offline players, depending on your permissions system.) |
Name | <PlayerTag.in_group[<group_name>].global> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has the group with no regard to the
player's current world. (Works with offline players) (Note: This may or may not be functional with your permissions system.) |
Name | <PlayerTag.in_group[<group_name>].world[<world>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has the group in regards to a specific world.
(Works with offline players) (Note: This may or may not be functional with your permissions system.) |
Name | <PlayerTag.has_permission[permission.node]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has the specified node.
(May work with offline players, depending on your permissions system.) |
Name | <PlayerTag.has_permission[permission.node].global> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has the specified node, regardless of world.
(Works with offline players) (Note: this may or may not be functional with your permissions system.) |
Name | <PlayerTag.has_permission[permission.node].world[<world name>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has the specified node in regards to the
specified world. (Works with offline players) (Note: This may or may not be functional with your permissions system.) |
Name | <PlayerTag.uuid> |
Returns | ElementTag |
Description | Returns the UUID of the player.
Works with offline players. |
Name | <PlayerTag.list_name> |
Returns | ElementTag |
Description | Returns the name of the player as shown in the player list.
|
Name | <PlayerTag.display_name> |
Returns | ElementTag |
Description | Returns the display name of the player, which may contain
prefixes and suffixes, colors, etc. |
Mechanism | This tag can be modified using mechanism/PlayerTag.display_name |
Name | <PlayerTag.inventory> |
Returns | InventoryTag |
Description | Returns a InventoryTag of the player's current inventory.
Works with offline players. |
Name | <PlayerTag.enderchest> |
Returns | InventoryTag |
Description | Gets the player's enderchest inventory.
Works with offline players. |
Name | <PlayerTag.open_inventory> |
Returns | InventoryTag |
Description | Gets the inventory the player currently has open. If the player has no open
inventory, this returns the player's inventory. |
Name | <PlayerTag.discovered_recipes> |
Returns | ListTag |
Description | Returns a list of the recipes the player has discovered, in the Namespace:Key format, for example "minecraft:gold_nugget".
|
Name | <PlayerTag.selected_trade_index> |
Returns | ElementTag(Number) |
Description | Returns the index of the trade the player is currently viewing, if any.
|
Name | <PlayerTag.item_on_cursor> |
Returns | ItemTag |
Description | Returns the item on the player's cursor, if any. This includes
chest interfaces, inventories, and hotbars, etc. |
Mechanism | This tag can be modified using mechanism/PlayerTag.item_on_cursor |
Name | <PlayerTag.held_item_slot> |
Returns | ElementTag(Number) |
Description | Returns the slot location of the player's selected item.
|
Name | <PlayerTag.sidebar_lines> |
Returns | ListTag |
Description | Returns the current lines set on the player's Sidebar via the Sidebar command.
|
Name | <PlayerTag.sidebar_title> |
Returns | ElementTag |
Description | Returns the current title set on the player's Sidebar via the Sidebar command.
|
Name | <PlayerTag.sidebar_scores> |
Returns | ListTag |
Description | Returns the current scores set on the player's Sidebar via the Sidebar command,
in the same order as tag/PlayerTag.sidebar_lines. |
Name | <PlayerTag.skin_blob> |
Returns | ElementTag |
Description | Returns the player's current skin blob.
|
Mechanism | This tag can be modified using mechanism/PlayerTag.skin_blob |
Name | <PlayerTag.attack_cooldown_duration> |
Returns | DurationTag |
Description | Returns the amount of time that passed since the start of the attack cooldown.
|
Mechanism | This tag can be modified using mechanism/PlayerTag.attack_cooldown |
Name | <PlayerTag.attack_cooldown_max_duration> |
Returns | DurationTag |
Description | Returns the maximum amount of time that can pass before the player's main hand has returned
to its original place after the cooldown has ended. NOTE: This is slightly inaccurate and may not necessarily match with the actual attack cooldown progress. |
Mechanism | This tag can be modified using mechanism/PlayerTag.attack_cooldown |
Name | <PlayerTag.attack_cooldown_percent> |
Returns | ElementTag(Decimal) |
Description | Returns the progress of the attack cooldown. 0 means that the attack cooldown has just
started, while 100 means that the attack cooldown has finished. NOTE: This may not match exactly with the clientside attack cooldown indicator. |
Mechanism | This tag can be modified using mechanism/PlayerTag.attack_cooldown_percent |
Name | <PlayerTag.selected_npc> |
Returns | NPCTag |
Description | Returns the NPCTag that the player currently has selected with
'/npc select', null if no player selected. |
Name | <PlayerTag.entity> |
Returns | EntityTag |
Description | Returns the EntityTag object of the player.
(Note: This should never actually be needed. <PlayerTag> is considered a valid EntityTag by script commands.) |
Name | <PlayerTag.ip> |
Returns | ElementTag |
Description | Returns the player's IP address host name.
|
Name | <PlayerTag.ip.address_only> |
Returns | ElementTag |
Description | Returns the player's IP address.
|
Name | <PlayerTag.ip.address> |
Returns | ElementTag |
Description | Returns the player's IP address.
|
Name | <PlayerTag.nameplate> |
Returns | ElementTag |
Description | Returns the displayed text in the nameplate of the player.
|
Name | <PlayerTag.compass_target> |
Returns | LocationTag |
Description | Returns the location of the player's compass target.
|
Name | <PlayerTag.chunk_loaded[<chunk>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has the chunk loaded on their client.
|
Name | <PlayerTag.can_fly> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is allowed to fly.
|
Mechanism | This tag can be modified using mechanism/PlayerTag.can_fly |
Name | <PlayerTag.fly_speed> |
Returns | ElementTag(Decimal) |
Description | Returns the speed the player can fly at.
|
Mechanism | This tag can be modified using mechanism/PlayerTag.fly_speed |
Name | <PlayerTag.walk_speed> |
Returns | ElementTag(Decimal) |
Description | Returns the speed the player can walk at.
|
Mechanism | This tag can be modified using mechanism/PlayerTag.walk_speed |
Name | <PlayerTag.saturation> |
Returns | ElementTag(Decimal) |
Description | Returns the current saturation of the player.
|
Mechanism | This tag can be modified using mechanism/PlayerTag.saturation |
Name | <PlayerTag.formatted_food_level[(<max>)]> |
Returns | ElementTag |
Description | Returns a 'formatted' value of the player's current food level.
May be 'starving', 'famished', 'parched, 'hungry', or 'healthy'. |
Mechanism | This tag can be modified using mechanism/PlayerTag.food_level |
Name | <PlayerTag.food_level> |
Returns | ElementTag(Number) |
Description | Returns the current food level of the player.
|
Mechanism | This tag can be modified using mechanism/PlayerTag.food_level |
Name | <PlayerTag.gamemode> |
Returns | ElementTag |
Description | Returns the name of the gamemode the player is currently set to.
|
Mechanism | This tag can be modified using mechanism/PlayerTag.gamemode |
Name | <PlayerTag.is_blocking> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is currently blocking.
|
Name | <PlayerTag.ping> |
Returns | ElementTag(Number) |
Description | Returns the player's current ping.
|
Name | <PlayerTag.is_flying> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is currently flying.
|
Name | <PlayerTag.is_sleeping> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is currently sleeping.
|
Name | <PlayerTag.is_sneaking> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is currently sneaking.
|
Name | <PlayerTag.is_sprinting> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is currently sprinting.
|
Name | <PlayerTag.has_advancement[<advancement>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has completed the specified advancement.
|
Name | <PlayerTag.list_advancements> |
Returns | ListTag |
Description | Returns a list of the names of all advancements the player has completed.
|
Name | <PlayerTag.statistic[<statistic>]> |
Returns | ElementTag(Number) |
Description | Returns the player's current value for the specified statistic.
Valid statistics: url/https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Statistic.html |
Name | <PlayerTag.statistic[<statistic>].qualifier[<material>/<entity>]> |
Returns | ElementTag(Number) |
Description | Returns the player's current value for the specified statistic, with the
specified qualifier, which can be either an entity or material. Valid statistics: url/https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Statistic.html To check a statistic type dynamically, refer to tag/server.statistic_type. |
Name | <PlayerTag.time_asleep> |
Returns | DurationTag |
Description | Returns the time the player has been asleep.
|
Name | <PlayerTag.time> |
Returns | ElementTag(Number) |
Description | Returns the time the player is currently experiencing. This time could differ from
the time that the rest of the world is currently experiencing if a 'time' or 'freeze_time' mechanism is being used on the player. |
Mechanism | This tag can be modified using mechanism/PlayerTag.time |
Name | <PlayerTag.weather> |
Returns | ElementTag |
Description | Returns the type of weather the player is experiencing. This will be different
from the weather currently in the world that the player is residing in if the weather is currently being forced onto the player. Returns null if the player does not currently have any forced weather. |
Mechanism | This tag can be modified using mechanism/PlayerTag.weather |
Name | <PlayerTag.xp_level> |
Returns | ElementTag(Number) |
Description | Returns the number of XP levels the player has.
|
Name | <PlayerTag.xp_to_next_level> |
Returns | ElementTag(Number) |
Description | Returns the amount of XP the player needs to get to the next level.
|
Name | <PlayerTag.xp_total> |
Returns | ElementTag(Number) |
Description | Returns the total amount of experience points the player has.
|
Name | <PlayerTag.xp> |
Returns | ElementTag(Decimal) |
Description | Returns the percentage of experience points to the next level.
|
Name | <PlayerTag.chat_prefix> |
Returns | ElementTag |
Description | Returns the player's chat prefix.
NOTE: May work with offline players. Requires a Vault-compatible chat plugin. |
Mechanism | This tag can be modified using mechanism/PlayerTag.chat_prefix |
Note | This tag requires the plugin(s) Vault! |
Name | <PlayerTag.chat_suffix> |
Returns | ElementTag |
Description | Returns the player's chat suffix.
NOTE: May work with offline players. Requires a Vault-compatible chat plugin. |
Mechanism | This tag can be modified using mechanism/PlayerTag.chat_suffix |
Note | This tag requires the plugin(s) Vault! |
Name | <PlayerTag.fake_block_locations> |
Returns | ListTag(LocationTag) |
Description | Returns a list of locations that the player will see a fake block at, as set by command/showfake or connected commands.
|
Name | <PlayerTag.fake_block[<location>]> |
Returns | MaterialTag |
Description | Returns the fake material that the player will see at the input location, as set by command/showfake or connected commands.
Works best alongside tag/PlayerTag.fake_block_locations. Returns null if the player doesn't have a fake block at the location. |
Name | <PluginTag.name> |
Returns | ElementTag |
Description | Gets the name of this plugin.
|
Name | <PluginTag.version> |
Returns | ElementTag |
Description | Gets the version for the plugin specified.
|
Name | <PluginTag.description> |
Returns | ElementTag |
Description | Gets the description for the plugin specified.
|
Name | <PluginTag.authors> |
Returns | ListTag |
Description | Gets the list of authors for the plugin specified.
|
Name | <PluginTag.type> |
Returns | ElementTag |
Description | Always returns 'Plugin' for PluginTag objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Name | <WorldTag.entities> |
Returns | ListTag(EntityTag) |
Description | Returns a list of entities in this world.
|
Name | <WorldTag.living_entities> |
Returns | ListTag(EntityTag) |
Description | Returns a list of living entities in this world.
|
Name | <WorldTag.players> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of online players in this world.
|
Name | <WorldTag.spawned_npcs> |
Returns | ListTag(NPCTag) |
Description | Returns a list of spawned NPCs in this world.
|
Name | <WorldTag.npcs> |
Returns | ListTag(NPCTag) |
Description | Returns a list of all NPCs in this world.
|
Name | <WorldTag.can_generate_structures> |
Returns | ElementTag(Boolean) |
Description | Returns whether the world will generate structures.
|
Name | <WorldTag.loaded_chunks> |
Returns | ListTag(ChunkTag) |
Description | Returns a list of all the currently loaded chunks.
|
Name | <WorldTag.random_loaded_chunk> |
Returns | ChunkTag |
Description | Returns a random loaded chunk.
|
Name | <WorldTag.sea_level> |
Returns | ElementTag(Number) |
Description | Returns the level of the sea.
|
Name | <WorldTag.spawn_location> |
Returns | LocationTag |
Description | Returns the spawn location of the world.
|
Mechanism | This tag can be modified using mechanism/WorldTag.spawn_location |
Name | <WorldTag.name> |
Returns | ElementTag |
Description | Returns the name of the world.
|
Name | <WorldTag.seed> |
Returns | ElementTag |
Description | Returns the world seed.
|
Name | <WorldTag.allows_animals> |
Returns | ElementTag(Boolean) |
Description | Returns whether animals can spawn in this world.
|
Name | <WorldTag.allows_monsters> |
Returns | ElementTag(Boolean) |
Description | Returns whether monsters can spawn in this world.
|
Name | <WorldTag.allows_pvp> |
Returns | ElementTag(Boolean) |
Description | Returns whether player versus player combat is allowed in this world.
|
Name | <WorldTag.auto_save> |
Returns | ElementTag(Boolean) |
Description | Returns whether the world automatically saves.
|
Mechanism | This tag can be modified using mechanism/WorldTag.auto_save |
Name | <WorldTag.ambient_spawn_limit> |
Returns | ElementTag(Number) |
Description | Returns the number of ambient mobs that can spawn in a chunk in this world.
|
Mechanism | This tag can be modified using mechanism/WorldTag.ambient_spawn_limit |
Name | <WorldTag.animal_spawn_limit> |
Returns | ElementTag(Number) |
Description | Returns the number of animals that can spawn in a chunk in this world.
|
Mechanism | This tag can be modified using mechanism/WorldTag.animal_spawn_limit |
Name | <WorldTag.monster_spawn_limit> |
Returns | ElementTag(Number) |
Description | Returns the number of monsters that can spawn in a chunk in this world.
|
Mechanism | This tag can be modified using mechanism/WorldTag.monster_spawn_limit |
Name | <WorldTag.water_animal_spawn_limit> |
Returns | ElementTag(Number) |
Description | Returns the number of water animals that can spawn in a chunk in this world.
|
Mechanism | This tag can be modified using mechanism/WorldTag.water_animal_spawn_limit |
Name | <WorldTag.difficulty> |
Returns | ElementTag |
Description | Returns the name of the difficulty level.
|
Mechanism | This tag can be modified using mechanism/WorldTag.difficulty |
Name | <WorldTag.keep_spawn> |
Returns | ElementTag(Boolean) |
Description | Returns whether the world's spawn area should be kept loaded into memory.
|
Mechanism | This tag can be modified using mechanism/WorldTag.keep_spawn |
Name | <WorldTag.max_height> |
Returns | ElementTag(Number) |
Description | Returns the maximum height of this world.
|
Name | <WorldTag.ticks_per_animal_spawn> |
Returns | DurationTag |
Description | Returns the world's ticks per animal spawn value.
|
Mechanism | This tag can be modified using mechanism/WorldTag.ticks_per_animal_spawns |
Name | <WorldTag.ticks_per_monster_spawn> |
Returns | DurationTag |
Description | Returns the world's ticks per monster spawn value.
|
Mechanism | This tag can be modified using mechanism/WorldTag.ticks_per_monster_spawns |
Name | <WorldTag.time> |
Returns | ElementTag(Number) |
Description | Returns the relative in-game time of this world.
|
Mechanism | This tag can be modified using mechanism/WorldTag.time |
Name | <WorldTag.time.duration> |
Returns | DurationTags |
Description | Returns the relative in-game time of this world as a duration.
|
Name | <WorldTag.time.full> |
Returns | DurationTag |
Description | Returns the in-game time of this world.
|
Name | <WorldTag.time.period> |
Returns | ElementTag |
Description | Returns the time as 'day', 'night', 'dawn', or 'dusk'.
|
Name | <WorldTag.moon_phase> |
Returns | ElementTag(Number) |
Description | Returns the current phase of the moon, as an integer from 1 to 8.
|
Name | <WorldTag.has_storm> |
Returns | ElementTag(Boolean) |
Description | Returns whether there is currently a storm in this world.
ie, whether it is raining. To check for thunder, use tag/WorldTag.thundering. |
Name | <WorldTag.thunder_duration> |
Returns | DurationTag |
Description | Returns the duration of thunder.
|
Mechanism | This tag can be modified using mechanism/WorldTag.thunder_duration |
Name | <WorldTag.thundering> |
Returns | ElementTag(Boolean) |
Description | Returns whether it is currently thundering in this world.
|
Mechanism | This tag can be modified using mechanism/WorldTag.thundering |
Name | <WorldTag.weather_duration> |
Returns | DurationTag |
Description | Returns the duration of storms.
|
Mechanism | This tag can be modified using mechanism/WorldTag.weather_duration |
Name | <WorldTag.environment> |
Returns | ElementTag |
Description | Returns the environment of the world: NORMAL, NETHER, or THE_END.
|
Name | <WorldTag.type> |
Returns | ElementTag |
Description | Always returns 'World' for WorldTag objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Name | <WorldTag.border_size> |
Returns | ElementTag |
Description | returns the size of the world border in this world.
|
Name | <WorldTag.border_center> |
Returns | LocationTag |
Description | returns the center of the world border in this world.
|
Name | <WorldTag.border_damage> |
Returns | ElementTag |
Description | returns the size of the world border in this world.
|
Name | <WorldTag.border_damage_buffer> |
Returns | ElementTag |
Description | returns the damage buffer of the world border in this world.
|
Name | <WorldTag.border_warning_distance> |
Returns | ElementTag |
Description | returns the warning distance of the world border in this world.
|
Name | <WorldTag.border_warning_time> |
Returns | DurationTag |
Description | returns warning time of the world border in this world as a duration.
|
Name | <WorldTag.gamerule[<gamerule>]> |
Returns | ElementTag |
Description | returns the current value of the specified gamerule in the world.
Note that the name is case-sensitive... so "doFireTick" is correct, but "dofiretick" is not. |
Name | <ElementTag.as_chunk> |
Returns | ChunkTag |
Description | Returns the element as a chunk. Note: the value must be a valid chunk.
|
Group | conversion |
Name | <ElementTag.as_color> |
Returns | ColorTag |
Description | Returns the element as a ColorTag. Note: the value must be a valid color.
|
Group | conversion |
Name | <ElementTag.as_cuboid> |
Returns | CuboidTag |
Description | Returns the element as a cuboid. Note: the value must be a valid cuboid.
|
Group | conversion |
Name | <ElementTag.as_entity> |
Returns | EntityTag |
Description | Returns the element as an entity. Note: the value must be a valid entity.
|
Group | conversion |
Name | <ElementTag.as_inventory> |
Returns | InventoryTag |
Description | Returns the element as an inventory. Note: the value must be a valid inventory.
|
Group | conversion |
Name | <ElementTag.as_item> |
Returns | ItemTag |
Description | Returns the element as an item. Note: the value must be a valid item.
|
Group | conversion |
Name | <ElementTag.as_location> |
Returns | LocationTag |
Description | Returns the element as a location. Note: the value must be a valid location.
|
Group | conversion |
Name | <ElementTag.as_material> |
Returns | MaterialTag |
Description | Returns the element as a material. Note: the value must be a valid material.
|
Group | conversion |
Name | <ElementTag.as_npc> |
Returns | NPCTag |
Description | Returns the element as an NPC. Note: the value must be a valid NPC.
|
Group | conversion |
Name | <ElementTag.as_player> |
Returns | PlayerTag |
Description | Returns the element as a player. Note: the value must be a valid player. Can be online or offline.
|
Group | conversion |
Name | <ElementTag.as_world> |
Returns | WorldTag |
Description | Returns the element as a world.
|
Group | conversion |
Name | <ElementTag.as_plugin> |
Returns | PluginTag |
Description | Returns the element as a plugin. Note: the value must be a valid plugin.
|
Group | conversion |
Name | <ElementTag.last_color> |
Returns | ElementTag |
Description | Returns the ChatColors used last in an element.
|
Group | text checking |
Name | <ElementTag.format[<script>]> |
Returns | ElementTag |
Description | Returns the text re-formatted according to a format script.
|
Group | text manipulation |
Name | <ElementTag.strip_color> |
Returns | ElementTag |
Description | Returns the element with all color encoding stripped.
|
Group | text manipulation |
Name | <ElementTag.parse_color[<prefix>]> |
Returns | ElementTag |
Description | Returns the element with all color codes parsed.
Optionally, specify a character to prefix the color ids. Defaults to '&' if not specified. |
Group | text manipulation |
Name | <ElementTag.to_itemscript_hash> |
Returns | ElementTag |
Description | Shortens the element down to an itemscript hash ID, made of invisible color codes.
|
Group | conversion |
Name | <ElementTag.to_secret_colors> |
Returns | ElementTag |
Description | Hides the element's text in invisible color codes.
Inverts tag/ElementTag.from_secret_colors. |
Group | conversion |
Name | <ElementTag.from_secret_colors> |
Returns | ElementTag |
Description | Un-hides the element's text from invisible color codes back to normal text.
Inverts tag/ElementTag.to_secret_colors. |
Group | conversion |
Name | <ElementTag.to_raw_json> |
Returns | ElementTag |
Description | Converts normal colored text to Minecraft-style "raw JSON" format.
Inverts tag/ElementTag.from_raw_json. |
Group | conversion |
Name | <ElementTag.from_raw_json> |
Returns | ElementTag |
Description | Un-hides the element's text from invisible color codes back to normal text.
Inverts tag/ElementTag.to_raw_json. |
Group | conversion |
Name | <ElementTag.on_hover[<message>]> |
Returns | ElementTag |
Description | Adds a hover message to the element, which makes the element display the input hover text when the mouse is left over it.
This tag works for chat outputs and books. It does not work in other places (inside an item, title command, etc. this is not valid). |
Group | text manipulation |
Name | <ElementTag.on_hover[<message>].type[<type>]> |
Returns | ElementTag |
Description | Adds a hover message to the element, which makes the element display the input hover text when the mouse is left over it.
Optionally specify the hover type as one of: SHOW_TEXT, SHOW_ACHIEVEMENT, SHOW_ITEM, or SHOW_ENTITY. Note: for "SHOW_ITEM", replace the text with a valid ItemTag. For "SHOW_ENTITY", replace the text with a valid spawned EntityTag (requires F3+H to see entities). This tag works for chat outputs and books. It does not work in other places (inside an item, title command, etc. this is not valid). |
Group | text manipulation |
Name | <ElementTag.on_click[<click command>]> |
Returns | ElementTag |
Description | Adds a click command to the element, which makes the element execute the input command when clicked.
This tag works for chat outputs and books. It does not work in other places (inside an item, title command, etc. this is not valid). |
Group | text manipulation |
Name | <ElementTag.on_click[<message>].type[<type>]> |
Returns | ElementTag |
Description | Adds a click command to the element, which makes the element execute the input command when clicked.
Optionally specify the hover type as one of: OPEN_URL, OPEN_FILE, RUN_COMMAND, SUGGEST_COMMAND, or CHANGE_PAGE. This tag works for chat outputs and books. It does not work in other places (inside an item, title command, etc. this is not valid). |
Group | text manipulation |
Name | <ElementTag.with_insertion[<message>]> |
Returns | ElementTag |
Description | Adds an insertion message to the element, which makes the element insert the input message to chat when shift-clicked.
This tag works for chat outputs and books. It does not work in other places (inside an item, title command, etc. this is not valid). |
Group | text manipulation |
Name | <ElementTag.no_reset> |
Returns | ElementTag |
Description | Makes a color code (&0123456789abcdef) not reset other formatting details.
Use like '<&c.no_reset>' or '<red.no_reset>'. This tag works for chat outputs and books. It does not work in other places (inside an item, title command, etc. this is not valid). |
Group | text manipulation |
Name | <ElementTag.end_format> |
Returns | ElementTag |
Description | Makes a chat format code (&klmno) be the end of a format, as opposed to the start.
Use like '<&o.end_format>' or '<italic.end_format>'. This tag works for chat outputs and books. It does not work in other places (inside an item, title command, etc. this is not valid). |
Group | text manipulation |
Name | <ElementTag.italicize> |
Returns | ElementTag |
Description | Makes the input text italic. Equivalent to "<&o><ELEMENT_HERE><&o.end_format>"
This tag works for chat outputs and books. It does not work in other places (inside an item, title command, etc. this is not valid). |
Group | text manipulation |
Name | <ElementTag.bold> |
Returns | ElementTag |
Description | Makes the input text bold. Equivalent to "<&l><ELEMENT_HERE><&l.end_format>"
This tag works for chat outputs and books. It does not work in other places (inside an item, title command, etc. this is not valid). |
Group | text manipulation |
Name | <ElementTag.underline> |
Returns | ElementTag |
Description | Makes the input text underlined. Equivalent to "<&n><ELEMENT_HERE><&n.end_format>"
This tag works for chat outputs and books. It does not work in other places (inside an item, title command, etc. this is not valid). |
Group | text manipulation |
Name | <ElementTag.strikethrough> |
Returns | ElementTag |
Description | Makes the input text struck-through. Equivalent to "<&m><ELEMENT_HERE><&m.end_format>"
This tag works for chat outputs and books. It does not work in other places (inside an item, title command, etc. this is not valid). |
Group | text manipulation |
Name | <ElementTag.obfuscate> |
Returns | ElementTag |
Description | Makes the input text obfuscated. Equivalent to "<&k><ELEMENT_HERE><&k.end_format>"
This tag works for chat outputs and books. It does not work in other places (inside an item, title command, etc. this is not valid). |
Group | text manipulation |
Name | <ElementTag.color[<color>]> |
Returns | ElementTag |
Description | Makes the input text colored by the input color. Equivalent to "<COLOR><ELEMENT_HERE><COLOR.end_format>"
Color can be either a color name, or code. That is: ".color[gold]" and ".color[6]" are both valid. This tag works for chat outputs and books. It does not work in other places (inside an item, title command, etc. this is not valid). |
Group | text manipulation |
Name | <ListTag.formatted> |
Returns | ElementTag |
Description | Returns the list in a human-readable format.
EG, a list of "n@3|p@bob|potato" will return "GuardNPC, bob, and potato". |
Name | <QueueTag.npc> |
Returns | NPCTag |
Description | Returns the NPCTag linked to a queue.
|
Mechanism | This tag can be modified using mechanism/ScriptQueue.linked_npc |
Name | <QueueTag.player> |
Returns | PlayerTag |
Description | Returns the PlayerTag linked to a queue.
|
Mechanism | This tag can be modified using mechanism/ScriptQueue.linked_player |
Name | <ScriptTag.cooled_down[<player>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the script is currently cooled down for the player. Any global
cooldown present on the script will also be taken into account. Not specifying a player will result in using the attached player available in the script entry. Not having a valid player will result in 'null'. |
Name | <ScriptTag.cooldown[<player>]> |
Returns | DurationTag |
Description | Returns the time left for the player to cooldown for the script.
|
Name | <ScriptTag.step[<player>]> |
Returns | ElementTag |
Description | Returns the name of a script step that the player is currently on.
Must be an INTERACT script. |
Name | <EntityTag.has_ai> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity uses the default Minecraft AI to roam and look around.
This tends to have implications for other vanilla functionality, including gravity. This generally shouldn't be used with NPCs. NPCs do not have vanilla AI, regardless of what this tag returns. Other programmatic methods of blocking AI might also not be accounted for by this tag. |
Mechanism | This tag can be modified using mechanism/EntityTag.has_ai |
Group | attributes |
Name | <EntityTag.age> |
Returns | ElementTag(Number) |
Description | If the entity is ageable, returns the entity's age number (-24000 to 0)
|
Mechanism | This tag can be modified using mechanism/EntityTag.age |
Group | properties |
Name | <EntityTag.is_age_locked> |
Returns | ElementTag(Boolean) |
Description | If the entity is ageable, returns whether the entity is age locked.
|
Mechanism | This tag can be modified using mechanism/EntityTag.age_lock |
Group | properties |
Name | <EntityTag.is_baby> |
Returns | ElementTag(Boolean) |
Description | If the entity is ageable, returns whether the entity is a baby.
|
Mechanism | This tag can be modified using mechanism/EntityTag.age |
Group | properties |
Name | <EntityTag.anger> |
Returns | ElementTag(Number) |
Description | Returns the anger level of a PigZombie.
|
Mechanism | This tag can be modified using mechanism/EntityTag.anger |
Group | properties |
Name | <EntityTag.angry> |
Returns | ElementTag(Boolean) |
Description | If the entity is a wolf, returns whether the wolf is angry.
|
Mechanism | This tag can be modified using mechanism/EntityTag.angry |
Group | properties |
Name | <EntityTag.base_potion> |
Returns | ElementTag |
Description | Returns the Area Effect Cloud's base potion data.
In the format Type,Upgraded,Extended |
Mechanism | This tag can be modified using mechanism/EntityTag.base_potion |
Group | properties |
Name | <EntityTag.base_potion.type> |
Returns | ElementTag |
Description | Returns the Area Effect Cloud's base potion type.
|
Group | properties |
Name | <EntityTag.base_potion.is_upgraded> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Area Effect Cloud's base potion is upgraded.
|
Group | properties |
Name | <EntityTag.base_potion.is_extended> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Area Effect Cloud's base potion is extended.
|
Group | properties |
Name | <EntityTag.particle> |
Returns | ElementTag |
Description | Returns the Area Effect Cloud's particle.
|
Mechanism | This tag can be modified using mechanism/EntityTag.particle |
Group | properties |
Name | <EntityTag.particle.color> |
Returns | ColorTag |
Description | Returns the Area Effect Cloud's particle color.
|
Group | properties |
Name | <EntityTag.duration> |
Returns | DurationTag |
Description | Returns the Area Effect Cloud's duration.
|
Mechanism | This tag can be modified using mechanism/EntityTag.duration |
Group | properties |
Name | <EntityTag.duration.on_use> |
Returns | DurationTag |
Description | Returns the duration the Area Effect Cloud
will increase by when it applies an effect to an entity. |
Group | properties |
Name | <EntityTag.radius> |
Returns | ElementTag(Decimal) |
Description | Returns the Area Effect Cloud's radius.
|
Mechanism | This tag can be modified using mechanism/EntityTag.radius |
Group | properties |
Name | <EntityTag.radius.on_use> |
Returns | ElementTag(Decimal) |
Description | Returns the amount the Area Effect Cloud's radius
will increase by when it applies an effect to an entity. |
Group | properties |
Name | <EntityTag.radius.per_tick> |
Returns | ElementTag(Decimal) |
Description | Returns the amount the Area Effect Cloud's radius
will increase by every tick. |
Group | properties |
Name | <EntityTag.reapplication_delay> |
Returns | DurationTag |
Description | Returns the duration an entity will be immune
from the Area Effect Cloud's subsequent exposure. |
Mechanism | This tag can be modified using mechanism/EntityTag.reapplication_delay |
Group | properties |
Name | <EntityTag.wait_time> |
Returns | DurationTag |
Description | Returns the duration an entity must be exposed to
the Area Effect Cloud before its effect is applied. |
Mechanism | This tag can be modified using mechanism/EntityTag.wait_time |
Group | properties |
Name | <EntityTag.has_custom_effect[<effect>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Area Effect Cloud has a specified effect.
If no effect is specified, returns whether it has any custom effect. |
Mechanism | This tag can be modified using mechanism/EntityTag.custom_effects |
Group | properties |
Name | <EntityTag.source> |
Returns | EntityTag |
Description | Returns the source of the Area Effect Cloud.
|
Mechanism | This tag can be modified using mechanism/EntityTag.source |
Group | properties |
Name | <EntityTag.custom_effects> |
Returns | ListTag |
Description | Returns a ListTag of the Area Effect Cloud's custom effects
In the form Type,Amplifier,Duration,Ambient,Particles|... |
Mechanism | This tag can be modified using mechanism/EntityTag.custom_effects |
Group | properties |
Name | <EntityTag.custom_effects[<#>].type> |
Returns | ElementTag |
Description | Returns the specified Area Effect Cloud potion effect type.
|
Group | properties |
Name | <EntityTag.custom_effects[<#>].amplifier> |
Returns | ElementTag(Number) |
Description | Returns the specified Area Effect Cloud potion effect amplifier.
|
Group | properties |
Name | <EntityTag.custom_effects[<#>].duration> |
Returns | DurationTag |
Description | Returns the specified Area Effect Cloud potion effect duration.
|
Group | properties |
Name | <EntityTag.custom_effects[<#>].has_particles> |
Returns | ElementTag(Boolean) |
Description | Returns whether the specified Area Effect Cloud potion effect has particles.
|
Group | properties |
Name | <EntityTag.custom_effects[<#>].is_ambient> |
Returns | ElementTag(Boolean) |
Description | Returns whether the specified Area Effect Cloud potion effect is ambient.
|
Group | properties |
Name | <EntityTag.armor_bonus> |
Returns | ElementTag(Decimal) |
Description | Returns the entity's base armor bonus.
|
Mechanism | This tag can be modified using mechanism/EntityTag.armor_bonus |
Group | attributes |
Name | <EntityTag.armor_pose_list> |
Returns | ListTag |
Description | Returns a list of all poses and angles for the armor stand in the
format: PART|ANGLE|... For example, head|4.5,3,4.5|body|5.4,3.2,1 Angles are in radians! |
Mechanism | This tag can be modified using mechanism/EntityTag.armor_pose |
Group | attributes |
Name | <EntityTag.armor_pose[<part>]> |
Returns | LocationTag |
Description | Returns the current angle pose for the specified part.
Valid parts: HEAD, BODY, LEFT_ARM, RIGHT_ARM, LEFT_LEG, RIGHT_LEG Angles are in radians! |
Mechanism | This tag can be modified using mechanism/EntityTag.armor_pose |
Group | attributes |
Name | <EntityTag.arms> |
Returns | ElementTag(Boolean) |
Description | If the entity is an armor stand, returns whether the armor stand has arms.
|
Mechanism | This tag can be modified using mechanism/EntityTag.arms |
Group | properties |
Name | <EntityTag.damage> |
Returns | ElementTag(Decimal) |
Description | Returns the damage that the arrow/trident will inflict.
NOTE: The actual damage dealt by the arrow/trident may be different depending on the projectile's flight speed. |
Mechanism | This tag can be modified using mechanism/EntityTag.damage |
Group | properties |
Name | <EntityTag.attributes> |
Returns | ListTag |
Description | Returns a list of all attributes on the entity, formatted in a way that can be sent back into the 'attributes' mechanism.
|
Mechanism | This tag can be modified using mechanism/EntityTag.attributes |
Group | properties |
Name | <EntityTag.has_attribute[<attribute>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity has the named attribute.
Valid attribute names are listed at url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/attribute/Attribute.html |
Mechanism | This tag can be modified using mechanism/EntityTag.attributes |
Group | properties |
Name | <EntityTag.attribute_value[<attribute>]> |
Returns | ElementTag(Decimal) |
Description | Returns the final calculated value of the named attribute for the entity.
See also tag/EntityTag.has_attribute. Valid attribute names are listed at url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/attribute/Attribute.html |
Mechanism | This tag can be modified using mechanism/EntityTag.attributes |
Group | properties |
Name | <EntityTag.attribute_base_value[<attribute>]> |
Returns | ElementTag(Decimal) |
Description | Returns the base value of the named attribute for the entity.
See also tag/EntityTag.has_attribute. Valid attribute names are listed at url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/attribute/Attribute.html |
Mechanism | This tag can be modified using mechanism/EntityTag.attributes |
Group | properties |
Name | <EntityTag.attribute_default_value[<attribute>]> |
Returns | ElementTag(Decimal) |
Description | Returns the default value of the named attribute for the entity.
See also tag/EntityTag.has_attribute. Valid attribute names are listed at url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/attribute/Attribute.html |
Mechanism | This tag can be modified using mechanism/EntityTag.attributes |
Group | properties |
Name | <EntityTag.base_plate> |
Returns | ElementTag(Boolean) |
Description | If the entity is an armor stand, returns whether the armor stand has a base plate.
|
Mechanism | This tag can be modified using mechanism/EntityTag.base_plate |
Group | properties |
Name | <EntityTag.beam_target> |
Returns | LocationTag |
Description | Returns the target location of the ender crystal's beam, if any.
|
Mechanism | This tag can be modified using mechanism/EntityTag.beam_target |
Group | properties |
Name | <EntityTag.boat_type> |
Returns | ElementTag |
Description | Returns the wood type of the boat.
Valid wood types: GENERIC, REDWOOD, BIRCH, JUNGLE, ACACIA, DARK_OAK. |
Mechanism | This tag can be modified using mechanism/EntityTag.boat_type |
Group | properties |
Name | <EntityTag.body_arrows> |
Returns | ElementTag(Number) |
Description | Returns the number of arrows stuck in the entity's body.
Note: Body arrows will only be visible for players or player-type npcs. |
Mechanism | This tag can be modified using mechanism/EntityTag.body_arrows |
Group | properties |
Name | <EntityTag.bounding_box> |
Returns | ListTag(LocationTag) |
Description | Returns the collision bounding box of the entity in the format "<low>|<high>", essentially a cuboid with decimals.
|
Mechanism | This tag can be modified using mechanism/EntityTag.bounding_box |
Group | properties |
Name | <EntityTag.carries_chest> |
Returns | ElementTag(Boolean) |
Description | If the entity is a horse, returns whether it is carrying a chest.
|
Mechanism | This tag can be modified using mechanism/EntityTag.carries_chest |
Group | properties |
Name | <EntityTag.color> |
Returns | ElementTag |
Description | If the entity can have a color, returns the entity's color.
For the available color options, refer to language/Entity Color Types. |
Mechanism | This tag can be modified using mechanism/EntityTag.color |
Group | properties |
Name | <EntityTag.critical> |
Returns | ElementTag(Boolean) |
Description | If the entity is an arrow or trident, returns whether the arrow/trident is critical.
|
Mechanism | This tag can be modified using mechanism/EntityTag.critical |
Group | properties |
Name | <EntityTag.custom_name_visible> |
Returns | ElementTag(Boolean) |
Description | Returns true if the entity's custom name is visible.
|
Mechanism | This tag can be modified using mechanism/EntityTag.custom_name_visible |
Group | attributes |
Name | <EntityTag.custom_name> |
Returns | ElementTag |
Description | Returns the entity's custom name, if any.
|
Mechanism | This tag can be modified using mechanism/EntityTag.custom_name |
Group | attributes |
Name | <EntityTag.disabled_slots.raw> |
Returns | ElementTag(Number) |
Description | If the entity is an armor stand, returns its raw disabled slots value.
See url/https://minecraft.gamepedia.com/Armor_Stand/ED |
Mechanism | This tag can be modified using mechanism/EntityTag.disabled_slots_raw |
Group | properties |
Name | <EntityTag.disabled_slots> |
Returns | ListTag |
Description | If the entity is an armor stand, returns a list of its disabled slots in the form li@slot/action|...
|
Mechanism | This tag can be modified using mechanism/EntityTag.disabled_slots |
Group | properties |
Name | <EntityTag.elder> |
Returns | ElementTag(Boolean) |
Description | If the entity is a guardian, returns whether it is elder.
|
Mechanism | This tag can be modified using mechanism/EntityTag.elder |
Group | properties |
Name | <EntityTag.equipment.boots> |
Returns | ItemTag |
Description | Returns the item the entity is wearing as boots.
|
Group | inventory |
Name | <EntityTag.equipment.chestplate> |
Returns | ItemTag |
Description | Returns the item the entity is wearing as a chestplate.
|
Group | inventory |
Name | <EntityTag.equipment.helmet> |
Returns | ItemTag |
Description | Returns the item the entity is wearing as a helmet.
|
Group | inventory |
Name | <EntityTag.equipment.leggings> |
Returns | ItemTag |
Description | Returns the item the entity is wearing as leggings.
|
Group | inventory |
Name | <EntityTag.equipment> |
Returns | ListTag |
Description | Returns a ListTag containing the entity's equipment.
Output list is boots|leggings|chestplate|helmet |
Mechanism | This tag can be modified using mechanism/EntityTag.equipment |
Group | inventory |
Name | <EntityTag.explosion_fire> |
Returns | ElementTag(Boolean) |
Description | If this entity is explosive, returns whether its explosion creates fire.
|
Mechanism | This tag can be modified using mechanism/EntityTag.explosion_fire |
Group | properties |
Name | <EntityTag.explosion_radius> |
Returns | ElementTag(Decimal) |
Description | If this entity can explode, returns its explosion radius.
|
Mechanism | This tag can be modified using mechanism/EntityTag.explosion_radius |
Group | properties |
Name | <EntityTag.firework_item> |
Returns | ItemTag |
Description | If the entity is a firework, returns the firework item used to launch it.
|
Mechanism | This tag can be modified using mechanism/EntityTag.firework_item |
Group | properties |
Name | <EntityTag.framed_item_rotation> |
Returns | ElementTag |
Description | If the entity is an item frame, returns the rotation of the item currently framed.
|
Mechanism | This tag can be modified using mechanism/EntityTag.framed |
Group | properties |
Name | <EntityTag.framed_item> |
Returns | ItemTag |
Description | If the entity is an item frame, returns the item currently framed.
|
Mechanism | This tag can be modified using mechanism/EntityTag.framed |
Group | properties |
Name | <EntityTag.has_framed_item> |
Returns | ElementTag(Boolean) |
Description | If the entity is an item frame, returns whether the frame has an item in it.
|
Mechanism | This tag can be modified using mechanism/EntityTag.framed |
Group | properties |
Name | <EntityTag.gravity> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity has gravity.
|
Mechanism | This tag can be modified using mechanism/EntityTag.gravity |
Group | properties |
Name | <EntityTag.formatted_health> |
Returns | ElementTag |
Description | Returns a formatted value of the player's current health level.
May be 'dying', 'seriously wounded', 'injured', 'scraped', or 'healthy'. |
Mechanism | This tag can be modified using mechanism/EntityTag.health_data |
Group | attributes |
Name | <EntityTag.health_max> |
Returns | ElementTag(Decimal) |
Description | Returns the maximum health of the entity.
|
Mechanism | This tag can be modified using mechanism/EntityTag.max_health |
Group | attributes |
Name | <EntityTag.health_percentage> |
Returns | ElementTag(Decimal) |
Description | Returns the entity's current health as a percentage.
|
Mechanism | This tag can be modified using mechanism/EntityTag.health |
Group | attributes |
Name | <EntityTag.health> |
Returns | ElementTag(Decimal) |
Description | Returns the current health of the entity.
|
Mechanism | This tag can be modified using mechanism/EntityTag.health |
Group | attributes |
Name | <EntityTag.inventory> |
Returns | InventoryTag |
Description | Returns the entity's inventory, if it has one.
|
Group | inventory |
Name | <EntityTag.invulnerable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is invulnerable (cannot be damaged).
|
Mechanism | This tag can be modified using mechanism/EntityTag.invulnerable |
Group | properties |
Name | <EntityTag.is_showing_bottom> |
Returns | ElementTag(Boolean) |
Description | If the entity is an ender crystal, returns whether the ender crystal has its bottom showing.
|
Mechanism | This tag can be modified using mechanism/EntityTag.is_showing_bottom |
Group | properties |
Name | <EntityTag.item> |
Returns | ItemTag |
Description | If the entity is a dropped item, returns the item represented by the entity.
If the entity is an enderman, returns the item that the enderman is holding. If the entity is a trident, returns the trident item represented by the entity. |
Mechanism | This tag can be modified using mechanism/EntityTag.item |
Group | properties |
Name | <EntityTag.jump_strength> |
Returns | ElementTag(Number) |
Description | Returns the power of a horse's jump.
|
Mechanism | This tag can be modified using mechanism/EntityTag.jump_strength |
Group | properties |
Name | <EntityTag.knockback> |
Returns | ElementTag(Number) |
Description | If the entity is an arrow or trident, returns the knockback strength of the arrow/trident.
|
Mechanism | This tag can be modified using mechanism/EntityTag.knockback |
Group | properties |
Name | <EntityTag.marker> |
Returns | ElementTag(Boolean) |
Description | If the entity is an armor stand, returns whether the armor stand is a marker.
|
Mechanism | This tag can be modified using mechanism/EntityTag.marker |
Group | properties |
Name | <EntityTag.max_fuse_ticks> |
Returns | ElementTag(Number) |
Description | Returns the default number of ticks until the creeper explodes when primed (NOT the time remaining if already primed).
|
Mechanism | This tag can be modified using mechanism/EntityTag.max_fuse_ticks |
Group | properties |
Name | <EntityTag.painting_width> |
Returns | ElementTag |
Description | If the entity is a painting, returns its width.
|
Mechanism | This tag can be modified using mechanism/EntityTag.painting |
Group | properties |
Name | <EntityTag.painting_height> |
Returns | ElementTag |
Description | If the entity is a painting, returns its height.
|
Mechanism | This tag can be modified using mechanism/EntityTag.painting |
Group | properties |
Name | <EntityTag.painting> |
Returns | ElementTag |
Description | If the entity is a painting, returns what art it shows.
|
Mechanism | This tag can be modified using mechanism/EntityTag.painting |
Group | properties |
Name | <EntityTag.pickup_status> |
Returns | ElementTag |
Description | If the entity is an arrow or trident, returns the pickup status of the arrow/trident.
|
Mechanism | This tag can be modified using mechanism/EntityTag.pickup_status |
Group | properties |
Name | <EntityTag.potion> |
Returns | ItemTag |
Description | If the entity is a Tipped Arrow, returns an ItemTag of a potion with the base potion data of the arrow.
If the entity is a Splash Potion, returns an ItemTag of the splash potion's full potion data. |
Mechanism | This tag can be modified using mechanism/EntityTag.potion |
Group | properties |
Name | <EntityTag.list_effects> |
Returns | ListTag |
Description | Returns the list of active potion effects on the entity, in the format: li@TYPE,AMPLIFIER,DURATION,IS_AMBIENT,HAS_PARTICLES,HAS_ICON|...
Note that AMPLIFIER is a number representing the level, and DURATION is a number representing the time, in ticks, it will last for. IS_AMBIENT, HAS_PARTICLES, and HAS_ICON are booleans. |
Mechanism | This tag can be modified using mechanism/EntityTag.potion_effects |
Group | attribute |
Name | <EntityTag.has_effect[<effect>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity has a specified effect.
If no effect is specified, returns whether the entity has any effect. |
Group | attributes |
Name | <EntityTag.powered> |
Returns | ElementTag(Boolean) |
Description | If the entity is a creeper, returns whether the creeper is powered.
|
Mechanism | This tag can be modified using mechanism/EntityTag.powered |
Group | properties |
Name | <EntityTag.profession> |
Returns | ElementTag |
Description | If the entity can have professions, returns the entity's profession.
Currently, only Villager-type and infected zombie entities can have professions. For the list of possible professions, refer to url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/Villager.Profession.html |
Mechanism | This tag can be modified using mechanism/EntityTag.profession |
Group | properties |
Name | <EntityTag.has_pumpkin_head> |
Returns | ElementTag(Boolean) |
Description | If the entity is a snowman, returns whether the snowman has a pumpkin on its head.
|
Mechanism | This tag can be modified using mechanism/EntityTag.has_pumpkin_head |
Group | properties |
Name | <EntityTag.is_using_riptide> |
Returns | ElementTag(Boolean) |
Description | Returns whether this entity is using the Riptide enchantment.
|
Mechanism | This tag can be modified using mechanism/EntityTag.is_using_riptide |
Group | properties |
Name | <EntityTag.rotation_vector> |
Returns | LocationTag |
Description | If the entity can have a rotation, returns the entity's rotation as a direction vector.
Currently, only Hanging-type entities can have rotations. |
Mechanism | This tag can be modified using mechanism/EntityTag.rotation |
Group | properties |
Name | <EntityTag.rotation> |
Returns | ElementTag |
Description | If the entity can have a rotation, returns the entity's rotation.
Currently, only Hanging-type entities can have rotations. |
Mechanism | This tag can be modified using mechanism/EntityTag.rotation |
Group | properties |
Name | <EntityTag.silent> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is silent. (Plays no sounds)
|
Mechanism | This tag can be modified using mechanism/EntityTag.silent |
Group | attributes |
Name | <EntityTag.sitting> |
Returns | ElementTag(Boolean) |
Description | If the entity is a wolf, cat, or parrot, returns whether the animal is sitting.
|
Mechanism | This tag can be modified using mechanism/EntityTag.sitting |
Group | properties |
Name | <EntityTag.size> |
Returns | ElementTag(Number) |
Description | Returns the size of a slime-type entity or a Phantom (1-120).
|
Mechanism | This tag can be modified using mechanism/EntityTag.size |
Group | properties |
Name | <EntityTag.is_small> |
Returns | ElementTag(Boolean) |
Description | Returns whether the armor stand is small.
|
Mechanism | This tag can be modified using mechanism/EntityTag.is_small |
Group | properties |
Name | <EntityTag.speed> |
Returns | ElementTag(Decimal) |
Description | Returns how fast the entity can move.
|
Mechanism | This tag can be modified using mechanism/EntityTag.speed |
Group | attributes |
Name | <EntityTag.spell> |
Returns | ElementTag |
Description | Returns the spell the entity is currently casting.
Can be: url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/Spellcaster.Spell.html |
Mechanism | This tag can be modified using mechanism/EntityTag.spell |
Group | properties |
Name | <EntityTag.is_tamed> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity has been tamed.
|
Mechanism | This tag can be modified using mechanism/EntityTag.tame |
Group | properties |
Name | <EntityTag.owner> |
Returns | PlayerTag |
Description | Returns the owner of a tamed entity.
|
Mechanism | This tag can be modified using mechanism/EntityTag.owner |
Group | properties |
Name | <EntityTag.trades> |
Returns | ListTag(TradeTag) |
Description | Returns a list of the Villager's trade recipes.
|
Mechanism | This tag can be modified using mechanism/EntityTag.trades |
Name | <EntityTag.visible> |
Returns | ElementTag(Boolean) |
Description | Returns whether the armor stand is visible.
|
Mechanism | This tag can be modified using mechanism/EntityTag.visible |
Group | attributes |
Name | <InventoryTag.list_contents> |
Returns | ListTag(ItemTag) |
Description | Returns a list of all items in the inventory.
|
Mechanism | This tag can be modified using mechanism/InventoryTag.contents |
Group | properties |
Name | <InventoryTag.list_contents.simple> |
Returns | ListTag(ItemTag) |
Description | Returns a list of all items in the inventory, without item properties.
|
Mechanism | This tag can be modified using mechanism/InventoryTag.contents |
Group | properties |
Name | <InventoryTag.list_contents.full> |
Returns | ListTag(ItemTag) |
Description | Returns a list of all items in the inventory, with the tag item.full used.
Irrelevant on modern (1.13+) servers. |
Mechanism | This tag can be modified using mechanism/InventoryTag.contents |
Group | properties |
Name | <InventoryTag.list_contents.with_lore[<element>]> |
Returns | ListTag(ItemTag) |
Description | Returns a list of all items in the inventory with the specified
lore. Color codes are ignored. |
Mechanism | This tag can be modified using mechanism/InventoryTag.contents |
Group | properties |
Name | <InventoryTag.list_contents.with_lore[<element>].simple> |
Returns | ListTag(ItemTag) |
Description | Returns a list of all items in the inventory with the specified
lore, without item properties. Color codes are ignored. |
Mechanism | This tag can be modified using mechanism/InventoryTag.contents |
Group | properties |
Name | <InventoryTag.id_holder> |
Returns | ObjectTag |
Description | Returns Denizen's holder ID for this inventory. (p@joe, l@123,321,123,world, etc.)
|
Mechanism | This tag can be modified using mechanism/InventoryTag.holder |
Group | properties |
Name | <InventoryTag.script_name> |
Returns | ElementTag |
Description | Returns the name of the script that this inventory came from (if any).
|
Group | properties |
Name | <InventoryTag.size> |
Returns | ElementTag(Number) |
Description | Return the number of slots in the inventory.
|
Mechanism | This tag can be modified using mechanism/InventoryTag.size |
Group | properties |
Name | <InventoryTag.title> |
Returns | ElementTag |
Description | Returns the title of the inventory.
|
Mechanism | This tag can be modified using mechanism/InventoryTag.title |
Group | properties |
Name | <ItemTag.apple_enchanted> |
Returns | ElementTag(Boolean) |
Description | Returns whether a golden apple item is enchanted.
NOTE: In 1.13+, enchanted golden apples are now a separate Material type, making this tag no longer required. |
Mechanism | This tag can be modified using mechanism/ItemTag.apple_enchanted |
Group | properties |
Name | <ItemTag.nbt_attributes> |
Returns | ListTag |
Description | Returns the NBT attribute data (as matches the mechanism input), if any.
|
Mechanism | This tag can be modified using mechanism/ItemTag.nbt_attributes |
Group | properties |
Name | <ItemTag.base_color> |
Returns | ElementTag |
Description | Gets the base color of a banner.
For the list of possible colors, see url/http://bit.ly/1dydq12. As of 1.13+, this tag is no longer relevant. |
Mechanism | This tag can be modified using mechanism/ItemTag.base_color |
Group | properties |
Name | <ItemTag.block_material> |
Returns | MaterialTag |
Description | Returns the material for an item with complex-block-data attached.
|
Mechanism | This tag can be modified using mechanism/ItemTag.block_material |
Group | properties |
Name | <ItemTag.book_author> |
Returns | ElementTag |
Description | Returns the author of the book.
|
Mechanism | This tag can be modified using mechanism/ItemTag.book |
Group | properties |
Name | <ItemTag.book_title> |
Returns | ElementTag |
Description | Returns the title of the book.
|
Mechanism | This tag can be modified using mechanism/ItemTag.book |
Group | properties |
Name | <ItemTag.book_pages> |
Returns | ListTag |
Description | Returns the plain-text pages of the book as a ListTag.
|
Mechanism | This tag can be modified using mechanism/ItemTag.book |
Group | properties |
Name | <ItemTag.book> |
Returns | ElementTag |
Description | Returns full information on the book item, in the format
author|AUTHOR|title|TITLE|raw_pages|PAGE_ONE|PAGE_TWO|... or as raw_pages|PAGE_ONE|PAGE_TWO|... Pre-escaped to prevent issues. See language/Property Escaping |
Mechanism | This tag can be modified using mechanism/ItemTag.book |
Group | properties |
Name | <ItemTag.can_destroy> |
Returns | ListTag(MaterialTag) |
Description | Returns a list of materials this item can destroy while in adventure mode, if any.
|
Mechanism | This tag can be modified using mechanism/ItemTag.can_destroy |
Group | properties |
Name | <ItemTag.can_place_on> |
Returns | ListTag(MaterialTag) |
Description | Returns a list of materials this item can be placed on while in adventure mode, if any.
|
Mechanism | This tag can be modified using mechanism/ItemTag.can_place_on |
Group | properties |
Name | <ItemTag.charged_projectiles> |
Returns | ListTag(ItemTag) |
Description | Returns a list of charged projectile items on this crossbow.
|
Mechanism | This tag can be modified using mechanism/ItemTag.charged_projectiles |
Group | properties |
Name | <ItemTag.is_charged> |
Returns | ElementTag(Boolean) |
Description | Returns whether this crossbow is charged.
|
Mechanism | This tag can be modified using mechanism/ItemTag.charged_projectiles |
Group | properties |
Name | <ItemTag.color> |
Returns | ColorTag |
Description | Returns the color of the leather armor item or potion item.
|
Mechanism | This tag can be modified using mechanism/ItemTag.color |
Group | properties |
Name | <ItemTag.has_custom_model_data> |
Returns | ElementTag(Boolean) |
Description | Returns whether the item has a custom model data ID number set on it.
Also see tag/ItemTag.custom_model_data. |
Mechanism | This tag can be modified using mechanism/ItemTag.custom_model_data |
Group | properties |
Name | <ItemTag.custom_model_data> |
Returns | ElementTag(Number) |
Description | Returns the custom model data ID number of the item.
This tag is invalid for items that do not have a custom model data ID. Also see tag/ItemTag.has_custom_model_data. |
Mechanism | This tag can be modified using mechanism/ItemTag.custom_model_data |
Group | properties |
Name | <ItemTag.display> |
Returns | ElementTag |
Description | Returns the display name of the item, as set by plugin or an anvil.
|
Mechanism | This tag can be modified using mechanism/ItemTag.display_name |
Group | properties |
Name | <ItemTag.has_display> |
Returns | ElementTag(Boolean) |
Description | Returns whether the item has a custom set display name.
|
Mechanism | This tag can be modified using mechanism/ItemTag.display_name |
Group | properties |
Name | <ItemTag.durability> |
Returns | ElementTag(Number) |
Description | Returns the current durability (number of uses) on the item.
|
Mechanism | This tag can be modified using mechanism/ItemTag.durability |
Group | properties |
Name | <ItemTag.max_durability> |
Returns | ElementTag(Number) |
Description | Returns the maximum durability (number of uses) of this item.
For use with tag/ItemTag.durability and mechanism/ItemTag.durability. |
Group | properties |
Name | <ItemTag.is_enchanted> |
Returns | ElementTag(Boolean) |
Description | Returns whether the item has any enchantments.
|
Mechanism | This tag can be modified using mechanism/ItemTag.enchantments |
Group | properties |
Name | <ItemTag.enchantments.with_levels> |
Returns | ListTag |
Description | Returns a list of enchantments on the item, with their levels listed too.
In the format of ENCHANTMENT,LEVEL - For example: sharpness,3 |
Mechanism | This tag can be modified using mechanism/ItemTag.enchantments |
Group | properties |
Name | <ItemTag.enchantments.levels> |
Returns | ListTag |
Description | Returns a list of enchantments on the item, showing only the level.
|
Mechanism | This tag can be modified using mechanism/ItemTag.enchantments |
Group | properties |
Name | <ItemTag.enchantments.level[<name>]> |
Returns | ElementTag(Number) |
Description | Returns the level of a specified enchantment.
|
Mechanism | This tag can be modified using mechanism/ItemTag.enchantments |
Group | properties |
Name | <ItemTag.enchantments> |
Returns | ListTag |
Description | Returns a list of enchantments on the item.
|
Mechanism | This tag can be modified using mechanism/ItemTag.enchantments |
Group | properties |
Name | <ItemTag.firework> |
Returns | ListTag |
Description | Returns the firework's property value as a list, matching the format of the mechanism.
|
Mechanism | This tag can be modified using mechanism/ItemTag.firework |
Group | properties |
Name | <ItemTag.flags> |
Returns | ListTag |
Description | Returns a list of flags set on this item.
Valid flags include: HIDE_ATTRIBUTES, HIDE_DESTROYS, HIDE_ENCHANTS, HIDE_PLACED_ON, HIDE_POTION_EFFECTS, and HIDE_UNBREAKABLE NOTE: 'HIDE_POTION_EFFECTS' also hides banner patterns. |
Mechanism | This tag can be modified using mechanism/ItemTag.flags |
Group | properties |
Name | <ItemTag.inventory> |
Returns | InventoryTag |
Description | Returns a InventoryTag of a container item.
|
Mechanism | This tag can be modified using mechanism/ItemTag.inventory |
Group | properties |
Name | <ItemTag.knowledge_book_recipes> |
Returns | ListTag |
Description | Returns a recipes unlocked by this knowledge book. Recipes are in the Namespace:Key format, for example "minecraft:gold_nugget".
These keys are not necessarily 1:1 with material names, as seen in the example "minecraft:gold_ingot_from_nuggets". |
Mechanism | This tag can be modified using mechanism/ItemTag.knowledge_book_recipes |
Group | properties |
Name | <ItemTag.lock> |
Returns | ElementTag |
Description | Returns the lock password of this item.
|
Mechanism | This tag can be modified using mechanism/ItemTag.lock |
Group | properties |
Name | <ItemTag.is_locked> |
Returns | ElementTag(Boolean) |
Description | Returns whether this item has a lock password.
|
Mechanism | This tag can be modified using mechanism/ItemTag.lock |
Group | properties |
Name | <ItemTag.lore> |
Returns | ListTag |
Description | Returns lore as a ListTag. Excludes the custom-script-id lore.
To get that information, use <ItemTag.scriptname>. |
Mechanism | This tag can be modified using mechanism/ItemTag.lore |
Group | properties |
Name | <ItemTag.has_lore> |
Returns | ElementTag(Boolean) |
Description | Returns whether the item has lore set on it.
|
Mechanism | This tag can be modified using mechanism/ItemTag.lore |
Group | properties |
Name | <ItemTag.map> |
Returns | ElementTag(Number) |
Description | Returns the ID number of the map item's map.
|
Mechanism | This tag can be modified using mechanism/ItemTag.map |
Group | properties |
Name | <ItemTag.has_nbt[<key>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether this item has the specified NBT key.
|
Group | properties |
Name | <ItemTag.nbt_keys> |
Returns | ListTag |
Description | Returns all of this item's NBT keys as a ListTag.
|
Group | properties |
Name | <ItemTag.nbt[<key>]> |
Returns | ElementTag |
Description | Returns the value of this item's NBT key as an ElementTag as best it can.
If no key is specified, returns the full list of NBT key/value pairs (valid for input to nbt mechanism). See also language/property escaping. |
Mechanism | This tag can be modified using mechanism/ItemTag.nbt |
Group | properties |
Name | <ItemTag.patterns> |
Returns | ListTag |
Description | Lists a banner's patterns in the form "li@COLOR/PATTERN|COLOR/PATTERN" etc.
TODO: Local meta for these links For the list of possible colors, see url/http://bit.ly/1dydq12. For the list of possible patterns, see url/http://bit.ly/1MqRn7T. |
Mechanism | This tag can be modified using mechanism/ItemTag.patterns |
Group | properties |
Name | <ItemTag.plant_growth> |
Returns | ElementTag |
Description | Returns the growth level of a plant item as one of the following:
Wheat: SEEDED, GERMINATED, VERY_SMALL, SMALL, MEDIUM, TALL, VERY_TALL, RIPE Nether Warts: SEEDED, STAGE_ONE, STAGE_TWO, RIPE Cocoa Plants: SMALL, MEDIUM, LARGE Pumpkin stem, melon stem, carrot, potato: 0-7 Deprecated as of MC 1.13, use tag/MaterialTag.age instead. |
Mechanism | This tag can be modified using mechanism/ItemTag.plant_growth |
Group | properties |
Name | <ItemTag.potion_base> |
Returns | ElementTag |
Description | Returns the potion effect on this item.
In the format Effect,Level,Extended,Splash,Color |
Mechanism | This tag can be modified using mechanism/ItemTag.potion_effects |
Group | properties |
Name | <ItemTag.has_potion_effect> |
Returns | ElementTag(Boolean) |
Description | Returns whether the potion has a potion effect.
|
Mechanism | This tag can be modified using mechanism/ItemTag.potion_effects |
Name | <ItemTag.potion_effect[<#>].is_splash> |
Returns | ElementTag(Boolean) |
Description | Returns whether the potion is a splash potion.
|
Mechanism | This tag can be modified using mechanism/ItemTag.potion_effects |
Group | properties |
Name | <ItemTag.potion_effect[<#>].is_extended> |
Returns | ElementTag(Boolean) |
Description | Returns whether the potion effect is extended.
|
Mechanism | This tag can be modified using mechanism/ItemTag.potion_effects |
Group | properties |
Name | <ItemTag.potion_effect[<#>].level> |
Returns | ElementTag(Number) |
Description | Returns the potion effect's level.
|
Mechanism | This tag can be modified using mechanism/ItemTag.potion_effects |
Group | properties |
Name | <ItemTag.potion_effect[<#>].is_ambient> |
Returns | ElementTag(Boolean) |
Description | Returns whether the potion effect is ambient.
|
Mechanism | This tag can be modified using mechanism/ItemTag.potion_effects |
Group | properties |
Name | <ItemTag.potion_effect[<#>].color> |
Returns | ColorTag |
Description | Returns the potion effect's color.
NOTE: Not supported as of Minecraft version 1.13. |
Mechanism | This tag can be modified using mechanism/ItemTag.potion_effects |
Group | properties |
Name | <ItemTag.potion_effect[<#>].icon> |
Returns | ElementTag(Boolean) |
Description | Returns whether the potion effect shows an icon.
|
Mechanism | This tag can be modified using mechanism/ItemTag.potion_effects |
Group | properties |
Name | <ItemTag.potion_effect[<#>].has_particles> |
Returns | ElementTag(Boolean) |
Description | Returns whether the potion effect has particles.
|
Mechanism | This tag can be modified using mechanism/ItemTag.potion_effects |
Group | properties |
Name | <ItemTag.potion_effect[<#>].duration> |
Returns | ElementTag(Number) |
Description | Returns the duration in ticks of the potion.
|
Mechanism | This tag can be modified using mechanism/ItemTag.potion_effects |
Group | properties |
Name | <ItemTag.potion_effect[<#>].amplifier> |
Returns | ElementTag(Number) |
Description | Returns the amplifier level of the potion effect.
|
Mechanism | This tag can be modified using mechanism/ItemTag.potion_effects |
Group | properties |
Name | <ItemTag.potion_effect[<#>].type> |
Returns | ElementTag |
Description | Returns the type of the potion effect.
|
Mechanism | This tag can be modified using mechanism/ItemTag.potion_effects |
Group | properties |
Name | <ItemTag.potion_effect[<#>]> |
Returns | ElementTag |
Description | Returns the potion effect on this item.
In the format Effect,Level,Extended,Splash |
Mechanism | This tag can be modified using mechanism/ItemTag.potion_effects |
Group | properties |
Warning | Don't use this directly, use its sub-tags!
|
Name | <ItemTag.quantity> |
Returns | ElementTag(Number) |
Description | Returns the number of items in the ItemTag's itemstack.
|
Mechanism | This tag can be modified using mechanism/ItemTag.quantity |
Group | properties |
Name | <ItemTag.max_stack> |
Returns | ElementTag(Number) |
Description | Returns the max number of this item possible in a single stack of this type.
For use with tag/ItemTag.quantity and mechanism/ItemTag.quantity. |
Group | properties |
Name | <ItemTag.repair_cost> |
Returns | ElementTag(Number) |
Description | Returns the current repair cost (on an anvil) for this item.
Note that zero indicates no repair cost. |
Mechanism | This tag can be modified using mechanism/ItemTag.repair_cost |
Group | properties |
Name | <ItemTag.has_script> |
Returns | ElementTag(Boolean) |
Description | Returns whether the item was created by an item script.
|
Group | scripts |
Name | <ItemTag.scriptname> |
Returns | ElementTag |
Description | Returns the script name of the item if it was created by an item script.
|
Group | scripts |
Name | <ItemTag.script> |
Returns | ScriptTag |
Description | Returns the script of the item if it was created by an item script.
|
Group | scripts |
Name | <ItemTag.sign_contents> |
Returns | ListTag |
Description | Returns a list of lines on a sign item.
|
Mechanism | This tag can be modified using mechanism/ItemTag.sign_contents |
Group | properties |
Name | <ItemTag.skin> |
Returns | ElementTag |
Description | Returns the UUID of the player whose skin a skull item uses.
Note: Item must be a 'skull_item' with a skin. |
Mechanism | This tag can be modified using mechanism/ItemTag.skull_skin |
Group | properties |
Name | <ItemTag.skin.full> |
Returns | ElementTag|Element |
Description | Returns the UUID of the player whose skin a skull item uses, along
with the permanently cached texture property. Note: Item must be a 'skull_item' with a skin. |
Mechanism | This tag can be modified using mechanism/ItemTag.skull_skin |
Group | properties |
Name | <ItemTag.has_skin> |
Returns | ElementTag(Boolean) |
Description | Returns whether the item has a custom skin set.
(Only for human 'skull_item's) |
Mechanism | This tag can be modified using mechanism/ItemTag.skull_skin |
Group | properties |
Name | <ItemTag.spawn_type> |
Returns | ElementTag |
Description | Returns the spawn egg's entity type.
NOTE: In 1.13+, spawn eggs are distinct materials. |
Mechanism | This tag can be modified using mechanism/ItemTag.spawn_type |
Group | properties |
Name | <ItemTag.spawner_count> |
Returns | ElementTag(Number) |
Description | Returns the spawn count for a spawner block item.
|
Mechanism | This tag can be modified using mechanism/ItemTag.spawner_count |
Group | properties |
Name | <ItemTag.spawner_spawn_delay> |
Returns | ElementTag(Number) |
Description | Returns the current spawn delay for a spawner block item.
|
Mechanism | This tag can be modified using mechanism/ItemTag.spawner_delay_data |
Group | properties |
Name | <ItemTag.spawner_minimum_spawn_delay> |
Returns | ElementTag(Number) |
Description | Returns the minimum spawn delay for a spawner block item.
|
Mechanism | This tag can be modified using mechanism/ItemTag.spawner_delay_data |
Group | properties |
Name | <ItemTag.spawner_maximum_spawn_delay> |
Returns | ElementTag(Number) |
Description | Returns the maximum spawn delay for a spawner block item.
|
Mechanism | This tag can be modified using mechanism/ItemTag.spawner_delay_data |
Group | properties |
Name | <ItemTag.spawner_max_nearby_entities> |
Returns | ElementTag(Number) |
Description | Returns the maximum nearby entities for a spawner block item.
|
Mechanism | This tag can be modified using mechanism/ItemTag.spawner_max_nearby_entities |
Group | properties |
Name | <ItemTag.spawner_player_range> |
Returns | ElementTag(Number) |
Description | Returns the maximum player range for a spawner block item (ie how close a player must be for this spawner to be active).
|
Mechanism | This tag can be modified using mechanism/ItemTag.spawner_player_range |
Group | properties |
Name | <ItemTag.spawner_range> |
Returns | ElementTag(Number) |
Description | Returns the spawn range for a spawner block item.
|
Mechanism | This tag can be modified using mechanism/ItemTag.spawner_range |
Group | properties |
Name | <ItemTag.spawner_type> |
Returns | EntityTag |
Description | Returns the spawn type for a spawner block item.
|
Mechanism | This tag can be modified using mechanism/ItemTag.spawner_type |
Group | properties |
Name | <ItemTag.unbreakable> |
Returns | ElementTag(Boolean) |
Description | Returns whether an item has the unbreakable flag.
|
Mechanism | This tag can be modified using mechanism/ItemTag.unbreakable |
Group | properties |
Name | <MaterialTag.maximum_age> |
Returns | ElementTag(Number) |
Description | Returns the maximum age for an ageable material. This includes plant growth.
|
Group | properties |
Name | <MaterialTag.age> |
Returns | ElementTag(Number) |
Description | Returns the current age for an ageable material. This includes plant growth.
|
Mechanism | This tag can be modified using mechanism/MaterialTag.age |
Group | properties |
Name | <MaterialTag.valid_directions> |
Returns | ListTag |
Description | Returns a list of directions that are valid for a directional material.
See also tag/MaterialTag.direction |
Mechanism | This tag can be modified using mechanism/MaterialTag.direction |
Group | properties |
Name | <MaterialTag.direction> |
Returns | ElementTag |
Description | Returns the current facing direction for a directional material (like a door or a bed).
Output is a direction name like "NORTH", or an axis like "X". |
Mechanism | This tag can be modified using mechanism/MaterialTag.direction |
Group | properties |
Name | <MaterialTag.valid_faces> |
Returns | ListTag |
Description | Returns a list of faces that are valid for a material that has multiple faces.
See also tag/MaterialTag.faces |
Mechanism | This tag can be modified using mechanism/MaterialTag.faces |
Group | properties |
Name | <MaterialTag.faces> |
Returns | ListTag |
Description | Returns a list of the current faces for a material that has multiple faces (like a mushroom block).
Output is a direction name like "NORTH". |
Mechanism | This tag can be modified using mechanism/MaterialTag.faces |
Group | properties |
Name | <MaterialTag.half> |
Returns | ElementTag |
Description | Returns the current half for a bisected material (like a door, double-plant, chest, or a bed).
Output for "Bisected" blocks (doors/double plants/...) is "BOTTOM" or "TOP". Output for beds is "HEAD" or "FOOT". Output for chests is "LEFT" or "RIGHT". |
Mechanism | This tag can be modified using mechanism/MaterialTag.half |
Group | properties |
Name | <MaterialTag.relative_vector> |
Returns | ElementTag |
Description | Returns a vector location of the other block for a bisected material.
|
Mechanism | This tag can be modified using mechanism/MaterialTag.half |
Group | properties |
Name | <MaterialTag.persistent> |
Returns | ElementTag(Boolean) |
Description | Returns whether this block will decay from being too far away from a tree.
|
Mechanism | This tag can be modified using mechanism/MaterialTag.persistent |
Group | properties |
Name | <MaterialTag.maximum_level> |
Returns | ElementTag(Number) |
Description | Returns the maximum level for a levelable material (like water, lava, and Cauldrons), or a cake.
|
Group | properties |
Name | <MaterialTag.level> |
Returns | ElementTag(Number) |
Description | Returns the current level for a levelable material (like water, lava, and Cauldrons), or a cake.
|
Mechanism | This tag can be modified using mechanism/MaterialTag.level |
Group | properties |
Name | <MaterialTag.lit> |
Returns | ElementTag(Boolean) |
Description | Returns whether a lightable material (such as a redstone torch) is lit currently.
|
Mechanism | This tag can be modified using mechanism/MaterialTag.lit |
Group | properties |
Name | <MaterialTag.pickle_count> |
Returns | ElementTag(Number) |
Description | Returns the amount of pickles in a Sea Pickle material.
|
Mechanism | This tag can be modified using mechanism/MaterialTag.pickle_count |
Group | properties |
Name | <MaterialTag.pickle_max> |
Returns | ElementTag(Number) |
Description | Returns the maximum amount of pickles allowed in a Sea Pickle material.
|
Group | properties |
Name | <MaterialTag.pickle_min> |
Returns | ElementTag(Number) |
Description | Returns the minimum amount of pickles allowed in a Sea Pickle material.
|
Group | properties |
Name | <MaterialTag.slab_type> |
Returns | ElementTag |
Description | Returns the current type for a slab.
Output is "BOTTOM", "TOP", or "DOUBLE". |
Mechanism | This tag can be modified using mechanism/MaterialTag.slab_type |
Group | properties |
Name | <MaterialTag.switch_face> |
Returns | ElementTag |
Description | Returns the current attach direction for a switch.
Output is "CEILING", "FLOOR", or "WALL". |
Mechanism | This tag can be modified using mechanism/MaterialTag.switch_face |
Group | properties |
Name | <MaterialTag.waterlogged> |
Returns | ElementTag(Boolean) |
Description | Returns whether this block is waterlogged or not.
|
Mechanism | This tag can be modified using mechanism/MaterialTag.waterlogged |
Group | properties |
Name | <TradeTag.has_xp> |
Returns | ElementTag(Boolean) |
Description | Returns whether the trade has an experience reward.
|
Mechanism | This tag can be modified using mechanism/TradeTag.has_xp |
Name | <TradeTag.inputs> |
Returns | ListTag(ItemTag) |
Description | Returns the list of items required to make the trade.
|
Mechanism | This tag can be modified using mechanism/TradeTag.inputs |
Name | <TradeTag.max_uses> |
Returns | ElementTag(Number) |
Description | Returns the maximum amount of times that the trade can be used.
|
Mechanism | This tag can be modified using mechanism/TradeTag.max_uses |
Name | <TradeTag.result> |
Returns | ItemTag |
Description | Returns what the trade will give the player.
|
Mechanism | This tag can be modified using mechanism/TradeTag.result |
Name | <TradeTag.uses> |
Returns | ElementTag(Number) |
Description | Returns how many times the trade has been used.
|
Mechanism | This tag can be modified using mechanism/TradeTag.uses |
Name | <schematic.list> |
Returns | ListTag |
Description | Returns a list of all loaded schematics.
|
Name | <schematic[<name>].exists> |
Returns | ElementTag(Boolean) |
Description | Returns whether the schematic exists.
|
Name | <schematic[<name>].height> |
Returns | ElementTag(Number) |
Description | Returns the height (Y) of the schematic.
|
Name | <schematic[<name>].length> |
Returns | ElementTag(Number) |
Description | Returns the length (Z) of the schematic.
|
Name | <schematic[<name>].width> |
Returns | ElementTag(Number) |
Description | Returns the width (X) of the schematic.
|
Name | <schematic[<name>].block[<location>]> |
Returns | MaterialTag |
Description | Returns the material for the block at the location in the schematic.
|
Name | <schematic[<name>].origin> |
Returns | LocationTag |
Description | Returns the origin location of the schematic.
|
Name | <schematic[<name>].blocks> |
Returns | ElementTag(Number) |
Description | Returns the number of blocks in the schematic.
|
Name | <schematic[<name>].cuboid[<origin location>]> |
Returns | CuboidTag |
Description | Returns a cuboid of where the schematic would be if it was pasted at an origin.
|
Name | <biome[<biome>]> |
Returns | BiomeTag |
Description | Returns a biome object constructed from the input value.
|
Name | <chunk[<chunk>]> |
Returns | ChunkTag |
Description | Returns a chunk object constructed from the input value.
|
Name | <color[<color>]> |
Returns | ColorTag |
Description | Returns a color object constructed from the input value.
|
Name | <cuboid[<cuboid>]> |
Returns | CuboidTag |
Description | Returns a cuboid object constructed from the input value.
|
Name | <ellipsoid[<ellipsoid>]> |
Returns | EllipsoidTag |
Description | Returns an ellipsoid object constructed from the input value.
|
Name | <entity[<entity>]> |
Returns | EntityTag |
Description | Returns an entity object constructed from the input value.
|
Name | <inventory[<inventory>]> |
Returns | InventoryTag |
Description | Returns an inventory object constructed from the input value.
|
Name | <item[<item>]> |
Returns | ItemTag |
Description | Returns an item object constructed from the input value.
|
Name | <location[<location>]> |
Returns | LocationTag |
Description | Returns a location object constructed from the input value.
|
Name | <material[<material>]> |
Returns | MaterialTag |
Description | Returns a material object constructed from the input value.
|
Name | <npc[(<npc>)]> |
Returns | NPCTag |
Description | Returns an npc object constructed from the input value.
If no input value is specified, returns the linked NPC. |
Name | <player[(<player>)]> |
Returns | PlayerTag |
Description | Returns a player object constructed from the input value.
If no input value is specified, returns the linked player. |
Name | <plugin[<plugin>]> |
Returns | PluginTag |
Description | Returns a plugin object constructed from the input value.
|
Name | <server.economy.format[<#.#>]> |
Returns | ElementTag |
Description | Returns the amount of money, formatted according to the server's economy.
|
Note | This tag requires the plugin(s) Vault! |
Name | <server.economy.currency_name[<#.#>]> |
Returns | ElementTag |
Description | Returns the server's economy currency name (automatically singular or plural based on input value).
|
Note | This tag requires the plugin(s) Vault! |
Name | <server.economy.currency_plural> |
Returns | ElementTag |
Description | Returns the server's economy currency name (in the plural form, like "Dollars").
|
Note | This tag requires the plugin(s) Vault! |
Name | <server.economy.currency_singular> |
Returns | ElementTag |
Description | Returns the server's economy currency name (in the singular form, like "Dollar").
|
Note | This tag requires the plugin(s) Vault! |
Name | <server.slot_id[<slot>]> |
Returns | ElementTag(Number) |
Description | Returns the slot ID number for an input slot (see language/Slot Inputs).
|
Name | <server.parse_bukkit_item[<serial>]> |
Returns | ItemTag |
Description | Returns the ItemTag resultant from parsing Bukkit item serialization data (under subkey "item").
|
Name | <server.list_recipe_ids[(<type>)]> |
Returns | ListTag |
Description | Returns a list of all recipe IDs on the server.
Returns a list in the Namespace:Key format, for example "minecraft:gold_nugget". Optionally, specify a recipe type (CRAFTING, FURNACE, COOKING, BLASTING, SHAPED, SHAPELESS, SMOKING, STONECUTTING) to limit to just recipes of that type. |
Name | <server.recipe_items[<id>]> |
Returns | ListTag(ItemTag) |
Description | Returns a list of the items used as input to the recipe within the input ID.
This is formatted equivalently to the item script recipe input, with "material:" for non-exact matches, and a full ItemTag for exact matches. Note that this won't represent all recipes perfectly (primarily those with multiple input choices per slot). For furnace-style recipes, this will return a list with only 1 item. |
Name | <server.scoreboard[<board>].exists> |
Returns | ListTag |
Description | Returns whether a given scoreboard exists on the server.
|
Name | <server.scoreboard[(<board>)].objectives> |
Returns | ListTag |
Description | Returns a list of all objective names in the scoreboard.
Optionally, specify which scoreboard to use. |
Name | <server.scoreboard[(<board>)].objective[<name>].criteria> |
Returns | ListTag |
Description | Returns the criteria specified for the given objective.
Optionally, specify which scoreboard to use. |
Name | <server.scoreboard[(<board>)].objective[<name>].display_name> |
Returns | ListTag |
Description | Returns the display name specified for the given objective.
Optionally, specify which scoreboard to use. |
Name | <server.scoreboard[(<board>)].objective[<name>].display_slot> |
Returns | ListTag |
Description | Returns the display slot specified for the given objective. Can be: BELOW_NAME, PLAYER_LIST, or SIDEBAR.
Note that not all objectives have a display slot. Optionally, specify which scoreboard to use. |
Name | <server.scoreboard[(<board>)].team[<team>].members> |
Returns | ListTag |
Description | Returns a list of all members of a scoreboard team. Generally returns as a list of names or text entries.
Members are not necessarily written in any given format and are not guaranteed to validly fit any requirements. Optionally, specify which scoreboard to use. |
Name | <server.object_is_valid[<object>]> |
Returns | ElementTag(boolean) |
Description | Returns whether the object is a valid object (non-null), as well as not an Element.
|
Name | <server.has_whitelist> |
Returns | ElementTag(boolean) |
Description | Returns true if the server's whitelist is active, otherwise returns false.
|
Name | <server.has_flag[<flag_name>]> |
Returns | ElementTag(boolean) |
Description | Returns true if the server has the specified flag, otherwise returns false.
|
Name | <server.flag[<name>]> |
Returns | Flag ListTag |
Description | Returns the specified flag from the server.
|
Name | <server.flag[<flag_name>].is_expired> |
Returns | ElementTag(Boolean) |
Description | returns true if the flag is expired or does not exist, false if it is not yet expired or has no expiration.
|
Name | <server.flag[<flag_name>].expiration> |
Returns | DurationTag |
Description | Returns a DurationTag of the time remaining on the flag, if it has an expiration.
Works with offline players. |
Name | <server.list_traits> |
Returns | ListTag |
Description | Returns a list of all available NPC traits on the server.
|
Note | This tag requires the plugin(s) Citizens! |
Name | <server.list_commands> |
Returns | ListTag |
Description | Returns a list of all registered command names in Bukkit.
|
Name | <server.list_advancements> |
Returns | ListTag |
Description | Returns a list of all registered advancement names.
Generally used with tag/PlayerTag.has_advancement. |
Name | <server.list_nbt_attribute_types> |
Returns | ListTag |
Description | Returns a list of all registered advancement names.
Generally used with tag/EntityTag.has_attribute. This is only their Bukkit enum names, as seen at url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/attribute/Attribute.html. |
Name | <server.list_damage_causes> |
Returns | ListTag |
Description | Returns a list of all registered damage causes.
Generally used with event/entity damaged. This is only their Bukkit enum names, as seen at url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityDamageEvent.DamageCause.html. |
Name | <server.list_biome_types> |
Returns | ListTag(BiomeTag) |
Description | Returns a list of all biomes known to the server.
Generally used with language/BiomeTag Objects. This is based on Bukkit Biome enum, as seen at url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/Biome.html. |
Name | <server.list_enchantments> |
Returns | ListTag |
Description | Returns a list of all enchantments known to the server.
This is only their Bukkit enum names, as seen at url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/enchantments/Enchantment.html. Generally, prefer tag/server.list_enchantment_keys. |
Name | <server.list_enchantment_keys> |
Returns | ListTag |
Description | Returns a list of all enchantments known to the server.
Generally used with mechanism/ItemTag.enchantments. This is specifically their minecraft key names, which generally align with the names you see in-game. |
Name | <server.list_entity_types> |
Returns | ListTag |
Description | Returns a list of all entity types known to the server.
Generally used with language/EntityTag Objects. This is only their Bukkit enum names, as seen at url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/EntityType.html. |
Name | <server.list_material_types> |
Returns | ListTag(MaterialTag) |
Description | Returns a list of all materials known to the server.
Generally used with language/MaterialTag Objects. This is only types listed in the Bukkit Material enum, as seen at url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html. |
Name | <server.list_sounds> |
Returns | ListTag |
Description | Returns a list of all sounds known to the server.
Generally used with command/playsound. This is only their Bukkit enum names, as seen at url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html. |
Name | <server.list_particles> |
Returns | ListTag |
Description | Returns a list of all particle effect types known to the server.
Generally used with command/playeffect. This is only their Bukkit enum names, as seen at url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Particle.html. Refer also to tag/server.list_effects. |
Name | <server.list_effects> |
Returns | ListTag |
Description | Returns a list of all 'effect' types known to the server.
Generally used with command/playeffect. This is only their Bukkit enum names, as seen at url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Effect.html. Refer also to tag/server.list_particles. |
Name | <server.list_patterns> |
Returns | ListTag |
Description | Returns a list of all banner patterns known to the server.
Generally used with tag/ItemTag.patterns. This is only their Bukkit enum names, as seen at url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/banner/PatternType.html. |
Name | <server.list_potion_effects> |
Returns | ListTag |
Description | Returns a list of all potion effects known to the server.
Can be used with command/cast. This is only their Bukkit enum names, as seen at url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionEffectType.html. Refer also to tag/server.list_potion_types. |
Name | <server.list_potion_types> |
Returns | ListTag |
Description | Returns a list of all potion types known to the server.
This is only their Bukkit enum names, as seen at url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionType.html. Refer also to tag/server.list_potion_effects. |
Name | <server.list_tree_types> |
Returns | ListTag |
Description | Returns a list of all tree types known to the server.
Generally used with mechanism/LocationTag.generate_tree. This is only their Bukkit enum names, as seen at url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/TreeType.html. |
Name | <server.list_map_cursor_types> |
Returns | ListTag |
Description | Returns a list of all map cursor types known to the server.
Generally used with command/map and language/Map Script Containers. This is only their Bukkit enum names, as seen at url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/map/MapCursor.Type.html. |
Name | <server.list_world_types> |
Returns | ListTag |
Description | Returns a list of all world types known to the server.
Generally used with command/createworld. This is only their Bukkit enum names, as seen at url/https://hub.spigotmc.org/javadocs/spigot/org/bukkit/WorldType.html. |
Name | <server.list_statistics[(<type>)]> |
Returns | ListTag |
Description | Returns a list of all statistic types known to the server.
Generally used with tag/PlayerTag.statistic. This is only their Bukkit enum names, as seen at url/https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Statistic.html. Optionally, specify a type to limit to statistics of a given type. Valid types: UNTYPED, ITEM, ENTITY, or BLOCK. Refer also to tag/server.statistic_type. |
Name | <server.list_flags[(regex:)<search>]> |
Returns | ListTag |
Description | Returns a list of the server's flag names, with an optional search for
names containing a certain pattern. |
Name | <server.list_notables[<type>]> |
Returns | ListTag |
Description | Lists all saved Notables currently on the server.
Optionally, specify a type to search for. Valid types: locations, cuboids, ellipsoids, items, inventories |
Name | <server.statistic_type[<statistic>]> |
Returns | ElementTag |
Description | Returns the qualifier type of the given statistic.
Generally relevant to usage with tag/PlayerTag.statistic.qualifier. Returns UNTYPED, ITEM, ENTITY, or BLOCK. Refer also to tag/server.list_statistics. |
Name | <server.start_time> |
Returns | DurationTag |
Description | Returns the time the server started as a duration time.
|
Name | <server.disk_free> |
Returns | ElementTag(Number) |
Description | How much remaining disk space is available to this server.
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. |
Name | <server.disk_total> |
Returns | ElementTag(Number) |
Description | How much total disk space is on the drive containing this server.
This counts only the drive the server folder is on, not any other drives. |
Name | <server.disk_usage> |
Returns | ElementTag(Number) |
Description | How much space on the drive is already in use.
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. |
Name | <server.ram_allocated> |
Returns | ElementTag(Number) |
Description | How much RAM is allocated to the server, in bytes (total memory).
This is how much of the system memory is reserved by the Java process, NOT how much is actually in use by the minecraft server. |
Name | <server.ram_max> |
Returns | ElementTag(Number) |
Description | How much RAM is available to the server (total), in bytes (max memory).
|
Name | <server.ram_free> |
Returns | ElementTag(Number) |
Description | How much RAM is unused but available on the server, in bytes (free memory).
|
Name | <server.ram_usage> |
Returns | ElementTag(Number) |
Description | How much RAM is used by the server, in bytes (free memory).
Equivalent to ram_max minus ram_free |
Name | <server.available_processors> |
Returns | ElementTag(Number) |
Description | How many virtual processors are available to the server.
(In general, Minecraft only uses one, unfortunately.) |
Name | <server.current_time_millis> |
Returns | ElementTag(Number) |
Description | Returns the number of milliseconds since Jan 1, 1970.
Note that this can change every time the tag is read! |
Name | <server.has_event[<event_name>]> |
Returns | ElementTag(Number) |
Description | Returns whether a world event exists on the server.
This tag will ignore ObjectTag identifiers (see language/objecttag). |
Name | <server.event_handlers[<event_name>]> |
Returns | ListTag(ScriptTag) |
Description | Returns a list of all world scripts that will handle a given event name.
This tag will ignore ObjectTag identifiers (see language/objecttag). For use with tag/server.has_event[event_name] |
Name | <server.selected_npc> |
Returns | NPCTag |
Description | Returns the server's currently selected NPC.
|
Name | <server.list_npcs_named[<name>]> |
Returns | ListTag(NPCTag) |
Description | Returns a list of NPCs with a certain name.
|
Name | <server.has_file[<name>]> |
Returns | ElementTag(Boolean) |
Description | Returns true if the specified file exists. The starting path is /plugins/Denizen.
|
Name | <server.list_files[<path>]> |
Returns | ListTag |
Description | Returns a list of all files in the specified directory. The starting path is /plugins/Denizen.
|
Name | <server.has_permissions> |
Returns | ElementTag(Boolean) |
Description | Returns whether the server has a known permission plugin loaded.
Note: should not be considered incredibly reliable. |
Name | <server.has_economy> |
Returns | ElementTag(Boolean) |
Description | Returns whether the server has a known economy plugin loaded.
|
Note | This tag requires the plugin(s) Vault! |
Name | <server.denizen_version> |
Returns | ElementTag |
Description | Returns the version of Denizen currently being used.
|
Name | <server.bukkit_version> |
Returns | ElementTag |
Description | Returns the version of Bukkit currently being used.
|
Name | <server.version> |
Returns | ElementTag |
Description | Returns the version of the server.
|
Name | <server.java_version> |
Returns | ElementTag |
Description | Returns the current Java version of the server.
|
Name | <server.max_players> |
Returns | ElementTag(Number) |
Description | Returns the maximum number of players allowed on the server.
|
Name | <server.list_sql_connections> |
Returns | ListTag |
Description | Returns a list of all SQL connections opened by command/sql.
|
Name | <server.group_prefix[<group>]> |
Returns | ElementTag |
Description | Returns an ElementTag of a group's chat prefix.
|
Name | <server.group_prefix[<group>].world[<world>]> |
Returns | ElementTag |
Description | Returns an ElementTag of a group's chat prefix for the specified WorldTag.
|
Name | <server.group_suffix[<group>]> |
Returns | ElementTag |
Description | Returns an ElementTag of a group's chat suffix.
|
Name | <server.group_suffix[<group>].world[<world>]> |
Returns | ElementTag |
Description | Returns an ElementTag of a group's chat suffix for the specified WorldTag.
|
Name | <server.list_permission_groups> |
Returns | ListTag |
Description | Returns a list of all permission groups on the server.
|
Name | <server.list_scripts> |
Returns | ListTag(ScriptTag) |
Description | Gets a list of all scripts currently loaded into Denizen.
|
Name | <server.match_player[<name>]> |
Returns | PlayerTag |
Description | Returns the online player that best matches the input name.
EG, in a group of 'bo', 'bob', and 'bobby'... input 'bob' returns p@bob, input 'bobb' returns p@bobby, and input 'b' returns p@bo. |
Name | <server.match_offline_player[<name>]> |
Returns | PlayerTag |
Description | Returns any player (online or offline) that best matches the input name.
EG, in a group of 'bo', 'bob', and 'bobby'... input 'bob' returns p@bob, input 'bobb' returns p@bobby, and input 'b' returns p@bo. |
Name | <server.list_npcs_assigned[<assignment_script>]> |
Returns | ListTag(NPCTag) |
Description | Returns a list of all NPCs assigned to a specified script.
|
Name | <server.list_online_players_flagged[<flag_name>]> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all online players with a specified flag set.
|
Name | <server.list_players_flagged[<flag_name>]> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all players with a specified flag set.
|
Name | <server.list_spawned_npcs_flagged[<flag_name>]> |
Returns | ListTag(NPCTag) |
Description | Returns a list of all spawned NPCs with a specified flag set.
|
Name | <server.list_npcs_flagged[<flag_name>]> |
Returns | ListTag(NPCTag) |
Description | Returns a list of all NPCs with a specified flag set.
|
Name | <server.list_npcs> |
Returns | ListTag(NPCTag) |
Description | Returns a list of all NPCs.
|
Name | <server.list_worlds> |
Returns | ListTag(WorldTag) |
Description | Returns a list of all worlds.
|
Name | <server.list_plugins> |
Returns | ListTag(PluginTag) |
Description | Gets a list of currently enabled PluginTags from the server.
|
Name | <server.list_players> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all players that have ever played on the server, online or not.
|
Name | <server.list_online_players> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all online players.
|
Name | <server.list_offline_players> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all offline players.
|
Name | <server.list_banned_players> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all banned players.
|
Name | <server.list_banned_addresses> |
Returns | ListTag |
Description | Returns a list of all banned ip addresses.
|
Name | <server.is_banned[<address>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the given ip address is banned.
|
Name | <server.ban_info[<address>].expiration> |
Returns | DurationTag |
Description | Returns the expiration of the ip address's ban, if it is banned.
Potentially can be null. |
Name | <server.ban_info[<address>].reason> |
Returns | ElementTag |
Description | Returns the reason for the ip address's ban, if it is banned.
|
Name | <server.ban_info[<address>].created> |
Returns | DurationTag |
Description | Returns when the ip address's ban was created, if it is banned.
|
Name | <server.ban_info[<address>].source> |
Returns | ElementTag |
Description | Returns the source of the ip address's ban, if it is banned.
|
Name | <server.list_ops> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all ops, online or not.
|
Name | <server.list_online_ops> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all online ops.
|
Name | <server.list_offline_ops> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all offline ops.
|
Name | <server.motd> |
Returns | ElementTag |
Description | Returns the server's current MOTD.
|
Name | <server.view_distance> |
Returns | ElementTag(Number) |
Description | Returns the server's current view distance.
|
Name | <server.entity_is_spawned[<entity>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether an entity is spawned and valid.
|
Name | <server.player_is_valid[<player name>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether a player exists under the specified name.
|
Name | <server.npc_is_valid[<npc>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether an NPC exists and is usable.
|
Name | <server.current_bossbars> |
Returns | ListTag |
Description | Returns a list of all currently active boss bar IDs.
|
Name | <server.recent_tps> |
Returns | ListTag |
Description | Returns the 3 most recent ticks per second measurements.
|
Name | <server.port> |
Returns | ElementTag(Number) |
Description | Returns the port that the server is running on.
|
Name | <server.debug_enabled> |
Returns | ElementTag(Boolean) |
Description | Returns whether script debug is currently globally enabled on the server.
|
Name | <server.list_plugins_handling_event[<bukkit event>]> |
Returns | ListTag(PluginTag) |
Description | Returns a list of all plugins that handle a given Bukkit event.
Can specify by ScriptEvent name ("PlayerBreaksBlock"), or by full Bukkit class name ("org.bukkit.event.block.BlockBreakEvent"). This is a primarily a dev tool and is not necessarily useful to most players or scripts. |
Name | <&pc> |
Returns | ElementTag |
Description | Returns a percent symbol: %
|
Name | <&nl> |
Returns | ElementTag |
Description | Returns a newline symbol.
|
Name | <&ss> |
Returns | ElementTag |
Description | Returns an internal coloring symbol: §
|
Name | <&sq> |
Returns | ElementTag |
Description | Returns a single-quote symbol: '
|
Name | <&sp> |
Returns | ElementTag |
Description | Returns a space symbol.
|
Name | < > |
Returns | ElementTag |
Description | Returns a non-breaking space symbol.
|
Name | <&dq> |
Returns | ElementTag |
Description | Returns a double-quote symbol: "
|
Name | <&co> |
Returns | ElementTag |
Description | Returns a colon symbol: :
|
Name | <&rb> |
Returns | ElementTag |
Description | Returns a right-bracket symbol: ]
|
Name | <&lb> |
Returns | ElementTag |
Description | Returns a left-bracket symbol: [
|
Name | <&rc> |
Returns | ElementTag |
Description | Returns a right-brace symbol: }
|
Name | <&lc> |
Returns | ElementTag |
Description | Returns a left-brace symbol: {
|
Name | <&ns> |
Returns | ElementTag |
Description | Returns a number sign / hash / pound symbol: #
|
Name | <<> |
Returns | ElementTag |
Description | Returns a less than symbol: <
|
Name | <>> |
Returns | ElementTag |
Description | Returns a greater than symbol: >
|
Name | <&bs> |
Returns | ElementTag |
Description | Returns a backslash symbol: \
|
Name | <&chr[<character>]> |
Returns | ElementTag |
Description | Returns the Unicode character specified. e.g. <&chr[2665]> returns a heart.
|
Name | <n> |
Returns | ElementTag |
Description | Returns a newline symbol, for use in books.
|
Name | <p> |
Returns | ElementTag |
Description | Returns a paragraph, for use in books.
|
Name | <&hover[<hover text>]> |
Returns | ElementTag |
Description | Returns a special chat code that makes the following text display the input hover text when the mouse is left over it.
This tag must be followed by an <&end_hover> tag. For example: - narrate "There is a <&hover[you found it!]>secret<&end_hover> in this message!" |
Name | <&hover[<hover text>].type[<type>]> |
Returns | ElementTag |
Description | Returns a special chat code that makes the following text display the input hover text when the mouse is left over it.
This tag must be followed by an <&end_hover> tag. Optionally specify the hover type as one of: SHOW_TEXT, SHOW_ACHIEVEMENT, SHOW_ITEM, or SHOW_ENTITY. For example: - narrate "There is a <&hover[you found it!].type[SHOW_TEXT]>secret<&end_hover> in this message!" Note: for "SHOW_ITEM", replace the text with a valid ItemTag. For "SHOW_ENTITY", replace the text with a valid spawned EntityTag (requires F3+H to see entities). |
Name | <&click[<click command>]> |
Returns | ElementTag |
Description | Returns a special chat code that makes the following text execute the input command when clicked.
This tag must be followed by an <&end_click> tag. For example: - narrate "You can <&click[say wow]>click here<&end_click> to say wow!" |
Name | <&click[<click command>].type[<type>]> |
Returns | ElementTag |
Description | Returns a special chat code that makes the following text execute the input command when clicked.
This tag must be followed by an <&end_click> tag. Optionally specify the hover type as one of: OPEN_URL, OPEN_FILE, RUN_COMMAND, SUGGEST_COMMAND, or CHANGE_PAGE. For example: - narrate "You can <&click[say wow].type[RUN_COMMAND]>click here<&end_click> to say wow!" |
Name | <&insertion[<message>]> |
Returns | ElementTag |
Description | Returns a special chat code that makes the following text insert the input message to chat when shift-clicked.
This tag must be followed by an <&end_insertion> tag. For example: - narrate "You can <&insertion[wow]>click here<&end_insertion> to add 'wow' to your chat!" |
Name | <&end_click> |
Returns | ElementTag |
Description | Returns a special chat code that ends a '&click' tag.
|
Name | <&end_hover> |
Returns | ElementTag |
Description | Returns a special chat code that ends a '&hover' tag.
|
Name | <&end_insertion> |
Returns | ElementTag |
Description | Returns a special chat code that ends an '&insertion' tag.
|
Name | <&keybind[<key>]> |
Returns | ElementTag |
Description | Returns a special chat code that displays a keybind.
For example: - narrate "Press your <&keybind[key.jump]> key!" |
Name | <&selector[<key>]> |
Returns | ElementTag |
Description | Returns a special chat code that displays a vanilla selector.
|
Name | <&translate[<key>]> |
Returns | ElementTag |
Description | Returns a special chat code that displays an autotranslated message.
For example: - narrate "Reward: <&translate[item.minecraft.diamond_sword]>" Be warned that language keys change between Minecraft versions. |
Name | <&translate[<key>].with[<text>|...]> |
Returns | ElementTag |
Description | Returns a special chat code that displays an autotranslated message.
Optionally, specify a list of escaped text values representing input data for the translatable message. Be aware that missing 'with' values will cause exceptions in your console. For example: - narrate "<&translate[commands.give.success.single].with[32|<&translate[item.minecraft.diamond_sword].escaped>|<player.name.escaped>]>" Be warned that language keys change between Minecraft versions. |
Name | <&score[<name>|<objective>(|<value>)]> |
Returns | ElementTag |
Description | Returns a special chat code that displays a scoreboard entry. Input is an escaped list of:
Name of the relevant entity, name of the objective, then optionally a value (if unspecified, will use current scoreboard value). |
Name | <&0> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Black.
|
Name | <&1> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Blue.
|
Name | <&2> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Green.
|
Name | <&3> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Cyan.
|
Name | <&4> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Red.
|
Name | <&5> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Magenta.
|
Name | <&6> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Gold.
|
Name | <&7> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Light Gray.
|
Name | <&8> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Gray.
|
Name | <&9> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Light Blue.
|
Name | <&a> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Light Green.
|
Name | <&b> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Cyan.
|
Name | <&c> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Light Red.
|
Name | <&d> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Magenta.
|
Name | <&e> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Yellow.
|
Name | <&f> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters White.
|
Name | <&k> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters obfuscated.
|
Name | <&l> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters bold.
|
Name | <&m> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters have a strike-through.
|
Name | <&n> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters have an underline.
|
Name | <&o> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters italicized.
|
Name | <&r> |
Returns | ElementTag |
Description | Returns the ChatColor that resets the following characters to normal.
|
Name | <black> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Black.
|
Name | <dark_blue> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Blue.
|
Name | <dark_green> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Green.
|
Name | <dark_aqua> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Cyan.
|
Name | <dark_red> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Red.
|
Name | <dark_purple> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Magenta.
|
Name | <gold> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Gold.
|
Name | <gray> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Light Gray.
|
Name | <dark_gray> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Dark Gray.
|
Name | <blue> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Light Blue.
|
Name | <green> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Light Green.
|
Name | <aqua> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Cyan.
|
Name | <red> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Light Red.
|
Name | <light_purple> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Magenta.
|
Name | <yellow> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters Yellow.
|
Name | <white> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters White.
|
Name | <magic> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters obfuscated.
|
Name | <bold> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters bold.
|
Name | <strikethrough> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters have a strike-through.
|
Name | <underline> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters have an underline.
|
Name | <italic> |
Returns | ElementTag |
Description | Returns the ChatColor that makes the following characters italicized.
|
Name | <reset> |
Returns | ElementTag |
Description | Returns the ChatColor that resets the following characters to normal.
|
Name | <trade[<trade>]> |
Returns | TradeTag |
Description | Returns a trade object constructed from the input value.
|
Name | <world[<world>]> |
Returns | WorldTag |
Description | Returns a world object constructed from the input value.
|
Name | <skyblock.island_world> |
Returns | WorldTag |
Description | Returns the world that A Skyblock uses for islands.
|
Note | This tag requires the plugin(s) Depenizen, A SkyBlock! |
Name | <skyblock.nether_world> |
Returns | WorldTag |
Description | Returns the world that A Skyblock uses for the nether.
|
Note | This tag requires the plugin(s) Depenizen, A SkyBlock! |
Name | <skyblock.island_count> |
Returns | ElementTag(Number) |
Description | Returns the number of Skyblock Islands that exist.
|
Note | This tag requires the plugin(s) Depenizen, A SkyBlock! |
Name | <essentials.warp[<warp name>]> |
Returns | LocationTag |
Description | Returns the location of the warp name.
|
Note | This tag requires the plugin(s) Depenizen, Essentials! |
Name | <essentials.list_warps> |
Returns | ListTag(Element) |
Description | Returns a list of all Warp names.
|
Note | This tag requires the plugin(s) Depenizen, Essentials! |
Name | <faction[<name>]> |
Returns | FactionTag |
Description | Returns the faction for the input name.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <factions.list_factions> |
Returns | ListTag(dFaction) |
Description | Returns a list of all current factions.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <griefprevention.list_claims> |
Returns | ListTag(GriefPreventionClaimTag) |
Description | Returns a list of all GriefPrevention claims.
|
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <jobs[(<name>)]> |
Returns | ListTag(dJob)/dJob |
Description | Returns a list of all known dJobs, or the job by the given input name if one is given.
|
Note | This tag requires the plugin(s) Depenizen, Jobs! |
Name | <luckperms.list_tracks> |
Returns | ListTag(luckpermstrack) |
Description | Returns a list of all tracks.
|
Note | This tag requires the plugin(s) Depenizen, LuckPerms! |
Name | <luckperms.track[<track name>]> |
Returns | luckpermstrack |
Description | Returns the track from the name given.
|
Note | This tag requires the plugin(s) Depenizen, LuckPerms! |
Name | <mobarena[<name>]> |
Returns | MobArena |
Description | Returns the mob arena for the input name.
|
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <mobarena.list_arenas> |
Returns | ListTag(MobArena) |
Description | Returns a list of all MobArenas.
|
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <mythic_item[<name>]> |
Returns | ItemTag |
Description | Returns an ItemTag of the named mythic item.
|
Note | This tag requires the plugin(s) Depenizen, MythicMobs! |
Name | <pvparena[<name>]> |
Returns | PVPArena |
Description | Returns the PVPArena by the input name.
|
Note | This tag requires the plugin(s) Depenizen, PVPArena! |
Name | <pvparena.list_arenas> |
Returns | ListTag(PVPArena) |
Description | Returns a list of all PVPArenas.
|
Note | This tag requires the plugin(s) Depenizen, PVPArena! |
Name | <placeholder[<name>]> |
Returns | ElementTag |
Description | Returns the value of the placeholder.
|
Note | This tag requires the plugin(s) Depenizen, PlaceholderAPI! |
Name | <playerpoints.leaders> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all players known to PlayerPoints, sorted in order of point value.
Use like, for example, '<playerpoints.leaders.get[1].to[10]>' to get the top 10. |
Note | This tag requires the plugin(s) Depenizen, PlayerPoints! |
Name | <quests.list_quests> |
Returns | ListTag |
Description | Returns a list of all quest IDs from the Quests plugin.
|
Note | This tag requires the plugin(s) Depenizen, Quests! |
Name | <towny.list_towns[<world name>]> |
Returns | ListTag(Element) |
Description | Returns a list of all towns. Optionally specify a world name.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <town[<name>]> |
Returns | TownTag |
Description | Returns the town by the input name.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <nation[<name>]> |
Returns | NationTag |
Description | Returns the nation by the input name.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <bungee.server> |
Returns | ElementTag |
Description | Returns the name of the current server (according to the Bungee proxy config).
|
Note | This tag requires the plugin(s) Depenizen, BungeeCord! |
Name | <bungee.list_servers> |
Returns | ListTag |
Description | Returns a list of known bungee server names.
|
Note | This tag requires the plugin(s) Depenizen, BungeeCord! |
Name | <bungee.connected> |
Returns | ElementTag(Boolean) |
Description | Returns this server is currently connected to the BungeeCord proxy server.
|
Note | This tag requires the plugin(s) Depenizen, BungeeCord! |
Name | <AreaShopTag.is_bought> |
Returns | ElementTag(Boolean) |
Description | Returns whether this AreaShop has been bought.
|
Note | This tag requires the plugin(s) Depenizen, AreaShop! |
Name | <AreaShopTag.is_rented> |
Returns | ElementTag(Boolean) |
Description | Returns whether this AreaShop is being rented.
|
Note | This tag requires the plugin(s) Depenizen, AreaShop! |
Name | <AreaShopTag.groups> |
Returns | ListTag |
Description | Returns a list of groups that control this AreaShop.
|
Note | This tag requires the plugin(s) Depenizen, AreaShop! |
Name | <AreaShopTag.landlord> |
Returns | PlayerTag |
Description | Returns the landlord of the AreaShop.
|
Note | This tag requires the plugin(s) Depenizen, AreaShop! |
Name | <AreaShopTag.name> |
Returns | ElementTag |
Description | Returns the name of the AreaShop.
|
Note | This tag requires the plugin(s) Depenizen, AreaShop! |
Name | <AreaShopTag.owner> |
Returns | PlayerTag |
Description | Returns the owner of the AreaShop.
|
Note | This tag requires the plugin(s) Depenizen, AreaShop! |
Name | <AreaShopTag.worldguard_region> |
Returns | WorldGuardRegion |
Description | Returns the WorldGuardRegion that holds the AreaShop.
|
Note | This tag requires the plugin(s) Depenizen, AreaShop! |
Name | <FactionTag.balance> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of money the faction currently has.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <FactionTag.warp[<name>]> |
Returns | LocationTag |
Description | Returns the location of the faction's warp by name, if any.
Note that this was previously named "home" instead of "warp". |
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <FactionTag.id> |
Returns | ElementTag |
Description | Returns the unique ID for this faction.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <FactionTag.is_open> |
Returns | ElementTag(Boolean) |
Description | Returns true if the faction is open.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <FactionTag.is_peaceful> |
Returns | ElementTag(Boolean) |
Description | Returns true if the faction is peaceful.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <FactionTag.is_permanent> |
Returns | ElementTag(Boolean) |
Description | Returns true if the faction is permanent.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <FactionTag.leader> |
Returns | PlayerTag |
Description | Returns the faction's leader as a PlayerTag.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <FactionTag.name> |
Returns | ElementTag |
Description | Returns the name of the faction.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <FactionTag.player_count> |
Returns | ElementTag(Number) |
Description | Returns the number of players in the faction.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <FactionTag.power> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of power the faction currently has.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <FactionTag.relation[<faction>]> |
Returns | ElementTag |
Description | Returns the current relation between the faction and another faction.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <FactionTag.size> |
Returns | ElementTag(Number) |
Description | Returns the amount of land the faction has.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <FactionTag.type> |
Returns | ElementTag |
Description | Always returns 'Faction' for dFaction objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <FactionTag.claimed_chunks> |
Returns | ListTag(ChunkTag) |
Description | Returns a list of all chunks claimed in the faction.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <FactionTag.list_players> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all players in the faction.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <NationTag.allies> |
Returns | ListTag(dNation) |
Description | Returns a list of the nation's allies.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <NationTag.assistants> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of the nation's assistants.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <NationTag.balance> |
Returns | ElementTag(Decimal) |
Description | Returns the current money balance of the nation.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <NationTag.capital> |
Returns | TownTag |
Description | Returns the capital city of the nation as a dTown.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <NationTag.enemies> |
Returns | ListTag(dNation) |
Description | Returns a list of the nation's enemies.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <NationTag.is_neutral> |
Returns | ElementTag(Boolean) |
Description | Returns true if the nation is neutral.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <NationTag.king> |
Returns | PlayerTag |
Description | Returns the king of the nation.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <NationTag.name> |
Returns | ElementTag |
Description | Returns the nation's name.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <NationTag.player_count> |
Returns | ElementTag(Number) |
Description | Returns the amount of players in the nation.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <NationTag.relation[<nation>]> |
Returns | ElementTag |
Description | Returns the nation's current relation with another nation.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <NationTag.residents> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of the nation's residents.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <NationTag.tag> |
Returns | ElementTag |
Description | Returns the nation's tag.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <NationTag.taxes> |
Returns | ElementTag(Decimal) |
Description | Returns the nation's current taxes.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <NationTag.town_count> |
Returns | ElementTag(Number) |
Description | Returns the number of towns in the nation.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <NationTag.type> |
Returns | ElementTag |
Description | Always returns 'Nation' for dNation objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <GriefPreventionClaimTag.id> |
Returns | ElementTag(Number) |
Description | Returns the GriefPreventionClaim's ID.
|
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <GriefPreventionClaimTag.managers> |
Returns | ListTag(PlayerTag) |
Description | Returns the GriefPreventionClaim's managers.
|
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <GriefPreventionClaimTag.trusted> |
Returns | ListTag(PlayerTag) |
Description | Returns the GriefPreventionClaim's trusted.
|
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <GriefPreventionClaimTag.builders> |
Returns | ListTag(PlayerTag) |
Description | Returns the GriefPreventionClaim's builders.
|
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <GriefPreventionClaimTag.containers> |
Returns | ListTag(PlayerTag) |
Description | Returns the GriefPreventionClaim's containers.
|
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <GriefPreventionClaimTag.accessors> |
Returns | ListTag(PlayerTag) |
Description | Returns the GriefPreventionClaim's accessors.
|
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <GriefPreventionClaimTag.owner> |
Returns | PlayerTag/Element |
Description | Returns the GriefPreventionClaim's owner.
Can be "Admin" or a PlayerTag. |
Mechanism | This tag can be modified using mechanism/GriefPreventionClaim.owner |
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <GriefPreventionClaimTag.cuboid> |
Returns | CuboidTag |
Description | Returns the GriefPreventionClaim's cuboid area.
|
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <GriefPreventionClaimTag.is_adminclaim> |
Returns | ElementTag(Boolean) |
Description | Returns whether GriefPreventionClaim is an Admin Claim.
|
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <GriefPreventionClaimTag.chunks> |
Returns | ListTag(ChunkTag) |
Description | Returns a list of all chunks in the GriefPreventionClaim.
|
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <GriefPreventionClaimTag.can_siege[<player>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the GriefPreventionClaim can siege the player.
|
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <GriefPreventionClaimTag.is_sieged> |
Returns | ElementTag(Boolean) |
Description | Returns whether the GriefPreventionClaim is currently under siege.
|
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <JobsJobTag.xp.max> |
Returns | ElementTag(Number) |
Description | Returns the maximum experience a player can get in a specified job.
|
Note | This tag requires the plugin(s) Depenizen, Jobs! |
Name | <JobsJobTag.xp.level> |
Returns | ElementTag(Number) |
Description | Returns the current experience level a player has in a specified job.
|
Note | This tag requires the plugin(s) Depenizen, Jobs! |
Name | <JobsJobTag.xp> |
Returns | ElementTag(Decimal) |
Description | Returns the current experience a player has in a specified job.
|
Note | This tag requires the plugin(s) Depenizen, Jobs! |
Name | <JobsJobTag.color> |
Returns | ElementTag |
Description | Returns the ChatColor of the job.
|
Note | This tag requires the plugin(s) Depenizen, Jobs! |
Name | <JobsJobTag.description> |
Returns | ElementTag |
Description | Returns the description of the job.
|
Note | This tag requires the plugin(s) Depenizen, Jobs! |
Name | <JobsJobTag.name.short> |
Returns | ElementTag |
Description | Returns the shortened name of the job.
|
Note | This tag requires the plugin(s) Depenizen, Jobs! |
Name | <JobsJobTag.name> |
Returns | ElementTag |
Description | Returns the name of the job.
|
Note | This tag requires the plugin(s) Depenizen, Jobs! |
Name | <jobs@job.type> |
Returns | ElementTag |
Description | Always returns 'Job' for JobsJob objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Note | This tag requires the plugin(s) Depenizen, Jobs! |
Name | <LibsDisguiseTag.type> |
Returns | ElementTag |
Description | Returns the type of the disguise.
|
Note | This tag requires the plugin(s) Depenizen, LibsDisguises! |
Name | <LibsDisguiseTag.entity> |
Returns | EntityTag |
Description | Returns the entity of the disguise.
|
Note | This tag requires the plugin(s) Depenizen, LibsDisguises! |
Name | <LibsDisguiseTag.display_name> |
Returns | ElementTag |
Description | Returns the display name of the disguise.
|
Note | This tag requires the plugin(s) Depenizen, LibsDisguises! |
Name | <LuckPermsTrackTag.name> |
Returns | ElementTag |
Description | Returns the name of the track.
|
Note | This tag requires the plugin(s) Depenizen, LuckPerms! |
Name | <LuckPermsTrackTag.groups> |
Returns | ListTag(Element) |
Description | Returns the list of groups in the track.
|
Note | This tag requires the plugin(s) Depenizen, LuckPerms! |
Name | <PartyTag.name> |
Returns | ElementTag |
Description | Returns the name of the party.
|
Note | This tag requires the plugin(s) Depenizen, mcMMO! |
Name | <PartyTag.leader> |
Returns | PlayerTag |
Description | Returns the leader of the party.
|
Note | This tag requires the plugin(s) Depenizen, mcMMO! |
Name | <PartyTag.members> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all party members.
|
Note | This tag requires the plugin(s) Depenizen, mcMMO! |
Name | <MobArenaArenaTag.name> |
Returns | ElementTag |
Description | Returns the name of the arena.
|
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <MobArenaArenaTag.config_name> |
Returns | ElementTag |
Description | Returns the configuration name of the arena.
|
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <MobArenaArenaTag.is_running> |
Returns | ElementTag(Boolean) |
Description | Returns whether the arena is running.
|
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <MobArenaArenaTag.wave_count> |
Returns | ElementTag(Number) |
Description | Returns the number of waves this arena has in total.
|
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <MobArenaArenaTag.current_wave> |
Returns | ElementTag(Number) |
Description | Returns the current wave number.
NOTE: Requires the arena to be running. |
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <MobArenaArenaTag.wave_type> |
Returns | ElementTag |
Description | Returns the type of the current wave.
NOTE: Requires the arena to be running. |
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <MobArenaArenaTag.is_enabled> |
Returns | ElementTag(Boolean) |
Description | Returns whether the arena is enabled.
|
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <MobArenaArenaTag.status> |
Returns | ElementTag |
Description | Returns the status of the arena.
Will return 'closed', 'open', or 'running'. |
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <MobArenaArenaTag.players.in_arena> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of players in the arena.
|
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <MobArenaArenaTag.players.in_lobby> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of players in the lobby.
|
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <MobArenaArenaTag.players> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all players in the arena (including the lobby).
|
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <MobArenaArenaTag.type> |
Returns | ElementTag |
Description | Always returns 'MobArena' for MobArena objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <MythicMobsMobTag.internal_name> |
Returns | ElementTag |
Description | Returns the name MythicMobs identifies the MythicMob with.
|
Note | This tag requires the plugin(s) Depenizen, MythicMobs! |
Name | <MythicMobsMobTag.display_name> |
Returns | ElementTag |
Description | Returns the display name of the MythicMob.
|
Note | This tag requires the plugin(s) Depenizen, MythicMobs! |
Name | <MythicMobsMobTag.spawner_name> |
Returns | ElementTag |
Description | Returns the name of the spawner (as set on creation in-game) that spawned this mob.
Returns null, if the mob was spawned by something other than a spawner. |
Note | This tag requires the plugin(s) Depenizen, MythicMobs! |
Name | <MythicMobsMobTag.level> |
Returns | ElementTag(Number) |
Description | Returns the level of the MythicMob.
|
Note | This tag requires the plugin(s) Depenizen, MythicMobs! |
Name | <MythicMobsMobTag.players_killed> |
Returns | ElementTag(Number) |
Description | Returns the number of players the MythicMob has killed.
|
Note | This tag requires the plugin(s) Depenizen, MythicMobs! |
Name | <MythicMobsMobTag.damage> |
Returns | ElementTag(Decimal) |
Description | Returns the damage the MythicMob deals.
|
Note | This tag requires the plugin(s) Depenizen, MythicMobs! |
Name | <MythicMobsMobTag.armor> |
Returns | ElementTag(Decimal) |
Description | Returns the armor the MythicMob has.
|
Note | This tag requires the plugin(s) Depenizen, MythicMobs! |
Name | <MythicMobsMobTag.has_target> |
Returns | ElementTag(Boolean) |
Description | Returns whether the MythicMob has a target.
|
Note | This tag requires the plugin(s) Depenizen, MythicMobs! |
Name | <MythicMobsMobTag.target> |
Returns | EntityTag |
Description | Returns the MythicMob's target.
|
Note | This tag requires the plugin(s) Depenizen, MythicMobs! |
Name | <MythicMobsMobTag.is_damaging> |
Returns | ElementTag(Boolean) |
Description | Returns whether the MythicMob is using its damaging skill.
|
Note | This tag requires the plugin(s) Depenizen, MythicMobs! |
Name | <MythicMobsMobTag.entity> |
Returns | EntityTag |
Description | Returns the EntityTag for the MythicMob.
|
Note | This tag requires the plugin(s) Depenizen, MythicMobs! |
Name | <MythicMobsMobTag.global_cooldown> |
Returns | ElementTag(Number) |
Description | Returns the MythicMob's global cooldown.
|
Note | This tag requires the plugin(s) Depenizen, MythicMobs! |
Name | <MythicMobsMobTag.type> |
Returns | ElementTag |
Description | Always returns 'Mythic Mob' for MythicMob objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Note | This tag requires the plugin(s) Depenizen, MythicMobs! |
Name | <PlotSquaredPlotTag.id_x> |
Returns | ElementTag(Number) |
Description | Returns the plot's X coordinate portion of its ID.
|
Note | This tag requires the plugin(s) Depenizen, PlotSquared! |
Name | <PlotSquaredPlotTag.id_Z> |
Returns | ElementTag(Number) |
Description | Returns the plot's Z coordinate portion of its ID.
|
Note | This tag requires the plugin(s) Depenizen, PlotSquared! |
Name | <PlotSquaredPlotTag.home> |
Returns | LocationTag |
Description | Returns the plot's current home location.
|
Note | This tag requires the plugin(s) Depenizen, PlotSquared! |
Name | <PlotSquaredPlotTag.default_home> |
Returns | LocationTag |
Description | Returns the plot's default home location.
|
Note | This tag requires the plugin(s) Depenizen, PlotSquared! |
Name | <PlotSquaredPlotTag.world> |
Returns | WorldTag |
Description | Returns the plot's world.
|
Note | This tag requires the plugin(s) Depenizen, PlotSquared! |
Name | <PlotSquaredPlotTag.owners> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all owners of the plot.
|
Note | This tag requires the plugin(s) Depenizen, PlotSquared! |
Name | <PlotSquaredPlotTag.trusted> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all trusted of the plot.
|
Note | This tag requires the plugin(s) Depenizen, PlotSquared! |
Name | <PlotSquaredPlotTag.denied> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all players denied from the plot.
|
Note | This tag requires the plugin(s) Depenizen, PlotSquared! |
Name | <PlotSquaredPlotTag.members> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all members of the plot.
|
Note | This tag requires the plugin(s) Depenizen, PlotSquared! |
Name | <PlotSquaredPlotTag.cuboid> |
Returns | CuboidTag |
Description | Returns the plot's cuboid.
|
Note | This tag requires the plugin(s) Depenizen, PlotSquared! |
Name | <PlotSquaredPlotTag.all_cuboids> |
Returns | ListTag(CuboidTag) |
Description | Returns all the plot's cuboids in a list. Useful for merged plots.
|
Note | This tag requires the plugin(s) Depenizen, PlotSquared! |
Name | <PVPArenaArenaTag.name> |
Returns | ElementTag |
Description | Returns the name of the arena.
|
Note | This tag requires the plugin(s) Depenizen, PVPArena! |
Name | <PVPArenaArenaTag.fighters> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of all fighters in the arena.
|
Note | This tag requires the plugin(s) Depenizen, PvPArena! |
Name | <PVPArenaArenaTag.type> |
Returns | ElementTag |
Description | Always returns 'PVPArena' for PVPArena objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Note | This tag requires the plugin(s) Depenizen, PVPArena! |
Name | <ResidenceTag.name> |
Returns | ElementTag |
Description | Returns the name of the residence.
|
Note | This tag requires the plugin(s) Depenizen, Residence! |
Name | <ResidenceTag.owner> |
Returns | PlayerTag |
Description | Returns the owner of the residence.
|
Note | This tag requires the plugin(s) Depenizen, Residence! |
Name | <ResidenceTag.is_within[<location>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the specified location is within this Residence.
|
Note | This tag requires the plugin(s) Depenizen, Residence! |
Name | <ShopKeeperTag.is_active> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Shopkeeper is active.
|
Note | This tag requires the plugin(s) Depenizen, ShopKeepers! |
Name | <ShopKeeperTag.is_ui_active> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Shopkeeper is currently in a trade.
|
Note | This tag requires the plugin(s) Depenizen, ShopKeepers! |
Name | <ShopKeeperTag.trades> |
Returns | ListTag) |
Description | Returns a ListTag of the Shopkeeper's trades (as escaped sub-lists).
NOTE: see '!language Property Escaping'. |
Note | This tag requires the plugin(s) Depenizen, ShopKeepers! |
Name | <ShopKeeperTag.entity> |
Returns | EntityTag |
Description | Returns the EntityTag for this ShopKeeper.
|
Note | This tag requires the plugin(s) Depenizen, ShopKeepers! |
Name | <ShopKeeperTag.owner> |
Returns | PlayerTag |
Description | Returns the player that owns this ShopKeeper, if any.
|
Note | This tag requires the plugin(s) Depenizen, ShopKeepers! |
Name | <ShopKeeperTag.type> |
Returns | ElementTag |
Description | Always returns 'ShopKeeper' for ShopKeeper objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Note | This tag requires the plugin(s) Depenizen, ShopKeepers! |
Name | <SkillAPIClassTag.name> |
Returns | ElementTag |
Description | Returns the name of this SkillAPI class.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <SkillAPIClassTag.prefix_color> |
Returns | ElementTag |
Description | Returns the color of the prefix of this SkillAPI class.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <SkillAPIClassTag.prefix> |
Returns | ElementTag |
Description | Returns the prefix of this SkillAPI class.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <SkillAPIClassTag.needs_permission> |
Returns | ElementTag(Boolean) |
Description | Returns whether this SkillAPI class requires permission to profess as it.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <SkillAPIClassTag.group.name> |
Returns | ElementTag |
Description | Returns the name of the group that this SkillAPI class falls into.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <SkillAPIClassTag.has_parent> |
Returns | ElementTag(Boolean) |
Description | Returns the whether this SkillAPI class has a parent class.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <SkillAPIClassTag.parent> |
Returns | SkillAPIClass |
Description | Returns the parent class of this SkillAPI class.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <SkillAPIClassTag.icon> |
Returns | ItemTag |
Description | Returns the item icon representing this SkillAPI class in menus.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <SkillAPIClassTag.max_level> |
Returns | ElementTag(Decimal) |
Description | Returns the maximum level that this SkillAPI class can reach.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <SkillAPIClassTag.base_health> |
Returns | ElementTag(Decimal) |
Description | Returns the base amount of health for this SkillAPI class.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <SkillAPIClassTag.health_scale> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of health gained per level for this SkillAPI class.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <SkillAPIClassTag.base_mana> |
Returns | ElementTag(Decimal) |
Description | Returns the base amount of mana for this SkillAPI class.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <SkillAPIClassTag.mana_scale> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of mana gained per level for this SkillAPI class.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <SkillAPIClassTag.mana_name> |
Returns | ElementTag |
Description | Returns the alias for mana that this SkillAPI class uses.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <SkillAPIClassTag.has_mana_regen> |
Returns | ElementTag(Boolean) |
Description | Returns whether this SkillAPI class has mana regeneration.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <SkillAPIClassTag.mana_regen> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of mana regeneration that this SkillAPI class has.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <TownTag.assistants> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of the town's assistants.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.balance> |
Returns | ElementTag(Decimal) |
Description | Returns the current money balance of the town.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.board> |
Returns | ElementTag |
Description | Returns the town's current board.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.is_open> |
Returns | ElementTag(Boolean) |
Description | Returns true if the town is currently open.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.is_public> |
Returns | ElementTag(Boolean) |
Description | Returns true if the town is currently public.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.mayor> |
Returns | PlayerTag |
Description | Returns the mayor of the town.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.name> |
Returns | ElementTag |
Description | Returns the town's names.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.nation> |
Returns | NationTag |
Description | Returns the nation that the town belongs to.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.player_count> |
Returns | ElementTag(Number) |
Description | Returns the number of players in the town.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.residents> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of the town's residents.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.size> |
Returns | ElementTag(Number) |
Description | Returns the number of blocks the town owns.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.spawn> |
Returns | LocationTag |
Description | Returns the spawn point of the town.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.tag> |
Returns | ElementTag |
Description | Returns the town's tag.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.taxes> |
Returns | ElementTag(Decimal) |
Description | Returns the town's current taxes.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.outposts> |
Returns | ListTag(LocationTag) |
Description | Returns a list of the town's outpost locations.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.type> |
Returns | ElementTag |
Description | Always returns 'Town' for dTown objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.has_explosions> |
Returns | ElementTag(Boolean) |
Description | Returns if the town has explosions turned on.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.has_mobs> |
Returns | ElementTag(Boolean) |
Description | Returns if the town has mobs turned on.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.has_pvp> |
Returns | ElementTag(Boolean) |
Description | Returns if the town has PvP turned on.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.has_firespread> |
Returns | ElementTag(Boolean) |
Description | Returns if the town has firespread turned on.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.has_taxpercent> |
Returns | ElementTag(Boolean) |
Description | Returns if the town has taxes in percentage.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.plottax> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of taxes collected from plots.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <TownTag.plotprice> |
Returns | ElementTag(Decimal) |
Description | Returns the price of a plot.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <WorldGuardRegionTag.cuboid> |
Returns | CuboidTag |
Description | Converts a cuboid-shaped region to a CuboidTag.
|
Note | This tag requires the plugin(s) Depenizen, WorldGuard! |
Group | conversion |
Name | <WorldGuardRegionTag.id> |
Returns | ElementTag |
Description | Gets the ID name of the region.
|
Note | This tag requires the plugin(s) Depenizen, WorldGuard! |
Name | <WorldGuardRegionTag.members> |
Returns | ListTag(PlayerTag) |
Description | Gets a list of all members of a region. (Members are permitted to build, etc.)
|
Note | This tag requires the plugin(s) Depenizen, WorldGuard! |
Name | <WorldGuardRegionTag.owners> |
Returns | ListTag(PlayerTag) |
Description | Gets a list of all owners of a region. (Owners are permitted to build, edit settings, etc.)
|
Note | This tag requires the plugin(s) Depenizen, WorldGuard! |
Name | <WorldGuardRegionTag.type> |
Returns | ElementTag |
Description | Always returns 'Region' for WorldGuardRegion objects. All objects fetchable by the Object Fetcher will return the
type of object that is fulfilling this attribute. |
Note | This tag requires the plugin(s) Depenizen, WorldGuard! |
Name | <WorldGuardRegionTag.world> |
Returns | WorldTag |
Description | Gets the WorldTag this region is in.
|
Note | This tag requires the plugin(s) Depenizen, WorldGuard! |
Name | <PlayerTag.areashop.owned> |
Returns | ListTag(AreaShop) |
Description | Returns a list of AreaShops the player owns.
|
Note | This tag requires the plugin(s) Depenizen, AreaShop! |
Name | <LocationTag.skyblock.has_skyblock> |
Returns | ElementTag(Boolean) |
Description | Returns whether the location has a skyblock.
|
Note | This tag requires the plugin(s) Depenizen, A SkyBlock! |
Name | <LocationTag.skyblock.get_owner> |
Returns | PlayerTag |
Description | Returns whether the owner of the skyblock at the location.
|
Note | This tag requires the plugin(s) Depenizen, A SkyBlock! |
Name | <PlayerTag.skyblock.has_skyblock> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has a skyblock.
|
Note | This tag requires the plugin(s) Depenizen, A SkyBlock! |
Name | <PlayerTag.skyblock.center> |
Returns | LocationTag |
Description | Returns the centre of the player's skyblock.
|
Note | This tag requires the plugin(s) Depenizen, A SkyBlock! |
Name | <PlayerTag.skyblock.spawn_point> |
Returns | LocationTag |
Description | Returns the spawnpoint of the player's skyblock.
|
Note | This tag requires the plugin(s) Depenizen, A SkyBlock! |
Name | <PlayerTag.skyblock.members> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of members of the player's skyblock.
|
Note | This tag requires the plugin(s) Depenizen, A SkyBlock! |
Name | <PlayerTag.skyblock.level> |
Returns | ElementTag(Number) |
Description | Returns the level of the player's skyblock.
|
Note | This tag requires the plugin(s) Depenizen, A SkyBlock! |
Name | <WorldTag.is_skyblock_world> |
Returns | ElementTag(Boolean) |
Description | Returns whether the world is used by A SkyBlock.
|
Note | This tag requires the plugin(s) Depenizen, A SkyBlock! |
Name | <InventoryTag.is_bossshop> |
Returns | ElementTag(Boolean) |
Description | Returns whether the inventory is a BossShop.
|
Note | This tag requires the plugin(s) Depenizen, BossShop! |
Name | <ItemTag.worth> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of money one of this item is worth in Essentials.
|
Mechanism | This tag can be modified using mechanism/ItemTag.worth |
Note | This tag requires the plugin(s) Depenizen, Essentials! |
Name | <ItemTag.worth.quantity[<#>]> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of money the quantity specified of this item is worth in Essentials.
|
Note | This tag requires the plugin(s) Depenizen, Essentials! |
Name | <PlayerTag.god_mode> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is currently in god mode.
|
Mechanism | This tag can be modified using mechanism/PlayerTag.god_mode |
Note | This tag requires the plugin(s) Depenizen, Essentials! |
Name | <PlayerTag.has_home> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has set at least one home.
|
Note | This tag requires the plugin(s) Depenizen, Essentials! |
Name | <PlayerTag.is_afk> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is AFK.
|
Mechanism | This tag can be modified using mechanism/PlayerTag.is_afk |
Note | This tag requires the plugin(s) Depenizen, Essentials! |
Name | <PlayerTag.is_muted> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is muted.
|
Mechanism | This tag can be modified using mechanism/PlayerTag.is_muted |
Note | This tag requires the plugin(s) Depenizen, Essentials! |
Name | <PlayerTag.is_vanished> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is vanished.
|
Mechanism | This tag can be modified using mechanism/PlayerTag.vanish |
Note | This tag requires the plugin(s) Depenizen, Essentials! |
Name | <PlayerTag.list_homes> |
Returns | ListTag |
Description | Returns a list of the homes of the player, in the format "HomeName/l@x,y,z,world".
|
Note | This tag requires the plugin(s) Depenizen, Essentials! |
Name | <PlayerTag.list_home_locations> |
Returns | ListTag(LocationTag) |
Description | Returns a list of the locations of homes of the player.
|
Note | This tag requires the plugin(s) Depenizen, Essentials! |
Name | <PlayerTag.list_home_names> |
Returns | ListTag |
Description | Returns a list of the names of homes of the player.
|
Note | This tag requires the plugin(s) Depenizen, Essentials! |
Name | <PlayerTag.ignored_players> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of the ignored players of the player.
|
Note | This tag requires the plugin(s) Depenizen, Essentials! |
Name | <PlayerTag.list_mails> |
Returns | ListTag |
Description | Returns a list of mail the player currently has.
|
Note | This tag requires the plugin(s) Depenizen, Essentials! |
Name | <PlayerTag.mute_timeout> |
Returns | DurationTag |
Description | Returns how much time is left until the player is muted.
|
Note | This tag requires the plugin(s) Depenizen, Essentials! |
Name | <PlayerTag.socialspy> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has SocialSpy enabled.
|
Mechanism | This tag can be modified using mechanism/PlayerTag.socialspy |
Note | This tag requires the plugin(s) Depenizen, Essentials! |
Name | <LocationTag.faction> |
Returns | FactionTag |
Description | Returns the faction at the location. (Can also be SafeZone, WarZone, or Wilderness)
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <NPCTag.factions.power> |
Returns | ElementTag(Decimal) |
Description | Returns the NPC's power level.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <NPCTag.factions.role> |
Returns | ElementTag |
Description | Returns the NPC's role in their faction.
Note: In modern Factions these are called ranks instead of roles. |
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <NPCTag.factions.title> |
Returns | ElementTag |
Description | Returns the NPC's title.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <NPCTag.faction> |
Returns | FactionTag |
Description | Returns the NPC's faction.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <PlayerTag.factions.power> |
Returns | ElementTag(Decimal) |
Description | Returns the player's power level.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <PlayerTag.factions.role> |
Returns | ElementTag |
Description | Returns the player's role in their faction.
Note: In modern Factions these are called ranks instead of roles. |
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <PlayerTag.factions.title> |
Returns | ElementTag |
Description | Returns the player's title.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <PlayerTag.faction> |
Returns | FactionTag |
Description | Returns the player's faction.
|
Note | This tag requires the plugin(s) Depenizen, Factions! |
Name | <LocationTag.griefprevention.has_claim[(<ignore_height>)]> |
Returns | ElementTag(Boolean) |
Description | Returns whether there is a GriefPreventionClaim at this location.
Optionally specify an ElementTag(Boolean) for whether to ignore Y axis. |
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <LocationTag.griefprevention.claim> |
Returns | GriefPreventionClaimTag |
Description | Returns the GriefPreventionClaim at this location.
|
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <PlayerTag.griefprevention.list_claims> |
Returns | ListTag(GriefPreventionClaimTag) |
Description | Returns a list of all claims the player has.
|
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <PlayerTag.griefprevention.claims> |
Returns | ElementTag(Number) |
Description | Returns the number of claims the player has in GriefPrevention.
|
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <PlayerTag.griefprevention.blocks.remaining> |
Returns | ElementTag(Number) |
Description | Returns the number of claim blocks the player has left.
|
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <PlayerTag.griefprevention.blocks.bonus> |
Returns | ElementTag(Number) |
Description | Returns the number of bonus claim blocks the player has.
|
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <PlayerTag.griefprevention.blocks.total> |
Returns | ElementTag(Number) |
Description | Returns the total number of claim blocks the player has.
|
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <PlayerTag.griefprevention.blocks> |
Returns | ElementTag(Number) |
Description | Returns the number of normal claim blocks the payer has.
|
Note | This tag requires the plugin(s) Depenizen, GriefPrevention! |
Name | <PlayerTag.jobs[<job>]> |
Returns | JobsJobTag |
Description | Returns the job specified with the player's information attached.
|
Note | This tag requires the plugin(s) Depenizen, Jobs! |
Name | <EntityTag.is_disguised> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is in a disguise.
|
Note | This tag requires the plugin(s) Depenizen, LibsDisguises! |
Name | <EntityTag.disguise> |
Returns | LibsDisguiseTag |
Description | Returns the disguise of the entity.
|
Note | This tag requires the plugin(s) Depenizen, LibsDisguises! |
Name | <PlayerTag.luckperms_tracks> |
Returns | ListTag(luckpermstrack) |
Description | Returns a list of tracks the player is in.
|
Note | This tag requires the plugin(s) Depenizen, LuckPerms! |
Name | <PlayerTag.magicspells.mana> |
Returns | ElementTag(Number) |
Description | Returns the mana of the player.
|
Note | This tag requires the plugin(s) Depenizen, MagicSpells! |
Name | <EntityTag.mcmmo.is_spawned_mob> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is tracked by McMMO as a 'spawned' mob (one from a spawner block or spawn egg).
|
Note | This tag requires the plugin(s) Depenizen, mcMMO! |
Name | <LocationTag.mcmmo.is_placed> |
Returns | ElementTag(Boolean) |
Description | Returns whether the location is tracked by McMMO as a player-placed block (might only apply to certain block types).
|
Note | This tag requires the plugin(s) Depenizen, mcMMO! |
Name | <PlayerTag.mcmmo.level[<skill>]> |
Returns | ElementTag(Number) |
Description | Returns the player's level in a skill. If no skill is specified,
this returns the player's overall level. |
Note | This tag requires the plugin(s) Depenizen, mcMMO! |
Name | <PlayerTag.mcmmo.party> |
Returns | ElementTag |
Description | Returns the name of the player's party.
|
Note | This tag requires the plugin(s) Depenizen, mcMMO! |
Name | <PlayerTag.mcmmo.xp[<skill>].to_next_level> |
Returns | ElementTag(Number) |
Description | Returns the amount of experience a player needs to level up
in a skill. |
Note | This tag requires the plugin(s) Depenizen, mcMMO! |
Name | <PlayerTag.mcmmo.xp[<skill>].level> |
Returns | ElementTag(Number) |
Description | Returns the player's experience level in a skill.
|
Note | This tag requires the plugin(s) Depenizen, mcMMO! |
Name | <PlayerTag.mcmmo.xp[<skill>]> |
Returns | ElementTag(Number) |
Description | Returns the player's amount of experience in a skill.
|
Note | This tag requires the plugin(s) Depenizen, mcMMO! |
Name | <PlayerTag.mcmmo.rank[<skill>]> |
Returns | ElementTag(Number) |
Description | Returns the player's current rank in a skill. If no skill is specified,
this returns the player's overall rank. |
Note | This tag requires the plugin(s) Depenizen, mcMMO! |
Name | <PlayerTag.mobarena.in_arena> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is in an arena.
|
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <PlayerTag.mobarena.current_arena> |
Returns | mobarena |
Description | Returns the arena the player is in.
NOTE: requires the player to be in an arena. |
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <PlayerTag.mobarena.class> |
Returns | ElementTag |
Description | Returns the name of the class the player is using.
NOTE: requires the player to be in an arena. |
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <PlayerTag.mobarena.stats[<mobarena>].kills> |
Returns | ElementTag(Number) |
Description | Returns the number of kills the player has in the arena.
|
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <PlayerTag.mobarena.stats[<mobarena>].damage_done> |
Returns | ElementTag(Number) |
Description | Returns the amount of damage the player has dealt in the arena.
|
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <PlayerTag.mobarena.stats[<mobarena>].damage_taken> |
Returns | ElementTag(Number) |
Description | Returns the amount of damage the player has taken in the arena.
|
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <PlayerTag.mobarena.stats[<mobarena>].last_wave> |
Returns | ElementTag(Number) |
Description | Returns the wave the player reached in their last match in the arena.
|
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <PlayerTag.mobarena.stats[<mobarena>].times_swung> |
Returns | ElementTag(Number) |
Description | Returns the number of times the player has swung their weapon in the arena.
|
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <PlayerTag.mobarena.stats[<mobarena>].times_hit> |
Returns | ElementTag(Number) |
Description | Returns the number of times the player has hit an enemy in the arena.
|
Note | This tag requires the plugin(s) Depenizen, MobArena! |
Name | <EntityTag.is_mythicmob> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is a MythicMob.
|
Note | This tag requires the plugin(s) Depenizen, MythicMobs! |
Name | <EntityTag.mythicmob> |
Returns | MythicMobsMob |
Description | Returns the MythicMob for this entity.
|
Note | This tag requires the plugin(s) Depenizen, MythicMobs! |
Name | <PlayerTag.ncp.infractions> |
Returns | ElementTag(Number) |
Description | Returns the number of infractions this player has with NoCheatPlus
NOTE: Cannot guarantee the accuracy of this tag, due to lack of API in NoCheatPlus. |
Note | This tag requires the plugin(s) Depenizen, NoCheatPlus.! |
Name | <PlayerTag.nbs_is_playing> |
Returns | ElementTag(Boolean) |
Description | Returns true if the player is currently listening to a note block song.
|
Note | This tag requires the plugin(s) Depenizen, NoteBlockAPI! |
Name | <PlayerTag.playerpoints_points> |
Returns | ElementTag(Number) |
Description | Returns the amount of points the player has. Only works on online players.
|
Note | This tag requires the plugin(s) Depenizen, PlayerPoints! |
Name | <ElementTag.as_plotsquared_plot> |
Returns | PlotSquaredPlotTag |
Description | Returns the element as a dPlotSquaredPlot.
|
Note | This tag requires the plugin(s) Depenizen, PlotSquared! |
Name | <LocationTag.plotsquared_plot> |
Returns | PlotSquaredPlotTag |
Description | Returns the plot contained by this location.
|
Note | This tag requires the plugin(s) Depenizen, PlotSquared! |
Name | <PlayerTag.plotsquared_plots[<WorldTag>]> |
Returns | ListTag(dPlotSquaredPlot) |
Description | Returns a list of plots a player has in a world. Exclude the context to get plots in all worlds.
|
Note | This tag requires the plugin(s) Depenizen, PlotSquared! |
Name | <PlayerTag.pvparena.in_arena[<pvparena>]> |
Returns | ElementTag(Boolean) |
Description | Returns true if the player is in the specified arena. If no arena is specified,
this returns true if the player is in any arena. |
Note | This tag requires the plugin(s) Depenizen, PvP Arena! |
Name | <PlayerTag.pvparena.class> |
Returns | ElementTag |
Description | Returns the player's class if they're in an arena. Otherwise, returns null.
|
Note | This tag requires the plugin(s) Depenizen, PvP Arena! |
Name | <PlayerTag.pvparena.is_ready> |
Returns | ElementTag(Boolean) |
Description | Returns true if the player is ready.
|
Note | This tag requires the plugin(s) Depenizen, PvP Arena! |
Name | <PlayerTag.pvparena.team.player_count> |
Returns | ElementTag(Number) |
Description | Returns the number of players in the team.
|
Note | This tag requires the plugin(s) Depenizen, PvP Arena! |
Name | <PlayerTag.pvparena.team.name> |
Returns | ElementTag |
Description | Returns the player's team name if they're in an arena. Otherwise, returns null.
|
Note | This tag requires the plugin(s) Depenizen, PvP Arena! |
Name | <PlayerTag.pvpstats.deaths> |
Returns | ElementTag |
Description | Returns the number of times the player has died.
|
Note | This tag requires the plugin(s) Depenizen, PvP Stats! |
Name | <PlayerTag.pvpstats.elo> |
Returns | ElementTag |
Description | Returns the Elo rating of the player.
|
Note | This tag requires the plugin(s) Depenizen, PvP Stats! |
Name | <PlayerTag.pvpstats.kills> |
Returns | ElementTag |
Description | Returns the number of players the player has killed.
|
Note | This tag requires the plugin(s) Depenizen, PvP Stats! |
Name | <PlayerTag.pvpstats.streak> |
Returns | ElementTag |
Description | Returns the current kill streak of the player.
|
Note | This tag requires the plugin(s) Depenizen, PvP Stats! |
Name | <PlayerTag.pvpstats.max_streak> |
Returns | ElementTag |
Description | Returns the highest kill streak of the player.
|
Note | This tag requires the plugin(s) Depenizen, PvP Stats! |
Name | <PlayerTag.quests.points> |
Returns | ElementTag(Number) |
Description | Returns the number of quest points the player has.
|
Note | This tag requires the plugin(s) Depenizen, Quests! |
Name | <PlayerTag.quests.completed_names> |
Returns | ListTag |
Description | Returns the names of quests the player has completed.
|
Note | This tag requires the plugin(s) Depenizen, Quests! |
Name | <PlayerTag.quests.active_names> |
Returns | ListTag |
Description | Returns the names of quests the player has active.
|
Note | This tag requires the plugin(s) Depenizen, Quests! |
Name | <PlayerTag.quests.completed> |
Returns | ElementTag(Number) |
Description | Returns the number of quests the player has completed.
|
Note | This tag requires the plugin(s) Depenizen, Quests! |
Name | <PlayerTag.quests.active> |
Returns | ElementTag(Number) |
Description | Returns the number of quests the player has active.
|
Note | This tag requires the plugin(s) Depenizen, Quests! |
Name | <LocationTag.has_residence> |
Returns | ElementTag(Boolean) |
Description | Returns if the location has a residence.
|
Note | This tag requires the plugin(s) Depenizen, Residence! |
Name | <LocationTag.residence> |
Returns | ResidenceTag |
Description | Returns the residence contained by this location.
|
Note | This tag requires the plugin(s) Depenizen, Residence! |
Name | <PlayerTag.has_main_residence> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has a main Residence.
|
Note | This tag requires the plugin(s) Depenizen, Residence! |
Name | <PlayerTag.main_residence> |
Returns | ResidenceTag |
Description | Returns the player's current main Residence if they have one.
|
Note | This tag requires the plugin(s) Depenizen, Residence! |
Name | <PlayerTag.residences> |
Returns | ListTag(dResidence) |
Description | Returns the player's current list of Residences.
|
Note | This tag requires the plugin(s) Depenizen, Residence! |
Name | <NPCTag.sentinel.chasing> |
Returns | EntityTag |
Description | Returns the entity currently being chased by this Sentinel NPC (if any).
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.targets> |
Returns | ListTag |
Description | Returns a list of all targets currently targeted by this Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.ignores> |
Returns | ListTag |
Description | Returns a list of all targets currently ignored by this Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.avoids> |
Returns | ListTag |
Description | Returns a list of all targets currently avoided by this Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.avoid_range> |
Returns | ElementTag(Decimal) |
Description | Returns the avoid range of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.range> |
Returns | ElementTag(Decimal) |
Description | Returns the range of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.raw_damage> |
Returns | ElementTag(Decimal) |
Description | Returns the raw damage value (no calculating) of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.damage> |
Returns | ElementTag(Decimal) |
Description | Returns the current damage value (with calculations if needed) of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.raw_armor> |
Returns | ElementTag(Decimal) |
Description | Returns the raw armor value (no calculating) of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.armor> |
Returns | ElementTag(Decimal) |
Description | Returns the current armor value (with calculations if needed) of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.health> |
Returns | ElementTag(Decimal) |
Description | Returns the max health of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.ranged_chase> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Sentinel NPC will chase with ranged weapons.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.close_chase> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Sentinel NPC will chase with close weapons.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.invincible> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Sentinel NPC is invincible.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.fightback> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Sentinel NPC will fight back.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.runaway> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Sentinel NPC will run away.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.attack_rate> |
Returns | DurationTag |
Description | Returns the attack rate of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.attack_rate_ranged> |
Returns | DurationTag |
Description | Returns the attack rate (at range) of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.heal_rate> |
Returns | DurationTag |
Description | Returns the heal rate of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.guarding> |
Returns | EntityTag |
Description | Returns the entity currently being guarded by this Sentinel NPC (if any).
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.needs_ammo> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Sentinel NPC needs ammo.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.safe_shot> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Sentinel NPC has safe-shot enabled.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.respawn_time> |
Returns | DurationTag |
Description | Returns how long a Sentinel NPC will wait after death before respawning.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.chase_range> |
Returns | ElementTag(Decimal) |
Description | Returns the chase range of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.spawn_point> |
Returns | LocationTag |
Description | Returns the respawn point of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.avoid_return_point> |
Returns | LocationTag |
Description | Returns the avoid return point of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.drops> |
Returns | ListTag(ItemTag) |
Description | Returns a list of items that this Sentinel NPC will drop on death.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.drop_chances> |
Returns | ListTag |
Description | Returns a list of drop chances for items that this Sentinel NPC will drop on death.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.enemy_drops> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Sentinel NPC has enemy-drops enabled.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.enemy_target_time> |
Returns | DurationTag |
Description | Returns how long a Sentinel NPC will wait before abandoning an unseen target.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.speed> |
Returns | ElementTag(Decimal) |
Description | Returns the movement speed of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.warning> |
Returns | ElementTag |
Description | Returns the warning message of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.greeting> |
Returns | ElementTag |
Description | Returns the greeting message of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.greet_range> |
Returns | ElementTag(Decimal) |
Description | Returns the greeting range of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.greet_rate> |
Returns | DurationTag |
Description | Returns the greeting rate of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.autoswitch> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Sentinel NPC will automatically switch weapons.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.squad> |
Returns | ElementTag |
Description | Returns the name of this Sentinel NPC's squad (if any).
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.accuracy> |
Returns | ElementTag(Decimal) |
Description | Returns the accuracy value of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.realistic> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Sentinel NPC is set to realistic targeting mode.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.reach> |
Returns | ElementTag(Decimal) |
Description | Returns the hand reach value of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.guard_distance_minimum> |
Returns | ElementTag(Decimal) |
Description | Returns the minimum-guard-distance value of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.guard_selection_range> |
Returns | ElementTag(Decimal) |
Description | Returns the guard-selection-range value of a Sentinel NPC.
|
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.weapon_damage> |
Returns | ListTag |
Description | Returns a list-mapping of custom weapon damage values of a Sentinel NPC.
For example, "stick/5|stone/3" |
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <NPCTag.sentinel.weapon_redirects> |
Returns | ListTag |
Description | Returns a list-mapping of custom weapon redirect values of a Sentinel NPC.
For example, "stick/bow|stone/diamond_sword" |
Note | This tag requires the plugin(s) Depenizen, Sentinel! |
Name | <EntityTag.is_shopkeeper> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity is a Shopkeeper.
|
Note | This tag requires the plugin(s) Depenizen, ShopKeepers! |
Name | <EntityTag.shopkeeper> |
Returns | ShopKeeper |
Description | Returns the ShopKeeper for this entity.
|
Note | This tag requires the plugin(s) Depenizen, ShopKeepers! |
Name | <PlayerTag.skillapi.main_class> |
Returns | SkillAPIClass |
Description | Returns the player's main SkillAPI class.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.in_class[<class>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player professes in the specified class. If none is specified, returns
whether the player professes in any class. |
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.has_skill[<skill>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has the specified skill.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.mana> |
Returns | ElementTag(Decimal) |
Description | Returns the player's current amount of mana.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.max_mana> |
Returns | ElementTag(Decimal) |
Description | Returns the player's maximum amount of mana.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.class_exp[<class>]> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of experience the player has toward the next level in the specified class.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.class_required_exp[<class>]> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of experience the player must receive to get to the next level
in the specified class. |
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.class_total_exp[<class>]> |
Returns | ElementTag(Decimal) |
Description | Returns the total amount of experience the player has in the specified class.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.class_level[<class>]> |
Returns | ElementTag(Number) |
Description | Returns the level the player is in the specified class.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.class_points[<class>]> |
Returns | ElementTag(Number) |
Description | Returns the number of skill points the player has in the specified class.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.class_maxed[<class>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has hit maximum level in the specified class.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.class_health[<class>]> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of health the player gets from the specified class.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.class_mana[<class>]> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of mana the player gets from the specified class.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.skill_bind[<skill>]> |
Returns | MaterialTag |
Description | Returns the material this skill is currently bound to.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.skill_level_requirement[<skill>]> |
Returns | ElementTag(Number) |
Description | Returns the level the player must be to level up the specified skill.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.skill_level[<skill>]> |
Returns | ElementTag(Number) |
Description | Returns the level the player is in the specified skill.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.skill_points[<skill>]> |
Returns | ElementTag(Number) |
Description | Returns how many skill points the player has invested in the specified skill.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.skill_cost[<skill>]> |
Returns | ElementTag(Number) |
Description | Returns the cost the for the player to level up the specified skill.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.skill_on_cooldown[<skill>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the specified skill is currently on cooldown for the player.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.skill_cooldown[<skill>]> |
Returns | DurationTag |
Description | Returns the remaining cooldown the player has in the specified skill.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.skill_maxed[<skill>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has reached max level in the specified skill.
|
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <PlayerTag.skillapi.skill_status[<skill>]> |
Returns | ElementTag |
Description | Returns the player's current status for the specified skill.
Can be: ON_COOLDOWN, MISSING_MANA, or READY |
Note | This tag requires the plugin(s) Depenizen, SkillAPI! |
Name | <LocationTag.tc_biome.name> |
Returns | ElementTag |
Description | Returns the TerrainControl biome name at this location, if any.
|
Note | This tag requires the plugin(s) Depenizen, TerrainControl! |
Name | <LocationTag.tc_biome.temperature> |
Returns | ElementTag |
Description | Returns the TerrainControl biome temperature at this location, if any.
|
Note | This tag requires the plugin(s) Depenizen, TerrainControl! |
Name | <PlayerTag.townychat.channels> |
Returns | ListTag(Element) |
Description | Returns a list of all channels the player is in.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <PlayerTag.townychat.muted_in[<channel name>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is muted in the specified channel.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <PlayerTag.townychat.has_permission[<channel name>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has permissions to join the specified channel.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <CuboidTag.has_town> |
Returns | ElementTag(Boolean) |
Description | Returns whether the cuboid contains any town at all.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <CuboidTag.list_towns> |
Returns | ListTag(dTown) |
Description | Returns all the towns within the cuboid.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <LocationTag.towny.resident> |
Returns | ElementTag(Boolean) |
Description | Returns the resident of a Towny plot at the location, if any.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <LocationTag.has_town> |
Returns | ElementTag(Boolean) |
Description | Returns whether the location is within a town.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <LocationTag.town> |
Returns | TownTag |
Description | Returns the town at the specified location.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <LocationTag.is_wilderness> |
Returns | ElementTag(Boolean) |
Description | Returns whether the location is wilderness.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <PlayerTag.has_nation> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is part of a nation.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <PlayerTag.has_town> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player is part of a town.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <PlayerTag.mode_list> |
Returns | ListTag(Element) |
Description | Returns the player's towny modes as a list.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <PlayerTag.nation_ranks> |
Returns | ListTag(Element) |
Description | Returns the player's nation ranks.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <PlayerTag.nation> |
Returns | NationTag |
Description | Returns the player's nation.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <PlayerTag.town_ranks> |
Returns | ListTag(Element) |
Description | Returns the player's town ranks.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <PlayerTag.town> |
Returns | TownTag |
Description | Returns the player's town.
|
Note | This tag requires the plugin(s) Depenizen, Towny! |
Name | <PlayerTag.is_vampire> |
Returns | ElementTag(Boolean) |
Description | Returns true if the player is a vampire.
|
Note | This tag requires the plugin(s) Depenizen, Vampire! |
Name | <PlayerTag.is_ínfected> |
Returns | ElementTag(Boolean) |
Description | Returns true if the player is infected.
|
Note | This tag requires the plugin(s) Depenizen, Vampire! |
Name | <PlayerTag.combat_infect> |
Returns | ElementTag(Decimal) |
Description | Returns the value of the combat infection risk.
|
Note | This tag requires the plugin(s) Depenizen, Vampire! |
Name | <PlayerTag.combat_damage> |
Returns | ElementTag(Decimal) |
Description | Returns the value of the combat damage factor.
|
Note | This tag requires the plugin(s) Depenizen, Vampire! |
Name | <PlayerTag.viaversion> |
Returns | ElementTag(Number) |
Description | Returns the protocol version number of the player's client.
See url/https://wiki.vg/Protocol_version_numbers as a reference list. |
Note | This tag requires the plugin(s) Depenizen, ViaVersion! |
Name | <PlayerTag.we_brush_info[(<item>)]> |
Returns | ListTag |
Description | Returns information about a player's current brush for an item.
If no item is specified, will be based on their held item. Output is in format: type|size|range|material Note that some values may be listed as "unknown" or strange values due to WorldEdit having a messy API (no way to automatically stringify brush data). |
Note | This tag requires the plugin(s) Depenizen, WorldEdit! |
Name | <PlayerTag.we_selection> |
Returns | CuboidTag |
Description | Returns the player's current block area selection, as a CuboidTag.
|
Note | This tag requires the plugin(s) Depenizen, WorldEdit! |
Name | <CuboidTag.has_region> |
Returns | ElementTag(Boolean) |
Description | Returns whether the cuboid contains any region.
|
Note | This tag requires the plugin(s) Depenizen, WorldGuard! |
Name | <CuboidTag.regions> |
Returns | ListTag(Region) |
Description | Returns a list of regions that are in this cuboid.
|
Note | This tag requires the plugin(s) Depenizen, WorldGuard! |
Name | <LocationTag.in_region[<name>|...]> |
Returns | ElementTag(Boolean) |
Description | If a region name or list of names is specified, returns whether the
location is in one of the listed regions, otherwise returns whether the location is in any region. |
Note | This tag requires the plugin(s) Depenizen, WorldGuard! |
Name | <LocationTag.regions> |
Returns | ListTag(Region) |
Description | Returns a list of regions that the location is in.
|
Note | This tag requires the plugin(s) Depenizen, WorldGuard! |
Name | <PlayerTag.worldguard.can_build[<location>]> |
Returns | ElementTag(Boolean) |
Description | Whether WorldGuard allows to build at a location.
|
Note | This tag requires the plugin(s) Depenizen, WorldGuard! |
Name | <PlayerTag.worldguard.test_flag[<name>]> |
Returns | ElementTag(Boolean) |
Description | Returns the state of a flag for that player at their location.
For example: .test_flag[pvp] returns 'true' when the player can be attacked. |
Note | This tag requires the plugin(s) Depenizen, WorldGuard! |
Name | <PlayerTag.worldguard.test_flag[<name>].at[<location>]> |
Returns | ElementTag(Boolean) |
Description | Returns the state of a flag for that player at the specified location.
|
Note | This tag requires the plugin(s) Depenizen, WorldGuard! |
Name | <WorldTag.list_regions> |
Returns | ListTag(WorldGuardRegionTag) |
Description | Returns a list of WorldGuard regions in this world.
|
Note | This tag requires the plugin(s) Depenizen, WorldGuard! |
Name | <WorldTag.has_region[<name>]> |
Returns | BooleanTag |
Description | Returns whether a region exists in this world for the given name.
|
Note | This tag requires the plugin(s) Depenizen, WorldGuard! |
Name | <discord[<bot-id>].exists> |
Returns | ElementTag(Boolean) |
Description | Returns whether a Discord bot exists with the given bot ID.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <discord[<bot-id>]> |
Returns | Discord |
Description | Returns the Discord bot for the given bot ID.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordBotTag.name> |
Returns | ElementTag |
Description | Returns the name of the bot.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordBotTag.self_user> |
Returns | DiscordUserTag |
Description | Returns the bot's own Discord user object.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordBotTag.groups> |
Returns | ListTag(DiscordGroupTag) |
Description | Returns a list of all groups (aka 'guilds' or 'servers') that this Discord bot has access to.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordBotTag.group[<name>]> |
Returns | DiscordGroupTag |
Description | Returns the Discord group (aka 'guild' or 'server') that best matches the input name, or null if there's no match.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordChannelTag.name> |
Returns | ElementTag |
Description | Returns the name of the channel.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordChannelTag.type> |
Returns | ElementTag |
Description | Returns the type of the channel.
Will be any of: GUILD_TEXT, DM, GUILD_VOICE, GROUP_DM, GUILD_CATEGORY |
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordChannelTag.id> |
Returns | ElementTag(Number) |
Description | Returns the ID number of the channel.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordChannelTag.mention> |
Returns | ElementTag |
Description | Returns the raw mention string for the channel.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordChannelTag.group> |
Returns | DiscordGroupTag |
Description | Returns the group that owns this channel.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordGroupTag.name> |
Returns | ElementTag |
Description | Returns the name of the group.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordGroupTag.id> |
Returns | ElementTag(Number) |
Description | Returns the ID number of the group.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordGroupTag.channels> |
Returns | ListTag(DiscordChannelTag) |
Description | Returns a list of all channels in the group.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordGroupTag.members> |
Returns | ListTag(DiscordUserTag) |
Description | Returns a list of all users in the group.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordGroupTag.roles> |
Returns | ListTag(DiscordRoleTag) |
Description | Returns a list of all roles in the group.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordGroupTag.member[<name>]> |
Returns | DiscordUserTag |
Description | Returns the group member that best matches the input name, or null if there's no match.
For input of username#id, will always only match for the exact user. For input of only the username, return value might be unexpected if multiple members have the same username (this happens more often than you might expect - many users accidentally join new Discord groups from the web on a temporary web account, then rejoin on a local client with their 'real' account). |
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordGroupTag.channel[<name>]> |
Returns | DiscordChannelTag |
Description | Returns the channel that best matches the input name, or null if there's no match.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordGroupTag.role[<name>]> |
Returns | DiscordRoleTag |
Description | Returns the role that best matches the input name, or null if there's no match.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordRoleTag.name> |
Returns | ElementTag |
Description | Returns the name of the role.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordRoleTag.id> |
Returns | ElementTag(Number) |
Description | Returns the ID number of the role.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordRoleTag.mention> |
Returns | ElementTag |
Description | Returns the raw mention string the role.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordRoleTag.group> |
Returns | DiscordGroupTag |
Description | Returns the group that owns this role.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordUserTag.name> |
Returns | ElementTag |
Description | Returns the user name of the user.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordUserTag.is_bot> |
Returns | ElementTag(Boolean) |
Description | Returns a boolean indicating whether the user is a bot.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordUserTag.nickname[<group>]> |
Returns | ElementTag |
Description | Returns the group-specific nickname of the user (if any).
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordUserTag.id> |
Returns | ElementTag(Number) |
Description | Returns the ID number of the user.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordUserTag.mention> |
Returns | ElementTag |
Description | Returns the raw mention string for the user.
|
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordUserTag.status[<group>]> |
Returns | ElementTag |
Description | Returns the status of the user, as seen from the given group.
Can be any of: online, dnd, idle, invisible, offline. |
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordUserTag.activity_type[<group>]> |
Returns | ElementTag |
Description | Returns the activity type of the user, as seen from the given group.
Can be any of: PLAYING, LISTENING, STREAMING, WATCHING. Not present for all users. |
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordUserTag.activity_name[<group>]> |
Returns | ElementTag |
Description | Returns the name of the activity of the user, as seen from the given group.
Can be any of: PLAYING, LISTENING, STREAMING, WATCHING. Not present for all users. |
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordUserTag.activity_url[<group>]> |
Returns | ElementTag |
Description | Returns the stream URL of the activity of the user, as seen from the given group.
Can be any of: PLAYING, LISTENING, STREAMING, WATCHING. Not present for all users. |
Note | This tag requires the plugin(s) dDiscordBot! |
Name | <DiscordUserTag.roles[<group>]> |
Returns | ListTag(DiscordRoleTag) |
Description | Returns a list of all roles the user has in the given group.
|
Note | This tag requires the plugin(s) dDiscordBot! |