-
Notifications
You must be signed in to change notification settings - Fork 0
Placeholders
All messages are able to parse external PlaceholderAPI placeholders. They will be parsed for the recipient of the message. Below is a table of provided placeholders.
Name | Type | Description |
---|---|---|
<viewer> |
Internal | Viewer of the current chat message. |
<viewer_credits> |
Internal | Amount of credits the current chat message viewer currently has. |
<viewer_uuid> |
Internal | UUID that the plugin currently has stored for the current chat message viewer. |
<viewer_redeemed> |
Internal | Amount of credits the current chat message viewer has redeemed. |
<sender> |
Internal | Name of the command executor. |
<sender_credits> |
Internal | Amount of credits the command executor currently has. |
<sender_uuid> |
Internal | UUID that the plugin currently has stored for the command executor. |
<sender_redeemed> |
Internal | Amount of credits the command executor has redeemed. |
<target> |
Internal | Name of the command target. |
<target_credits> |
Internal | Amount of credits the command target currently has. |
<target_uuid> |
Internal | UUID that the plugin currently has stored for the command target. |
<target_redeemed> |
Internal | Amount of credits the command target has redeemed. |
<skill> |
Internal | Name of affected mcMMO skill, formatted. Ex. Acrobatics. |
<cap> |
Internal | Level cap of affected mcMMO skill. |
<amount> |
Internal | Amount of credits used within a transaction. Works for modify or redeem commands. |
<rank> |
Internal | Rank on the MCMMOCredits leaderboard. Only usable in the "leaderboard-entry" message. |
%mcmmocredits_credits% |
PlaceholderAPI | Returns the amount of mcMMO Credits a user currently has. |
%mcmmocredits_redeemed% |
PlaceholderAPI | Returns the amount of mcMMO Credits a user has redeemed. |
%mcmmocredits_username% |
PlaceholderAPI | Returns the username stored for a User. |
%mcmmocredits_uuid% |
PlaceholderAPI | Returns the UUID stored for a User. |
%mcmmocredits_cached% |
PlaceholderAPI | Returns if the user is currently cached. |
In commands, there are a specific subset of placeholders also available for command failures. These are below.
Name | Type | Description |
---|---|---|
<correct_syntax> |
Command Caption | Provides the correct command syntax in the "invalid-syntax" message. |
<correct_sender> |
Command Caption | Provides the correct command sender type in the "invalid-sender" message. |
<permission> |
Command Caption | Provides the required permission in the "no-permission" message. |
<command_context> |
Command Caption | Attempts to provide the command context in the "command-execution" message. Likely to be removed. |
<argument_error> |
Command Caption | See below |
<input> |
Command Caption | Command input used in multiple command argument parse failure messages. |
<flag> |
Command Caption | Available when a command flag is involved in the error. Example: argument-parse-failure-flag-duplicate-flag |
<min> |
Command Caption | Minimum acceptable number in argument-parse-failure-number message. |
<max> |
Command Caption | Maximum acceptable number in argument-parse-failure-number message. |
<stringMode> |
Command Caption | String mode used in argument-parse-failure-string message. |
<acceptableValues> |
Command Caption | List of acceptable values used in argument-parse-failure-enum |
The <argument_error>
placeholder will output the message configured in config.yml that matches the relevant argument parsing failure. For example, if a flag is duplicated within a command, the "argument-parsing" message is sent to the User, with the <argument_error>
placeholder replaced with the message located at argument-parse-failure-flag-duplicate-flag
in the config.
argument-parse-failure-flag-duplicate-flag: Duplicate flag <flag>
argument-parsing: '<red>Argument Error: <argument_error>'
When a user duplicates a flag, the message they would receive is: <red>Argument Error: Duplicate flag <flag>