com.comphenix.xp

Class ExperienceMod

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

com.comphenix.xp.ExperienceMod

All Implemented Interfaces:

Debugger, org.bukkit.command.CommandExecutor, org.bukkit.plugin.Plugin

public class ExperienceMod
extends org.bukkit.plugin.java.JavaPlugin
implements Debugger

Constructor Summary

Constructors

Constructor and Description
ExperienceMod()

Method Summary

Methods

Modifier and Type	Method and Description
ActionTypes	getActionTypes() Retrieves the current registered action types.
AutoUpdate	getAutoUpdate() Retrieves the object responsible for notifying of new updates.
ChannelProvider	getChannelProvider()
net.milkbowl.vault.chat.Chat	getChat()
ConfigurationLoader	getConfigLoader() Retrieves the object responsible for parsing and loading configuration files.
CustomBlockProviders	getCustomBlockProvider()
DataCollector	getDataCollector()
net.milkbowl.vault.economy.Economy	getEconomy()
GlobalSettings	getGlobalSettings() Retrieves the global plugin settings.
HistoryProviders	getHistoryProviders() Gets the registry of history plugins.
ExperienceInformerListener	getInformer()
ItemRewardListener	getItemListener()
java.util.List<Action>	getMobReward(org.bukkit.entity.Player killer, MobQuery query) Retrieves a list of action rewards that applies when a mob is killed, either by the environment (when KILLER is NULL), or by a player.
java.util.List<Action>	getPlayerReward(org.bukkit.entity.Player player, java.lang.Integer trigger, Query query) Retrieves a list of action rewards that applies when a player performs a given action to the item or block specified by the query.
PlayerScheduler	getPlayerScheduler()
Presets	getPresets()
RewardProvider	getRewardProvider()
boolean	isDebugEnabled() Whether or not a debug mode is enabled.
org.bukkit.configuration.file.YamlConfiguration	loadConfig(java.lang.String name, java.lang.String createMessage)
void	loadDefaults(boolean reload) Reloads (if reload is TRUE) configurations.
void	onDisable()
void	onEnable()
void	onLoad()
void	onServerTick() Invoked every server tick.
void	printDebug(java.lang.Object sender, java.lang.String message, java.lang.Object... params) Prints or logs a debug message.
void	printWarning(java.lang.Object sender, java.lang.String message, java.lang.Object... params) Prints or logs a warning.
void	processInventoryClick(org.bukkit.event.inventory.InventoryClickEvent event, BlockResponse response) Handles the given inventory event using the default behavior for the given inventory type.
void	respond(org.bukkit.command.CommandSender sender, java.lang.String message)
void	setConfigLoader(ConfigurationLoader configLoader) Sets the object responsible for parsing and loading configuration files.
void	setHistoryProviders(HistoryProviders historyProviders) Sets the registry of history plugins.
void	toggleDebug() Toggles debug messages.

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

getClassLoader, getCommand, getConfig, getDatabase, getDatabaseClasses, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPluginLoader, getResource, getServer, initialize, installDDL, isEnabled, isInitialized, isNaggable, onCommand, reloadConfig, removeDDL, 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

ExperienceMod

public ExperienceMod()

Method Detail

onLoad

public void onLoad()

Specified by:

onLoad in interface org.bukkit.plugin.Plugin

Overrides:

onLoad in class org.bukkit.plugin.java.JavaPlugin

onEnable

public void onEnable()

Specified by:

onEnable in interface org.bukkit.plugin.Plugin

Overrides:

onEnable in class org.bukkit.plugin.java.JavaPlugin

onDisable

public void onDisable()

Specified by:

onDisable in interface org.bukkit.plugin.Plugin

Overrides:

onDisable in class org.bukkit.plugin.java.JavaPlugin

loadConfig

public org.bukkit.configuration.file.YamlConfiguration loadConfig(java.lang.String name,
                                                         java.lang.String createMessage)
                                                           throws java.io.IOException

Throws:

java.io.IOException

loadDefaults

public void loadDefaults(boolean reload)
                  throws java.io.IOException

Reloads (if reload is TRUE) configurations. There's no need to call this after adding reward providers.

Parameters:

reload - - if TRUE; reload configuration.

Throws:

java.io.IOException - An I/O error occurred.

onServerTick

public void onServerTick()

Invoked every server tick.

isDebugEnabled

public boolean isDebugEnabled()

Description copied from interface: Debugger

