Package dev.itsharshxd.zentrix.api.events.currency

Enum Class CurrencyChangeEvent.ChangeReason

java.lang.Object

java.lang.Enum<CurrencyChangeEvent.ChangeReason>

dev.itsharshxd.zentrix.api.events.currency.CurrencyChangeEvent.ChangeReason

All Implemented Interfaces:

Serializable, Comparable<CurrencyChangeEvent.ChangeReason>, Constable

Enclosing class:

CurrencyChangeEvent

public static enum CurrencyChangeEvent.ChangeReason
extends Enum<CurrencyChangeEvent.ChangeReason>

Represents the reason for a currency balance change.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADDON	Balance was changed by a third-party addon.
ADMIN	Balance was changed by an administrator command.
EVENT_REWARD	Balance was changed due to a game event reward.
OTHER	Balance was changed for an unknown or unspecified reason.
PENALTY	Balance was changed due to a penalty (e.g., death penalty).
PURCHASE	Balance was changed due to a purchase or transaction.
RESET	Balance was reset to default/starting balance.
STORAGE_LOAD	Balance was loaded from storage.
TRANSFER	Balance was changed due to a transfer between players.

Method Summary

Modifier and Type	Method	Description
static CurrencyChangeEvent.ChangeReason	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CurrencyChangeEvent.ChangeReason[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ADMIN

public static final CurrencyChangeEvent.ChangeReason ADMIN

Balance was changed by an administrator command.

Examples: /currency set, /currency add, /currency take

EVENT_REWARD

public static final CurrencyChangeEvent.ChangeReason EVENT_REWARD

Balance was changed due to a game event reward.

Examples: kill reward, win bonus, first blood, placement rewards

ADDON

public static final CurrencyChangeEvent.ChangeReason ADDON

Balance was changed by a third-party addon.

Addons should use this reason when modifying balances.

PURCHASE

public static final CurrencyChangeEvent.ChangeReason PURCHASE

Balance was changed due to a purchase or transaction.

PENALTY

public static final CurrencyChangeEvent.ChangeReason PENALTY

Balance was changed due to a penalty (e.g., death penalty).

TRANSFER

public static final CurrencyChangeEvent.ChangeReason TRANSFER

Balance was changed due to a transfer between players.

RESET

public static final CurrencyChangeEvent.ChangeReason RESET

Balance was reset to default/starting balance.

STORAGE_LOAD

public static final CurrencyChangeEvent.ChangeReason STORAGE_LOAD

Balance was loaded from storage.

OTHER

public static final CurrencyChangeEvent.ChangeReason OTHER

Balance was changed for an unknown or unspecified reason.

Method Details

values

public static CurrencyChangeEvent.ChangeReason[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CurrencyChangeEvent.ChangeReason valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null