Hook into PlaceholderAPI
Important
The Wiki has been moved! You can now find it here: https://wiki.placeholderapi.com
This particulare page can be found here: https://wiki.placeholderapi.com/developers/using-placeholderapi/
The GitHub release may be different from the spigot release
This page is about using PlaceholderAPI in your own plugin, to either let other plugins use your plugin, or just use placeholders from other plugins in your own.
Please note, that the examples in this page are only available for PlaceholderAPI 2.10.0 or higher!
Before you can actually make use of PlaceholderAPI, you first have to import it into your project.
To import PlaceholderAPI, simply add the following code to your pom.xml
Replace {VERSION}
with the version listed at the top of this page.
<repositories>
<repository>
<id>placeholderapi</id>
<url>https://repo.extendedclip.com/content/repositories/placeholderapi/</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>me.clip</groupId>
<artifactId>placeholderapi</artifactId>
<version>{VERSION}</version>
<scope>provided</scope>
</dependency>
</dependencies>
Here is how you can import PlaceholderAPI through gradle.
Put this into your Gradle.build.
Replace {VERSION}
with the version listed at the top of this page.
repositories {
maven {
url = 'https://repo.extendedclip.com/content/repositories/placeholderapi/'
}
}
dependencies {
compileOnly 'me.clip:placeholderapi:{VERSION}'
}
Next step is to go to your plugin.yml or paper-plugin.yml and add PlaceholderAPI as a depend or softdepend, depending (no pun intended) on if it is optional or not.
Example Softdepend:
-
plugin.yml
name: ExamplePlugin version: 1.0 author: author main: your.main.path.Here # This sets PlaceholderAPI as an optional dependency for your plugin. softdepend: [PlaceholderAPI]
-
paper-plugin.yml
name: ExamplePlugin version: 1.0 author: author main: your.main.path.Here dependencies: server: PlaceholderAPI: # Load order is relative to the dependency. So here PlaceholderAPI loads before our plugin. load: BEFORE required: false
Example Depend:
-
plugin.yml
name: ExamplePlugin version: 1.0 author: author main: your.main.path.Here # This sets PlaceholderAPI as a dependency for your plugin. depend: [PlaceholderAPI]
-
paper-plugin.yml
name: ExamplePlugin version: 1.0 author: author main: your.main.path.Here dependencies: server: PlaceholderAPI: # Load order is relative to the dependency. So here PlaceholderAPI loads before our plugin. load: BEFORE required: true
A full guide on how to create expansions can be found on the PlaceholderExpansion page of this wiki.
PlaceholderAPI offers the ability, to automatically parse placeholders from other plugins within your own plugin, giving the ability for your plugin to support thousands of other placeholders without depending on each plugin individually.
To use placeholders from other plugins in our own plugin, we simply have to (soft)depend on PlaceholderAPI and use the setPlaceholders
method.
It is also important to point out, that any required plugin/dependency for an expansion has to be on the server and enabled, or the setPlaceholders
method will just return the placeholder itself (do nothing).
Example:
Let's assume we want to send an own join message that shows the group a player has.
To achieve that, we can do the following:
package at.helpch.placeholderapi;
import me.clip.placeholderapi.PlaceholderAPI;
import org.bukkit.Bukkit;
import org.bukkit.event.EventHandler;
import org.bukkit.event.EventPriority;
import org.bukkit.event.Listener;
import org.bukkit.event.player.PlayerJoinEvent;
import org.bukkit.plugin.java.JavaPlugin;
import me.clip.placeholderapi.PlaceholderAPI;
public class JoinExample extends JavaPlugin implements Listener {
@Override
public void onEnable() {
if (Bukkit.getPluginManager().getPlugin("PlaceholderAPI") != null) {
/*
* We register the EventListener here, when PlaceholderAPI is installed.
* Since all events are in the main class (this class), we simply use "this"
*/
Bukkit.getPluginManager().registerEvents(this, this);
} else {
/*
* We inform about the fact that PlaceholderAPI isn't installed and then
* disable this plugin to prevent issues.
*/
getLogger().warn("Could not find PlaceholderAPI! This plugin is required.");
Bukkit.getPluginManager().disablePlugin(this);
}
}
@EventHandler(priority = EventPriority.HIGHEST)
public void onJoin(PlayerJoinEvent event) {
String joinText = "%player_name% &ajoined the server! They are rank &f%vault_rank%";
/*
* We parse the placeholders using "setPlaceholders"
* This would turn %vault_rank% into the name of the Group, that the
* joining player has.
*/
joinText = PlaceholderAPI.setPlaceholders(event.getPlayer(), joinText);
event.setJoinMessage(joinText);
}
}
© 2015 - 2024 PlaceholderAPI Team
Thanks for using PlaceholderAPI.Plugin-page | Placeholders | Plugins using PlaceholderAPI | Hook into PlaceholderAPI