Package de.ellpeck.actuallyadditions.api.farmer

Enum Class FarmerResult

java.lang.Object

java.lang.Enum<FarmerResult>

de.ellpeck.actuallyadditions.api.farmer.FarmerResult

All Implemented Interfaces:

Serializable, Comparable<FarmerResult>, Constable

public enum FarmerResult
extends Enum<FarmerResult>

Return values for IFarmerBehavior, each one has a different meaning in harvest and planting contexts.

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
FAIL	Indicates that your behavior failed to perform the action it attempted.
STOP_PROCESSING	Indicates you want the farmer to halt all further actions this tick.
SUCCESS	Indicates that your behavior succeeded doing the action it attempted.

Method Summary

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

FAIL

public static final FarmerResult FAIL

Indicates that your behavior failed to perform the action it attempted.

SUCCESS

public static final FarmerResult SUCCESS

Indicates that your behavior succeeded doing the action it attempted. For harvesting, this also shrinks the current stack by one, and stops processing.

STOP_PROCESSING

public static final FarmerResult STOP_PROCESSING

Indicates you want the farmer to halt all further actions this tick. This will exit the farmer behavior loop if returned.

Method Details

values

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