These are all of the placeholders and special characters you can use in
skills and mechanics that use strings. There are some examples of usage at the bottom to get you started.
__**Note:** Usage of many variables in skills are locked to the premium versions, excluding MMOCore, special characters, color codes, and `setvariable`__.
It's recommended that you use [MiniMessage tags](https://docs.adventure.kyori.net/minimessage/format.html#standard-tags) for text styling and text decorations.
Here's an example using MiniMessage tags:
```yml
MessageSkill:
Skills:
-message{m=<rainbow>This text is a rainbow</rainbow> but <red>this is red</red>!} @target
-message{m=<#bae5f4>This is a cool color that I picked from</#bae5f4> <red><click:open_url:https://www.color-hex.com/color/bae5f4>color-hex site</click></red>} @target
```
MiniMessage also has a [web viewer](https://webui.adventure.kyori.net/) to see what your text will look like in game.
# Additional Placeholders
Links to placeholders added by addon plugins. Any placeholders from these links will not work without that plugin installed.
Most placeholders that fetches data "from the environment" have a `scope` prepended to them. You can see the scope as "telling the placeholder" *which entity or location* to fetch the data from.
So, for instance, the `<caster.name>` placeholder will be retuning the name of the mechanic's caster, while `<target.name>` will also be returning a name, but this time it will be that of the mechanic's target
```yaml
Skills:
-message{m=Hello <target.name>, i am <caster.name>} @NearestPlayer
```
> [!important] {scope}
> In the following list, every time you see a placeholder that starts with [{scope}], it means that you can use there *any* of the scopes stated above
> [!note] Other words in `{}`
> When you see other words written in `{}` (such as `{auraname}`), it means that, when using the placeholder, you must write the requested context there (in case of `{auraname}`. you should write the name of the aura you want to check against. `<caster.aura.youraura.stacks>`)
| <[{scope}].armor> | Returns the entity's armor value | Double |
| <[{scope}].attack_cooldown> | Returns the attack cooldown of the player's equipped item. The value will be a double between 0 (maximum cooldown for the item) and 1 (no cooldown) | Double |
| <[{scope}].aura.`{auraName}`.stacks> | Returns the entity's amount of stacks for the specified aura | Integer |
| <[{scope}].block.data> | Returns the location block's data | String |
| <[{scope}].block.type> | Returns the location block's type | String |
| <[{scope}].children> | Returns a list of the entity children's uuids | List |
| <[{scope}].children.size> | Returns the amount of children the entity has | Integer |
| <[{scope}].damage> | Returns the entity's Attack_Damage attribute value | Double |
| <[{scope}].display> | Returns the entity's displayed name | String |
| <[{scope}].distance> | Returns the distance between the entity and the caster | Double |
| <[{scope}].distancesquared> | Returns the distance between the entity and the caster, squared.<br>Realistically speaking, you should never need this. | Double |
| <[{scope}].enchantlevel.`{enchantname}`> | Returns the total amount of levels the entity has for the specified enchant. (the levels on all slots are summed) | Integer |
| <[{scope}].item> | For Item entities, returns its item | Item |
| <[{scope}].item.amount> | For Item entities, returns the item's amount. Otherwise, returns 0 | Integer |
| <[{scope}].item.model> | For Item entities, returns the item's custom model data. Otherwise, returns 0 | Integer |
| <[{scope}].item.itemstack.`{slot}`> | Returns the itemstack of the item in the entity's `slot` | String |
| <[{scope}].item.type> | For Item entities, returns the item's type. Otherwise, returns AIR| String |
| <[{scope}].entity_type> | Returns the type of the entity | String |
| <[{scope}].fovoffset{rotation=0;absolute=true}> | Returns the angular offset (in degrees) between the direction the caster is looking and the direction from the caster to the target entity. This offset can be used to determine how far the target is from the caster's center of view | Double |
| <[{scope}].globalcooldown> | Returns the entity's global cooldown | Integer |
| <[{scope}].hp> | Returns the entity's health | Double |
| <[{scope}].php> | Returns the entity's health percent | Double |
| <[{scope}].mhp> | Returns the entity's max health | Double |
| <[{scope}].heldenchantlevel.`{enchantname}`> | Returns the levels the entity has for the specified enchant in the HAND slot | Integer |
| <[{scope}].held.item> | Returns the entity's held item | Item |
| <[{scope}].input.`{inputTypekey}`> | Returns whether the player entity is pressing the specified `{inputType key}`.<br> Available keys are `forward`, `backward`, `left`, `right`, `jump`, `sneak`, `sprint`.<br>In case the key is being pressed, returns `1`, otherwise `0` | Integer |
| <[{scope}].lastsignal> | Returns the entity's last received signal | String |
| <[{scope}].l.pitch> | Returns the location's pitch | Double |
| <[{scope}].l.yaw> | Returns the location's yaw | Double |
| <[{scope}].l.w> | Returns the location's world | String |
| <[{scope}].l.x> | Returns the location's centered x coordinate | Double |
| <[{scope}].l.x.double> | Returns the location's precise x coordinate | Double |
| <[{scope}].l.y> | Returns the location's centered y coordinate | Double |
| <[{scope}].l.y.double> | Returns the location's precise y coordinate | Double |
| <[{scope}].l.z> | Returns the location's centered z coordinate | Double |
| <[{scope}].l.z.double> | Returns the location's precise z coordinate | Double |
| <[{scope}].luck> | Returns the entity's luck | Double |
| <[{scope}].mythic_type> | Returns the entity's mythic type (internal mythic id) | String |
| <[{scope}].name> | Returns the entity's name | String |
| <[{scope}].pity.`{category}`> | Returns the entity's pity for the given category | Double |
| <[{scope}].raytrace{maxdistance=4.5}> | Returns the name of the block being looked at by the entity if within `maxdistance` range (defaults to `4.5`),. If no block is found, `AIR` is returned.|
| <[{scope}].skill.`{Metaskill}`.cooldown> | Returns the entity's current cooldown of the give skill as a float number | Float |
| <[{scope}].stance> | Returns the current stance of the entity | String |
| <[{scope}].stat.{Stat}> | Returns the value of the specified {Stat} on the entity | Float |
| <[{scope}].threat> | Returns the amount of threat the caster has towards the entity | Double |
| <[{scope}].tt.top> | Returns the name of the top threat holder of the entity | String |
| <[{scope}].tt.size> | Returns how many entities are on the entity's threat table | Integer |
| <[{scope}].type> | Returns the internal id of a MythicMob or the entity name otherwise | String |
| <[{scope}].type.name> | Returns the display name of a MythicMob or the entity name otherwise | String |
| <[{scope}].uuid> | Returns the UUID of the entity | String |
| <[{scope}].velocity> | Returns the entity's velocity | Double |
| <[{scope}].ydiff> | Returns the difference in the y value between the caster and the location | Double |
| <drop.amount> | Returns the amount dropped while used in specific drop types | |
| <drops.xp> | Returns the xp dropped via specific drop types | |
| <drops.money> | Returns the money dropped through the vault plug-in | |
| <random.#to#> | Returns a random integer in the specified range | |
| <random.float.#to#> | Returns a random float number in the specified range | |
| <random.uuid> | Returns a random uuid | String |
| <utils.epoch> | Returns the current epoch | Long |
| <utils.epoch.seconds> | Returns the current epoch | Long |
| <utils.epoch.timestamp> | Returns the amount of milliseconds elapsed since the epoch | Long |
| <utils.epoch.millis> | Returns the amount of milliseconds of the current epoch | Long |
| <utils.epoch.ticks> | Returns the current epoch, converted in ticks. Assumes that the server always maintains 20 ticks per second. Accounts for milliseconds. <br>While unorthodox, since time within Minecraft (and by extension Mythic) is measured in ticks, this may be of some help streamlining some processes where converting the normal epoch time to accomodate for ticks may be burdensome if done at scale | Long |
| <skill.power> | Returns the [power](/Mobs/Power) of the metaskill in which the placeholder is evaluated | Float |
| <skill.targets> | Returns the amount of inherited targets | Integer |
| <spawner.pir> | Returns the amount of players in the spawner's radius | Integer |
| <bar{value=0;maxValue=100;length=100;remainingSymbol="#";progressSymbol="#";remainingPrefix=<gray>;progressPrefix=<green>}> | Returns a formatted bar with the specified values | String |
| <centertext{value=Thetexttocenter;pixelwidth=100;singlepixelunicodes=,,,;bold=false}> | Centers the given text. The attributes are:<br>`value/v/text/line`: The text to center<br>`pixelwidth/width/w/pw`: The total pixels (integer) to account for (will center at half the width)<br>`bold/b`: Whether the provided value is bolded<br>`singlepixelunicodes/spus`: A list of unicodes of 1-3 pixels to use for extra precision. Defaults to `" , , , "` | String |
## Variable Placeholders
These placeholders will return whatever variable has been called. For instance <caster.var.\[name\]> will return the value of the caster's \[name\] variable.
Some of these variables are only generated and available under some special circumstances, such as some specific trigger/attribute/metamechanic being used previously in the skilltree.
| Variable Placeholder | Generated by | Function |
| <caster.var.{VariableName}> | | Returns the value of the variable {VariableName} on the variable registry of the caster of the mechanic |
| <target.var.{VariableName}> | | Returns the value of the variable {VariableName} on the variable registry of the target of the mechanic |
| <world.var.{VariableName}> | | Returns the value of the variable {VariableName} on the variable registry of the world the mechanic is used in |
| <global.var.{VariableName}> | | Returns the value of the variable {VariableName} on the variable registry of the whole server |
| <skill.var.{VariableName}> | | Returns the value of the variable {VariableName} on the current [skill tree](https://git.lumine.io/mythiccraft/MythicMobs/-/wikis/Skills/SkillTrees) |
| <skill.var.damage-amount> | [~onDamaged] trigger <br> [~onAttack] trigger <br> [~onBowHit] trigger <br> [onDamaged] mechanic <br> [onAttack] mechanic | Returns the amount of damage taken or done |
| <skill.var.damage-type> | [~onDamaged] trigger <br> [~onAttack] trigger <br> [~onBowHit] trigger <br> [onDamaged] mechanic <br> [onAttack] mechanic | Returns the type of damage taken or done, if any |
| <skill.var.damage-cause> | [~onDamaged] trigger <br> [~onAttack] trigger <br> [~onBowHit] trigger <br> [onDamaged] mechanic <br> [onAttack] mechanic | Returns the cause of damage taken/done |
| <skill.var.aura-name> | Every [aura] mechanic | Returns the name of the aura |
| <skill.var.aura-type> | Every [aura] mechanic | Returns the type of the aura |
| <skill.var.aura-charges> | Every [aura] mechanic | Returns the amount of charges the aura has left |
| <skill.var.aura-duration> | Every [aura] mechanic | Returns the remaining duration of the aura |
| <skill.var.aura-duration-millis> | Every [aura] mechanic | Returns the remaining duration of the aura, in milliseconds |
| <skill.var.aura-stacks> | Every [aura] mechanic | Returns the amount of stacks the aura has left |
| <skill.var.interval> | Using the `repeat` and `repeatInterval` [universal attributes] | Returns the current iteration |
| <skill.var.itr> | Using the `repeat` and `repeatInterval` [universal attributes] | Returns the current iteration |
| <skill.var.volume> | [~onHear] trigger | Returns a float value between 1 and 15 representing the intensity of the sound. Directly proportional to the distance (the further away the source, the higher this value) |
| <skill.var.sound-type> | [~onHear] trigger | Returns the type of the sound |
| <skill.var.hit-block-type> | [raytrace] mechanic | Returns the block that was hit, or AIR if none |
| <skill.var.bow-tension> | [~onShoot] trigger | Returns the force with which the projectile has been shot |
| <skill.var.click-type> | [Custom Menus](/Custom-Menus#button-skills) Interactions | The type of the click used to interact with a [menu button](/Custom-Menus#button-skills). Returns `1` if rightclick was used, `0` otherwise |
> 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 Placeholders
You may now be wondering "Ok, but what is that `Return Type` listen after the placeholder's explanation?"<br>
That value determines
- What data the placeholder is returning and, subsequently
-**What Meta Placeholders you can use to mutate it!**
For instance... do you want to uppercase a string? Why not use
```yaml
<caster.name.uppercase>
```
Do you want to remove possible whitespace characters from the edges? then you can also
```yaml
<caster.name.uppercase.trim>
```
[See the full documentation HERE](/Skills/Placeholders/Meta-Placeholders)
# Placeholder Attributes
Some placeholders can use a set of attributes to further define the output they will give
| rounding | round, r | The rounding of the returned float value | 2 |
```yaml
Skills:
-message{m="<target.hp{round=2}>"} @self
```
# PlaceholderAPI Integration
Other than being able to use PlaceholderAPI placeholders anywhere placeholder support is in place, MythicMobs introduces some new PAPI placeholders that can be used by third parties to fetch MythicMobs-related values.
| %mythic_var_someVar% | Returns the value of the `someVar` variable that is set on the player |
| %mythic_var_world_someVar% | Returns the value of the `someVar` variable that is set on the world |
| %mythic_var_global_someVar% | Returns the value of the `someVar` variable that is set on the server |
| %mythic_var_\<playerName\>_someVar% | Returns the value of the `someVar` variable that is set on the specified player, by their name |
| %mythic_var_\<UUID\>_someVar% | Returns the value of the `someVar` variable that is set on the specified entity, by its UUID|
| %mythic_spawner_[name]_cooldown% | Returns the cooldown of the spawner called `name` |
| %mythic_spawner_[name]_cooldownleft% | Returns the remaining cooldown of the spawner called `name` |
| %mythic_spawner_[name]_warmup% | Returns the warmup of the spawner called `name` |
| %mythic_spawner_[name]_warmupleft% | Returns the remaining warmup of the spawner called `name` |
| %mythic_stat_[name]% | Returns the value of the specified stat on the evaluated player |
## PlaceholderAPI Parsing
When using placeholders via PlaceholderAPI, it is important to remember that some of them are meant to be parsed against a player, and if parsed against a mob they may behave unexpectedly.
More concretely, this means that:
- If used inside a mechanic, the target must be a player
- If used inside a condition, the checked entity must be a player (caster for conditions, inherited targets for targetconditions, trigger for triggerconditions)
...and so on
# Custom Placeholders
It's possible to create custom placeholders in any Pack by creating a file named `placeholders.yml` in the pack directory. These can be static or you can define conditional placeholders - the first one that evaluates true will be chosen, or the `Default` if they're all false.
Custom placeholders can be used via `<placeholder.[CustomPlaceholder]>`, with _[CustomPlaceholder]_ being the name of your custom placeholder.
```yaml
TestPlaceholder:'somevalue'
TestConditionalPlaceholder:
Day:
Conditions:
-day
Value:day
Night:
Conditions:
-night
Value:night
Default:idk
TestRandomPlaceholder:
-red
-green
-blue
```
> A value of "null" is not accepted
# Static Placeholders
Placeholders are considered "Static" when their parsing can only ever result in a single, defined output.
As of now, this is only the case for [Custom Placeholders](#custom-placeholders) that have a single possible value
```yaml
TestPlaceholder:'asinglevalue'
AnotherTestPlaceholder:'anothersinglevalue'
```
## Load-Time Static Placeholder Parsing
Static Placeholders not parsed when the configuration line is executed at runtime, but are parsed and replaced as soon as the configuration is loaded in, only once per reload, and before any other parsing is done.
This has numerous advantages!
The most obvious one is that of performance: If placeholders are replaced at load time, at runtime they will appear as normal strings, not needing to be parsed again and saving on resources.
There is also quite an interesting application to this: since static placeholders are parsed and replaced *before anything else is*, they can be used *anywhere* in the configuration files, even in places where normal placeholders would not make sense, such as internal names, mechanic names or anything else!
```yaml
# placeholders.yml
test:"message=1;"
debug:"#log"
```
```yaml
testPreparsedPlaceholders:
Skills:
-message{<placeholder.test>} @self
-<placeholder.debug>{message="hello world"}
```
# Examples
**This will make a mob send a teal message to all players in a radius of 20 blocks around in itself, stating what entity killed it in green.**
```yaml
Skills:
-message{m="<&b><caster.name><&r> was slain by <&a><trigger.name><&r>."} @PIR{r=20} ~onDeath
```
**This skill will make an announcement when the mob spawns that looks like this:**
These are all of the placeholders and special characters you can use in
skills and mechanics that use strings. There are some examples of usage at the bottom to get you started.
__**Note:** Usage of many variables in skills are locked to the premium versions, excluding MMOCore, special characters, color codes, and `setvariable`__.
It's recommended that you use [MiniMessage tags](https://docs.adventure.kyori.net/minimessage/format.html#standard-tags) for text styling and text decorations.
Here's an example using MiniMessage tags:
```yml
MessageSkill:
Skills:
-message{m=<rainbow>This text is a rainbow</rainbow> but <red>this is red</red>!} @target
-message{m=<#bae5f4>This is a cool color that I picked from</#bae5f4> <red><click:open_url:https://www.color-hex.com/color/bae5f4>color-hex site</click></red>} @target
```
MiniMessage also has a [web viewer](https://webui.adventure.kyori.net/) to see what your text will look like in game.
# Additional Placeholders
Links to placeholders added by addon plugins. Any placeholders from these links will not work without that plugin installed.
Most placeholders that fetches data "from the environment" have a `scope` prepended to them. You can see the scope as "telling the placeholder" *which entity or location* to fetch the data from.
So, for instance, the `<caster.name>` placeholder will be retuning the name of the mechanic's caster, while `<target.name>` will also be returning a name, but this time it will be that of the mechanic's target
```yaml
Skills:
-message{m=Hello <target.name>, i am <caster.name>} @NearestPlayer
```
> [!important] {scope}
> In the following list, every time you see a placeholder that starts with [{scope}], it means that you can use there *any* of the scopes stated above
> [!note] Other words in `{}`
> When you see other words written in `{}` (such as `{auraname}`), it means that, when using the placeholder, you must write the requested context there (in case of `{auraname}`. you should write the name of the aura you want to check against. `<caster.aura.youraura.stacks>`)
| <[{scope}].armor> | Returns the entity's armor value | Double |
| <[{scope}].attack_cooldown> | Returns the attack cooldown of the player's equipped item. The value will be a double between 0 (maximum cooldown for the item) and 1 (no cooldown) | Double |
| <[{scope}].aura.`{auraName}`.stacks> | Returns the entity's amount of stacks for the specified aura | Integer |
| <[{scope}].block.data> | Returns the location block's data | String |
| <[{scope}].block.type> | Returns the location block's type | String |
| <[{scope}].children> | Returns a list of the entity children's uuids | List |
| <[{scope}].children.size> | Returns the amount of children the entity has | Integer |
| <[{scope}].damage> | Returns the entity's Attack_Damage attribute value | Double |
| <[{scope}].display> | Returns the entity's displayed name | String |
| <[{scope}].distance> | Returns the distance between the entity and the caster | Double |
| <[{scope}].distancesquared> | Returns the distance between the entity and the caster, squared.<br>Realistically speaking, you should never need this. | Double |
| <[{scope}].enchantlevel.`{enchantname}`> | Returns the total amount of levels the entity has for the specified enchant. (the levels on all slots are summed) | Integer |
| <[{scope}].item> | For Item entities, returns its item | Item |
| <[{scope}].item.amount> | For Item entities, returns the item's amount. Otherwise, returns 0 | Integer |
| <[{scope}].item.model> | For Item entities, returns the item's custom model data. Otherwise, returns 0 | Integer |
| <[{scope}].item.itemstack.`{slot}`> | Returns the itemstack of the item in the entity's `slot` | String |
| <[{scope}].item.type> | For Item entities, returns the item's type. Otherwise, returns AIR| String |
| <[{scope}].entity_type> | Returns the type of the entity | String |
| <[{scope}].fovoffset{rotation=0;absolute=true}> | Returns the angular offset (in degrees) between the direction the caster is looking and the direction from the caster to the target entity. This offset can be used to determine how far the target is from the caster's center of view | Double |
| <[{scope}].globalcooldown> | Returns the entity's global cooldown | Integer |
| <[{scope}].hp> | Returns the entity's health | Double |
| <[{scope}].php> | Returns the entity's health percent | Double |
| <[{scope}].mhp> | Returns the entity's max health | Double |
| <[{scope}].heldenchantlevel.`{enchantname}`> | Returns the levels the entity has for the specified enchant in the HAND slot | Integer |
| <[{scope}].held.item> | Returns the entity's held item | Item |
| <[{scope}].input.`{inputTypekey}`> | Returns whether the player entity is pressing the specified `{inputType key}`.<br> Available keys are `forward`, `backward`, `left`, `right`, `jump`, `sneak`, `sprint`.<br>In case the key is being pressed, returns `1`, otherwise `0` | Integer |
| <[{scope}].lastsignal> | Returns the entity's last received signal | String |
| <[{scope}].l.pitch> | Returns the location's pitch | Double |
| <[{scope}].l.yaw> | Returns the location's yaw | Double |
| <[{scope}].l.w> | Returns the location's world | String |
| <[{scope}].l.x> | Returns the location's centered x coordinate | Double |
| <[{scope}].l.x.double> | Returns the location's precise x coordinate | Double |
| <[{scope}].l.y> | Returns the location's centered y coordinate | Double |
| <[{scope}].l.y.double> | Returns the location's precise y coordinate | Double |
| <[{scope}].l.z> | Returns the location's centered z coordinate | Double |
| <[{scope}].l.z.double> | Returns the location's precise z coordinate | Double |
| <[{scope}].luck> | Returns the entity's luck | Double |
| <[{scope}].mythic_type> | Returns the entity's mythic type (internal mythic id) | String |
| <[{scope}].name> | Returns the entity's name | String |
| <[{scope}].pity.`{category}`> | Returns the entity's pity for the given category | Double |
| <[{scope}].raytrace{maxdistance=4.5}> | Returns the name of the block being looked at by the entity if within `maxdistance` range (defaults to `4.5`),. If no block is found, `AIR` is returned.|
| <[{scope}].skill.`{Metaskill}`.cooldown> | Returns the entity's current cooldown of the give skill as a float number | Float |
| <[{scope}].stance> | Returns the current stance of the entity | String |
| <[{scope}].stat.{Stat}> | Returns the value of the specified {Stat} on the entity | Float |
| <[{scope}].threat> | Returns the amount of threat the caster has towards the entity | Double |
| <[{scope}].tt.top> | Returns the name of the top threat holder of the entity | String |
| <[{scope}].tt.size> | Returns how many entities are on the entity's threat table | Integer |
| <[{scope}].type> | Returns the internal id of a MythicMob or the entity name otherwise | String |
| <[{scope}].type.name> | Returns the display name of a MythicMob or the entity name otherwise | String |
| <[{scope}].uuid> | Returns the UUID of the entity | String |
| <[{scope}].velocity> | Returns the entity's velocity | Double |
| <[{scope}].ydiff> | Returns the difference in the y value between the caster and the location | Double |
| <drop.amount> | Returns the amount dropped while used in specific drop types | |
| <drops.xp> | Returns the xp dropped via specific drop types | |
| <drops.money> | Returns the money dropped through the vault plug-in | |
| <random.#to#> | Returns a random integer in the specified range | |
| <random.float.#to#> | Returns a random float number in the specified range | |
| <random.uuid> | Returns a random uuid | String |
| <utils.epoch> | Returns the current epoch | Long |
| <utils.epoch.seconds> | Returns the current epoch | Long |
| <utils.epoch.timestamp> | Returns the amount of milliseconds elapsed since the epoch | Long |
| <utils.epoch.millis> | Returns the amount of milliseconds of the current epoch | Long |
| <utils.epoch.ticks> | Returns the current epoch, converted in ticks. Assumes that the server always maintains 20 ticks per second. Accounts for milliseconds. <br>While unorthodox, since time within Minecraft (and by extension Mythic) is measured in ticks, this may be of some help streamlining some processes where converting the normal epoch time to accomodate for ticks may be burdensome if done at scale | Long |
| <skill.power> | Returns the [power](/Mobs/Power) of the metaskill in which the placeholder is evaluated | Float |
| <skill.targets> | Returns the amount of inherited targets | Integer |
| <spawner.pir> | Returns the amount of players in the spawner's radius | Integer |
| <bar{value=0;maxValue=100;length=100;remainingSymbol="#";progressSymbol="#";remainingPrefix=<gray>;progressPrefix=<green>}> | Returns a formatted bar with the specified values | String |
| <centertext{value=Thetexttocenter;pixelwidth=100;singlepixelunicodes=,,,;bold=false}> | Centers the given text. The attributes are:<br>`value/v/text/line`: The text to center<br>`pixelwidth/width/w/pw`: The total pixels (integer) to account for (will center at half the width)<br>`bold/b`: Whether the provided value is bolded<br>`singlepixelunicodes/spus`: A list of unicodes of 1-3 pixels to use for extra precision. Defaults to `" , , , "` | String |
## Variable Placeholders
These placeholders will return whatever variable has been called. For instance <caster.var.\[name\]> will return the value of the caster's \[name\] variable.
Some of these variables are only generated and available under some special circumstances, such as some specific trigger/attribute/metamechanic being used previously in the skilltree.
| Variable Placeholder | Generated by | Function |
| <caster.var.{VariableName}> | | Returns the value of the variable {VariableName} on the variable registry of the caster of the mechanic |
| <target.var.{VariableName}> | | Returns the value of the variable {VariableName} on the variable registry of the target of the mechanic |
| <world.var.{VariableName}> | | Returns the value of the variable {VariableName} on the variable registry of the world the mechanic is used in |
| <global.var.{VariableName}> | | Returns the value of the variable {VariableName} on the variable registry of the whole server |
| <skill.var.{VariableName}> | | Returns the value of the variable {VariableName} on the current [skill tree](https://git.lumine.io/mythiccraft/MythicMobs/-/wikis/Skills/SkillTrees) |
| <skill.var.damage-amount> | [~onDamaged] trigger <br> [~onAttack] trigger <br> [~onBowHit] trigger <br> [onDamaged] mechanic <br> [onAttack] mechanic | Returns the amount of damage taken or done |
| <skill.var.damage-type> | [~onDamaged] trigger <br> [~onAttack] trigger <br> [~onBowHit] trigger <br> [onDamaged] mechanic <br> [onAttack] mechanic | Returns the type of damage taken or done, if any |
| <skill.var.damage-cause> | [~onDamaged] trigger <br> [~onAttack] trigger <br> [~onBowHit] trigger <br> [onDamaged] mechanic <br> [onAttack] mechanic | Returns the cause of damage taken/done |
| <skill.var.aura-name> | Every [aura] mechanic | Returns the name of the aura |
| <skill.var.aura-type> | Every [aura] mechanic | Returns the type of the aura |
| <skill.var.aura-charges> | Every [aura] mechanic | Returns the amount of charges the aura has left |
| <skill.var.aura-duration> | Every [aura] mechanic | Returns the remaining duration of the aura |
| <skill.var.aura-duration-millis> | Every [aura] mechanic | Returns the remaining duration of the aura, in milliseconds |
| <skill.var.aura-stacks> | Every [aura] mechanic | Returns the amount of stacks the aura has left |
| <skill.var.interval> | Using the `repeat` and `repeatInterval` [universal attributes] | Returns the current iteration |
| <skill.var.itr> | Using the `repeat` and `repeatInterval` [universal attributes] | Returns the current iteration |
| <skill.var.volume> | [~onHear] trigger | Returns a float value between 1 and 15 representing the intensity of the sound. Directly proportional to the distance (the further away the source, the higher this value) |
| <skill.var.sound-type> | [~onHear] trigger | Returns the type of the sound |
| <skill.var.hit-block-type> | [raytrace] mechanic | Returns the block that was hit, or AIR if none |
| <skill.var.bow-tension> | [~onShoot] trigger | Returns the force with which the projectile has been shot |
| <skill.var.click-type> | [Custom Menus](/Custom-Menus#button-skills) Interactions | The type of the click used to interact with a [menu button](/Custom-Menus#button-skills). Returns `1` if rightclick was used, `0` otherwise |
> 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 Placeholders
You may now be wondering "Ok, but what is that `Return Type` listen after the placeholder's explanation?"<br>
That value determines
- What data the placeholder is returning and, subsequently
-**What Meta Placeholders you can use to mutate it!**
For instance... do you want to uppercase a string? Why not use
```yaml
<caster.name.uppercase>
```
Do you want to remove possible whitespace characters from the edges? then you can also
```yaml
<caster.name.uppercase.trim>
```
[See the full documentation HERE](/Skills/Placeholders/Meta-Placeholders)
# Placeholder Attributes
Some placeholders can use a set of attributes to further define the output they will give
| rounding | round, r | The rounding of the returned double value | 2 |
```yaml
Skills:
-message{m="<target.hp{round=2}>"} @self
```
# PlaceholderAPI Integration
Other than being able to use PlaceholderAPI placeholders anywhere placeholder support is in place, MythicMobs introduces some new PAPI placeholders that can be used by third parties to fetch MythicMobs-related values.
| %mythic_var_someVar% | Returns the value of the `someVar` variable that is set on the player |
| %mythic_var_world_someVar% | Returns the value of the `someVar` variable that is set on the world |
| %mythic_var_global_someVar% | Returns the value of the `someVar` variable that is set on the server |
| %mythic_var_\<playerName\>_someVar% | Returns the value of the `someVar` variable that is set on the specified player, by their name |
| %mythic_var_\<UUID\>_someVar% | Returns the value of the `someVar` variable that is set on the specified entity, by its UUID|
| %mythic_spawner_[name]_cooldown% | Returns the cooldown of the spawner called `name` |
| %mythic_spawner_[name]_cooldownleft% | Returns the remaining cooldown of the spawner called `name` |
| %mythic_spawner_[name]_warmup% | Returns the warmup of the spawner called `name` |
| %mythic_spawner_[name]_warmupleft% | Returns the remaining warmup of the spawner called `name` |
| %mythic_stat_[name]% | Returns the value of the specified stat on the evaluated player |
## PlaceholderAPI Parsing
When using placeholders via PlaceholderAPI, it is important to remember that some of them are meant to be parsed against a player, and if parsed against a mob they may behave unexpectedly.
More concretely, this means that:
- If used inside a mechanic, the target must be a player
- If used inside a condition, the checked entity must be a player (caster for conditions, inherited targets for targetconditions, trigger for triggerconditions)
...and so on
# Custom Placeholders
It's possible to create custom placeholders in any Pack by creating a file named `placeholders.yml` in the pack directory. These can be static or you can define conditional placeholders - the first one that evaluates true will be chosen, or the `Default` if they're all false.
Custom placeholders can be used via `<placeholder.[CustomPlaceholder]>`, with _[CustomPlaceholder]_ being the name of your custom placeholder.
```yaml
TestPlaceholder:'somevalue'
TestConditionalPlaceholder:
Day:
Conditions:
-day
Value:day
Night:
Conditions:
-night
Value:night
Default:idk
TestRandomPlaceholder:
-red
-green
-blue
```
> A value of "null" is not accepted
# Static Placeholders
Placeholders are considered "Static" when their parsing can only ever result in a single, defined output.
As of now, this is only the case for [Custom Placeholders](#custom-placeholders) that have a single possible value
```yaml
TestPlaceholder:'asinglevalue'
AnotherTestPlaceholder:'anothersinglevalue'
```
## Load-Time Static Placeholder Parsing
Static Placeholders not parsed when the configuration line is executed at runtime, but are parsed and replaced as soon as the configuration is loaded in, only once per reload, and before any other parsing is done.
This has numerous advantages!
The most obvious one is that of performance: If placeholders are replaced at load time, at runtime they will appear as normal strings, not needing to be parsed again and saving on resources.
There is also quite an interesting application to this: since static placeholders are parsed and replaced *before anything else is*, they can be used *anywhere* in the configuration files, even in places where normal placeholders would not make sense, such as internal names, mechanic names or anything else!
```yaml
# placeholders.yml
test:"message=1;"
debug:"#log"
```
```yaml
testPreparsedPlaceholders:
Skills:
-message{<placeholder.test>} @self
-<placeholder.debug>{message="hello world"}
```
# Examples
**This will make a mob send a teal message to all players in a radius of 20 blocks around in itself, stating what entity killed it in green.**
```yaml
Skills:
-message{m="<&b><caster.name><&r> was slain by <&a><trigger.name><&r>."} @PIR{r=20} ~onDeath
```
**This skill will make an announcement when the mob spawns that looks like this:**
