org.pepsoft.worldpainter.importing

Enum MapImporter.ReadOnlyOption

java.lang.Object

java.lang.Enum<MapImporter.ReadOnlyOption>

org.pepsoft.worldpainter.importing.MapImporter.ReadOnlyOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MapImporter.ReadOnlyOption>

Enclosing class:

MapImporter

public static enum MapImporter.ReadOnlyOption
extends java.lang.Enum<MapImporter.ReadOnlyOption>

An indication of how the ReadOnly layer should be applied to the imported world.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL The ReadOnly layer should be applied all chunks.
MAN_MADE The ReadOnly layer should be applied to every chunk that contains at least one man-made block (a block that would have been placed by a player).
MAN_MADE_ABOVE_GROUND The ReadOnly layer should be applied to every chunk that contains at least one above-ground man-made block (a block that would have been placed by a player).
NONE The ReadOnly layer should not be applied to the imported world.

Method Summary

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

NONE

public static final MapImporter.ReadOnlyOption NONE

The ReadOnly layer should not be applied to the imported world.

MAN_MADE

public static final MapImporter.ReadOnlyOption MAN_MADE

The ReadOnly layer should be applied to every chunk that contains at least one man-made block (a block that would have been placed by a player). The definition of "man-made" is up to the platform provider, but one option, used by the default platforms supported by WorldPainter, is to look at the Material.natural property.

MAN_MADE_ABOVE_GROUND

public static final MapImporter.ReadOnlyOption MAN_MADE_ABOVE_GROUND

The ReadOnly layer should be applied to every chunk that contains at least one above-ground man-made block (a block that would have been placed by a player). The definition of "man-made" is up to the platform provider, but one option, used by the default platforms supported by WorldPainter, is to look at the Material.natural property. "Above ground" means any block above the level that will become the terrain height in the WorldPainter world.

ALL

public static final MapImporter.ReadOnlyOption ALL

The ReadOnly layer should be applied all chunks.

Method Detail

values

public static MapImporter.ReadOnlyOption[] 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 (MapImporter.ReadOnlyOption c : MapImporter.ReadOnlyOption.values())
    System.out.println(c);

Returns:

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

valueOf

public static MapImporter.ReadOnlyOption 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