Placeholders
VanguardRanks integrates deeply with PlaceholderAPI to provide dynamic content and requirements. This guide covers all available placeholders and their usage.
Rank Placeholders
Rank placeholders provide information about ranks and are used in messages, GUIs, and commands.
Placeholder | Description | Example |
---|---|---|
%name% | The rank’s internal name | Novice |
%prefix% | The rank’s prefix shown in chat | [Novice] |
%display_name% | The rank’s display name | Novice Rank |
%order% | The rank’s position in hierarchy | 1 |
%next_name% | Next rank’s internal name | Advanced |
%next_prefix% | Next rank’s prefix | [Advanced] |
%next_display_name% | Next rank’s display name | Advanced Rank |
%next_order% | Next rank’s position | 2 |
%previous_name% | Previous rank’s internal name | Beginner |
%previous_prefix% | Previous rank’s prefix | [Beginner] |
%previous_display_name% | Previous rank’s display name | Beginner Rank |
%previous_order% | Previous rank’s position | 0 |
Requirement Placeholders
Requirement placeholders are used in requirement messages and GUI displays.
Placeholder | Description | Example |
---|---|---|
%current% | Current value of the requirement | 500 |
%required% | Required value to meet the requirement | 1000 |
%status% | Status message (configured in messages.yml) | ✓ Completed |
Player Placeholders
Player placeholders provide information about the player.
Placeholder | Description | Example |
---|---|---|
%player% | Player’s name | Steve |
Usage Examples
In Requirements
requirements:
- placeholder: "%vault_eco_balance%" # Player's balance
type: "GREATER_THAN"
value: 1000
gui_message: "Have $%required% - Current: $%current%"
deny_message: "You need $%required% to rank up! (Current: $%current%)"
In Messages
rankup_message: "&a%player% ranked up from %previous_rank% to %rank%!"
list_format: "&7%order%. &f%display_name% &7(%name%)"
In Commands
commands:
- "broadcast %player% has reached %rank%!"
- "give %player% diamond 1"
PlaceholderAPI Integration
VanguardRanks also registers its own placeholders for use in other plugins:
Placeholder | Description | Example |
---|---|---|
%vanguardranks_rank% | Player’s current rank display name | Novice Rank |
%vanguardranks_rank_name% | Player’s current rank name | novice |
%vanguardranks_rank_prefix% | Player’s current rank prefix | [Novice] |
%vanguardranks_next_rank% | Player’s next rank display name | Advanced Rank |
%vanguardranks_previous_rank% | Player’s previous rank display name | Beginner Rank |
These placeholders can be used in any plugin that supports PlaceholderAPI.
Last updated on