feat: wiki update authored by Taiyou06's avatar Taiyou06
......@@ -14,6 +14,8 @@ These can be used inside any Mythic skill, condition, mechanic, or menu lore via
| `<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. |
| `<caster.archetype.display.<group>>` | Caster's archetype *display name* in the given group. Accepts `<group>\|<fallback>`; the fallback is returned when no archetype is held. |
| `<caster.archetype.byid.display.<id>>` | Display name of the archetype with the given id (not tied to any player). Accepts `<id>\|<fallback>`; the fallback is returned when the id is blank or unknown. |
### Points
......@@ -22,7 +24,8 @@ These can be used inside any Mythic skill, condition, mechanic, or menu lore via
| `<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. |
| `<caster.points.archetype.<type>.<key>>` | Points the caster has *invested* in the talent tree named by `<key>` (a talent tree id, or an archetype id whose tree is used), counted for point type `<type>`. Returns `0` if the tree's own point type differs from `<type>`. Aliases: `tree`, `talenttree`. |
| `<caster.points.archetypeearned.<type>.<archetype>>` | Points the caster has *earned* via the given archetype, for point type `<type>`. Alias: `earnedarchetype`. |
### Spells
......@@ -45,6 +48,9 @@ These only resolve when used inside a talent skill context (e.g. inside the `Con
| `<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. |
| `<caster.talent.mod{m=<key>}>` | The scoped talent's modifier value, evaluated at the caster's invested rank. Returns the default (`0`, or the value after `\|` in the key) when the talent, modifier key, or rank is missing. |
Aliases for `talent.mod`: `talent.modifier`. Argument aliases: `m`/`mod`/`modifier` for the modifier key.
### Cast State
......@@ -62,6 +68,21 @@ These resolve against the target entity's current [cast-time](/Spells/Casting#ca
`<target.cast.*>` and `<trigger.cast.*>` work the same way against their respective scopes.
### Party / Friends
These resolve against the scoped player's friend list and party. `isfriend` is relational: it compares the scoped entity against the skill's caster, so it is normally used with a `target.` or `trigger.` scope.
| Placeholder | Returns |
|--------------------------------|-----------------------------------------------------------------------------|
| `<caster.friends.online>` | Number of the scoped player's friends who are currently online. |
| `<caster.friends.total>` | Total number of friends the scoped player has. |
| `<caster.friends.names>` | Comma-separated names of the scoped player's friends. |
| `<target.isfriend>` | `1` if the scoped entity is a friend of the caster, otherwise `0`. |
| `<caster.party.leader>` | Name of the scoped player's party leader (empty if not in a party). |
| `<caster.party.size>` | Number of members in the scoped player's party (`0` if not in a party). |
| `<caster.party.members>` | Comma-separated names of the scoped player's party members. |
| `<caster.party.isleader>` | `1` if the scoped player leads their party, otherwise `0`. |
## PlaceholderAPI Integration
......@@ -73,6 +94,7 @@ These work in any plugin that resolves PAPI placeholders.
|------------------------------------------|---------------------------------------------------------------------------------|
| `%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_byid_display_<id>%` | Display name of the archetype with the given id (not tied to any player). Empty if the id is unknown. |
| `%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. |
......@@ -117,13 +139,13 @@ These work in any plugin that resolves PAPI placeholders.
| Placeholder | Returns |
|------------------------------------------|-----------------------------------------------------------------------------------------|
| `%mythic_is_casting%` | `true` while quickcasting is active for the player, otherwise `false`. |
| `%mythicrpg_is_spell_casting%` | `true` while a [cast-time](/Spells/Casting#cast-time) cast is in progress, else `false`.|
| `%mythicrpg_casting_spell%` | Internal id of the spell currently being cast (empty if none). |
| `%mythicrpg_casting_spell_display%` | Display name of the spell currently being cast. |
| `%mythicrpg_cast_progress%` | Cast progress as a `0.00``1.00` value (`0` if not casting). |
| `%mythicrpg_cast_time_remaining%` | Remaining cast time in seconds (`0` if not casting). |
| `%mythicrpg_cast_time_total%` | Total cast time in seconds (`0` if not casting). |
| `%mythicrpg_cast_interruptible%` | `true` if the active cast is interruptible (`false` if not casting). |
| `%mythic_is_spell_casting%` | `true` while a [cast-time](/Spells/Casting#cast-time) cast is in progress, else `false`.|
| `%mythic_casting_spell%` | Internal id of the spell currently being cast (empty if none). |
| `%mythic_casting_spell_display%` | Display name of the spell currently being cast. |
| `%mythic_cast_progress%` | Cast progress as a `0.00``1.00` value (`0` if not casting). |
| `%mythic_cast_time_remaining%` | Remaining cast time in seconds (`0` if not casting). |
| `%mythic_cast_time_total%` | Total cast time in seconds (`0` if not casting). |
| `%mythic_cast_interruptible%` | `true` if the active cast is interruptible (`false` if not casting). |
### Waystones
......
......