com.comphenix.xp.rewards

Interface ResourceFactory

All Superinterfaces:

Multipliable<ResourceFactory>

All Known Implementing Classes:

CurrencyFactory, ExperienceFactory, ItemsFactory

public interface ResourceFactory
extends Multipliable<ResourceFactory>

Represents a resource holder factory.

Author:

Kristian

Method Summary

Methods

Modifier and Type	Method and Description
ResourceHolder	getMaximum(int count) Calculates the maximum amount of resources that may be awarded.
ResourceHolder	getMinimum(int count) Calculates the minimum amount of resources that may be awarded.
ResourceHolder	getResource(java.util.Random rnd) Retrieve a resource holder, using the given random number generator to determine the amount of the given resource to return.
ResourceHolder	getResource(java.util.Random rnd, int count) Retrieve a resource holder, using the given random number generator to determine the amount of the given resource to return.

Methods inherited from interface com.comphenix.xp.lookup.Multipliable

getMultiplier, withMultiplier

Method Detail

getResource

ResourceHolder getResource(java.util.Random rnd)

Retrieve a resource holder, using the given random number generator to determine the amount of the given resource to return.

Parameters:

rnd - - random number generator to use.

Returns:

A resource holder.

getMinimum

ResourceHolder getMinimum(int count)

Calculates the minimum amount of resources that may be awarded.

Parameters:

count - - resource amount multiplier.

Returns:

A resource holder.

getMaximum

ResourceHolder getMaximum(int count)

Calculates the maximum amount of resources that may be awarded.

Parameters:

count - - resource amount multiplier.

Returns:

A resource holder.

getResource

ResourceHolder getResource(java.util.Random rnd,
                         int count)

Retrieve a resource holder, using the given random number generator to determine the amount of the given resource to return.

Parameters:

rnd - - random number generator to use.

count - - resource amount multiplier.

Returns:

A resource holder.