com.captainup.android.core.model

Interface Currency

All Superinterfaces:

CaptainUpObject

public interface Currency
extends CaptainUpObject

Currency Object, can be used to know the total amount of currency a player has, or the amount of currency received by an action, a badge, an asset etc..

Method Summary

Modifier and Type	Method and Description
int	getAmount() The currency amount, used for example, to represent a specific currency amount awarded when achieving a badge or performing an action etc...
int	getAmountReceived() The currency amount that was earned in an action, or badge achieve event, or whenever a player earned currency.
int	getMultiplier() the currency multiplier (can be set in the admin panel)
java.lang.String	getName() The currency name, that is set up in the admin panel (for example, default currency name is "points")
long	getPlayerTotal() The total amount of currency a player has.

Method Detail

getName

java.lang.String getName()

The currency name, that is set up in the admin panel (for example, default currency name is "points")

Returns:

the currency name.

getAmount

int getAmount()

The currency amount, used for example, to represent a specific currency amount awarded when achieving a badge or performing an action etc...

Returns:

the currency amount.

getAmountReceived

int getAmountReceived()

The currency amount that was earned in an action, or badge achieve event, or whenever a player earned currency.

Returns:

the amount received.

getMultiplier

int getMultiplier()

the currency multiplier (can be set in the admin panel)

Returns:

the currency multiplier.

getPlayerTotal

long getPlayerTotal()

The total amount of currency a player has.

Returns:

the total amount of currency.