Package studio.magemonkey.fabled.api.enums

Enum Class PointSource

java.lang.Object

java.lang.Enum<PointSource>

studio.magemonkey.fabled.api.enums.PointSource

All Implemented Interfaces:

Serializable, Comparable<PointSource>, Constable

public enum PointSource
extends Enum<PointSource>

A collection of possible reasons skill points were gained by a player.

This is used when giving skill points to a player to allow effects to react differently depending on why it is being added.

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
COMMAND	A command gave the player additional skill points
INITIALIZATION	The skill points are from the player's data being initialized on startup
LEVEL	The player leveled up to get more skill points
REFUND	The player downgraded a skill and was refunded the skill points
SPECIAL	The player was given skill points for an unspecified reason

Method Summary

Modifier and Type	Method	Description
static PointSource	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PointSource[]	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

LEVEL

public static final PointSource LEVEL

The player leveled up to get more skill points

REFUND

public static final PointSource REFUND

The player downgraded a skill and was refunded the skill points

COMMAND

public static final PointSource COMMAND

A command gave the player additional skill points

SPECIAL

public static final PointSource SPECIAL

The player was given skill points for an unspecified reason

INITIALIZATION

public static final PointSource INITIALIZATION

The skill points are from the player's data being initialized on startup

Method Details

values

public static PointSource[] 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 PointSource 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