com.comphenix.xp.rewards

Interface RewardService

All Superinterfaces:

Service

All Known Implementing Classes:

RewardDrops, RewardEconomy, RewardExperience, RewardVirtual

public interface RewardService
extends Service

Represents a method of rewarding a player with resources.

Author:

Kristian

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.
ResourcesParser	getResourcesParser() Retrieves the standard or custom resource parser associated with this reward.
RewardTypes	getRewardType() Retrieves the reward type.
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.

Methods inherited from interface com.comphenix.xp.extra.Service

getServiceName

Method Detail

canReward

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.

Parameters:

player - - player to test.

resource - - the resource to give or take away.

reward

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

Rewards a player directly.

Parameters:

player - - player to award.

resource - - the resource to give or take away.

reward

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

Rewards a player with the given amount of resources.

Parameters:

player - - player to award.

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

resource - - the resource to give or take away.

reward

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

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

Parameters:

world - - the world to create this reward.

point - - where to put this reward.

resource - - the resource to give or take away.

getRewardType

RewardTypes getRewardType()

Retrieves the reward type.

Returns:

Reward type of this class.

getResourcesParser

ResourcesParser getResourcesParser()

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

Returns:

Resource parser.

clone

RewardService clone(Configuration config)

Clones this object with the settings from the given configuration.

Parameters:

config - - configuration file.

Returns:

A new reward manager with the given settings.