com.comphenix.xp

Class Configuration

java.lang.Object

com.comphenix.xp.Configuration

All Implemented Interfaces:

PlayerCleanupListener, Multipliable<Configuration>

public class Configuration
extends java.lang.Object
implements PlayerCleanupListener, Multipliable<Configuration>

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAXIMUM_BOOKCASE_COUNT
static int	DEFAULT_MAXIMUM_ENCHANT_LEVEL
static int	DEFAULT_MESSAGE_RATE
static double	DEFAULT_SCAN_RADIUS
static int	MAXIMUM_BOOKCASE_COUNT

Constructor Summary

Constructors

Constructor and Description
Configuration(Configuration other, double newMultiplier)
Configuration(Debugger debugger, ActionTypes actionTypes)
Configuration(Debugger debugger, RewardProvider provider, ChannelProvider channels)

Method Summary

Methods

Modifier and Type	Method and Description
static Configuration	fromMultiple(java.util.List<Configuration> configurations, Debugger debugger) Merge a list of configurations into a new configuration.
ActionParser	getActionParser()
ItemTree	getActionReward(java.lang.Integer actionID) Retrieves the rewards for the given action or trigger.
ItemTree	getActionReward(java.lang.String action) Retrieves the rewards for the given action or trigger.
java.util.Collection<Action>	getActions()
ActionTypes	getActionTypes() Retrieves the current registered action types.
ChannelProvider	getChannelProvider()
PotionTree	getComplexBrewingReward()
PotionTree	getComplexReward(java.lang.Integer actionID) Retrieves the complex potion rewards for the given action or trigger.
PotionTree	getComplexReward(java.lang.String action) Retrieves the complex potion rewards for the given action or trigger.
java.lang.String	getDefaultRewardName()
org.bukkit.inventory.ItemStack	getEconomyDropItem()
java.lang.Integer	getEconomyItemWorth()
MobTree	getExperienceDrop()
GlobalSettings	getGlobalSettings()
ItemParser	getItemParser()
LevelingRate	getLevelingRate() Overrides the rate at which players gain levels.
int	getMaximumBookcaseCount()
int	getMaximumEnchantLevel()
MessagePlayerQueue	getMessageQueue()
MobParser	getMobParser()
double	getMultiplier()
PlayerRewards	getPlayerRewards()
RewardProvider	getRewardProvider()
double	getScanRadiusSetting()
ItemTree	getSimpleBlockReward()
ItemTree	getSimpleBonusReward()
ItemTree	getSimpleBrewingReward()
ItemTree	getSimpleCraftingReward()
ItemTree	getSimplePlacingReward()
ItemTree	getSimpleSmeltingReward()
boolean	hasPreset() Whether or not this configuration is associated with a specified preset.
boolean	isDefaultRewardsDisabled()
void	loadFromConfig(org.bukkit.configuration.ConfigurationSection config) Initialize configuration from a configuration section.
void	onTick()
void	removePlayerCache(org.bukkit.entity.Player player) Removes a given player from being referenced by any preset node.
void	setActionParser(ActionParser actionParser)
ItemTree	setActionReward(java.lang.Integer actionID, ItemTree tree) Sets the tree of rewards for a given action.
void	setActionTypes(ActionTypes actionTypes) Sets the current registry of action types.
PotionTree	setComplexReward(java.lang.Integer actionID, PotionTree tree) Sets the tree of rewards for a given action.
void	setDefaultRewardName(java.lang.String rewardName)
void	setGlobalSettings(GlobalSettings globalSettings)
void	setItemParser(ItemParser itemParser)
void	setMobParser(MobParser mobParser)
void	setPreset(boolean value) Whether or not this configuration is associated with a specified preset.
void	setRewardManager(RewardProvider rewardProvider)
Configuration	withMultiplier(double newMultiplier) Returns a shallow copy of this object with a different experience multiplier.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SCAN_RADIUS

public static final double DEFAULT_SCAN_RADIUS

See Also:

Constant Field Values

DEFAULT_MESSAGE_RATE

public static final int DEFAULT_MESSAGE_RATE

See Also:

Constant Field Values

DEFAULT_MAXIMUM_ENCHANT_LEVEL

public static final int DEFAULT_MAXIMUM_ENCHANT_LEVEL

See Also:

Constant Field Values

DEFAULT_MAXIMUM_BOOKCASE_COUNT

public static final int DEFAULT_MAXIMUM_BOOKCASE_COUNT

See Also:

Constant Field Values

MAXIMUM_BOOKCASE_COUNT

public static final int MAXIMUM_BOOKCASE_COUNT

See Also:

Constant Field Values

Constructor Detail

Configuration

public Configuration(Debugger debugger,
             ActionTypes actionTypes)

Configuration

public Configuration(Configuration other,
             double newMultiplier)

Configuration

public Configuration(Debugger debugger,
             RewardProvider provider,
             ChannelProvider channels)

Method Detail

fromMultiple

public static Configuration fromMultiple(java.util.List<Configuration> configurations,
                         Debugger debugger)

Merge a list of configurations into a new configuration.

Parameters:

configurations - - list of configurations.

debugger - - debugger instance.

Returns:

Merged configuration.

