Placeholders
📄 Introduction
Placeholders allow you to display dynamic information about teams, players, and other aspects of your plugin in a variety of formats, such as messages or titles. These placeholders can be used in various configuration files to customize the server experience.
🧩 Supported Placeholders
Here is a list of the available placeholders you can use with the plugin, along with the format of the returned values:
%xwhitelist_mysql_enabled%
Returns if the MySQL mode is enabled.
Boolean: Status of MySQL mode (e.g., true)
%xwhitelist_whitelist_enabled%
Returns if the Whitelist is enabled.
Boolean: Status of Whitelist (e.g., true)
%xwhitelist_whitelist_iswhitelisted%
Returns if the player that parse the placeholder is on the whitelist.
Boolean: Status of the player (e.g., false)
%xwhitelist_whitelist_playerswhitelisted%
Returns the number of players on the whitelist.
Integer: Number of players (e.g., 9 or 123)
%xwhitelist_maintenance_enabled%
Returns if the Maintenance Whitelist is enabled.
Boolean: Status of Whitelist (e.g., true)
%xwhitelist_maintenance_iswhitelisted%
Returns if the player that parse the placeholder is on the maintenance whitelist.
Boolean: Status of the player (e.g., false)
%xwhitelist_maintenance_playerswhitelisted%
Returns the number of players on the maintenance whitelist.
Integer: Number of players (e.g., 9 or 123)
❓ How to Use These Placeholders
To use these placeholders, simply insert them in the appropriate places in supported configuration files like messages.yml
. For example, if you want, you can make show the number of players in the whitelist when you add a player to it.
💡 Example of Use in a Server
If you have PlaceholderAPI installed, these placeholders will automatically be replaced by the corresponding values when players see messages or titles that use them.
%xwhitelist_whitelist_playerswhitelisted%
will replace the placeholder with the number of players in the whitelist.%xwhitelist_whitelist_enabled%
will return if the whitelist is enabled.
⚙️ Example Configuration
🔗 Compatibility with PlaceholderAPI
If PlaceholderAPI is installed on your server, the plugin integrates directly with it. You do not need to do any extra configuration to make these placeholders work. Just add them to your messages, titles, or any other display format, and the plugin will handle the rest.
Last updated