Changes

Page history
Update Placeholders authored by Taiyou06's avatar Taiyou06
Hide whitespace changes
Inline Side-by-side
Placeholders.md
View page @ bf350ee3
These are all of the placeholders MythicRPG provides
[[_TOC_]]
## Caster Placeholders
| Placeholder | Function |
|:----------------------------------:|-------------------------------------------------------------------|
| <caster.archetype.[group]> | Returns the caster's [archetype](/Archetypes) from the specified `group`<br>Defaults to `NONE` |
| <caster.archetype.level.[group]> | Returns the caster's [archetype](/Archetypes) level from the specified `group` |
| <caster.archetype.exp.[group]> | Returns the caster's [archetype](/Archetypes) experience from the specified `group` |
| <caster.archetype.exp.goal.[group]>| Returns the caster's [archetype](/Archetypes) experience goal from the specified `group` |
## Placeholder API Integration
| Placeholder | Function |
|:----------------------------------:|-------------------------------------------------------------------|
| %mythic_reagent_[name]% | The parsed player reagent's current value.<br>Defaults to `0`.<br>If the resource does not exist, returns `[Invalid_Resource]` |
| %mythic_reagent_max_[name]% | The parsed player reagent's max value.<br>Defaults to `0`.<br>If the resource does not exist, returns `[Invalid_Resource]` |
| %mythic_archetype_[group]% | Returns the parsed player's [archetype](/Archetypes) from the specified `group`<br>Defaults to `NONE` |
| %mythic_archetype_level_[group]% | Returns the parsed player's [archetype](/Archetypes) level from the specified `group` |
| %mythic_archetype_exp_[group]% | Returns the parsed player's [archetype](/Archetypes) experience from the specified `group` |
| %mythic_archetype_exp_goal_[group]%| Returns the parsed player's [archetype](/Archetypes) experience goal from the specified `group` |
| %mythic_is_casting% | Whether the player is casting a skill using any mode |
| %mythic_binding_id_[binding]% | The spell ID bound to the given binding |
| %mythic_binding_name_[binding]% | The spell display name |
| %mythic_binding_cooldown_current_[binding]% | The current cooldown |
| %mythic_binding_cooldown_max_[binding]% | The max cooldown |
| %mythic_binding_cost_[reagent]_[binding]% | The reagent cost of the spell for the reagent type given |
| %mythic_binding_key_[binding]% | The button to press if using hotbar mode |
\ No newline at end of file
All placeholders provided by MythicRPG.
[[_TOC_]]
## MythicMobs Placeholders
These can be used inside any Mythic skill, condition, mechanic, or menu lore via `<...>` syntax (with the appropriate scope prefix — typically `caster.`, `target.`, or `trigger.`).
### Archetypes
| Placeholder | Returns |
|------------------------------------------|------------------------------------------------------------------------------------------|
| `<caster.archetype.<group>>` | Caster's archetype id in the given group. Returns `NONE` if no archetype is held. |
| `<caster.archetype.level.<group>>` | Caster's archetype level in the given group. |
| `<caster.archetype.exp.<group>>` | Caster's current experience in the given group. |
| `<caster.archetype.exp.goal.<group>>` | Caster's experience needed to reach the next level in the given group. |
### Points
| Placeholder | Returns |
|--------------------------------------------------------------|--------------------------------------------------------------------------|
| `<caster.points.available.<type>>` | Available (unspent) points of the given type. |
| `<caster.points.earned.<type>>` | Total points the caster has ever earned of the given type. |
| `<caster.points.spent.<type>>` | Total points the caster has spent of the given type. |
| `<caster.points.archetype.<type>.<archetype>>` | Points earned via a specific archetype. |
### Spells
| Placeholder | Returns |
|----------------------------------------------|---------------------------------------------------------------------------------------------------------------|
| `<caster.spell.level>` | Level of the spell currently being cast (only meaningful inside spell skill execution). |
| `<caster.spell.level{class=<spellId>}>` | Caster's level in a specific learned spell. |
| `<caster.spell.levels>` | List form of `spell.level` for spells with stacked sources. |
| `<caster.spell.mod{m=<key>}>` | The current spell's [modifier](/Spells#modifiers) value at the caster's spell level. |
| `<caster.spell.mod{m=<key>;c=<spellId>}>` | A specific learned spell's modifier value, evaluated at that spell's level. |
Aliases for `spell.mod`: `spell.modifier`, `modifier`. Argument aliases: `m`/`mod`/`modifier` for the modifier key, `c`/`class` for the spell id.
### Talents
These only resolve when used inside a talent skill context (e.g. inside the `Configuration.Talents.OnInvest` / `OnDivest` hooks documented on [Talents](/Archetypes/Talents#talent-tree-hooks)).
| Placeholder | Returns |
|--------------------------------------|----------------------------------------------------------------------------------|
| `<caster.talent.invested_points>` | Points the caster has currently invested in the talent in scope. |
| `<caster.talent.max_points>` | The talent's `MaxPoints` value. |
| `<caster.talent.pointed_needed>` | Points the caster still needs to invest in the *tree* before the talent unlocks. |
## PlaceholderAPI Integration
These work in any plugin that resolves PAPI placeholders.
### Archetypes
| Placeholder | Returns |
|------------------------------------------|---------------------------------------------------------------------------------|
| `%mythic_archetype_<group>%` | Player's archetype id in the given group. Returns `NONE` if none held. |
| `%mythic_archetype_display_<group>%` | Player's archetype *display name* in the given group. |
| `%mythic_archetype_level_<group>%` | Player's archetype level in the given group. |
| `%mythic_archetype_exp_<group>%` | Player's current archetype experience in the given group. |
| `%mythic_archetype_exp_goal_<group>%` | Experience needed for the next level. |
| `%mythic_archetype_exp_last_<group>%` | Amount of XP gained from the most recent grant in this group. |
### Experience Sources
| Placeholder | Returns |
|------------------------------------------|---------------------------------------------------------------------------------|
| `%mythic_expsource_last_<group>%` | Amount of XP gained from the most recent grant via the named source group. |
### Points
| Placeholder | Returns |
|--------------------------------------------------------------|----------------------------------------------------------|
| `%mythic_point_available_<type>%` | Available (unspent) points of the given type. |
| `%mythic_point_earned_<type>%` | Total points ever earned of the given type. |
| `%mythic_point_spent_<type>%` | Total points spent of the given type. |
| `%mythic_point_archetype_<type>_<archetype>%` | Points earned via a specific archetype. |
| `%mythic_point_display_<type>%` | The configured display name of the point type. |
### Reagents
| Placeholder | Returns |
|------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| `%mythic_reagent_<name>%` | Current value of the named [reagent](/Spells/Reagents). Returns `[Invalid_Resource]` if it doesn't exist. |
| `%mythic_reagent_max_<name>%` | Max value of the named reagent. |
### Spell Bindings
| Placeholder | Returns |
|----------------------------------------------------------|---------------------------------------------------------------|
| `%mythic_binding_id_<slot>%` | The spell id bound to the given hotbar slot. |
| `%mythic_binding_name_<slot>%` | The display name of the spell bound to the slot. |
| `%mythic_binding_cooldown_current_<slot>%` | Current remaining cooldown of the bound spell. |
| `%mythic_binding_cooldown_max_<slot>%` | Max cooldown of the bound spell. |
| `%mythic_binding_cost_<reagent>_<slot>%` | Reagent cost of the bound spell for the given reagent type. |
| `%mythic_binding_key_<slot>%` | The button to press if quickcasting in hotbar mode. |
### Casting State
| Placeholder | Returns |
|------------------------|--------------------------------------------------------------------------|
| `%mythic_is_casting%` | `true` while quickcasting is active for the player, otherwise `false`. |