com.comphenix.xp.rewards.xp

Class RewardVirtual

java.lang.Object

com.comphenix.xp.rewards.xp.RewardVirtual

All Implemented Interfaces:

Service, RewardService

public class RewardVirtual
extends java.lang.Object
implements RewardService

Rewards players with experience directly by simply adding the experience to their experience bar.

Author:

Kristian

Constructor Summary

Constructors

Constructor and Description
RewardVirtual()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canReward(org.bukkit.entity.Player player, ResourceHolder resource) Whether or not the player actually can be rewarded (or penalized, if negative) with the given amount of resources.
RewardService	clone(Configuration config) Clones this object with the settings from the given configuration.
LevelingRate	getLevelingRate()
ResourcesParser	getResourcesParser() Retrieves the standard or custom resource parser associated with this reward.
RewardTypes	getRewardType() Retrieves the reward type.
double	getSearchRadius()
java.lang.String	getServiceName() Retrieves a unique string identifying this service.
void	reward(org.bukkit.entity.Player player, org.bukkit.Location point, ResourceHolder resource) Rewards a player with the given amount of resources.
void	reward(org.bukkit.entity.Player player, ResourceHolder resource) Rewards a player directly.
void	reward(org.bukkit.World world, org.bukkit.Location point, ResourceHolder resource) Creates a reward at a given location through any means necessary.
void	setLevelingRate(LevelingRate levelingRate)
void	setSearchRadius(double searchRadius)

Methods inherited from class java.lang.Object

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

Constructor Detail

RewardVirtual

public RewardVirtual()

Method Detail

reward

public void reward(org.bukkit.entity.Player player,
          ResourceHolder resource)

Description copied from interface: RewardService

Rewards a player directly.

Specified by:

reward in interface RewardService

Parameters:

player - - player to award.

resource - - the resource to give or take away.

canReward

public boolean canReward(org.bukkit.entity.Player player,
                ResourceHolder resource)

Description copied from interface: RewardService

Whether or not the player actually can be rewarded (or penalized, if negative) with the given amount of resources.

Specified by:

canReward in interface RewardService

Parameters:

player - - player to test.

resource - - the resource to give or take away.

reward

public void reward(org.bukkit.entity.Player player,
          org.bukkit.Location point,
          ResourceHolder resource)

Description copied from interface: RewardService

Rewards a player with the given amount of resources.

Specified by:

reward in interface RewardService

Parameters:

player - - player to award.

point - - if possible, the location the award will be placed.

resource - - the resource to give or take away.

reward

public void reward(org.bukkit.World world,
          org.bukkit.Location point,
          ResourceHolder resource)

Description copied from interface: RewardService

Creates a reward at a given location through any means necessary.

Specified by:

reward in interface RewardService

Parameters:

world - - the world to create this reward.

point - - where to put this reward.

resource - - the resource to give or take away.

getResourcesParser

public ResourcesParser getResourcesParser()

Description copied from interface: RewardService

Retrieves the standard or custom resource parser associated with this reward.

Specified by:

getResourcesParser in interface RewardService

Returns:

Resource parser.

getSearchRadius

public double getSearchRadius()

setSearchRadius

public void setSearchRadius(double searchRadius)

getLevelingRate

public LevelingRate getLevelingRate()

setLevelingRate

public void setLevelingRate(LevelingRate levelingRate)

getRewardType

public RewardTypes getRewardType()

Description copied from interface: RewardService

Retrieves the reward type.

Specified by:

getRewardType in interface RewardService

Returns:

Reward type of this class.

getServiceName

public java.lang.String getServiceName()

Description copied from interface: Service

Retrieves a unique string identifying this service. May also be used during parsing.

Note that this identifier must conform to an ENUM convention: upper case only, underscore for space.

A service MUST not alter its identifier once it has been registered.

Specified by:

getServiceName in interface Service

Returns:

A unique reward ID.

clone

public RewardService clone(Configuration config)

Description copied from interface: RewardService

Clones this object with the settings from the given configuration.

Specified by:

clone in interface RewardService

Parameters:

config - - configuration file.

Returns:

A new reward manager with the given settings.