Placeholders
Last updated Jul 6, 2026
Placeholders
SoapsTeleporter registers a PlaceholderAPI expansion when PlaceholderAPI is installed.
- Identifier:
soapsteleporter - Prefix:
%soapsteleporter_...% - Registration: Automatic on plugin enable
- Persist: Yes (expansion stays registered across reloads)
Placeholders require an online player context. Console or offline requests return empty strings for player-specific values.
Portal Placeholders
| Placeholder | Returns |
|---|---|
%soapsteleporter_portals_count% |
Total portal count on the server |
%soapsteleporter_portals_connected% |
Number of connected portals |
%soapsteleporter_portals_nearest% |
Name of the nearest portal in the same world (None if none) |
%soapsteleporter_portals_nearest_distance% |
Distance to the nearest portal in blocks (one decimal) |
Nearest portal only considers portals in the player's current world.
Player Placeholders
| Placeholder | Returns |
|---|---|
%soapsteleporter_player_teleports% |
Total teleports by this player |
%soapsteleporter_player_portals_created% |
Portals created by this player |
%soapsteleporter_player_last_portal% |
Name of the last portal used (None if never) |
%soapsteleporter_player_cooldown% |
Remaining global cooldown in seconds (0 if none) |
Economy Placeholders
Requires Vault economy enabled in config.
| Placeholder | Returns |
|---|---|
%soapsteleporter_economy_balance% |
Player balance formatted to two decimals |
%soapsteleporter_economy_spent% |
Total money spent on portal fees |
If economy is disabled, these return Economy Disabled.
Stats Placeholders
| Placeholder | Returns |
|---|---|
%soapsteleporter_stats_server_teleports% |
Total teleports across all players |
%soapsteleporter_stats_most_used_portal% |
Name of the most-used portal (None if none) |
Usage Examples
Scoreboard line:
Nearest portal: %soapsteleporter_portals_nearest% (%soapsteleporter_portals_nearest_distance%m)
Chat format plugin:
Balance: $%soapsteleporter_economy_balance% | Teleports: %soapsteleporter_player_teleports%
Internal Parameter Format
The expansion parses parameters after the identifier using underscores:
| Root | Sub-parameters | Example |
|---|---|---|
portals |
count, connected, nearest, nearest_distance |
%soapsteleporter_portals_count% |
player |
teleports, portals_created, last_portal, cooldown |
%soapsteleporter_player_last_portal% |
economy |
balance, spent |
%soapsteleporter_economy_balance% |
stats |
server_teleports, most_used_portal |
%soapsteleporter_stats_server_teleports% |
Next Steps
- Integrations for Vault and PlaceholderAPI setup
- Economy for paid portals
- FAQ if placeholders show blank values