RuneHive-Tarnish: com.osroyale.content.store.currency.Currency Interface Reference

RuneHive-Tarnish

Neural OSRS Enhancement Framework

Loading...

Searching...

No Matches

Inheritance diagram for com.osroyale.content.store.currency.Currency:

Public Member Functions
boolean	tangible ()
boolean	takeCurrency (Player player, int amount)
void	recieveCurrency (Player player, int amount)
int	currencyAmount (Player player)
boolean	canRecieveCurrency (Player player)
String	toString ()

Detailed Description

The parent class of all currencies that provides basic functionality for any general currency. This can be used to register tangible, and even intangible currencies.

Author: lare96 http://github.com/lare96

Definition at line 11 of file Currency.java.

Member Function Documentation

◆ canRecieveCurrency()

boolean com.osroyale.content.store.currency.Currency.canRecieveCurrency ( Player player )

Determines if the currency can be received when player's inventory is full.

Parameters

player the player to determine this for.

Returns: true if the currency can be recieved, false otherwise.

Implemented in com.osroyale.content.store.currency.impl.ClanPointCurrency, com.osroyale.content.store.currency.impl.DonatorPointCurrency, com.osroyale.content.store.currency.impl.ItemCurrency, com.osroyale.content.store.currency.impl.LMSPointCurrency, com.osroyale.content.store.currency.impl.MageArenaCurrency, com.osroyale.content.store.currency.impl.PestPointCurrency, com.osroyale.content.store.currency.impl.PrestigePointCurrency, com.osroyale.content.store.currency.impl.SkillingPointCurrency, com.osroyale.content.store.currency.impl.SlayerPointCurrency, and com.osroyale.content.store.currency.impl.VotePointCurrency.

◆ currencyAmount()

int com.osroyale.content.store.currency.Currency.currencyAmount ( Player player )

The method that retrieves the amount of currency player currently has.

Parameters

player the player who's currency amount will be determined.

Returns: the amount of the currency the player has.

Implemented in com.osroyale.content.store.currency.impl.ClanPointCurrency, com.osroyale.content.store.currency.impl.DonatorPointCurrency, com.osroyale.content.store.currency.impl.ItemCurrency, com.osroyale.content.store.currency.impl.LMSPointCurrency, com.osroyale.content.store.currency.impl.MageArenaCurrency, com.osroyale.content.store.currency.impl.PestPointCurrency, com.osroyale.content.store.currency.impl.PrestigePointCurrency, com.osroyale.content.store.currency.impl.SkillingPointCurrency, com.osroyale.content.store.currency.impl.SlayerPointCurrency, and com.osroyale.content.store.currency.impl.VotePointCurrency.

◆ recieveCurrency()

void com.osroyale.content.store.currency.Currency.recieveCurrency	(	Player	player,
		int	amount )

The method executed when the currency is given to player.

Parameters

player	the player the currency is given to.
amount	the amount of currency that is given.

Implemented in com.osroyale.content.store.currency.impl.ClanPointCurrency, com.osroyale.content.store.currency.impl.DonatorPointCurrency, com.osroyale.content.store.currency.impl.ItemCurrency, com.osroyale.content.store.currency.impl.LMSPointCurrency, com.osroyale.content.store.currency.impl.MageArenaCurrency, com.osroyale.content.store.currency.impl.PestPointCurrency, com.osroyale.content.store.currency.impl.PrestigePointCurrency, com.osroyale.content.store.currency.impl.SkillingPointCurrency, com.osroyale.content.store.currency.impl.SlayerPointCurrency, and com.osroyale.content.store.currency.impl.VotePointCurrency.

◆ takeCurrency()

boolean com.osroyale.content.store.currency.Currency.takeCurrency	(	Player	player,
		int	amount )

The method executed when the currency is taken from player.

Parameters

player	the player the currency is taken from.
amount	the amount of currency that is taken.

Implemented in com.osroyale.content.store.currency.impl.ClanPointCurrency, com.osroyale.content.store.currency.impl.DonatorPointCurrency, com.osroyale.content.store.currency.impl.ItemCurrency, com.osroyale.content.store.currency.impl.LMSPointCurrency, com.osroyale.content.store.currency.impl.MageArenaCurrency, com.osroyale.content.store.currency.impl.PestPointCurrency, com.osroyale.content.store.currency.impl.PrestigePointCurrency, com.osroyale.content.store.currency.impl.SkillingPointCurrency, com.osroyale.content.store.currency.impl.SlayerPointCurrency, and com.osroyale.content.store.currency.impl.VotePointCurrency.

◆ tangible()

boolean com.osroyale.content.store.currency.Currency.tangible ( )

Determines if this currency is tangible.

Returns: true if this currency is tangible, false otherwise.

Implemented in com.osroyale.content.store.currency.impl.ClanPointCurrency, com.osroyale.content.store.currency.impl.DonatorPointCurrency, com.osroyale.content.store.currency.impl.ItemCurrency, com.osroyale.content.store.currency.impl.LMSPointCurrency, com.osroyale.content.store.currency.impl.MageArenaCurrency, com.osroyale.content.store.currency.impl.PestPointCurrency, com.osroyale.content.store.currency.impl.PrestigePointCurrency, com.osroyale.content.store.currency.impl.SkillingPointCurrency, com.osroyale.content.store.currency.impl.SlayerPointCurrency, and com.osroyale.content.store.currency.impl.VotePointCurrency.

◆ toString()

String com.osroyale.content.store.currency.Currency.toString ( )

Gets the name of the currency.

Implemented in com.osroyale.content.store.currency.impl.ItemCurrency.

The documentation for this interface was generated from the following file:

osroyale/content/store/currency/Currency.java