org.pepsoft.worldpainter

Class World2

java.lang.Object

org.pepsoft.worldpainter.InstanceKeeper

org.pepsoft.worldpainter.World2

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class World2
extends InstanceKeeper
implements java.io.Serializable, java.lang.Cloneable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	World2.BorderSettings
static class	World2.Warning

Nested classes/interfaces inherited from class org.pepsoft.worldpainter.InstanceKeeper

InstanceKeeper.InstantiationListener<T>

Field Summary

Fields

Modifier and Type	Field and Description
static int	BIOME_ALGORITHM_AUTO_BIOMES Deprecated.
static int	BIOME_ALGORITHM_CUSTOM_BIOMES Deprecated.
static int	BIOME_ALGORITHM_NONE Deprecated.
static long	DEFAULT_LAND_SEED
static long	DEFAULT_OCEAN_SEED
static java.lang.String	METADATA_KEY_NAME A string containing the name of the world.
static java.lang.String	METADATA_KEY_PLUGINS An optional two dimensional String[][2] array containing the plugins installed in the WorldPainter instance which saved the file.
static java.lang.String	METADATA_KEY_TIMESTAMP A Date containing the time at which this file was saved.
static java.lang.String	METADATA_KEY_WP_BUILD A String containing the WorldPainter build with which this file was saved.
static java.lang.String	METADATA_KEY_WP_VERSION A String containing the WorldPainter version with which this file was saved.

Constructor Summary

Constructors

Constructor and Description
World2(Platform platform, int minHeight, int maxHeight)
World2(Platform platform, long minecraftSeed, TileFactory tileFactory)

Method Summary

Modifier and Type	Method and Description
void	addDimension(Dimension dimension)
void	addHistoryEntry(int key, java.io.Serializable... args)
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
void	clearLayerData(Layer layer)
<T> java.util.Optional<T>	getAttribute(org.pepsoft.util.AttributeKey<T> key)
World2.BorderSettings	getBorderSettings()
long	getChangeNo()
java.util.List<java.io.File>	getDataPacks()
int	getDifficulty()
Dimension	getDimension(Dimension.Anchor anchor)
Dimension	getDimension(int dim) Deprecated. Use #getDimension(Anchor).
java.util.Set<Dimension>	getDimensions()
java.util.Set<Dimension>	getDimensionsWithRole(Dimension.Role role, boolean inverted, int id)
WorldExportSettings	getExportSettings()
GameType	getGameType()
Generator	getGenerator() Deprecated. Use Dimension.getGenerator().
java.lang.String	getGeneratorOptions() Deprecated. Use Dimension.getGenerator().
java.util.List<HistoryEntry>	getHistory()
java.io.File	getImportedFrom() The level.dat file of the map this world was Imported from.
int	getMaxHeight()
java.io.File	getMergedWith() The level.dat file of the map with which this world was last Merged.
java.util.Map<java.lang.String,java.lang.Object>	getMetadata()
int	getMinHeight()
MixedMaterial	getMixedMaterial(int index)
java.lang.String	getName()
Platform	getPlatform()
java.awt.Point	getSpawnPoint()
Dimension.Anchor	getSpawnPointDimension()
java.awt.Point	getTileCoordinates(int worldX, int worldY)
java.awt.Point	getTileCoordinates(java.awt.Point worldCoords)
Direction	getUpIs()
boolean	isAllowCheats()
boolean	isAllowMerging()
boolean	isAskToConvertToAnvil()
boolean	isAskToRotate()
boolean	isCreateGoodiesChest()
boolean	isDimensionPresent(Dimension.Anchor anchor)
boolean	isExtendedBlockIds()
boolean	isMapFeatures()
long	measureSize()
Dimension	removeDimension(Dimension.Anchor anchor)
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
void	save(java.util.zip.ZipOutputStream out)
void	setAllowCheats(boolean allowCheats)
void	setAllowMerging(boolean allowMerging)
void	setAskToConvertToAnvil(boolean askToConvertToAnvil)
void	setAskToRotate(boolean askToRotate)
<T> void	setAttribute(org.pepsoft.util.AttributeKey<T> key, T value)
void	setCreateGoodiesChest(boolean createGoodiesChest)
void	setDataPacks(java.util.List<java.io.File> dataPacks)
void	setDifficulty(int difficulty)
void	setExportSettings(WorldExportSettings exportSettings)
void	setExtendedBlockIds(boolean extendedBlockIds)
void	setGameType(GameType gameType)
void	setImportedFrom(java.io.File importedFrom)
void	setMapFeatures(boolean mapFeatures)
void	setMaxHeight(int maxHeight)
void	setMergedWith(java.io.File mergedWith)
void	setMetadata(java.util.Map<java.lang.String,java.lang.Object> metadata)
void	setMinHeight(int minHeight)
void	setMixedMaterial(int index, MixedMaterial material)
void	setName(java.lang.String name)
void	setPlatform(Platform platform)
void	setSpawnPoint(java.awt.Point spawnPoint)
void	setSpawnPointDimension(Dimension.Anchor spawnPointDimension)
void	setUpIs(Direction upIs)
void	transform(CoordinateTransform transform, org.pepsoft.util.ProgressReceiver progressReceiver) Transforms all dimensions of this world horizontally.
void	transform(Dimension.Anchor anchor, CoordinateTransform transform, org.pepsoft.util.ProgressReceiver progressReceiver) Transforms one dimension horizontally.

