- Compatible API Versions
- 1.0.0
- Contributors
- CreeperFace
PlaceholderAPI adds support for placeholders, so you can easily use the information from all plugins supporting PlaceholderAPI such as (Holograms, CustomMessages or LuckPerms) anywhere else.
KotlinLib is required to use plugin
How to use
Developer documentation
KotlinLib is required to use plugin
How to use
Placeholders in texts must be surrounded with percent signs.
example
"this is a text with placeholder %time%"
%time% will be replaced with the actual time
You can use multiple placeholders in one text.
Parameters
since version 1.3 placeholders can contain parameters, which modify the final value, it can be a permission we want to check or the key of something and so on.
parameters must be specified in the following format
%placeholder<parameters>% - generic format
%placeholder<param1=value1;param2=value2>% - PAPI supports named parameters which is usually used when you need to use multiple parameters, then it doesn't matter in what order you specifiy them. But it depends on the implementation of the plugin that provides the placeholders whether the naming is required or not. In general for single parameter the naming shouldn't be required.
example
%has_permission<nukkit.command.time>% - checks if player has the permission nukkit.command.time
%synapse_status<lobby;true=you can join;false=you can't join right now>% - returns synapse server status. When online then "you can join" otherwise "you can't join right now"
%player% - get the player's name
%player_displayname% - get the player's display name
%player_uuid% - get the player's UUID
%player_ping% - get the player's ping
%player_level% - get the player's level name
%player_can_fly% - Whether player is in the fly mode or not
%player_flying% - Whether player is flying or not
%player_health% - get the player's health
%player_max_health% - get the player's max health
%player_saturation% - get the player's saturation level
%player_food% - get the player's food level
%player_gamemode% - get the player's gamemdoe
%player_x% - get the player's x coordinate
%player_y% - get the player's y coordinate
%player_z% - get the player's z coordinate
%player_direction% - get the player's look direction
%player_exp% - get the player's cuurent experience
%player_exp_to_next% - get experience required to the player's next experience level
%player_exp_level% - get the player's experience level
%player_speed% - get the player's current speed
%player_max_air% - get the player's max air
%player_remaining_air% - get the player's remaining air
%player_item_in_hand% - get the item player hold
%server_online% - get current online players count
%server_max_players% - get max player count
%server_motd% - get the server motd
%server_ram_used% - get used memory
%server_ram_free% - get free memory
%server_ram_total% - get total memory
%server_ram_max% - get max memory
%server_cores% - get available processor cores
%server_tps% - get current TPS
%server_uptime% - get the current uptime
%time%
%player_displayname% - get the player's display name
%player_uuid% - get the player's UUID
%player_ping% - get the player's ping
%player_level% - get the player's level name
%player_can_fly% - Whether player is in the fly mode or not
%player_flying% - Whether player is flying or not
%player_health% - get the player's health
%player_max_health% - get the player's max health
%player_saturation% - get the player's saturation level
%player_food% - get the player's food level
%player_gamemode% - get the player's gamemdoe
%player_x% - get the player's x coordinate
%player_y% - get the player's y coordinate
%player_z% - get the player's z coordinate
%player_direction% - get the player's look direction
%player_exp% - get the player's cuurent experience
%player_exp_to_next% - get experience required to the player's next experience level
%player_exp_level% - get the player's experience level
%player_speed% - get the player's current speed
%player_max_air% - get the player's max air
%player_remaining_air% - get the player's remaining air
%player_item_in_hand% - get the item player hold
%server_online% - get current online players count
%server_max_players% - get max player count
%server_motd% - get the server motd
%server_ram_used% - get used memory
%server_ram_free% - get free memory
%server_ram_total% - get total memory
%server_ram_max% - get max memory
%server_cores% - get available processor cores
%server_tps% - get current TPS
%server_uptime% - get the current uptime
%time%
Developer documentation
