Skip to content

Placeholders · Changes

Page history
moved Meta Variable Placeholders to a separate page authored by Lxlp's avatar Lxlp
Show whitespace changes
Inline Side-by-side
Skills/Placeholders.md
View page @ bef07922
......@@ -258,268 +258,7 @@ Some of these variables are only generated and available under some special circ
> If you execute this metaskill yourself, this will send you a message saying `1 2 1 2` because the target of every mechanic is the caster, so the affected registry is always the caster's even if a "target" scope is used
### Meta Variable Placeholders
You can append some keywords (that we will call "meta keywords"), each specific to a variable's type, at the end of a variable placeholder in order to modify its return value and type.
```yaml
<{VariableScope}.var.{VariableName}.{keywords}>
```
Each keyword has an
- `Input Type`, which is the variable type the keyword applies to
- `Output Type`, which is the variable type that can be created from the keyword's returned value
> Placeholder support is allowed in every place inside of Variable Placeholders, so each keyword can also be another placeholder to be parsed
##
```yaml
<skill.var.exampleString.capitalize>
```
> Among all keywords for the String type, we are using the `capitalize` one, which has as an output a String type. This means that
> - It is applied to a String variable
> - It does some form of conversion to its value (in this case, capitalizing every character of the string)
> - It returns a String value
```yaml
<skill.var.exampleString.size>
```
> Among all keywords for the String type, we are using the `size` one, which has as an output an Integer type. This means that
> - It is applied to a String variable
> - It does some form of conversion to its value (in this case, returning the length of the string)
> - It returns an Integer value
##
Given that each meta keyword has a specific input and output type, it is possible to *chain* them together, obtaining a compound effect where each keyword coverts the variable's value and pass the result to the following one
```yaml
<skill.var.exampleString.substring.0.9.size.add.1>
```
> Among all keywords for the String type, we are using the `substring` one, which has as an output a String type. This means that
> - It is applied to a String variable
> - It does some form of conversion to its value (in this case, extracting the first 10 characters from the string)
> - It returns a String value
>
> Among all keywords for the String type, we are using the `size` one, which has as an output an Integer type. This means that
> - It is applied to a String variable (which the `substring` keyword just returned)
> - It does some form of conversion to its value (In this case, returning the length of the string, which we know will be between 0 and 10)
> - It returns an Integer value
>
> Among all keywords for the Integer type, we are using the `add` one, which has as an output an Integer type. This means that
> - It is applied to an Integer variable (which the `size` keyword just returned)
> - It does some form of conversion to its value (In this case, adding a value of 1 to the integer's value)
> - It returns an Integer value
#### Universal Meta Keywords
| Placeholder | Return Type | Return Value |
|--------------|-------------|----------|
| .cache | | Given the input value and the keywords used after it, this keyword will cache the result the first time the placeholder is parsed, and directly return the cached value each subsequent parsing |
| .formatted | STRING | Returns a more human-readable version of the input value |
| .tointeger | INTEGER | Converts the value to an Integer without doing any specific operation, allowing chaining for Integer meta keywords |
| .tofloat | FLOAT | Converts the value to a Float without doing any specific operation, allowing chaining for Float meta keywords |
| .tolong | LONG | Converts the value to a Long without doing any specific operation, allowing chaining for Long meta keywords |
| .todouble | DOUBLE | Converts the value to a Double without doing any specific operation, allowing chaining for Double meta keywords |
| .toboolean | BOOLEAN | Converts the value to a Boolean without doing any specific operation, allowing chaining for Boolean meta keywords |
| .tostring | STRING | Converts the value to a String without doing any specific operation, allowing chaining for String meta keywords |
| .tolocation | LOCATION | Converts the value to a Location without doing any specific operation, allowing chaining for Location meta keywords |
| .tovector | VECTOR | Converts the value to a Vector without doing any specific operation, allowing chaining for Vector meta keywords |
| .tolist | LIST | Converts the value to a List without doing any specific operation, allowing chaining for List meta keywords |
| .toset | SET | Converts the value to a Set without doing any specific operation, allowing chaining for Set meta keywords |
| .tomap | MAP | Converts the value to a Map without doing any specific operation, allowing chaining for Map meta keywords |
| .totime | TIME | Converts the value to a Time without doing any specific operation, allowing chaining for Time meta keywords |
> [Go To Explanation>>](#meta-variable-placeholders)
#### Integer Meta Keywords
| Placeholder | Return Type | Return Value |
|--------------|-------------|----------|
| .add.{Integer} | INTEGER | The addition between the value and the specified Integer |
| .sub.{Integer} | INTEGER | The subtraction between the value and the specified Integer |
| .mul.{Integer} | INTEGER | The multiplication between the value and the specified Integer |
| .div.{Integer} | INTEGER | The division between the value and the specified Integer |
| .abs | INTEGER | The absolute value of the value |
> [Go To Explanation>>](#meta-variable-placeholders)
#### Float Meta Keywords
| Placeholder | Return Type | Return Value |
|--------------|-------------|----------|
| .add.{Float} | FLOAT | The addition between the value and the specified Float |
| .sub.{Float} | FLOAT | The subtraction between the value and the specified Float |
| .mul.{Float} | FLOAT | The multiplication between the value and the specified Float |
| .div.{Float} | FLOAT | The division between the value and the specified Float |
| .abs | FLOAT | The absolute value of the value |
| .round | INTEGER | Rounds the value to the nearest Integer |
| .precision.{Integer} | FLOAT | Returns the same float value, but with a given maximum precision. Extra precision is rounded using the HALF_UP rounding mode |
> [Go To Explanation>>](#meta-variable-placeholders)
#### Long Meta Keywords
| Placeholder | Return Type | Return Value |
|--------------|-------------|----------|
| .add.{Long} | LONG | The addition between the value and the specified Long |
| .sub.{Long} | LONG | The subtraction between the value and the specified Long |
| .mul.{Long} | LONG | The multiplication between the value and the specified Long |
| .div.{Long} | LONG | The division between the value and the specified Long |
| .abs | LONG | The absolute value of the value |
> [Go To Explanation>>](#meta-variable-placeholders)
#### Double Meta Keywords
| Placeholder | Return Type | Return Value |
|--------------|-------------|----------|
| .add.{Double} | DOUBLE | The addition between the value and the specified Double |
| .sub.{Double} | DOUBLE | The subtraction between the value and the specified Double |
| .mul.{Double} | DOUBLE | The multiplication between the value and the specified Double |
| .div.{Double} | DOUBLE | The division between the value and the specified Double |
| .abs | DOUBLE | The absolute value of the value |
| .round | LONG | Rounds the value to the nearest Long |
| .precision.{Integer} | DOUBLE | Returns the same float value, but with a given maximum precision. Extra precision is rounded using the HALF_UP rounding mode |
> [Go To Explanation>>](#meta-variable-placeholders)
#### Boolean Meta Keywords
| Placeholder | Return Type | Return Value |
|--------------|-------------|----------|
| .inverse | BOOLEAN | The inverse of the value |
| .number | INTEGER | The value as either a 0 (false) or 1 (true) |
| .yesno | STRING | The value as either a no (false) or yes (true) |
| .union.{Boolean} | BOOLEAN | Logical OR with specified Boolean |
| .intersection.{Boolean} | BOOLEAN | Logical AND with specified Boolean |
| .difference.{Boolean} | BOOLEAN | True if value is true and argument is false |
> [Go To Explanation>>](#meta-variable-placeholders)
#### String Meta Keywords
| Placeholder | Return Type | Return Value |
|--------------|-------------|--------------|
| .size | INTEGER | The length of the string |
| .uppercase | STRING | The string in uppercase |
| .lowercase | STRING | The string in lowercase |
| .capitalize | STRING | The string with the first character in uppercase |
| .trim | STRING | The string with leading and trailing spaces removed |
| .replace.{old}.{new} | STRING | The string with occurrences of `old` replaced by `new` |
| .remove.{text} | STRING | The string with occurrences of `text` removed |
| .contains.{text} | BOOLEAN | Whether the string contains `text` |
| .substring.{start}.{end} | STRING | A substring from index `start` to `end` |
| .shift.{Integer} | STRING | Removes the first `Integer` characters |
| .split.{regex}.{joiner} | STRING | Splits the string by `regex`, then joins it with `joiner` |
| .indexof.{text} | INTEGER | The index of the first occurrence of `text` |
| .lastindexof.{text} | INTEGER | The index of the last occurrence of `text` |
| .startswith.{text} | BOOLEAN | Whether the string starts with `text` |
| .endswith.{text} | BOOLEAN | Whether the string ends with `text` |
| .append.{text} | STRING | Appends `text` to the end of the string |
| .prepend.{text} | STRING | Prepends `text` to the beginning of the string |
| .insert.{index}.{text} | STRING | Inserts `text` at the specified `index` |
| .regex.{pattern} | BOOLEAN | Whether the string matches the regex `pattern` |
| .{index} | STRING | Returns the character at the specified `index` |
> [Go To Explanation>>](#meta-variable-placeholders)
#### Set Meta Keywords
| Placeholder | Return Type | Return Value |
|--------------|-------------|--------------|
| .size | INTEGER | The number of elements in the set |
| .join.{delimiter} | STRING | Joins all elements using the `delimiter` |
| .contains.{element} | BOOLEAN | Whether the set contains the given `element` |
> [Go To Explanation>>](#meta-variable-placeholders)
#### Location Meta Keywords
| Placeholder | Return Type | Return Value |
|--------------|-------------|--------------|
| .x | DOUBLE | The X coordinate |
| .y | DOUBLE | The Y coordinate |
| .z | DOUBLE | The Z coordinate |
| .world | STRING | The world name |
| .yaw | DOUBLE | The yaw |
| .pitch | DOUBLE | The pitch |
| .coords | LIST | A list with the X, Y, and Z coordinates |
> [Go To Explanation>>](#meta-variable-placeholders)
#### Vector Meta Keywords
| Placeholder | Return Type | Return Value |
|--------------|-------------|--------------|
| .x | DOUBLE | The X component |
| .y | DOUBLE | The Y component |
| .z | DOUBLE | The Z component |
| .normalized | VECTOR | The normalized vector |
| .length | DOUBLE | The length (magnitude) of the vector |
| .mul.{vector} | VECTOR | Multiplies the vector by another vector |
| .div.{vector} | VECTOR | Divides the vector by another vector |
| .add.{vector} | VECTOR | Adds another vector |
| .sub.{vector} | VECTOR | Subtracts another vector |
| .rotate.{axis}.{angle} | VECTOR | Rotates the vector around `axis` by `angle` radians |
> [Go To Explanation>>](#meta-variable-placeholders)
#### List Meta Keywords
| Placeholder | Return Type | Return Value |
|--------------|-------------|--------------|
| .size | INTEGER | Number of elements in the list |
| .first | STRING | First element in the list |
| .last | STRING | Last element in the list |
| .reverse | LIST | The list reversed |
| .sort | LIST | The list sorted alphabetically |
| .sortnum | LIST | This list sorted numerically. Each element of the list needs to be a number |
| .shuffle | LIST | Shuffles the list, randomizing its elements |
| .get.{index} | STRING | Element at specified `index` |
| .join.{delimiter} | STRING | Joins elements using `delimiter` |
| .contains.{element} | BOOLEAN | Whether the list contains `element` |
| .maxnumber | DOUBLE | Maximum numerical value in list |
| .minnumber | DOUBLE | Minimum numerical value in list |
| .indexof.{value} | INTEGER | Index of first occurrence of `value` |
| .lastindexof.{value} | INTEGER | Index of last occurrence of `value` |
| .slice.{from}.{to} | LIST | Slice of list from `from` to `to` |
| .slicefrom.{index} | LIST | Slice of list from `index` to end |
| .sliceto.{index} | LIST | Slice of list from start to `index` |
| .append.{value} | LIST | Adds `value` to the end of the list |
| .prepend.{value} | LIST | Adds `value` to the start of the list |
| .insert.{index}.{value} | LIST | Inserts `value` at the given `index` |
| .remove.{index} | LIST | Removes value at given `index` |
| .{index} | STRING | Element at specified `index` |
> [Go To Explanation>>](#meta-variable-placeholders)
#### Map Meta Keywords
| Placeholder | Return Type | Return Value |
|--------------|-------------|--------------|
| .size | INTEGER | Number of key-value pairs |
| .keys | LIST | List of all keys |
| .values | LIST | List of all values |
| .get.{key} | STRING | Value associated with the specified `key` |
| .{key} | STRING | Value associated with the specified `key` |
> [Go To Explanation>>](#meta-variable-placeholders)
#### Time Meta Keywords
| Placeholder | Return Type | Return Value |
|--------------|-------------|--------------|
| .delta.{timestamp} | INTEGER | Difference between the value's time and the and given `timestamp` |
| .formatted.{pattern} | STRING | Formatted date/time using the specified pattern. The pattern can be anything the Java function [ZoneOffset.of](https://docs.oracle.com/javase/8/docs/api/java/time/ZoneOffset.html#of-java.lang.String-) accepts |
| .duration | STRING | Interprets the Time as a raw "amount of milliseconds" and displays the total amount of Seconds, Minutes, Hours, Days, Months and Years. Can be useful for countdowns and the likes, especially if paired with the `.delta` meta keywords|
> [Go To Explanation>>](#meta-variable-placeholders)
#### Item Meta Keywords
| Placeholder | Return Type | Return Value |
|-------------|-------------|--------------|
| .withType.{material} | ITEM | Returns the same item but with its type set to the specified `material` (case-insensitive, must match a valid `Material` enum) |
| .withDurability.{value} | ITEM | Returns the same item but with its durability set to the specified integer `value` |
| .withMaxDurability.{value} | ITEM | Returns the same item but with its maximum durability set to the specified integer `value` |
| .withLore.{list} | ITEM | Returns the same item but with its lore set to the specified list of strings. |
| .withName.{name} | ITEM | Returns the same item but with its display name set to `name` |
| .withMythicType.{type} | ITEM | Returns the same item but with its persistent "Mythic Type" set to `type`, allowing you to make Mythic believe the modified item is the `type` mythic item |
| .withEnchants.{map} | ITEM | Returns the same item but with enchantments replaced by those provided in the map. Removes all previous enchantments before applying the new ones |
| .withCustomData.{namespace}.{key}.{value} | ITEM | Returns the same item but with custom persistent data (`value` stored under `namespace:key`) |
| .withAmount.{value} | ITEM | Returns the same item but with its stack amount set to `value` |
| .withUUID.{uuid} | ITEM | Returns the same item but with its UUID nbt set to the specified value |
| .withTimestamp.{timestamp} | ITEM | Returns the same item but with its timestamp nbt set to the specified integer value |
| .withCustomModelData.{value} | ITEM | Returns the same item but with its Custom Model Data set to `value` |
| .withModel.{namespace}.{path} | ITEM | Returns the same item but with its item model set to `{namespace}:{path}` |
| .type | STRING | The item's type as a string (Material name) |
| .durability | INTEGER | The current durability value of the item |
| .maxDurability | INTEGER | The maximum durability value of the item |
| .lore | LIST | The item's lore as a list of strings |
| .name | STRING | The display name of the item |
| .mythicType | STRING | The persistent "Mythic Type" value of the item, if set |
| .enchants | MAP | A map of all enchantments on the item |
| .getCustomData.{namespace}.{key} | STRING | The string value stored in the item's custom persistent data under `{namespace}:{key}` |
| .customModelData | INTEGER | The item's Custom Model Data value |
| .model | STRING | The item's model identifier in `namespace:path` format |
| .amount | INTEGER | The stack amount of the item |
> [Go To Explanation>>](#meta-variable-placeholders)
Check them out [here](/Skills/Placeholders/Meta-Variable-Placeholders)
# Placeholder Attributes
Some placeholders can use a set of attributes to further define the output they will give
......