org.pepsoft.worldpainter.layers.exporters

Class AbstractCavesExporter<L extends Layer>

java.lang.Object

org.pepsoft.worldpainter.exporting.AbstractLayerExporter<L>

org.pepsoft.worldpainter.layers.exporters.AbstractCavesExporter<L>

Type Parameters:

L - The cave layer type.

All Implemented Interfaces:

LayerExporter

Direct Known Subclasses:

AbstractTunnelLayerExporter, CavernsExporter, CavesExporter, ChasmsExporter

public abstract class AbstractCavesExporter<L extends Layer>
extends AbstractLayerExporter<L>

Abstract base class for cave carving exporters, providing common functionality for excavating caves. Intended use:

• For each column (x and y coordinate):
• Invoke setupForColumn(long, Tile, int, int, boolean, boolean, boolean, boolean) once
• Going from the top to the bottom of the cave for that column, invoke processBlock(Chunk, int, int, int, boolean)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractCavesExporter.CaveDecorationSettings

Nested classes/interfaces inherited from class org.pepsoft.worldpainter.exporting.AbstractLayerExporter

AbstractLayerExporter.ChunksInTilesVisitor

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	decorationEnabled

Fields inherited from class org.pepsoft.worldpainter.exporting.AbstractLayerExporter

dimension, layer, maxHeight, maxZ, minHeight, minZ, platform, settings

Constructor Summary

Constructors

Constructor and Description
AbstractCavesExporter(Dimension dimension, Platform platform, CaveSettings settings, L layer)

Method Summary

Modifier and Type	Method and Description
protected void	decorateBlock(MinecraftWorld world, java.util.Random rng, int x, int y, int height)
protected void	emptyBlockEncountered()
protected void	processBlock(Chunk chunk, int x, int y, int z, boolean excavate)
protected void	resetColumn()
protected void	setupForColumn(long seed, Tile tile, int maxY, int waterLevel, boolean glassCeiling, boolean surfaceBreaking, boolean leaveWater, boolean floodWithLava)

Methods inherited from class org.pepsoft.worldpainter.exporting.AbstractLayerExporter

getDimension, getLayer, visitChunksForLayerInAreaForEditing

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

decorationEnabled

protected final boolean decorationEnabled

Constructor Detail

AbstractCavesExporter

public AbstractCavesExporter(Dimension dimension,
                             Platform platform,
                             CaveSettings settings,
                             L layer)

Method Detail

setupForColumn

protected final void setupForColumn(long seed,
                                    Tile tile,
                                    int maxY,
                                    int waterLevel,
                                    boolean glassCeiling,
                                    boolean surfaceBreaking,
                                    boolean leaveWater,
                                    boolean floodWithLava)

resetColumn

protected final void resetColumn()

emptyBlockEncountered

protected final void emptyBlockEncountered()

processBlock

protected final void processBlock(Chunk chunk,
                                  int x,
                                  int y,
                                  int z,
                                  boolean excavate)

decorateBlock

protected final void decorateBlock(MinecraftWorld world,
                                   java.util.Random rng,
                                   int x,
                                   int y,
                                   int height)