org.pepsoft.worldpainter.layers.bo2

Class Schem

java.lang.Object

org.pepsoft.minecraft.AbstractNBTItem

org.pepsoft.worldpainter.layers.bo2.Schem

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, NBTItem, WPObject

public final class Schem
extends AbstractNBTItem
implements WPObject

A Sponge schematic according to the specification at https://github.com/SpongePowered/Schematic-Specification/blob/master/versions/schematic-1.md.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.pepsoft.worldpainter.objects.WPObject

WPObject.BlockVisitor

Field Summary

Fields inherited from interface org.pepsoft.worldpainter.objects.WPObject

ATTRIBUTE_COLLISION_MODE, ATTRIBUTE_CONNECT_BLOCKS, ATTRIBUTE_EXTEND_FOUNDATION, ATTRIBUTE_FILE, ATTRIBUTE_FREQUENCY, ATTRIBUTE_HEIGHT_MODE, ATTRIBUTE_LEAF_DECAY_MODE, ATTRIBUTE_MANAGE_WATERLOGGED, ATTRIBUTE_NEEDS_FOUNDATION, ATTRIBUTE_OFFSET, ATTRIBUTE_RANDOM_MIRRORING_ONLY, ATTRIBUTE_RANDOM_ROTATION, ATTRIBUTE_RANDOM_ROTATION_ONLY, ATTRIBUTE_REPLACE_WITH_AIR, ATTRIBUTE_REPLACE_WITH_AIR_MATERIAL, ATTRIBUTE_SPAWN_IN_LAVA, ATTRIBUTE_SPAWN_IN_WATER, ATTRIBUTE_SPAWN_ON_LAND, ATTRIBUTE_SPAWN_ON_LAVA, ATTRIBUTE_SPAWN_ON_WATER, ATTRIBUTE_SPAWN_ON_WATER_NO_COLLIDE, ATTRIBUTE_UNDERGROUND_MODE, ATTRIBUTE_VERTICAL_OFFSET, ATTRIBUTE_Y_VARIATION, COLLISION_MODE_ALL, COLLISION_MODE_NONE, COLLISION_MODE_SOLID, HEIGHT_MODE_FIXED, HEIGHT_MODE_TERRAIN, LEAF_DECAY_NO_CHANGE, LEAF_DECAY_OFF, LEAF_DECAY_ON

Constructor Summary

Constructors

Constructor and Description
Schem(org.jnbt.CompoundTag tag, java.lang.String fallBackName)

Method Summary

Modifier and Type	Method and Description
Schem	clone() Create a clone of the object.
java.util.Set<Material>	getAllMaterials() Return all unique materials contained in this object.
java.util.Map<java.lang.String,java.io.Serializable>	getAttributes() Get a live view of the object metadata.
javax.vecmath.Point3i	getDimensions() Get the dimensions of the object.
java.util.List<Entity>	getEntities() Get any entities contained in the object.
boolean	getMask(int x, int y, int z) Determine whether a block should be placed at the specified relative coordinates.
Material	getMaterial(int x, int y, int z) Get the material to place at the specified relative coordinates.
java.lang.String	getName() Get the name of the object.
javax.vecmath.Point3i	getOffset() Get the offset to apply to this object when placing it.
java.util.List<TileEntity>	getTileEntities() Get any tile entities contained in the object.
static Schem	load(java.io.File file)
static Schem	load(java.io.InputStream stream, java.lang.String fallBackName)
void	prepareForExport(Dimension dimension) Make preparations, if necessary, for exporting the object.
<T extends java.io.Serializable> void	setAttribute(org.pepsoft.util.AttributeKey<T> key, T value) Convenience method for setting the value of an attribute stored in the external metadata, if any.
void	setAttributes(java.util.Map<java.lang.String,java.io.Serializable> attributes) Store external metadata about the object.
void	setName(java.lang.String name) Set the name of the object.

Methods inherited from class org.pepsoft.minecraft.AbstractNBTItem

containsTag, containsTag, containsType, forEachTag, getAllTags, getAllTags, getBoolean, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getByte, getByteArray, getByteArray, getDouble, getDouble, getDouble, getDouble, getDoubleList, getDoubleList, getFloat, getFloat, getFloat, getFloat, getFloatList, getFloatList, getInt, getInt, getInt, getInt, getIntArray, getIntArray, getList, getList, getLong, getLong, getLong, getLong, getLongArray, getLongArray, getMap, getMap, getShort, getShort, getShort, getShort, getString, getString, getString, getString, getTag, getTag, removeTag, removeTag, setBoolean, setBoolean, setByte, setByte, setByteArray, setByteArray, setDouble, setDouble, setDoubleList, setDoubleList, setFloat, setFloat, setFloatList, setFloatList, setInt, setInt, setIntArray, setIntArray, setList, setList, setLong, setLong, setLongArray, setLongArray, setMap, setMap, setShort, setShort, setString, setString, setTag, setTag, toMultipleNBT, toNBT, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepsoft.worldpainter.objects.WPObject

