Placeholders - PMPlugins/Development GitHub Wiki

Placeholders

What is Placeholders? Placeholders is a plugin designed to help plugin developers and server owners, by taking the trouble out of coding placeholders. Placeholders currently has over 70 pre-coded placeholders, but if that's not enough for you, you can add your own, by adding code to the placeholders.php file!

Notes:
The placeholders are case-insensitive.
$gvars contains global placeholders (like server info, and top kills)
$svars contains personal placeholders (like IP, name, and money)

// Example placeholders

$svars["{example_placeholder}"] = "Example!";

// You can make a placeholder out of normal text if you want
// This will replace "this is just text" with "Another example!"

$gvars["this is just text"] = "Another example!"

Pre-coded placeholders

Single (personal) placeholders

  • {x} Player's X

  • {y} Player's Y

  • {z} Player's Z

  • {name} Player's name

  • {displayname} Player's displayname

  • {gamemode} Player's gamemode

  • {health} Player's health

  • {ip} Player's IP

  • {nametag} Player's nametag

  • {yaw} Player's yaw

  • {pitch} Player's pitch

  • {world} Player's world

  • {world_seed} Player's world's seed

  • {money} Player's money (Economy, GoldSTD, MassiveEconomy, or PocketMoney)

  • {group} Player's group (PurePerms)

  • {score} Player's score (KillRate)

Global (for everyone) placeholders

  • {difficulty} Server's difficulty

  • {motd} Server's MOTD

  • {tps} Server's ticks per second

  • {max_players} Server's max players

  • {server_ip} Server's IP

  • {player_count} Server's player count

  • {server_port} Server's port

  • {pm_version} PocketMine's version

  • {version} Server's version

  • {view_distance} Server's view distance

  • {default_gamemode} Server's default gamemode

  • {default_level} Server's default level

  • {default_level_seed} Server's default level's seed

  • {server_flight} Server's flight option

  • {codename} PocketMine's codename

  • {api_version} PocketMine's API version

  • {line} New line

  • {BLACK}

  • {DARK_BLUE}

  • {DARK_GREEN}

  • {DARK_AQUA}

  • {DARK_RED}

  • {DARK_PURPLE}

  • {GOLD}

  • {GRAY}

  • {DARK_GRAY}

  • {BLUE}

  • {GREEN}

  • {AQUA}

  • {RED}

  • {LIGHT_PURPLE}

  • {YELLOW}

  • {WHITE}

  • {OBFUSCATED}

  • {BOLD}

  • {STRIKETHROUGH}

  • {UNDERLINE}

  • {ITALIC}

  • {RESET}

  • {12hour_0} Current hour, 12 hour format, with leading zeros (Possible outcome: 02)

  • {24hour_0} Current hour, 24 hour format, with leading zeros (Possible outcome: 02)

  • {12hour} Current hour, 12 hour format (Possible outcome: 2)

  • {24hour} Current hour, 24 hour format (Possible outcome: 2)

  • {month_number} Month number (Possible outcome: 1)

  • {month_number_0} Month number with leading zeros (Possible outcome: 01)

  • {month_name_short} Short month name (Possible outcome: Jan)

  • {month_name} Month name (Possible outcome: January)

  • {year} Year (Possible outcome: 2015)

  • {year_short} Short year (Possible outcome: 15)

  • {minute} Current minute with leading zeros (Possible outcome: 05)

  • {second} Current second with leading zeros (Possible outcome: 05)

  • {day} Current day name (Possible outcome: Sunday)

  • {day_short} Current short day name (Possible outcome: Sun)

  • {day_number_0} Current day number with leading zeros (Possible outcome: 02)

  • {day_number} Current day number (Possible outcome: 2)

  • {time_unix} Current unix timestamp (Possible outcome: 1444733325)

  • {kr_top_name_NUMBER} Name of player with rank NUMBER (Possible outcome: jojoe77777)

  • {kr_top_score_NUMBER} Score of player with rank NUMBER (Possible outcome: 1500)

API usage example from another plugin

$manager = $this->getServer()->getPluginManager();
$msg = "Your ip is {ip}";
if(($placeholders = $manager->getPlugin("Placeholders")) !== null){
$msg = $placeholders->allPlaceholders($msg, $player);
/* Output: "Your ip is 192.168.0.18" (Player's IP) */
}