Methods inherited from class org.pepsoft.worldpainter.InstanceKeeper

setInstantiationListener

Methods inherited from class java.lang.Object

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

Field Detail

BIOME_ALGORITHM_NONE

@Deprecated
public static final int BIOME_ALGORITHM_NONE

Deprecated.

See Also:

Constant Field Values

BIOME_ALGORITHM_CUSTOM_BIOMES

@Deprecated
public static final int BIOME_ALGORITHM_CUSTOM_BIOMES

Deprecated.

See Also:

Constant Field Values

BIOME_ALGORITHM_AUTO_BIOMES

@Deprecated
public static final int BIOME_ALGORITHM_AUTO_BIOMES

Deprecated.

See Also:

Constant Field Values

DEFAULT_OCEAN_SEED

public static final long DEFAULT_OCEAN_SEED

See Also:

Constant Field Values

DEFAULT_LAND_SEED

public static final long DEFAULT_LAND_SEED

See Also:

Constant Field Values

METADATA_KEY_WP_VERSION

public static final java.lang.String METADATA_KEY_WP_VERSION

A String containing the WorldPainter version with which this file was saved.

See Also:

Constant Field Values

METADATA_KEY_WP_BUILD

public static final java.lang.String METADATA_KEY_WP_BUILD

A String containing the WorldPainter build with which this file was saved.

See Also:

Constant Field Values

METADATA_KEY_TIMESTAMP

public static final java.lang.String METADATA_KEY_TIMESTAMP

A Date containing the time at which this file was saved.

See Also:

Constant Field Values

METADATA_KEY_PLUGINS

public static final java.lang.String METADATA_KEY_PLUGINS

An optional two dimensional String[][2] array containing the plugins installed in the WorldPainter instance which saved the file. One row per plugin, which each row containing two elements, the first being the plugin name, the second being the plugin version.

May be null if no non-standard plugins were present.

See Also:

Constant Field Values

METADATA_KEY_NAME

public static final java.lang.String METADATA_KEY_NAME

A string containing the name of the world.

See Also:

Constant Field Values

Constructor Detail

World2

public World2(Platform platform,
              int minHeight,
              int maxHeight)

World2

public World2(Platform platform,
              long minecraftSeed,
              TileFactory tileFactory)

Method Detail

getChangeNo

public long getChangeNo()

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

isCreateGoodiesChest

public boolean isCreateGoodiesChest()

setCreateGoodiesChest

public void setCreateGoodiesChest(boolean createGoodiesChest)

getTileCoordinates

public java.awt.Point getTileCoordinates(int worldX,
                                         int worldY)

getTileCoordinates

public java.awt.Point getTileCoordinates(java.awt.Point worldCoords)

getSpawnPoint

public java.awt.Point getSpawnPoint()

setSpawnPoint

public void setSpawnPoint(java.awt.Point spawnPoint)

getImportedFrom

public java.io.File getImportedFrom()

The level.dat file of the map this world was Imported from.

setImportedFrom

public void setImportedFrom(java.io.File importedFrom)

isMapFeatures

public boolean isMapFeatures()

setMapFeatures

public void setMapFeatures(boolean mapFeatures)

getGameType

public GameType getGameType()

setGameType

public void setGameType(GameType gameType)

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)

getDimension

@Deprecated
public Dimension getDimension(int dim)

Deprecated. Use #getDimension(Anchor).

isDimensionPresent

public boolean isDimensionPresent(Dimension.Anchor anchor)

getDimension

public Dimension getDimension(Dimension.Anchor anchor)

getDimensions

public java.util.Set<Dimension> getDimensions()

getDimensionsWithRole

public java.util.Set<Dimension> getDimensionsWithRole(Dimension.Role role,
                                                      boolean inverted,
                                                      int id)