Whether or not a debug mode is enabled.

Specified by:

isDebugEnabled in interface Debugger

Returns:

TRUE if debug mode is enabled, FALSE otherwise.

toggleDebug

public void toggleDebug()

Toggles debug messages.

getChat

public net.milkbowl.vault.chat.Chat getChat()

getEconomy

public net.milkbowl.vault.economy.Economy getEconomy()

getInformer

public ExperienceInformerListener getInformer()

getRewardProvider

public RewardProvider getRewardProvider()

getChannelProvider

public ChannelProvider getChannelProvider()

getCustomBlockProvider

public CustomBlockProviders getCustomBlockProvider()

getConfigLoader

public ConfigurationLoader getConfigLoader()

Retrieves the object responsible for parsing and loading configuration files.

Returns:

The current configuration loader.

setConfigLoader

public void setConfigLoader(ConfigurationLoader configLoader)

Sets the object responsible for parsing and loading configuration files.

Parameters:

configLoader - - the new configuration loader.

getHistoryProviders

public HistoryProviders getHistoryProviders()

Gets the registry of history plugins.

Returns:

Registry of history plugins.

setHistoryProviders

public void setHistoryProviders(HistoryProviders historyProviders)

Sets the registry of history plugins.

Parameters:

historyProviders - - new registry of history plugins.

getItemListener

public ItemRewardListener getItemListener()

getPresets

public Presets getPresets()

getPlayerScheduler

public PlayerScheduler getPlayerScheduler()

getGlobalSettings

public GlobalSettings getGlobalSettings()

Retrieves the global plugin settings.

Returns:

Global settings.

getActionTypes

public ActionTypes getActionTypes()

Retrieves the current registered action types.

Returns:

Registry of action types.

getDataCollector

public DataCollector getDataCollector()

getAutoUpdate

public AutoUpdate getAutoUpdate()

Retrieves the object responsible for notifying of new updates.

Returns:

The object keeping track of new updates on BukkitDev.

getMobReward

public java.util.List<Action> getMobReward(org.bukkit.entity.Player killer,
                                  MobQuery query)
                                    throws ParsingException

Retrieves a list of action rewards that applies when a mob is killed, either by the environment (when KILLER is NULL), or by a player.

Note that the returned list contains every possible reward that matches the given mob. In reality, only the first item will be awarded.

Parameters:

killer - - the player that killed this mob, or NULL if the mob died naturally.

query - - query representing the mob that was killed.

Returns:

A list of possible rewards. Only the first item will be chosen when rewards are actually awarded.

Throws:

ParsingException - If the stored preset option associated with the killer is malformed.

getPlayerReward

public java.util.List<Action> getPlayerReward(org.bukkit.entity.Player player,
                                     java.lang.Integer trigger,
                                     Query query)
                                       throws ParsingException

Retrieves a list of action rewards that applies when a player performs a given action to the item or block specified by the query.

The query must be a ItemQuery for every trigger except brewing, where it also can be a PotionQuery.

Also note that this list contains every possible reward that matches the given parameters. In reality, only the first item will be awarded.

Parameters:

player - - player performing the given action, or NULL if the default configuration file should be used.

trigger - - action the player performs.

query - - query representing the item or block that was the target of the action.

Returns:

A list of possible rewards. Only the first item will be chosen when rewards are actually awarded.

Throws:

ParsingException - If the stored preset option associated with this player is malformed.

processInventoryClick

public void processInventoryClick(org.bukkit.event.inventory.InventoryClickEvent event,
                         BlockResponse response)

Handles the given inventory event using the default behavior for the given inventory type.

Parameters:

event - - inventory click event.

response - - block response detailing how to process the inventory.

printDebug

public void printDebug(java.lang.Object sender,
              java.lang.String message,
              java.lang.Object... params)

Description copied from interface: Debugger

Prints or logs a debug message.

Specified by:

printDebug in interface Debugger

Parameters:

sender - - the object that sent this message.

message - - the format of the debug message to send.

params - - the parameters to include in the debug message.

respond

public void respond(org.bukkit.command.CommandSender sender,
           java.lang.String message)

printWarning

public void printWarning(java.lang.Object sender,
                java.lang.String message,
                java.lang.Object... params)

Description copied from interface: Debugger

Prints or logs a warning.

Specified by:

printWarning in interface Debugger

Parameters:

sender - - the object that sent this message.

message - - the format of the warning message to send.

params - - the parameters to include in the warning message.