Skip to content

GitLab

Placeholders · Changes

Page history
standardized placeholders embedded values syntax authored by Lxlp's avatar Lxlp
Hide whitespace changes
Inline Side-by-side
Showing with 30 additions and 27 deletions
Skills/Placeholders.md
View page @ 92eba1f7
...@@ -86,21 +86,21 @@ These placeholders will return whatever attribute of the caster that is called. ...@@ -86,21 +86,21 @@ These placeholders will return whatever attribute of the caster that is called.
| <caster.tt.top> | Returns the name of the top threat holder of the caster | | <caster.tt.top> | Returns the name of the top threat holder of the caster |
| <caster.l.w> | Returns the world name the caster is in | | <caster.l.w> | Returns the world name the caster is in |
| <caster.l.x> | Returns the X coordinate of the caster | | <caster.l.x> | Returns the X coordinate of the caster |
| <caster.l.x.#> | Returns the X coordinate of the caster +- random number between # | | <caster.l.x.{Float}> | Returns the X coordinate of the caster +- random number between {Float} |
| <caster.l.x.double> | Returns the precise X coordinate of the caster | | <caster.l.x.double> | Returns the precise X coordinate of the caster |
| <caster.l.y> | Returns the Y coordinate of the caster | | <caster.l.y> | Returns the Y coordinate of the caster |
| <caster.l.y.#> | Returns the Y coordinate of the caster +- random number between # | | <caster.l.y.{Float}> | Returns the Y coordinate of the caster +- random number between {Float} |
| <caster.l.y.double> | Returns the precise Y coordinate of the caster | | <caster.l.y.double> | Returns the precise Y coordinate of the caster |
| <caster.l.z> | Returns the Z coordinate of the caster | | <caster.l.z> | Returns the Z coordinate of the caster |
| <caster.l.z.#> | Returns the Z coordinate of the caster +- random number between # | | <caster.l.z.{Float}> | Returns the Z coordinate of the caster +- random number between {Float} |
| <caster.l.z.double> | Returns the precise Z coordinate of the caster | | <caster.l.z.double> | Returns the precise Z coordinate of the caster |
| <caster.l.yaw> | Returns the yaw of the caster | | <caster.l.yaw> | Returns the yaw of the caster |
| <caster.l.pitch> | Returns the pitch of the caster | | <caster.l.pitch> | Returns the pitch of the caster |
| <caster.stance> | Returns the current stance of the caster | | <caster.stance> | Returns the current stance of the caster |
| <caster.stat.STAT_NAME> | Returns the value of the specified stat on the caster | | <caster.stat.{Stat}> | Returns the value of the specified {Stat} on the caster |
| <caster.heldenchantlevel.#> | Returns the enchant level of specified # enchant | | <caster.heldenchantlevel.{Integer}> | Returns the enchant level of specified {Integer} enchant |
| <caster.skill.\[skill_name\].cooldown> | Returns the current cooldown of the give skill as a float number | | <caster.skill.{SkillName}.cooldown> | Returns the current cooldown of the give skill as a float number |
| <caster.raytrace.#> | Returns the name of the block being looked at by the caster if within # range, if # is specified. If only <caster.raytrace> is used, then the range defaults to `4.5`. If no block is found, `AIR` is returned.| | <caster.raytrace.{Float}> | Returns the name of the block being looked at by the caster if within {Float} range, if {Float} is specified. If only <caster.raytrace> is used, then the range defaults to `4.5`. If no block is found, `AIR` is returned.|
| <caster.children.size> | Returns the number of children this entity has | | <caster.children.size> | Returns the number of children this entity has |
| <caster.attack_cooldown> | Returns the attack cooldown of the player's equipped item. The value will be a float between 0 (maximum cooldown for the item) and 1 (no cooldown) | | <caster.attack_cooldown> | Returns the attack cooldown of the player's equipped item. The value will be a float between 0 (maximum cooldown for the item) and 1 (no cooldown) |
...@@ -110,8 +110,8 @@ Some of these variables are only generated and available under some special circ ...@@ -110,8 +110,8 @@ Some of these variables are only generated and available under some special circ
| Variable Placeholder | Generated by | Function | | Variable Placeholder | Generated by | Function |
|:-------------------------:|---------------------------------|------------------------------------------| |:-------------------------:|---------------------------------|------------------------------------------|
| <\[scope\].var.\[name\]> | | Returns the value of the variable \[name\] on the selected [scope](/Skills/Variables#variable-scopes) | | <{Scope}.var.{VariableName}> | | Returns the value of the variable {VariableName} on the selected [scope](/Skills/Variables#variable-scopes) |
| <skill.var.\[name\]> | | Returns the value of the variable \[name\] on the current skill tree | | <skill.var.{VariableName}> | | Returns the value of the variable {VariableName} on the current skill tree |
| <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-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-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.damage-cause> | [~onDamaged] trigger <br> [~onAttack] trigger <br> [~onBowHit] trigger <br> [onDamaged] mechanic <br> [onAttack] mechanic | Returns the cause of damage taken/done |
...@@ -144,11 +144,11 @@ These placeholders will return whatever target selector has been used. For insta ...@@ -144,11 +144,11 @@ These placeholders will return whatever target selector has been used. For insta
| <target.threat> | Returns the threat level of the target | | <target.threat> | Returns the threat level of the target |
| <target.l.w> | Returns the world name the target is in | | <target.l.w> | Returns the world name the target is in |
| <target.l.x> | Returns the X coordinate of the target | | <target.l.x> | Returns the X coordinate of the target |
| <target.l.x.#> | Returns the X coordinate of the target +- random number between # | | <target.l.x.{Float}> | Returns the X coordinate of the target +- random number between {Float} |
| <target.l.y> | Returns the Y coordinate of the target | | <target.l.y> | Returns the Y coordinate of the target |
| <target.l.y.#> | Returns the Y coordinate of the target +- random number between # | | <target.l.y.{Float}> | Returns the Y coordinate of the target +- random number between {Float}|
| <target.l.z> | Returns the Z coordinate of the target | | <target.l.z> | Returns the Z coordinate of the target |
| <target.l.z.#> | Returns the Z coordinate of the target +- random number between # | | <target.l.z.{Float}> | Returns the Z coordinate of the target +- random number between {Float} |
| <target.l.yaw> | Returns the yaw of the target | | <target.l.yaw> | Returns the yaw of the target |
| <target.l.pitch> | Returns the pitch of the target | | <target.l.pitch> | Returns the pitch of the target |
| <target.level> | Returns the level of the target | | <target.level> | Returns the level of the target |
...@@ -158,8 +158,8 @@ These placeholders will return whatever target selector has been used. For insta ...@@ -158,8 +158,8 @@ These placeholders will return whatever target selector has been used. For insta
| <target.item.type> | Returns the type of the targeted item entity | | <target.item.type> | Returns the type of the targeted item entity |
| <target.held.item> | Returns the item held by the target | | <target.held.item> | Returns the item held by the target |
| <target.itemstack_amount> | Returns the amount of item entities on the ground | | <target.itemstack_amount> | Returns the amount of item entities on the ground |
| <target.stat.STAT_NAME> | Returns the value of the specified stat on the target | | <target.stat.{StatName}> | Returns the value of the specified stat on the target |
| <target.raytrace.#> | Returns the name of the block being looked at by the target if within # range, if # is specified. If only <target.raytrace> is used, then the range defaults to `4.5`. If no block is found, `AIR` is returned.| | <target.raytrace.{Float}> | Returns the name of the block being looked at by the target if within {Float} range, if {Float} is specified. If only <target.raytrace> is used, then the range defaults to `4.5`. If no block is found, `AIR` is returned.|
| <target.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 | | <target.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 |
## Trigger Placeholders ## Trigger Placeholders
...@@ -182,11 +182,11 @@ The following are only some of the placeholders that can have a `trigger` scope, ...@@ -182,11 +182,11 @@ The following are only some of the placeholders that can have a `trigger` scope,
| <trigger.threat> | Returns the threat level of the entity triggering the skill | | <trigger.threat> | Returns the threat level of the entity triggering the skill |
| <trigger.l.w> | Returns the world name of the entity triggering the skill | | <trigger.l.w> | Returns the world name of the entity triggering the skill |
| <trigger.l.x> | Returns the X coordinate of the entity triggering the skill | | <trigger.l.x> | Returns the X coordinate of the entity triggering the skill |
| <trigger.l.x.#> | Returns the X coordinate of the entity triggering the skill +- random number between # | | <trigger.l.x.{Float}> | Returns the X coordinate of the entity triggering the skill +- random number between {Float} |
| <trigger.l.y> | Returns the Y coordinate of the entity triggering the skill | | <trigger.l.y> | Returns the Y coordinate of the entity triggering the skill |
| <trigger.l.y.#> | Returns the Y coordinate of the entity triggering the skill +- random number between # | | <trigger.l.y.{Float}> | Returns the Y coordinate of the entity triggering the skill +- random number between {Float} |
| <trigger.l.z> | Returns the Z coordinate of the entity triggering the skill | | <trigger.l.z> | Returns the Z coordinate of the entity triggering the skill |
| <trigger.l.z.#> | Returns the Z coordinate of the entity triggering the skill +- random number between # | | <trigger.l.z.{Float}> | Returns the Z coordinate of the entity triggering the skill +- random number between {Float} |
| <trigger.l.yaw> | Returns the yaw of the trigger | | <trigger.l.yaw> | Returns the yaw of the trigger |
| <trigger.l.pitch> | Returns the pitch of the trigger | | <trigger.l.pitch> | Returns the pitch of the trigger |
| <trigger.held.item> | Returns the item held by the trigger | | <trigger.held.item> | Returns the item held by the trigger |
...@@ -194,8 +194,8 @@ The following are only some of the placeholders that can have a `trigger` scope, ...@@ -194,8 +194,8 @@ The following are only some of the placeholders that can have a `trigger` scope,
| <trigger.item.amount> | Returns the amount of the item the trigger is holding | | <trigger.item.amount> | Returns the amount of the item the trigger is holding |
| <trigger.item.type> | Returns the type of the item the trigger is holding | | <trigger.item.type> | Returns the type of the item the trigger is holding |
| <trigger.item.model> | Returns the model of the item the trigger is holding | | <trigger.item.model> | Returns the model of the item the trigger is holding |
| <trigger.stat.STAT_NAME> | Returns the value of the specified stat on the trigger | | <trigger.stat.{Stat}> | Returns the value of the specified stat on the trigger |
| <trigger.raytrace.#> | Returns the name of the block being looked at by the trigger if within # range, if # is specified. If only <trigger.raytrace> is used, then the range defaults to `4.5`. If no block is found, `AIR` is returned.| | <trigger.raytrace.{Float}> | Returns the name of the block being looked at by the trigger if within {Float} range, if # is specified. If only <trigger.raytrace> is used, then the range defaults to `4.5`. If no block is found, `AIR` is returned.|
## Misc Placeholders ## Misc Placeholders
...@@ -212,20 +212,23 @@ The following are only some of the placeholders that can have a `trigger` scope, ...@@ -212,20 +212,23 @@ The following are only some of the placeholders that can have a `trigger` scope,
| **Placeholder** | **Function** | | **Placeholder** | **Function** |
|-----------------------------|-------------------------------------------------------------------------| |-----------------------------|-------------------------------------------------------------------------|
| <item.amount> | Returns the amount of the item that triggered the skill | | <item.amount> | Returns the amount of the item that triggered the skill |
| <mythicitem.[item].material>| Returns the material of the specified mythic item | | <mythicitem.{Item}.material>| Returns the material of the specified mythic item |
| <mythicitem.[item].model> | Returns the custommodeldata of the specified mythic item | | <mythicitem.{Item}.model> | Returns the custommodeldata of the specified mythic item |
| <mythicitem.[item].display> | Returns the display name of the specified mythic item | | <mythicitem.{Item}.display> | Returns the display name of the specified mythic item |
## Score Placeholders ## Score Placeholders
| **Placeholder** | **Function** | | **Placeholder** | **Function** |
|-----------------------------|-------------------------------------------------------------------------| |-----------------------------|-------------------------------------------------------------------------|
| <caster.score.objective> | Returns the score of the caster from "objective" | | <caster.score.{Objective}> | Returns the score of the caster from "{Objective}" |
| <target.score.objective> | Returns the targeters score from "objective" | | <target.score.{Objective}> | Returns the targeters score from "{Objective}" |
| <trigger.score.objective> | Returns the score of the trigger from "objective" | | <trigger.score.{Objective}> | Returns the score of the trigger from "{Objective}" |
| <global.score.objective> | Returns the score of fake player: \_\_GLOBAL\_\_ score from "objective" | | <global.score.{Objective}> | Returns the score of fake player: \_\_GLOBAL\_\_ score from "{Objective}" |
| <score.objective.player> | Returns the score of the defined player from "objective" | | <score.objective.player> | Returns the score of the defined player from "objective" |
| <score.objective.dummyname> | Returns the score of "dummyname" (fake player) from "objective" | | <score.objective.dummyname> | Returns the score of "dummyname" (fake player) from "objective" |
```yaml
- message{m=You have slain <trigger.var.slainmobs> Mobs!} @trigger ~onInteract
```
# Placeholder Attributes # Placeholder Attributes
Some placeholders can use a set of attributes to further define the output they will give Some placeholders can use a set of attributes to further define the output they will give
...@@ -265,7 +268,7 @@ More concretely, this means that: ...@@ -265,7 +268,7 @@ More concretely, this means that:
# Custom Placeholders # 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. 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.{customname}>`, with _{customname}_ being the name of your custom placeholder. Custom placeholders can be used via `<placeholder.[CustomPlaceholder]>`, with _[CustomPlaceholder]_ being the name of your custom placeholder.
```yaml ```yaml
TestPlaceholder: 'some value' TestPlaceholder: 'some value'
......