org.pepsoft.worldpainter.layers.plants

Class PlantLayer

java.lang.Object

org.pepsoft.worldpainter.layers.Layer

org.pepsoft.worldpainter.layers.CustomLayer

org.pepsoft.worldpainter.layers.plants.PlantLayer

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Layer>

public class PlantLayer
extends CustomLayer

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlantLayer.PlantSettings

Nested classes/interfaces inherited from class org.pepsoft.worldpainter.layers.Layer

Layer.DataSize

Field Summary

Fields inherited from class org.pepsoft.worldpainter.layers.CustomLayer

KEY_DIMENSION

Fields inherited from class org.pepsoft.worldpainter.layers.Layer

dataSize, discrete, id, priority

Constructor Summary

Constructors

Constructor and Description
PlantLayer(java.lang.String name, java.lang.String description, java.lang.Object paint)

Method Summary

Modifier and Type	Method and Description
PlantLayer	clone() Create a deep copy of the custom layer, with a different ID and independent settings.
java.util.Map<Plant,PlantLayer.PlantSettings>	getConfiguredPlants()
PlantLayerExporter	getExporter(Dimension dimension, Platform platform, ExporterSettings settings) Create a new exporter for this layer.
java.lang.Class<? extends LayerExporter>	getExporterType() Return the type of the exporter that Layer.getExporter(Dimension, Platform, ExporterSettings) will return.
Bo2ObjectProvider	getObjectProvider(Platform platform)
PlantLayer.PlantSettings	getSettings(int plantIndex)
java.lang.String	getType() Get a short, human-readable description of the layer type.
boolean	isGenerateFarmland()
boolean	isOnlyOnValidBlocks()
void	setGenerateFarmland(boolean generateFarmland)
void	setOnlyOnValidBlocks(boolean onlyOnValidBlocks)
void	setSettings(int plantIndex, PlantLayer.PlantSettings settings)

Methods inherited from class org.pepsoft.worldpainter.layers.CustomLayer

getActions, getBiome, getExportIndex, getIcon, getOpacity, getPaint, getPalette, getPaletteIndex, getRenderer, isExport, isHide, setBiome, setExport, setExportIndex, setHide, setMinMaxHeight, setName, setOpacity, setPaint, setPalette, setPaletteIndex

Methods inherited from class org.pepsoft.worldpainter.layers.Layer

compareTo, equals, getDataSize, getDefaultValue, getDescription, getId, getMnemonic, getName, getPriority, hashCode, isExportableToFile, setDescription, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PlantLayer

public PlantLayer(java.lang.String name,
                  java.lang.String description,
                  java.lang.Object paint)

Method Detail

getSettings

public PlantLayer.PlantSettings getSettings(int plantIndex)

setSettings

public void setSettings(int plantIndex,
                        PlantLayer.PlantSettings settings)

isGenerateFarmland

public boolean isGenerateFarmland()

setGenerateFarmland

public void setGenerateFarmland(boolean generateFarmland)

isOnlyOnValidBlocks

public boolean isOnlyOnValidBlocks()

setOnlyOnValidBlocks

public void setOnlyOnValidBlocks(boolean onlyOnValidBlocks)

getConfiguredPlants

public java.util.Map<Plant,PlantLayer.PlantSettings> getConfiguredPlants()

getObjectProvider

public Bo2ObjectProvider getObjectProvider(Platform platform)

getExporterType

public java.lang.Class<? extends LayerExporter> getExporterType()

Description copied from class: Layer

Return the type of the exporter that Layer.getExporter(Dimension, Platform, ExporterSettings) will return. If that method is implemented, this method must also be implemented. May be used to examine which phases the exporter requires. May return null for layers that cannot be exported.

Overrides:

getExporterType in class Layer

getExporter

public PlantLayerExporter getExporter(Dimension dimension,
                                      Platform platform,
                                      ExporterSettings settings)

Description copied from class: Layer

Create a new exporter for this layer.

If this method is implemented, Layer.getExporterType() must also be implemented to indicate which type this method will return.

Overrides:

getExporter in class Layer

Parameters:

dimension - The dimension that is being exported.

platform - The platform for which the dimension is being exported.

settings - The configured settings for the layer, if any. May be null.

Returns:

A new exporter for this layer.

getType

public java.lang.String getType()

Description copied from class: CustomLayer

Get a short, human-readable description of the layer type.

Overrides:

getType in class CustomLayer

clone

public PlantLayer clone()

Description copied from class: CustomLayer

Create a deep copy of the custom layer, with a different ID and independent settings.

Overrides:

clone in class CustomLayer

Returns:

A deep copy of the custom layer.