PlaceholderAPI placeholders

May 3, 2018
PlaceholderAPI placeholders
  • [​IMG]
    PlaceholderAPI is a module based system where placeholders for a specific function/object/plugin are usually compiled into individual .jar files called "Expansions".

    These expansions are similar to how actual plugins on your server work.

    In order for an expansion to be loaded and enabled, the <expansion name>.jar file must be located in the /server/plugins/ folder and you must also have any to use Factions placeholders, you will obviously need the Factions plugin installed and running properly on your server).

    This expansion system allows the core plugin of PlaceholderAPI to be as light and dependency free as possible while also allowing the expansion developer much flexibility as each set of placeholders is contained within its own environment. Updating is super easy, the code behind the placeholders can be organized neatly, and it doesn't bloat the actual plugin with tons of useless code or functions that are never used!

    All official expansions can be downloaded either in game via the command - /papi ecloud, or by visiting my website.

    If you are a developer and have expansions that you have made and would like to contribute to the official PlaceholderAPI expansion cloud for others to download and use, send me a message.

    NOTE:
    Some plugins may add placeholders to PlaceholderAPI other ways than the expansion system stated above such as include them with the plugin that the placeholders are associated with and load them into PlaceholderAPI when said plugin is enabled on your server.





    Date placeholders(top)


    These placeholders allow you to specify the format you want to use to get the current time/date / etc. These require you use valid date and time patterns. Once a valid pattern is used in a placeholder, it's cached for faster use later. Valid patterns can be found here: http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html
    Expansion download command: /papi ecloud download Server

    %server_time_<format>%


    Javascript placeholders(top)

    Expansion download command: /papi ecloud download JavaScript

    %javascript_<your placeholder identifier>%


    JavaScript placeholders wiki(top)

    These placeholders can be found here


    Server placeholders(top)

    Expansion download command: /papi ecloud download Server

    %server_online% Shows the player count of the server.
    %server_max_players%
    %server_unique_joins%
    %server_uptime%
    %server_ram_used%
    %server_ram_free%
    %server_ram_total%
    %server_ram_max%
    %server_tps%

    %server_online_(world)%
    Shows the player count of the world.
    %server_countdown_<SimpleDateFormat>_<time>% ex. %server_countdown_MM/dd/yyyy-HH:mm_10/11/2019-06:30%

    NOTE: %server_ram_total% and %server_ram_max% do the exact same thing.


    Player sound placeholders(top)

    Play a sound to the player the placeholder values are being parsed for
    Expansion download command: /papi ecloud download Sound

    %sound_<sound>-<volume>-<pitch>%
    %sound_ORB_PICKUP-1-2%


    Global sound placeholders(top)

    Play a sound to all players on the server when this placeholder is parsed
    Expansion download command: /papi ecloud download Sound

    %sound_all_<sound>-<volume>-<pitch>%
    %sound_all_ORB_PICKUP-1-2%


    Sound names can be found here:
    https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html


    Pinger placeholders(top)

    These placeholders require "warmup" time of around a minute or two after installing the expansion (Replace 'Testplugins.com:25565' with your server/ip).
    Expansion download command: /papi ecloud download Pinger

    %pinger_gameversion_testplugins.com:25565%
    %pinger_version_testplugins.com:25565%
    %pinger_online_testplugins.com:25565%
    %pinger_isonline_testplugins.com:25565%
    %pinger_max_testplugins.com:25565%
    %pinger_players_testplugins.com:25565%
    %pinger_motd_testplugins.com:25565%
    %pinger_pingversion_testplugins.com:25565%

    NOTE: %pinger_online_testplugins.com:25565% and %pinger_isonline_testplugins.com:25565% do the exact same thing.


    BungeeCord placeholders(top)

    Expansion download command: /papi ecloud download Bungee

    %bungee_total%
    %bungee_<servername>%


    RedisBungee placeholders(top)

    Expansion download command: /papi ecloud download RedisBungee

    %redisbungee_total%
    %redisbungee_<servername>%


    NMS Player placeholders(top)

    NewPing placeholders (1.11.x)(top)

    These placeholders are obsolete. Use Player expansion 1.1.0 or higher

    ListPlayers placeholders(top)

    Expansion download command: /papi ecloud download ListPlayers

    %listplayers_with_perm_<permission>%
    %listplayers_in_world_<worldname>%



    Player placeholders(top)

    Expansion download command: /papi ecloud download Player

    %player_timestamp%
    %player_server%
    %player_name%
    %player_displayname%
    %player_uuid%
    %player_gamemode%
    %player_x%
    %player_y%
    %player_z%
    %player_world%
    %player_is_op%
    %player_bed_x%
    %player_bed_y%
    %player_bed_z%
    %player_bed_world%
    %player_ip%
    %player_allow_flight%
    %player_can_pickup_items%
    %player_compass_x%
    %player_compass_y%
    %player_compass_z%
    %player_compass_world%
    %player_has_permission_<permission>%
    %player_custom_name%
    %player_exp%
    %player_exp_to_level%
    %player_total_exp%
    %player_level%
    %player_first_join_date%
    %player_fly_speed%
    %player_food_level%
    %player_health%
    %player_max_health%
    %player_health_scale%
    %player_item_in_hand%
    %player_last_damage%
    %player_max_air%
    %player_remaining_air%
    %player_no_damage_ticks%
    %player_max_no_damage_ticks%
    %player_time%
    %player_time_offset%
    %player_saturation%
    %player_sleep_ticks%
    %player_walk_speed%
    %player_ticks_lived%
    %player_seconds_lived%
    %player_minutes_lived%
    %player_ping% - added in 1.1.0
    %player_ping_<playername>% - added in 1.1.0
    %player_hasitem-mat:<MATERIAL>-amt:<amount>-data:<data value>%
    %player_has_empty_slot%
    %player_world_time_12%
    %player_world_time_24%


    OtherPlayer placeholders(top)

    [Link to page]


    %otherplayer_displayname_<player>%
    %otherplayer_gamemode_<player>%
    %otherplayer_hasperm_<player>_perm_<permission.string>%
    %otherplayer_haspotioneffect_<player>_effect_<effect_name>%
    %otherplayer_health_<player>%
    %otherplayer_hunger_<player>%
    %otherplayer_iteminhand_<player>%
    %otherplayer_ip_<player>%
    %otherplayer_level_<player>%
    %otherplayer_locx_<player>%
    %otherplayer_locy_<player>%
    %otherplayer_locz_<player>%
    %otherplayer_oxygen_<player>%
    %otherplayer_spells_<player>%
    %otherplayer_uuid_<player>%
    %otherplayer_world_<player>%

    Scoreboard Objectives placeholders(top)

    [Link to page]

    %objective_score_<obj-name>%
    %objective_score_<obj-name>_[otherEntry]%
    Note: [otherEntry] can be another player name, Offline Player name, or non-player Entry



    Statistic placeholders(top)

    Expansion download command: /papi ecloud download Statistic

    %statistic_mine_block_<material>%
    ex: %statistic_mine_block_DIAMOND_BLOCK%


    %statistic_use_item_<Item Material>%
    %statistic_break_item_<Item Material>%
    %statistic_craft_item_<Item Material>%
    ex: %statistic_craft_item_DIAMOND_SWORD%


    %statistic_kill_entity_<MobType>%
    ex: %statistic_kill_entity_CREEPER%


    %statistic_entity_killed_by_<MobType>%
    ex: %statistic_entity_killed_by_CREEPER%


    %statistic_mine_block% - total blocks broken
    %statistic_use_item% - total item uses
    %statistic_break_item% - total item breks
    %statistic_craft_item% - total items crafted
    %statistic_ticks_played% - total ticks played
    %statistic_seconds_played%
    %statistic_minutes_played%
    %statistic_hours_played%
    %statistic_days_played%
    %statistic_time_played%
    %statistic_seconds_played_remaining%
    %statistic_minutes_played_remaining%
    %statistic_hours_played_remaining%
    %statistic_days_played_remaining%
    %statistic_animals_bred%
    %statistic_armor_cleaned%
    %statistic_banner_cleaned%
    %statistic_beacon_interacted%
    %statistic_boat_one_cm%
    %statistic_brewingstand_interaction%
    %statistic_cake_slices_eaten%
    %statistic_cauldron_filled%
    %statistic_cauldron_used%
    %statistic_chest_opened%
    %statistic_climb_one_cm%
    %statistic_crafting_table_interaction%
    %statistic_crouch_one_cm%
    %statistic_damage_dealt%
    %statistic_damage_taken%
    %statistic_deaths%
    %statistic_dispenser_inspected%
    %statistic_dive_one_cm%
    %statistic_drop%
    %statistic_dropper_inspected%
    %statistic_enderchest_opened%
    %statistic_fall_one_cm%
    %statistic_fish_caught%
    %statistic_flower_potted%
    %statistic_fly_one_cm%
    %statistic_furnace_interaction%
    %statistic_hopper_inspected%
    %statistic_horse_one_cm%
    %statistic_item_enchanted%
    %statistic_jump%
    %statistic_junk_fished%
    %statistic_leave_game%
    %statistic_join_game%
    %statistic_minecart_one_cm%
    %statistic_noteblock_played%
    %statistic_noteblock_tuned%
    %statistic_pig_one_cm%
    %statistic_player_kills%
    %statistic_record_played%
    %statistic_sprint_one_cm%
    %statistic_swim_one_cm%
    %statistic_talked_to_villager%
    %statistic_time_since_death%
    %statistic_ticks_since_death%
    %statistic_seconds_since_death%
    %statistic_minutes_since_death%
    %statistic_hours_since_death%
    %statistic_days_since_death%
    %statistic_traded_with_villager%
    %statistic_trapped_chest_triggered%
    %statistic_walk_one_cm%
    %statistic_sleep_in_bed%
    %statistic_sneak_time%
    %statistic_aviate_one_cm%


    TrueFalse placeholders(top)

    Expansion download command: /papi ecloud download TrueFalse

    %truefalse_true%
    %truefalse_false%


    MVdW placeholders(top)

    (Requires MVdWPlaceholderAPI and one of Maxims placeholder plugins)
    Expansion download command: /papi ecloud download MVdW

    %mvdw_<placeholder without brackets>%
    A list of his placeholders can be found here


    Plugin placeholders(top)

    Expansion download command: /papi ecloud download Plugin

    %plugin_isenabled_<plugin name>%
    %plugin_isdisabled_<plugin name>%
    %plugin_exists_<plugin name>%

    Plugins placeholders(top)


    These placeholders require a certain plugin be on your server to work

    There are too many placeholders to fit on one wiki page!

    Click a page below view placeholders for plugins:

    Next page:(top)

    [​IMG]
    Note: plugin placeholders are not listed in any specific order at the moment. I tried to keep it in alphabetical order at first but that failed by the time page 1 was full. Feel free to organize if you wish, just do not remove any placeholders accidentally!
  • Loading...
  • Loading...