[Enhancement] Placeholder Rework

[RAYCAL2000]

Placeholder Rework

The following aims to rework and simplify the existing placeholders that the plugin currently has. Some of the placeholders that already exist are redundant and can be removed entirely or reworked. Additionally, the plugin lacks sufficient support for flags and values to be shown or used via PlaceholderAPI.

This rework also aims to add similar functionality that MMOCore has. If a server is using the “ACTION_BAR” mode, there will be an additional set of Placeholders that will allow players to access the names and cooldowns of skills as well as the skills in certain positions.

By default, all Placeholders will link up to the same main class group that is configured in the Config file. For example if you have 'main-class-group': 'class' in your config file, then this will pull information from the class group. For some, you may specify an optional group to get information from that group specifically. For some information such as health, mana, etc. it will take the combined total of all groupings.

Class

• %fabled_level[_group]%
  • Player’s current class level, [_group] is optional and will default to their main-class-group if not specified.
• %fabled_maxlevel[_group]%
  • Player’s current class maximum level, [_group] is optional and will default to their main-class-group if not specified.
• %fabled_totallevel%
  • Player’s combined level of all groups.
• %fabled_totalmaxlevel%
  • Player’s maximum combined level of all groups.
• %fabled_prefix[_group]%
  • Player’s class prefix, [_group] is optional and will default to their main-class-group if not specified.
• %fabled_class[_group]%
  • Player’s current class name, [_group] is optional and will default to their main-class-group if not specified.
• %fabled_parent[_group]%
  • The parent class of the specified group, main if not specified. (Example: Human > Blacksmith).
• %fabled_children[_group]%
  • Children of the class in the specified group as a list, main if not specified. (Example: Human, Orc, Troll)

Health

• %fabled_health%
  • Player’s current health.
• %fabled_maxhealth%
  • Player’s current maximum health.
• %fabled_basehealth[_group]%
  • Health at level 1 of the class in this group.
• %fabled_healthat:[_group]%
  • The health the player would have at the chosen level for a specific group. Defaults to main if not specified.
• %fabled_healthscale[_group]%
  • How much health scales per level of this group. Defaults to main if not specified.

Mana

• %fabled_mana%
  • Player’s current mana.
• %fabled_maxmana%
  • Player’s maximum mana.
• %fabled_mananame[_group]%
  • Player’s mana name of the class in a specified group.
• %fabled_basemana[_group]%
  • The mana at level 1 of the class in the specified group.
• %fabled_manaregen[_group]%
  • If no group is specified, it will return the total mana regen rate. The mana regen for this group.
• %fabled_manaat:[level][_group]%
  • The mana the player would have at the chosen level for a specific group. Defaults to main if not specified.
• %fabled_manascale[_groupname]%
  • How much mana scales per level of this group. Defaults to main if not specified.

Leveling

• %fabled_attribute:[attributename][_group]%
  • Indicates how many points the player has in the specified attribute within the group.
• %fabled_attributepoints%
  • Player’s available attribute points
• %fabled_investedattributepoints%
  • Player’s invested attribute points, if no attribute is specified, works for all.
• %fabled_currentexp[_group]%
  • Player’s experience points, for the main group, or specified group.
• %fabled_requiredexp[_group]%
  • Player’s required experience points for the next level, main class group.
• %fabled_requiredexpat:[level][_group]%
  • The required experience the player would need at the chosen level.
• %fabled_skillpoints[_group]%
  • Player’s total available skill points.
• %fabled_investedskillpoints[_group]%
  • Specifies the number of invested skill points the player has within the group.

Accounts (From Enhancement #991)

• %fabled_accounts%
  • Total number of accounts the player has.
• %fabled_currentaccount%
  • The number account the player is on.
• %fabled_classaccount:[id]%
  • Returns the main class group that the player has for a specified account.

Variable Placeholders

These placeholders aim as a way for players to gain access to flags and values outside of just the Fabled plugin. This will make the current variable system much more versatile than it already is.

• %fabled_flag:[flagname]%
  • Returns true if this flag is set, false otherwise.
• %fabled_flagleft:[flagname]%
  • Returns the remaining time the flag has, returns 0 if not set.
• %fabled_value:[valuename]%
  • Returns the value stored, returns 0 if not found.

Skill Placeholders

These placeholders aim to add additional skill information for players to be able to use in other plugins. This will allow players to use them in various HUD plugins such as HappyHUD and BetterHUD to display skill information through them.

• %fabled_skilllevel:[skillname]%
  • Returns the level of the skill, if the player does not have the skill it will return 0.
• %fabled_casting%
  • Returns true if the player is skill casting.
• %fabled_skillcost:[skillname]%
  • Returns the mana cost of a skill.
• %fabled_skillcooldownremaining:[skillname]%
  • Returns the remaining cooldown of a skill, 0 if the skill can be casted again.
• %fabled_skillcooldown:[skillname]%
  • Returns the default cooldown of a skill.
• %fabled_skillactionbar:[slot_id]%
  • Slot ID must be 0-9, returns the skill bound in that spot if the ACTION_BAR mode is being used.
• %fabled_skillactionbarcooldown:[slot_id]%
  • Slot ID must be 0-9, returns the skill bound in that spot if the ACTION_BAR mode is being used.

[funaydmc]

Can we make it more concise and flexible? For example with %fabled_main_level% We can make it to %fabled_level[_<group>]% [_<group>] is optional, default is main group. The same applies to other placeholders.

[RAYCAL2000]

Can we make it more concise and flexible?

For example with %fabled_main_level%

We can make it to %fabled_level[_<group>]%

[_<group>] is optional, default is main group.

The same applies to other placeholders.

You know sometimes my brain only half functions, but yeah that seems like a brilliant idea. Let me do a quick rewrite and concise things down later.

[RAYCAL2000]

I have gone ahead and finished a second rewrite of the Placeholders, just needs a second pair of eyes before I go ahead and attempt to make it functional.