com.comphenix.xp

Class Action

java.lang.Object

com.comphenix.xp.Action

public class Action
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static Action	Default

Constructor Summary

Constructors

Constructor and Description
Action()
Action(java.lang.String rewardType, ResourceFactory reward)

Method Summary

Methods

Modifier and Type	Method and Description
void	addReward(java.lang.String rewardType, ResourceFactory factory) Adds the given reward to the action that will be triggered.
void	announceMessages(ChannelProvider provider, MessageFormatter formatter) Sends a general message informing anyone listening of the resources awarded.
boolean	canRewardPlayer(RewardProvider provider, org.bukkit.entity.Player player, java.util.List<ResourceHolder> generatedRewards) Determines whether or not a player can be rewarded (or penalized) with the given list of rewards.
void	emoteMessages(ChannelProvider provider, MessageFormatter formatter, org.bukkit.entity.Player player) Sends a message from the given player informing anyone listening of the action performed and the resources awarded.
boolean	equals(java.lang.Object obj)
java.util.List<ResourceHolder>	generateRewards(RewardProvider provider, java.util.Random rnd) Generates a list of resources, in the same order as each associated reward factory.
java.util.List<ResourceHolder>	generateRewards(RewardProvider provider, java.util.Random rnd, int count) Generates a list of resources, in the same order as each associated reward factory.
Debugger	getDebugger()
int	getId()
Message	getMessage()
ResourceFactory	getReward(RewardTypes type) Retrieves a associated reward by type.
ResourceFactory	getReward(java.lang.String name) Retrieves a associated reward by name.
java.util.Collection<java.lang.String>	getRewardNames() Retrieves a list of the name of every reward.
int	hashCode()
Action	multiply(double multiply)
void	removeAll() Removes all associated rewards.
void	removeReward(java.lang.String rewardType) Remove a reward by name.
java.util.Collection<ResourceHolder>	rewardAnyone(RewardProvider provider, org.bukkit.World world, java.util.List<ResourceHolder> generatedRewards, org.bukkit.Location point) Spawns resources at the given location.
java.util.Collection<ResourceHolder>	rewardPlayer(RewardProvider provider, org.bukkit.entity.Player player, java.util.List<ResourceHolder> generatedRewards) Rewards or penalizes a player with the given amount of resources.
java.util.Collection<ResourceHolder>	rewardPlayer(RewardProvider provider, org.bukkit.entity.Player player, java.util.List<ResourceHolder> generatedRewards, org.bukkit.Location point) Rewards or penalizes a given player with resources at a given location.
void	setDebugger(Debugger debugger)
void	setId(int id)
void	setMessage(Message message)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

Default

public static final Action Default

Constructor Detail

Action

public Action()

Action

public Action(java.lang.String rewardType,
      ResourceFactory reward)

Method Detail

addReward

public void addReward(java.lang.String rewardType,
             ResourceFactory factory)

Adds the given reward to the action that will be triggered.

Parameters:

rewardType - - name of the reward.

factory - - factory that generates the rewards when they are needed.

removeReward

public void removeReward(java.lang.String rewardType)

Remove a reward by name.

Parameters:

rewardType - - name of the reward to remove.

getReward

public ResourceFactory getReward(java.lang.String name)

Retrieves a associated reward by name.

Parameters:

name - - name of the reward to retrieve.

Returns:

Factory that generates rewards of this type.

getReward

public ResourceFactory getReward(RewardTypes type)

Retrieves a associated reward by type.

Parameters:

type - - type of the reward to retrieve.

Returns:

Factory that generates rewards of this type.

getRewardNames

public java.util.Collection<java.lang.String> getRewardNames()

Retrieves a list of the name of every reward.

Returns:

Names of every reward.

removeAll

public void removeAll()

Removes all associated rewards.

generateRewards

public java.util.List<ResourceHolder> generateRewards(RewardProvider provider,
                                             java.util.Random rnd)

Generates a list of resources, in the same order as each associated reward factory.

Parameters:

provider - - provider of reward services.

rnd - - random number generator.

Returns:

A list of resources in a specific order.

generateRewards

public java.util.List<ResourceHolder> generateRewards(RewardProvider provider,
                                             java.util.Random rnd,
                                             int count)

Generates a list of resources, in the same order as each associated reward factory.

Parameters:

provider - - provider of reward services.

rnd - - random number generator.

count - - number of times to reward this action.

Returns:

A list of resources in a specific order.

canRewardPlayer

public boolean canRewardPlayer(RewardProvider provider,
                      org.bukkit.entity.Player player,
                      java.util.List<ResourceHolder> generatedRewards)

Determines whether or not a player can be rewarded (or penalized) with the given list of rewards.

Parameters:

provider - - reward provider.

player - - the player to test.

generatedRewards - - the list of rewards to use.

Returns:

TRUE if the action can be rewarded with this list, FALSE otherwise.

rewardPlayer

public java.util.Collection<ResourceHolder> rewardPlayer(RewardProvider provider,
                                                org.bukkit.entity.Player player,
                                                java.util.List<ResourceHolder> generatedRewards)

Rewards or penalizes a player with the given amount of resources.

In the resulting list the resources will be arbitrarily ordered, and resources of the same type will be combined into one.

Parameters:

provider - - reward provider that determines specifically how to reward players.

player - - the player to reward.

generatedRewards - - the list of rewards to use.

Returns:

Combined amount of resources given.

rewardPlayer

public java.util.Collection<ResourceHolder> rewardPlayer(RewardProvider provider,
                                                org.bukkit.entity.Player player,
                                                java.util.List<ResourceHolder> generatedRewards,
                                                org.bukkit.Location point)

Rewards or penalizes a given player with resources at a given location.

In the resulting list the resources will be arbitrarily ordered, and resources of the same type will be combined into one.

Parameters:

provider - - reward provider that determines specifically how to reward players.

player - - the player to reward.

generatedRewards - - the list of rewards to use.

point - - the location to place the reward, if relevant.

Returns:

Combined amount of resources given.

rewardAnyone

public java.util.Collection<ResourceHolder> rewardAnyone(RewardProvider provider,
                                                org.bukkit.World world,
                                                java.util.List<ResourceHolder> generatedRewards,
                                                org.bukkit.Location point)

Spawns resources at the given location. In the resulting list the resources will be arbitrarily ordered, and resources of the same type will be combined into one.

Parameters:

provider - - reward provider that determines specifically how to award resources.

world - - the world where the resources should be spawned.

generatedRewards - - the list of rewards to use.

point - - the location to place the reward.

Returns:

Combined amount of resources given.

emoteMessages

public void emoteMessages(ChannelProvider provider,
                 MessageFormatter formatter,
                 org.bukkit.entity.Player player)

Sends a message from the given player informing anyone listening of the action performed and the resources awarded.

Parameters:

provider - - channel provider to use.

formatter - - message formatter, complete with all the parameter information.

player - - the sender.

announceMessages

public void announceMessages(ChannelProvider provider,
                    MessageFormatter formatter)

Sends a general message informing anyone listening of the resources awarded.

Parameters:

provider - - channel provider to use.

formatter - - message formatter, complete with all the parameter information.

getMessage

public Message getMessage()

setMessage

public void setMessage(Message message)

getId

public int getId()

setId

public void setId(int id)

multiply

public Action multiply(double multiply)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDebugger

public Debugger getDebugger()

setDebugger

public void setDebugger(Debugger debugger)