de.ellpeck.rockbottom.api

Enum StaticTileProps.LogType

java.lang.Object

java.lang.Enum<StaticTileProps.LogType>

de.ellpeck.rockbottom.api.StaticTileProps.LogType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<StaticTileProps.LogType>

Enclosing class:

StaticTileProps

public static enum StaticTileProps.LogType
extends java.lang.Enum<StaticTileProps.LogType>

An enum of log types that are used for the StaticTileProps.LOG_VARIANT property.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BRANCH_LEFT
BRANCH_RIGHT
PLACED
ROOT_LEFT
ROOT_RIGHT
TRUNK_BOTTOM
TRUNK_MIDDLE
TRUNK_TOP

Method Summary

Modifier and Type	Method and Description
boolean	isNatural()
static StaticTileProps.LogType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StaticTileProps.LogType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PLACED

public static final StaticTileProps.LogType PLACED

BRANCH_LEFT

public static final StaticTileProps.LogType BRANCH_LEFT

BRANCH_RIGHT

public static final StaticTileProps.LogType BRANCH_RIGHT

TRUNK_TOP

public static final StaticTileProps.LogType TRUNK_TOP

TRUNK_MIDDLE

public static final StaticTileProps.LogType TRUNK_MIDDLE

TRUNK_BOTTOM

public static final StaticTileProps.LogType TRUNK_BOTTOM

ROOT_LEFT

public static final StaticTileProps.LogType ROOT_LEFT

ROOT_RIGHT

public static final StaticTileProps.LogType ROOT_RIGHT

Method Detail

values

public static StaticTileProps.LogType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StaticTileProps.LogType c : StaticTileProps.LogType.values())
    System.out.println(c);

Returns:

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

valueOf

public static StaticTileProps.LogType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isNatural

public boolean isNatural()

Returns:

If a certain log type is considered to be natural, meaning not player-placed