Package com.minecolonies.api.colony

Enum Class ColonyState

java.lang.Object

java.lang.Enum<ColonyState>

com.minecolonies.api.colony.ColonyState

All Implemented Interfaces:

IAIState, IState, Serializable, Comparable<ColonyState>, Constable

public enum ColonyState
extends Enum<ColonyState>
implements IAIState

THe states a colony can be in.

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
ACTIVE	Colony is active
INACTIVE	Colony is not ticking
UNLOADED	Colony chunks are not loaded

Method Summary

Modifier and Type	Method	Description
boolean	isOkayToEat()	Check whether we can interrupt the current state to eat
static ColonyState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ColonyState[]	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

INACTIVE

public static final ColonyState INACTIVE

Colony is not ticking

ACTIVE

public static final ColonyState ACTIVE

Colony is active

UNLOADED

public static final ColonyState UNLOADED

Colony chunks are not loaded

Method Details

values

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

isOkayToEat

public boolean isOkayToEat()

Description copied from interface: IAIState

Check whether we can interrupt the current state to eat

Specified by:

isOkayToEat in interface IAIState

Returns:

true if we can