be.maximvdw.placeholderapi

Class PlaceholderAPI

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

be.maximvdw.placeholderapi.PlaceholderAPI

All Implemented Interfaces:

CommandExecutor, TabCompleter, TabExecutor, Plugin

public class PlaceholderAPI
extends JavaPlugin

MVdWPlaceholderAPI

Constructor Summary

Constructors

Constructor and Description
PlaceholderAPI()

Method Summary

Modifier and Type	Method and Description
void	addPlaceholderListener(PlaceholderAddedEvent handler) Add a placeholder listener
static int	getLoadedPlaceholderCount() Returns the amount of placeholders loaded into the memory
static void	initialize(PlaceholderAPI api)
void	onEnable()
boolean	registerMVdWPlugin(Plugin plugin, PlaceholderPlugin placeholderPlugin) Register an MVdW Plugin
static boolean	registerPlaceholder(Plugin plugin, java.lang.String placeholder, PlaceholderReplacer replacer) Register a custom placeholder
static boolean	registerPlaceholder(Plugin plugin, java.lang.String placeholder, PlaceholderReplacer replacer, PlaceholderOptions... options) Register a custom placeholder
static boolean	registerStaticPlaceholders(Plugin plugin, java.lang.String placeholder, java.lang.String value) Register a static custom placeholder
static java.lang.String	replacePlaceholders(OfflinePlayer offlinePlayer, java.lang.String input) Replace placeholders in input

Methods inherited from class org.bukkit.plugin.java.JavaPlugin

getClassLoader, getCommand, getConfig, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, isEnabled, isNaggable, onCommand, onDisable, onLoad, onTabComplete, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toString

Methods inherited from class org.bukkit.plugin.PluginBase

equals, getName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PlaceholderAPI

public PlaceholderAPI()

Method Detail

onEnable

public void onEnable()

Specified by:

onEnable in interface Plugin

Overrides:

onEnable in class JavaPlugin

initialize

public static void initialize(PlaceholderAPI api)

registerMVdWPlugin

public boolean registerMVdWPlugin(Plugin plugin,
                                  PlaceholderPlugin placeholderPlugin)

Register an MVdW Plugin

Parameters:

plugin - Plugin

placeholderPlugin - Placeholder plugin container

Returns:

success

replacePlaceholders

public static java.lang.String replacePlaceholders(OfflinePlayer offlinePlayer,
                                                   java.lang.String input)

Replace placeholders in input

Parameters:

offlinePlayer - Player to replace placeholders for

input - Placeholder format {placeholder}

Returns:

Return result with replaced placeholders

getLoadedPlaceholderCount

public static int getLoadedPlaceholderCount()

Returns the amount of placeholders loaded into the memory

Returns:

Placeholder count

registerPlaceholder

public static boolean registerPlaceholder(Plugin plugin,
                                          java.lang.String placeholder,
                                          PlaceholderReplacer replacer)

Register a custom placeholder

Parameters:

plugin - Plugin that is registering the placeholder

placeholder - Placeholder to be registered WITHOUT { }

Returns:

Returns if the placeholder is added or not

registerPlaceholder

public static boolean registerPlaceholder(Plugin plugin,
                                          java.lang.String placeholder,
                                          PlaceholderReplacer replacer,
                                          PlaceholderOptions... options)

Register a custom placeholder

Parameters:

plugin - Plugin that is registering the placeholder

placeholder - Placeholder to be registered WITHOUT { }

Returns:

Returns if the placeholder is added or not

registerStaticPlaceholders

public static boolean registerStaticPlaceholders(Plugin plugin,
                                                 java.lang.String placeholder,
                                                 java.lang.String value)

Register a static custom placeholder

Parameters:

plugin - Plugin that is registering the placeholder

placeholder - Placeholder to be registered WITHOUT { }

value - Placeholder value

Returns:

Returns if the placeholder is added or not

addPlaceholderListener

public void addPlaceholderListener(PlaceholderAddedEvent handler)

Add a placeholder listener

Parameters:

handler - placeholder added handler