Skip to content

GitLab

Placeholders · Changes

Page history
Removing HTML, modernizing mob to caster, adding an example authored by Eutherin's avatar Eutherin
Show whitespace changes
Inline Side-by-side
Showing with 152 additions and 286 deletions
Skills/Placeholders.md
View page @ 2c96873c
Placeholders
# Placeholders
------------
These are all of the placeholders and special characters you can use in
skills and mechanics that use strings.
skills and mechanics that use strings. There are some examples of usage at the bottom to get you started.
##### Examples
__**Note:** Usage of many variables in skills are locked to the premium versions, excluding MMOCore, special characters, color codes, and `setvariable`__.
This will make a mob (name in teal (&b)) send a message to all players
in a radius of 20 blocks around in itself, stating that it was slain by
player x (<trigger.name> in green (&a))
Special Characters
------------------
Skills:
- message{m="&b<mob.name>&r was slain by the warrior skills of &a<trigger.name>&r"} @PIR{r=20} ~onDeath
| **Placeholder** | **Function** |
|-----------------|---------------------------------------|
| <&co> | Returns a colon (:) |
| <&sq> | Returns an apostrophe (') |
| <&da> | Returns a dash (-) |
| <&bs> | Returns a backslash (\\) |
| <&fs> | Returns a forward slash (/) |
| <&sp> | Returns a space |
| <&cm> | Returns a comma (,) |
| <&sc> | Returns a semicolon (;) |
| <&eq> | Returns an equals symbol \[=\] |
| <&ss> | Returns a section symbol (ยง) |
| <&dq> | Returns double quotes (") |
| <&rb> | Returns a right bracket (\]) |
| <&lb> | Returns a left bracket (\[) |
| <&rc> | Returns a right curly bracket (}) |
| <&lc> | Returns a left curly bracket ({) |
| <&nl> | Forces a new line |
| <&heart> | Returns a heart |
| <&skull> | Returns a skull and bones |
Skill Placeholders
Color Codes
-----------
These color codes work anywhere in mob- and skill-files. They will even
properly format tellraw-commands used in command skills!
| **Code** | **Color** | **Code** | **Color** |
|----------|-------------|----------|----------------|
| &0 | Black | &B | Aqua |
| &1 | Dark Blue | &C | Red |
| &2 | Dark Green | &D | Light Purple |
| &3 | Dark Aqua | &E | Yellow |
| &4 | Dark Red | &F | White |
| &5 | Dark Purple | &K | Magic |
| &6 | Gold | &L | Bold |
| &7 | Gray | &M | Strike through |
| &8 | Dark Gray | N | Underline |
| &9 | Blue | &O | Italic |
| &A | Green | &R | Reset |
Caster Placeholders
------------------
These placeholders will return whatever attribute of the caster that is called. For instance `<caster.l.y.#>` will return the caster's Y location.
<table>
<thead>
<tr class="header">
<th><strong>Mob Placeholder</strong></th>
<th><strong>Function</strong></th>
</tr>
</thead>
<tbody>
<tr class="even">
<td>&lt;caster.uuid&gt;</td>
<td>Returns the UUID of the caster</td>
</tr>
<tr class="odd">
<td>&lt;caster.level&gt;</td>
<td>Returns the level of the caster</td>
</tr>
<tr class="even">
<td>&lt;caster.name&gt;</td>
<td>Returns the name of the caster</td>
</tr>
<tr class="odd">
<td>&lt;caster.hp&gt;</td>
<td>Returns current hp of the caster</td>
</tr>
<tr class="even">
<td>&lt;caster.mhp&gt;</td>
<td>Returns the max hp of the caster</td>
</tr>
<tr class="odd">
<td>&lt;caster.php&gt;</td>
<td>Returns the percent hp of the caster</td>
</tr>
<tr class="even">
<td>&lt;caster.thp&gt;</td>
<td>Returns the full number hp of the caster</td>
</tr>
<tr class="odd">
<td>&lt;caster.tt.top&gt;</td>
<td>Returns the name of the top threat holder of the caster</td>
</tr>
<tr class="even">
<td>&lt;caster.l.w&gt;</td>
<td>Returns the world name the caster is in</td>
</tr>
<tr class="odd">
<td>&lt;caster.l.x&gt;</td>
<td>Returns the X coordinate of the caster</td>
</tr>
<tr class="even">
<td>&lt;caster.l.x.#&gt;</td>
<td>Returns the X coordinate of the caster<br />
+- random number between #</td>
</tr>
<tr class="odd">
<td>&lt;caster.l.x.double&gt;</td>
<td>Returns the precise X coordinate of the caster</td>
</tr>
<tr class="even">
<td>&lt;caster.l.y&gt;</td>
<td>Returns the Y coordinate of the caster</td>
</tr>
<tr class="odd">
<td>&lt;caster.l.y.#&gt;</td>
<td>Returns the Y coordinate of the caster<br />
+- random number between #</td>
</tr>
<tr class="even">
<td>&lt;caster.l.y.double&gt;</td>
<td>Returns the precise Y coordinate of the caster</td>
</tr>
<tr class="odd">
<td>&lt;caster.l.z&gt;</td>
<td>Returns the Z coordinate of the caster</td>
</tr>
<tr class="even">
<td>&lt;caster.l.z.#&gt;</td>
<td>Returns the Z coordinate of the caster<br />
+- random number between #</td>
</tr>
<tr class="odd">
<td>&lt;caster.l.z.double&gt;</td>
<td>Returns the precise Z coordinate of the caster</td>
</tr>
<tr class="even">
<td>&lt;caster.l.yaw&gt;</td>
<td>Returns the yaw of the caster</td>
</tr>
<tr class="odd">
<td>&lt;caster.l.pitch&gt;</td>
<td>Returns the pitch of the caster</td>
</tr>
<tr class="even">
<td>&lt;caster.stance&gt;</td>
<td>Returns the current stance of the caster</td>
</tr>
<tr class="odd">
<td>&lt;caster.owner.name&gt;</td>
<td>Returns the name of the wolf's owner</td>
</tr>
<tr class="even">
<td>&lt;caster.owner.uuid&gt;</td>
<td>Returns the uuid of the wolf's owner</td>
</tr>
</tbody>
</table>
|Caster Placeholder|Function|
|----------------------------------|-------------------------------------------------------------------------|
|<caster.uuid>|Returns the UUID of the caster|
|<caster.level>|Returns the level of the caster|
|<caster.name>|Returns the name of the caster|
|<caster.hp>|Returns current hp of the caster|
|<caster.mhp>|Returns the max hp of the caster|
|<caster.php>|Returns the percent hp of the caster|
|<caster.thp>|Returns the full number hp 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.x>|Returns the X coordinate of the caster|
|<caster.l.x.#>|Returns the X coordinate of the caster +- random number between #|
|<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 +- random number between #|
|<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 +- random number between #|
|<caster.l.z.double>|Returns the precise Z coordinate of the caster|
|<caster.l.yaw>|Returns the yaw of the caster|
|<caster.l.pitch>|Returns the pitch of the caster|
|<caster.stance>|Returns the current stance of the caster|
|<caster.owner.name>|Returns the name of the wolf's owner|
|<caster.owner.uuid>|Returns the uuid of the wolf's owner|
**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.
| **Variable Placeholders (v4.6)** | **Function** |
| **Variable Placeholder** | **Function** |
|----------------------------------|-------------------------------------------------------------------------|
| &lt;caster.var.\[name\]&gt; | Returns the value of the variable \[name\] on the caster. |
| &lt;skill.var.\[name\]&gt; | Returns the value of the variable \[name\] on the current skill tree. |
| &lt;skill.var.damage-amount&gt; | Returns the amount of damage taken in the onDamaged trigger |
| &lt;skill.var.damage-type&gt; | Returns the type of damage taken as specified in a mechanic, aura, etc. |
| <caster.var.\[name\]> | Returns the value of the variable \[name\] on the caster. |
| <skill.var.\[name\]> | Returns the value of the variable \[name\] on the current skill tree.|
| <skill.var.damage-amount> | Returns the amount of damage taken in the onDamaged trigger |
| <skill.var.damage-type> | Returns the type of damage taken as specified in a mechanic, aura, etc.|
<table>
<thead>
<tr class="header">
<th><strong>Target Placeholders</strong></th>
<th><strong>Function</strong></th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><em>These placeholders will return whatever targetselector has been used. For instance &lt;target.name&gt; + @NearestPlayer will return the name of the player closest to the casting mob.</em></td>
<td></td>
</tr>
<tr class="even">
<td>&lt;target.uuid&gt;</td>
<td>Returns the UUID of the target</td>
</tr>
<tr class="odd">
<td>&lt;target.name&gt;</td>
<td>Returns the name of the target</td>
</tr>
<tr class="even">
<td>&lt;target.hp&gt;</td>
<td>Returns the current hp of the target</td>
</tr>
<tr class="odd">
<td>&lt;target.threat&gt;</td>
<td>Returns the threat level of the target</td>
</tr>
<tr class="even">
<td>&lt;target.l.w&gt;</td>
<td>Returns the world name the target is in</td>
</tr>
<tr class="odd">
<td>&lt;target.l.x&gt;</td>
<td>Returns the X coordinate of the target</td>
</tr>
<tr class="even">
<td>&lt;target.l.x.#&gt;</td>
<td>Returns the X coordinate of the target<br />
+- random number between #</td>
</tr>
<tr class="odd">
<td>&lt;target.l.y&gt;</td>
<td>Returns the Y coordinate of the target</td>
</tr>
<tr class="even">
<td>&lt;target.l.y.#&gt;</td>
<td>Returns the Y coordinate of the target<br />
+- random number between #</td>
</tr>
<tr class="odd">
<td>&lt;target.l.z&gt;</td>
<td>Returns the Z coordinate of the target</td>
</tr>
<tr class="even">
<td>&lt;target.l.z.#&gt;</td>
<td>Returns the Z coordinate of the target<br />
+- random number between #</td>
</tr>
</tbody>
</table>
**Target Placeholders**
-----------------
These placeholders will return whatever target selector has been used. For instance <target.name> + @NearestPlayer will return the name of the player closest to the casting mob.
<table>
<thead>
<tr class="header">
<th><strong>Trigger Placeholders</strong></th>
<th><strong>Function</strong></th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>&lt;trigger.uuid&gt;</td>
<td>Returns the UUID of the person triggering the skill</td>
</tr>
<tr class="even">
<td>&lt;trigger.name&gt;</td>
<td>Returns the name of the person triggering the skill</td>
</tr>
<tr class="odd">
<td>&lt;trigger.hp&gt;</td>
<td>Returns the current hp of the person triggering the skill</td>
</tr>
<tr class="even">
<td>&lt;trigger.threat&gt;</td>
<td>Returns the threat level of the person triggering the skill</td>
</tr>
<tr class="odd">
<td>&lt;trigger.l.w&gt;</td>
<td>Returns the world name of the person triggering the skill</td>
</tr>
<tr class="even">
<td>&lt;trigger.l.x&gt;</td>
<td>Returns the X coordinate of the person triggering the skill</td>
</tr>
<tr class="odd">
<td>&lt;trigger.l.x.#&gt;</td>
<td>Returns the X coordinate of the person triggering the skill<br />
+- random number between #</td>
</tr>
<tr class="even">
<td>&lt;trigger.l.y&gt;</td>
<td>Returns the Y coordinate of the person triggering the skill</td>
</tr>
<tr class="odd">
<td>&lt;trigger.l.y.#&gt;</td>
<td>Returns the Y coordinate of the person triggering the skill<br />
+- random number between #</td>
</tr>
<tr class="even">
<td>&lt;trigger.l.z&gt;</td>
<td>Returns the Z coordinate of the person triggering the skill</td>
</tr>
<tr class="odd">
<td>&lt;trigger.l.z.#&gt;</td>
<td>Returns the Z coordinate of the person triggering the skill<br />
+- random number between #</td>
</tr>
</tbody>
</table>
| **Target Placeholders** | **Function** |
|----------------------------------|-------------------------------------------------------------------------|
|<target.uuid>|Returns the UUID of the target|
|<target.name>|Returns the name of the target|
|<target.hp>|Returns the current hp 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.x>|Returns the X coordinate of the target|
|<target.l.x.#>|Returns the X coordinate of the target +- random number between #|
|<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.z>|Returns the Z coordinate of the target|
|<target.l.z.#>|Returns the Z coordinate of the target +- random number between #|
**Trigger Placeholders**
These placeholders will return whatever attribute of the entity that caused the skill to happen. For instance `<trigger.name>` combined with an `~onDeath` trigger will return the name of the entity that killed the mob.
Skills:
- message{m="<&b><caster.name><&r> was slain by <&a><trigger.name><&r>."} @PIR{r=20} ~onDeath
-----------------
|Trigger Placeholders|Function|
|------------------|--------------------------------------------------------------------------------------|
|<trigger.uuid> |Returns the UUID of the entity triggering the skill|
|<trigger.name> |Returns the name of the entity triggering the skill|
|<trigger.hp> |Returns the current hp 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.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.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.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 #|
Misc Placeholders
......@@ -257,61 +138,46 @@ Misc Placeholders
| **Placeholder** | **Function** |
|-----------------------|-----------------------------------------------------|
| **Misc Placeholders** | |
| &lt;drops.xp&gt; | Returns the xp dropped via Heroes or SkillAPI mods |
| &lt;drops.money&gt; | Returns the money dropped through the vault plug-in |
| <drops.xp> | Returns the xp dropped via Heroes or SkillAPI mods |
| <drops.money> | Returns the money dropped through the vault plug-in |
Special Placeholders
--------------------
| **Placeholder** | **Function** |
|----------------------------------------|---------------------------------------------------------------------------|
| &lt;caster.score.objective&gt; | Returns the score of the caster from "objective" **(2.3)** |
| &lt;target.score.objective&gt; | Returns the targeters score from "objective" **(2.3)** |
| &lt;trigger.score.objective&gt; | Returns the score of the trigger from "objective" **(2.3)** |
| &lt;global.score.objective&gt; | Returns the global score from "objective" **(2.3)** |
| &lt;score.objective.dummyname&gt; | Returns the score of "dummyname" (fake player) from "objective" **(2.3)** |
| &lt;random.\#-\#&gt; <sup>(v4.6)</sup> | Returns a random number in the specified range |
| <caster.score.objective> | Returns the score of the caster from "objective" **(2.3)** |
| <target.score.objective> | Returns the targeters score from "objective" **(2.3)** |
| <trigger.score.objective> | Returns the score of the trigger from "objective" **(2.3)** |
| <global.score.objective> | Returns the global score from "objective" **(2.3)** |
| <score.objective.dummyname> | Returns the score of "dummyname" (fake player) from "objective" **(2.3)** |
| <random.\#-\#> | Returns a random number in the specified range |
Special Characters
------------------
| **Placeholder** | **Function** |
|-----------------|---------------------------------------|
| &lt;&co&gt; | Returns a colon (:) |
| &lt;&sq&gt; | Returns an apostrophe (') |
| &lt;&da&gt; | Returns a dash (-) |
| &lt;&bs&gt; | Returns a backslash (\\) |
| &lt;&fs&gt; | Returns a forward slash (/) |
| &lt;&sp&gt; | Returns a space |
| &lt;&cm&gt; | Returns a comma (,) |
| &lt;&sc&gt; | Returns a semicolon (;) |
| &lt;&eq&gt; | Returns an equals symbol \[=\] |
| &lt;&ss&gt; | Returns a section symbol (ยง) |
| &lt;&dq&gt; | Returns double quotes (") |
| &lt;&rb&gt; | Returns a right bracket (\]) |
| &lt;&lb&gt; | Returns a left bracket (\[) |
| &lt;&rc&gt; | Returns a right curly bracket (}) |
| &lt;&lc&gt; | Returns a left curly bracket ({) |
| &lt;&nl&gt; | Forces a new line |
| &lt;&heart&gt; | Returns a heart **(2.1.7)** |
| &lt;&skull&gt; | Returns a skull and bones **(2.1.7)** |
##### Examples
Color Codes
-----------
This will make a mob send a teal (<&b>) message to all players in a radius of 20 blocks around in itself, stating that it was slain by player (<trigger.name>) in green (<&a>)
These color codes work anywhere in mob- and skill-files. They will even
properly format tellraw-commands used in command skills!
Skills:
- message{m="<&b><caster.name><&r> was slain by <&a><trigger.name><&r>."} @PIR{r=20} ~onDeath
| **Code** | **Color** | **Code** | **Color** |
|----------|-------------|----------|----------------|
| &0 | Black | &B | Aqua |
| &1 | Dark Blue | &C | Red |
| &2 | Dark Green | &D | Light Purple |
| &3 | Dark Aqua | &E | Yellow |
| &4 | Dark Red | &F | White |
| &5 | Dark Purple | &K | Magic |
| &6 | Gold | &L | Bold |
| &7 | Gray | &M | Strike through |
| &8 | Dark Gray | &N | Underline |
| &9 | Blue | &O | Italic |
| &A | Green | &R | Reset |
This skill will make an announcement like this:
![image](uploads/91ed6d8aaa669e8ae21f8745e8ff4643/image.png)
when the mob spawns
```
Skills:
- Skill{s=SaveBossLocation} @self ~onSpawn
- message{m="&eA &BGiant Zombie&e (Level &4<caster.level>&e) &ehas spawned at <caster.var.SpawnLoc>"} ~onSpawn @PlayersInWorld
- message{m="&eThe &BGiant Zombie&e (Level &4<caster.level>&e) &espawned at <caster.var.SpawnLoc>&e has been slain."} ~onDeath @PlayersInWorld
```
Be sure to place this skill somewhere in the skills file
```
SaveBossLocation:
Skills:
- setvariable{var=SpawnLoc;type=STRING;value="&b<caster.l.x>&e, &b<caster.l.y>&e, &b<caster.l.z>";scope=CASTER} @self
```
You can also use color tags and formatting tags to make the mobs have pretty names:
![image](uploads/9ad97422803c3f35fbeac2e4df7f7d52/image.png)
```
ZOMBIE:
Display: 'ZOMBIE &F- &A<caster.hp>/<caster.mhp>HP &F- &ELv.<caster.level>'
```