Package net.risingworld.api.world

Enum Class EditRestriction

java.lang.Object

java.lang.Enum<EditRestriction>

net.risingworld.api.world.EditRestriction

All Implemented Interfaces:

Serializable, Comparable<EditRestriction>, Constable

public enum EditRestriction
extends Enum<EditRestriction>

Optional restrictions when performing terrain modifications.

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
AirOnly	Only affects air blocks (id 0)
None	No restriction, affects all blocks
SoilOnly	Only affects soil blocks like dirt, sand etc
SolidOnly	Only affects solid blocks, i.e no air
SpecificIDOnly	Only affects a specific type id (editInfo == id)
StoneOnly	Only affects stone blocks
TallGrassOnly	Only affects tall grass (all grass except plain/flat grass)
WaterAndAirOnly	Only affects water and air blocks
WaterOnly	Only affects water blocks

Method Summary

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

None

public static final EditRestriction None

No restriction, affects all blocks

AirOnly

public static final EditRestriction AirOnly

Only affects air blocks (id 0)

SoilOnly

public static final EditRestriction SoilOnly

Only affects soil blocks like dirt, sand etc

StoneOnly

public static final EditRestriction StoneOnly

Only affects stone blocks

TallGrassOnly

public static final EditRestriction TallGrassOnly

Only affects tall grass (all grass except plain/flat grass)

SolidOnly

public static final EditRestriction SolidOnly

Only affects solid blocks, i.e no air

WaterOnly

public static final EditRestriction WaterOnly

Only affects water blocks

WaterAndAirOnly

public static final EditRestriction WaterAndAirOnly

Only affects water and air blocks

SpecificIDOnly

public static final EditRestriction SpecificIDOnly

Only affects a specific type id (editInfo == id)

Method Details

values

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