gyurix.api

Class VariableAPI

java.lang.Object

gyurix.api.VariableAPI

public class VariableAPI
extends java.lang.Object

VariableAPI - Used for advanced placeholder filling in Strings

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VariableAPI.VariableHandler Custom VariableHandlers should implement this interface and add themselves to the handlers map, for being used during the variable filling process

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.HashMap<java.lang.String,VariableAPI.VariableHandler>	handlers Available VariableHandlers
static boolean	phaHook Field for checking and setting the PlaceholderAPI hook status, true = hook enabled, false = hook disabled

Constructor Summary

Constructors

Constructor and Description
VariableAPI()

Method Summary

Modifier and Type	Method and Description
static java.util.ArrayList<java.lang.Object>	fill(java.lang.String msg, int from, org.bukkit.entity.Player plr, java.lang.Object[] extArgs) Fills variables in the given message from the given character recursively.
static java.lang.String	fillVariables(java.lang.String msg, org.bukkit.entity.Player plr, java.lang.Object... extArgs) Fills all the placeholders in the given message
static void	init() Initializes the VariableAPI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

handlers

public static final java.util.HashMap<java.lang.String,VariableAPI.VariableHandler> handlers

Available VariableHandlers

phaHook

public static boolean phaHook

Field for checking and setting the PlaceholderAPI hook status, true = hook enabled, false = hook disabled

Constructor Detail

VariableAPI

public VariableAPI()

Method Detail

fill

public static java.util.ArrayList<java.lang.Object> fill(java.lang.String msg,
                                                         int from,
                                                         org.bukkit.entity.Player plr,
                                                         java.lang.Object[] extArgs)

Fills variables in the given message from the given character recursively.

Parameters:

msg - - The message containing placeholders

from - - Index of character from which the variables should be filled

plr - - The Player whose data should be used in the message filling

extArgs - - External object arguments

Returns:

The first element is always the position of the last read character, the rest are the objects generated by the VariableHandlers for the placeholders found in the message

fillVariables

public static java.lang.String fillVariables(java.lang.String msg,
                                             org.bukkit.entity.Player plr,
                                             java.lang.Object... extArgs)

Fills all the placeholders in the given message

Parameters:

msg - - The variable fillable message

plr - - Player whose data should be used for variable filling

extArgs - - External arguments passed to the VariableHandlers

Returns:

The variable filled message

init

public static void init()

Initializes the VariableAPI. This method is coded for internal usage, it's only public for being callable from the plugins core