Skip to content
This repository has been archived by the owner on Jul 22, 2023. It is now read-only.

Placeholders

NotMyFault edited this page Jun 20, 2021 · 11 revisions

Overview

Placeholder systems allow you to display data from PlotSquared in other plugins and allow you to display data of other plugins in PlotSquared.

For example with FeatherBoard you can create a scoreboard (sideboard) with the info about the plot you're standing on. And with using of the PlaceholderAPI with /plot flag set greeting Welcome %player_name% you can send the message "Welcome Steve" when the player Steve enters a plot.

Setup

PlotSquared has explicit and official support for PlaceholderAPI and MVdWPlaceholderAPI.

Follow the instruction of these placeholder systems to install it correctly.

Warn: For the PlaceholderAPI placeholders of PlotSquared you don't need to download an PAPI expansion. As opposed to some other plugins, PlotSquared handles everything internally.

Placeholder Deactivation in PlotSquared

If you have already installed a placeholder system and down't wish to allow using of the placeholders in PlotSquared, you can deactivate it in the settings.yml:

  external-placeholders: false

Tips for specify plugins

Chat-System

If you're using EssentialsChat and PlaceholderAPI, you must install ChatInjector in order for the placeholders to show up in the chat. However, please note it has been reported that ChatInjector might cause issues.

We recommend you to use an alternative chat plugin which supports PlaceholderAPI, such as DeluxeChat.

PlotSquared placeholders

Tip: If you think a placeholder for PlotSquared should be added, then please check then please raise an an issue here.

Available placeholders in 6.0.0:

Placeholder Description
%plotsquared_currentplot_alias% Alias of the plot
%plotsquared_currentplot_owner% Owner of the plot
%plotsquared_currentplot_members% Amount of players added and trusted to the plot
%plotsquared_currentplot_members_added% Amount of players added to the plot
%plotsquared_currentplot_members_added_list% Display a list of added members
%plotsquared_currentplot_members_trusted% Amount of players trusted to the plot
%plotsquared_currentplot_members_trusted_list% Display a list of trusted members
%plotsquared_currentplot_members_denied% Amount of members denied from the plot
%plotsquared_currentplot_members_denied_list% Display a list of denied members
%plotsquared_currentplot_world_name% Get the world name
%plotsquared_currentplot_can_build% Displays true or false whether the player has build rights on the plot
%plotsquared_world_name% Get the name of the world
%plotsquared_has_plot% Displays true or false whether the player has plot
%plotsquared_has_plot_(world)% Displays true or false whether the player has plot in a specific world
%plotsquared_plot_count% Amount of global plots of a player
%plotsquared_plot_count_(World)% Amount of plots for a player in a specific world
%plotsquared_allowed_plot_count% Amount of maximum plots a player can have. Returns "infinite" if you have * permission
%plotsquared_currentplot_xy% Displays the X and Y ID of a plot
%plotsquared_currentplot_x% Displays the X ID of a plot
%plotsquared_currentplot_y% Displays the Y ID of a plot
%plotsquared_currentplot_rating% Displays the average rating of a plot
%plotsquared_currentplot_biome% Displays the biome of a plot
%plotsquared_currentplot_localflag_<flag>% Display the value of the flag set on current plot
%plotsquared_currentplot_flag_<flag>% Display the value of the flag set on current plot or if it's not set: display the inherited flag value (worlds.yml)
%plotsquared_currentplot_creationdate% Display the creation date of the plot

PlaceholderAPI placeholders

https://github.com/PlaceholderAPI/PlaceholderAPI/wiki/Placeholders

MVdWPlaceholderAPI placeholders

https://www.spigotmc.org/wiki/mvdw-placeholders