org.pepsoft.worldpainter.plugins

Interface BlockBasedPlatformProvider

All Superinterfaces:

PlatformProvider, Plugin, Provider<Platform>

All Known Implementing Classes:

JavaPlatformProvider

public interface BlockBasedPlatformProvider
extends PlatformProvider

A PlatformProvider for Minecraft-like block based platforms based on 16x16 chunks.

Nested Class Summary

Nested classes/interfaces inherited from interface org.pepsoft.worldpainter.plugins.PlatformProvider

PlatformProvider.MapInfo

Field Summary

Fields inherited from interface org.pepsoft.worldpainter.plugins.Plugin

PROPERTY_MINIMUM_WORLDPAINTER_VERSION, PROPERTY_NAME, PROPERTY_UUIDS, PROPERTY_VERSION

Method Summary

Modifier and Type	Method and Description
default Chunk	createChunk(Platform platform, int x, int z, int minHeight, int maxHeight) Create a new, empty chunk for a platform supported by this provider.
ChunkStore	getChunkStore(Platform platform, java.io.File worldDir, int dimension) Obtain a ChunkStore which will save chunks in the format of the platform, for a platform supported by this provider and for a specific map base directory and dimension number.
int[]	getDimensions(Platform platform, java.io.File worldDir) Determine which dimensions are present in the map specified by a particular Platform and directory.
PostProcessor	getPostProcessor(Platform platform) Obtain a PostProcessor for a platform supported by this provider.

Methods inherited from interface org.pepsoft.worldpainter.plugins.PlatformProvider

getDefaultExportDir, getDefaultExportSettings, getExporter, getExportSettingsEditor, getMapRecognizer, identifyMap, isCompatible, selectBackupDir

Methods inherited from interface org.pepsoft.worldpainter.plugins.Provider

getKeys

Methods inherited from interface org.pepsoft.worldpainter.plugins.Plugin

getMinimumWorldPainterVersion, getName, getProperties, getUUIDs, getVersion, init

Method Detail

getDimensions

int[] getDimensions(Platform platform,
                    java.io.File worldDir)

Determine which dimensions are present in the map specified by a particular Platform and directory.

Parameters:

platform - The platform for which to determine the dimensions.

worldDir - The map base directory for which to determine the dimensions.

Returns:

An array of dimension numbers corresponding to the constants Constants.DIM_NORMAL, Constants.DIM_NETHER and Constants.DIM_END for dimensions which correspond to vanilla Minecraft dimensions.

createChunk

default Chunk createChunk(Platform platform,
                          int x,
                          int z,
                          int minHeight,
                          int maxHeight)

Create a new, empty chunk for a platform supported by this provider.

The default implementation delegates to #createChunk(Platform, int, int, int) if minHeight is zero, or throws an IllegalArgumentException otherwise.

Implementations MUST implement at least on of createChunk(Platform, int, int, int, int) or #createChunk(Platform, int, int, int).

Parameters:

platform - The platform for which to create a chunk.

x - The X coordinate (in chunks) of the chunk to create.

z - The Z coordinate (in chunks) of the chunk to create.

minHeight - The depth (in blocks) ot the chunk to create.

maxHeight - The height (in blocks) of the chunk to create.

Returns:

The newly created chunk.

getChunkStore

ChunkStore getChunkStore(Platform platform,
                         java.io.File worldDir,
                         int dimension)

Obtain a ChunkStore which will save chunks in the format of the platform, for a platform supported by this provider and for a specific map base directory and dimension number.

Parameters:

platform - The platform for which to provide a chunk store.

worldDir - The map base directory for which to provide a chunk store.

dimension - The dimension number for which to provide a chunk store.

Returns:

A chunk store which will write chunks in the appropriate format for the specified dimension under the specified base directory.

getPostProcessor

PostProcessor getPostProcessor(Platform platform)

Obtain a PostProcessor for a platform supported by this provider.

Parameters:

platform - The platform for which to provide a post processor.

Returns:

A post processor for the specified platform.