Enum Class StatChangeDirection

java.lang.Object

java.lang.Enum<StatChangeDirection>

com.hypixel.hytale.server.core.modules.entitystats.StatChangeDirection

All Implemented Interfaces:

Serializable, Comparable<StatChangeDirection>, Constable

public enum StatChangeDirection
extends Enum<StatChangeDirection>

Direction of a stat value change, used to scope stat-change suppression (see EntityStatMap.setStatChangeSuppressed(int, StatChangeDirection, boolean)). BOTH is the composite a stat holds when something suppresses its increases and its decreases at the same time.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTH	Both directions.
LOWER	Value-decreasing changes (damage, oxygen drain, drain).
RAISE	Value-increasing changes (heal, regen, refill).

Method Summary

Modifier and Type	Method	Description
boolean	covers(StatChangeDirection other)	Whether suppressing this direction also suppresses other.
StatChangeDirection	union(StatChangeDirection other)	This direction combined with other (BOTH when they differ).
static StatChangeDirection	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StatChangeDirection[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
StatChangeDirection	without(StatChangeDirection other)	This direction with other removed, or null when nothing remains.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RAISE

public static final StatChangeDirection RAISE

Value-increasing changes (heal, regen, refill).

LOWER

public static final StatChangeDirection LOWER

Value-decreasing changes (damage, oxygen drain, drain).

BOTH

public static final StatChangeDirection BOTH

Both directions.

Method Details

values

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

covers

public boolean covers(@Nonnull
 StatChangeDirection other)

Whether suppressing this direction also suppresses other.

union

@Nonnull
public StatChangeDirection union(@Nonnull
 StatChangeDirection other)

This direction combined with other (BOTH when they differ).

without

@Nullable
public StatChangeDirection without(@Nonnull
 StatChangeDirection other)

This direction with other removed, or null when nothing remains.