loadFromConfig

public void loadFromConfig(org.bukkit.configuration.ConfigurationSection config)

Initialize configuration from a configuration section.

Parameters:

config - - configuration section to load from.

getActions

public java.util.Collection<Action> getActions()

hasPreset

public boolean hasPreset()

Whether or not this configuration is associated with a specified preset.

Returns:

TRUE if it is, FALSE otherwise.

setPreset

public void setPreset(boolean value)

Whether or not this configuration is associated with a specified preset.

Parameters:

value - - new value.

getGlobalSettings

public GlobalSettings getGlobalSettings()

setGlobalSettings

public void setGlobalSettings(GlobalSettings globalSettings)

getLevelingRate

public LevelingRate getLevelingRate()

Overrides the rate at which players gain levels.

Returns:

Custom rules for how much experience a player needs to level up.

withMultiplier

public Configuration withMultiplier(double newMultiplier)

Description copied from interface: Multipliable

Returns a shallow copy of this object with a different experience multiplier.

Specified by:

withMultiplier in interface Multipliable<Configuration>

Parameters:

newMultiplier - - New multiplier value.

Returns:

Shallow copy of this object.

getMultiplier

public double getMultiplier()

Specified by:

getMultiplier in interface Multipliable<Configuration>

getExperienceDrop

public MobTree getExperienceDrop()

getActionReward

public ItemTree getActionReward(java.lang.Integer actionID)

Retrieves the rewards for the given action or trigger.

Parameters:

actionID - - unique ID for the given action.

Returns:

Tree of every associated reward.

getActionReward

public ItemTree getActionReward(java.lang.String action)

Retrieves the rewards for the given action or trigger.

Parameters:

action - - name for the given action.

Returns:

Tree of every associated reward.

setActionReward

public ItemTree setActionReward(java.lang.Integer actionID,
                       ItemTree tree)

Sets the tree of rewards for a given action.

Parameters:

actionID - - unique ID for the given action.

Returns:

Previously associated tree of rewards, or NULL if no tree was associated.

getComplexReward

public PotionTree getComplexReward(java.lang.Integer actionID)

Retrieves the complex potion rewards for the given action or trigger.

Parameters:

actionID - - unique ID for the given action.

Returns:

Tree of every associated reward.

getComplexReward

public PotionTree getComplexReward(java.lang.String action)

Retrieves the complex potion rewards for the given action or trigger.

Parameters:

action - - name for the given action.

Returns:

Tree of every associated reward.

setComplexReward

public PotionTree setComplexReward(java.lang.Integer actionID,
                          PotionTree tree)

Sets the tree of rewards for a given action.

Parameters:

actionID - - unique ID for the given action.

Returns:

Previously associated tree of rewards, or NULL if no tree was associated.

isDefaultRewardsDisabled

public boolean isDefaultRewardsDisabled()

getMaximumEnchantLevel

public int getMaximumEnchantLevel()

getMaximumBookcaseCount

public int getMaximumBookcaseCount()

getPlayerRewards

public PlayerRewards getPlayerRewards()

getRewardProvider

public RewardProvider getRewardProvider()

getChannelProvider

public ChannelProvider getChannelProvider()

setRewardManager

public void setRewardManager(RewardProvider rewardProvider)

getMessageQueue

public MessagePlayerQueue getMessageQueue()

getEconomyDropItem

public org.bukkit.inventory.ItemStack getEconomyDropItem()

getEconomyItemWorth

public java.lang.Integer getEconomyItemWorth()

getDefaultRewardName

public java.lang.String getDefaultRewardName()

setDefaultRewardName

public void setDefaultRewardName(java.lang.String rewardName)

getSimpleBlockReward

public ItemTree getSimpleBlockReward()

getSimpleBonusReward

public ItemTree getSimpleBonusReward()

getSimpleBrewingReward

public ItemTree getSimpleBrewingReward()

getSimpleCraftingReward

public ItemTree getSimpleCraftingReward()

getSimplePlacingReward

public ItemTree getSimplePlacingReward()

getSimpleSmeltingReward

public ItemTree getSimpleSmeltingReward()

getComplexBrewingReward

public PotionTree getComplexBrewingReward()

getScanRadiusSetting

public double getScanRadiusSetting()

getActionTypes

public ActionTypes getActionTypes()

Retrieves the current registered action types.

Returns:

Registry of action types.

setActionTypes

public void setActionTypes(ActionTypes actionTypes)

Sets the current registry of action types. This must be changed before configurations are loaded.

Parameters:

actionTypes - - new action type registry.

getItemParser

public ItemParser getItemParser()

setItemParser

public void setItemParser(ItemParser itemParser)

getMobParser

public MobParser getMobParser()

setMobParser

public void setMobParser(MobParser mobParser)

getActionParser

public ActionParser getActionParser()

setActionParser

public void setActionParser(ActionParser actionParser)

onTick

public void onTick()

removePlayerCache

public void removePlayerCache(org.bukkit.entity.Player player)

Description copied from interface: PlayerCleanupListener

Removes a given player from being referenced by any preset node. Must be called when a player logs out.

Specified by:

removePlayerCache in interface PlayerCleanupListener

Parameters:

player - - player to remove.