com.jrfom.gw2.api.model

Class Coins

java.lang.Object

com.jrfom.gw2.api.model.Coins

public class Coins
extends Object

Represents in-game currency. This object handles all currency conversion. For example, given 15310 copper:

 Coins coins = new Coins(15310);
 System.out.println(coins.goldValue()); // 1.0
 System.out.println(coins.silverValue()); // 53.0
 System.out.println(coins.copperValue()); // 10.0
 
 

Constructor Summary

Constructors

Constructor and Description
Coins() Create an instance with the value set to 0.
Coins(int amount) Create an instance with the value set to amount.
Coins(String amount) Same as Coins(int).

Method Summary

Methods

Modifier and Type	Method and Description
void	addCopper(int copper) Increase the instance's value by the specified number of in-game copper.
void	addGold(int gold) Increase the instance's value by the specified number of in-game gold.
void	addSilver(int silver) Increase the instance's value by the specified number of in-game silver.
double	copperValue() The number of in-game copper the instance represents.
double	getValue() Retrieve the actual value the instance represents.
double	goldValue() The number of in-game gold the instance represents.
void	setAmount(int amount) Set the instance's actual value to a specific number of coins.
void	setAmount(int gold, int silver, int copper) Set the instance's actual value to a specific number of coins as represented by the in-game currency denominations.
double	silverValue() The number of in-game silver the instance represents.
void	subtractCopper(int copper) Decrease the instance's value by the specified number of in-game copper.
void	subtractGold(int gold) Decrease the instance's value by the specified number of in-game gold.
void	subtractSilver(int silver) Decrease the instance's value by the specified number of in-game silver.

Methods inherited from class java.lang.Object

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

Constructor Detail

Coins

public Coins()

Create an instance with the value set to 0.

Coins

public Coins(int amount)

Create an instance with the value set to amount.

Parameters:

amount - The initial number of coins in "copper".

Coins

public Coins(String amount)

Same as Coins(int). Only used for deserialization.

Parameters:

amount - The initial number of coins in "copper".

Method Detail

getValue

public double getValue()

Retrieve the actual value the instance represents. For example, if you initialized the object with 15310 coins, and didn't add or subtract any afterward, then this method will return 15310.

Returns:

The actual value of coins the instance represents.

goldValue

public double goldValue()

The number of in-game gold the instance represents.

Returns:

A number representing the gold (e.g. 1.0).

silverValue

public double silverValue()

The number of in-game silver the instance represents.

Returns:

A number representing the silver (e.g. 53.0).

copperValue

public double copperValue()

The number of in-game copper the instance represents.

Returns:

A number representing the copper (e.g. 10.0).

addGold

public void addGold(int gold)

Increase the instance's value by the specified number of in-game gold.

Parameters:

gold - A number of gold coins.

addSilver

public void addSilver(int silver)

Increase the instance's value by the specified number of in-game silver.

Parameters:

silver - A number of silver coins.

addCopper

public void addCopper(int copper)

Increase the instance's value by the specified number of in-game copper.

Parameters:

copper - A number of copper coins.

subtractGold

public void subtractGold(int gold)

Decrease the instance's value by the specified number of in-game gold.

Parameters:

gold - A number of gold coins.

subtractSilver

public void subtractSilver(int silver)

Decrease the instance's value by the specified number of in-game silver.

Parameters:

silver - A number of silver coins.

subtractCopper

public void subtractCopper(int copper)

Decrease the instance's value by the specified number of in-game copper.

Parameters:

copper - A number of copper coins.

setAmount

public void setAmount(int amount)

Set the instance's actual value to a specific number of coins. This overwrites any previously stored amount.

Parameters:

amount - The amount of coins this instance should represent.

setAmount

public void setAmount(int gold,
             int silver,
             int copper)

Set the instance's actual value to a specific number of coins as represented by the in-game currency denominations. This overwrites any previously stored value.

Parameters:

gold - The number of gold coins this instance should represent.

silver - The number of silver coins this instance should represent.

copper - The number of copper coins this instance should represent.