addDimension

public final void addDimension(Dimension dimension)

removeDimension

public Dimension removeDimension(Dimension.Anchor anchor)

getMixedMaterial

public MixedMaterial getMixedMaterial(int index)

setMixedMaterial

public void setMixedMaterial(int index,
                             MixedMaterial material)

getMinHeight

public int getMinHeight()

setMinHeight

public void setMinHeight(int minHeight)

getMaxHeight

public int getMaxHeight()

setMaxHeight

public void setMaxHeight(int maxHeight)

getGenerator

@Deprecated
public Generator getGenerator()

Deprecated. Use Dimension.getGenerator().

Returns the generator type setting of the surface dimension.

getPlatform

public Platform getPlatform()

setPlatform

public void setPlatform(Platform platform)

isAskToConvertToAnvil

public boolean isAskToConvertToAnvil()

setAskToConvertToAnvil

public void setAskToConvertToAnvil(boolean askToConvertToAnvil)

isAskToRotate

public boolean isAskToRotate()

setAskToRotate

public void setAskToRotate(boolean askToRotate)

getUpIs

public Direction getUpIs()

setUpIs

public void setUpIs(Direction upIs)

isAllowMerging

public boolean isAllowMerging()

setAllowMerging

public void setAllowMerging(boolean allowMerging)

isAllowCheats

public boolean isAllowCheats()

setAllowCheats

public void setAllowCheats(boolean allowCheats)

getGeneratorOptions

@Deprecated
public java.lang.String getGeneratorOptions()

Deprecated. Use Dimension.getGenerator().

Returns the custom generator name setting of the surface dimension, or null if the surface dimension generator is not a custom generator.

isExtendedBlockIds

public boolean isExtendedBlockIds()

setExtendedBlockIds

public void setExtendedBlockIds(boolean extendedBlockIds)

getDifficulty

public int getDifficulty()

setDifficulty

public void setDifficulty(int difficulty)

getExportSettings

public WorldExportSettings getExportSettings()

setExportSettings

public void setExportSettings(WorldExportSettings exportSettings)

getHistory

public java.util.List<HistoryEntry> getHistory()

addHistoryEntry

public void addHistoryEntry(int key,
                            java.io.Serializable... args)

getMetadata

public java.util.Map<java.lang.String,java.lang.Object> getMetadata()

setMetadata

public void setMetadata(java.util.Map<java.lang.String,java.lang.Object> metadata)

getBorderSettings

public World2.BorderSettings getBorderSettings()

getMergedWith

public java.io.File getMergedWith()

The level.dat file of the map with which this world was last Merged.

setMergedWith

public void setMergedWith(java.io.File mergedWith)

getDataPacks

public java.util.List<java.io.File> getDataPacks()

setDataPacks

public void setDataPacks(java.util.List<java.io.File> dataPacks)

getSpawnPointDimension

public Dimension.Anchor getSpawnPointDimension()

setSpawnPointDimension

public void setSpawnPointDimension(Dimension.Anchor spawnPointDimension)

getAttribute

public <T> java.util.Optional<T> getAttribute(org.pepsoft.util.AttributeKey<T> key)

setAttribute

public <T> void setAttribute(org.pepsoft.util.AttributeKey<T> key,
                             T value)

transform

public void transform(CoordinateTransform transform,
                      org.pepsoft.util.ProgressReceiver progressReceiver)
               throws org.pepsoft.util.ProgressReceiver.OperationCancelled

Transforms all dimensions of this world horizontally. If an undo manager is installed this operation will destroy all undo info.

Parameters:

transform - The coordinate transform to apply.

progressReceiver - A progress receiver which will be informed of rotation progress.

Throws:

org.pepsoft.util.ProgressReceiver.OperationCancelled

transform

public void transform(Dimension.Anchor anchor,
                      CoordinateTransform transform,
                      org.pepsoft.util.ProgressReceiver progressReceiver)
               throws org.pepsoft.util.ProgressReceiver.OperationCancelled

Transforms one dimension horizontally. If it's the surface dimension also transforms any surface-related metadata stored in the world. If an undo manager is installed this operation will destroy all undo info.

Parameters:

anchor - The anchor of the dimension to transform.

transform - The coordinate transform to apply.

progressReceiver - A progress receiver which will be informed of rotation progress.

Throws:

org.pepsoft.util.ProgressReceiver.OperationCancelled

clearLayerData

public void clearLayerData(Layer layer)

measureSize

public long measureSize()

save

public void save(java.util.zip.ZipOutputStream out)
          throws java.io.IOException

Throws:

java.io.IOException