dump, getAttribute, guessConnectBlocks, guessManageWaterlogged, guestimateOffset, hasAttribute, visitBlocks

Constructor Detail

Schem

public Schem(org.jnbt.CompoundTag tag,
             java.lang.String fallBackName)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: WPObject

Get the name of the object.

Specified by:

getName in interface WPObject

Returns:

The name of the object.

setName

public void setName(java.lang.String name)

Description copied from interface: WPObject

Set the name of the object.

Specified by:

setName in interface WPObject

Parameters:

name - The new name of the object.

getDimensions

public javax.vecmath.Point3i getDimensions()

Description copied from interface: WPObject

Get the dimensions of the object.

Specified by:

getDimensions in interface WPObject

Returns:

The dimensions of the object.

getOffset

public javax.vecmath.Point3i getOffset()

Description copied from interface: WPObject

Get the offset to apply to this object when placing it. In other words these are the reverse of the coordinates of the "anchor" block of this object.

This is a convenience method which must return the same as invoking getAttribute(ATTRIBUTE_OFFSET). See WPObject.getAttribute(AttributeKey) and WPObject.ATTRIBUTE_OFFSET.

Specified by:

getOffset in interface WPObject

Returns:

The offset to apply to this object when placing it.

getMaterial

public Material getMaterial(int x,
                            int y,
                            int z)

Description copied from interface: WPObject

Get the material to place at the specified relative coordinates. Should only be invoked for coordinates for which WPObject.getMask(int, int, int) returns true. These coordinates are zero-based and must never be negative.

Specified by:

getMaterial in interface WPObject

Parameters:

x - The relative X coordinate.

y - The relative Y coordinate.

z - The relative Z coordinate.

Returns:

The material to place at the specified relative coordinates.

getMask

public boolean getMask(int x,
                       int y,
                       int z)

Description copied from interface: WPObject

Determine whether a block should be placed at the specified relative coordinates. These coordinates are zero-based and must never be negative.

Specified by:

getMask in interface WPObject

Parameters:

x - The relative X coordinate.

y - The relative Y coordinate.

z - The relative Z coordinate.

Returns:

true if a block should be placed at the specified relative coordinates.

getAllMaterials

public java.util.Set<Material> getAllMaterials()

Description copied from interface: WPObject

Return all unique materials contained in this object.

Specified by:

getAllMaterials in interface WPObject

Returns:

All unique materials contained in this object.

getEntities

public java.util.List<Entity> getEntities()

Description copied from interface: WPObject

Get any entities contained in the object. The entities' coordinates should be relative to the object, not absolute.

Specified by:

getEntities in interface WPObject

Returns:

Any entities contained in the object. May be null.

getTileEntities

public java.util.List<TileEntity> getTileEntities()

Description copied from interface: WPObject

Get any tile entities contained in the object. The entities' coordinates should be relative to the object, not absolute.

Specified by:

getTileEntities in interface WPObject

Returns:

Any tile entities contained in the object. May be null.

prepareForExport

public void prepareForExport(Dimension dimension)

Description copied from interface: WPObject

Make preparations, if necessary, for exporting the object. For example retrieving and applying a mapping. This method will be invoked by WorldPainter before WPObject.getMask(int, int, int) or WPObject.getMaterial(int, int, int) are invoked.

Specified by:

prepareForExport in interface WPObject

Parameters:

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

getAttributes

public java.util.Map<java.lang.String,java.io.Serializable> getAttributes()

Description copied from interface: WPObject

Get a live view of the object metadata.

Specified by:

getAttributes in interface WPObject

Returns:

A live view of the object metadata. May be null.

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.io.Serializable> attributes)

Description copied from interface: WPObject

Store external metadata about the object.

Specified by:

setAttributes in interface WPObject

Parameters:

attributes - The external metadata to store.

setAttribute

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

Description copied from interface: WPObject

Convenience method for setting the value of an attribute stored in the external metadata, if any. Setting the value to null will delete the attribute from the store. If the store becomes empty it is deleted entirely.

Specified by:

setAttribute in interface WPObject

Type Parameters:

T - The type of the attribute.

Parameters:

key - The key of the attribute to set or delete.

value - The value of the attribute to set, or null to delete it.

clone

public Schem clone()

Description copied from interface: WPObject

Create a clone of the object. The block data is immutable so may be shared, but all mutable settings are copied so they can be changed independently.

Specified by:

clone in interface WPObject

Overrides:

clone in class AbstractNBTItem

Returns:

A clone of the object.

load

public static Schem load(java.io.File file)
                  throws java.io.IOException

Throws:

java.io.IOException

load

public static Schem load(java.io.InputStream stream,
                         java.lang.String fallBackName)
                  throws java.io.IOException

Throws:

java.io.IOException