org.pepsoft.worldpainter.layers.plants

Class Plant

java.lang.Object

org.pepsoft.worldpainter.layers.plants.Plant

All Implemented Interfaces:

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

public abstract class Plant
extends java.lang.Object
implements WPObject

A plant.

See Also:

Serialized Form

Nested Class Summary

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

WPObject.BlockVisitor

Field Summary

Fields

Modifier and Type	Field and Description
protected Category[]	categories
protected java.lang.String	iconName
protected Material	material
protected java.lang.String	name

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

Modifier	Constructor and Description
protected	Plant(java.lang.String name, Material material, java.lang.String iconName, Category... categories)

Method Summary

Modifier and Type	Method and Description
WPObject	clone() Create a clone of the object.
java.util.Map<java.lang.String,java.io.Serializable>	getAttributes() Get a live view of the object metadata.
Category[]	getCategories() Get the categories of the plant.
int	getDefaultGrowth() The default growth stage to present to the user.
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.
int	getMaxGrowth() Get the maximum growth stage of this plant, where 1 is the minimum growth stage.
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.
Category	isValidFoundation(MinecraftWorld world, int x, int y, int height, boolean checkBlockBelow) Determine whether the block at a particular location in a particular map is a valid foundation on which to place this plant.
void	prepareForExport(Dimension dimension) Make preparations, if necessary, for exporting the object.
Plant	realise(int growth, Platform platform) Obtain a version of the plant suitable for actually placing in a map.
<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.
java.lang.String	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, getAllMaterials, getAttribute, getDimensions, guessConnectBlocks, guessManageWaterlogged, guestimateOffset, hasAttribute, visitBlocks

Field Detail

name

protected final java.lang.String name

iconName

protected final java.lang.String iconName

material

protected final Material material

categories

protected final Category[] categories

Constructor Detail

Plant

protected Plant(java.lang.String name,
                Material material,
                java.lang.String iconName,
                Category... categories)

Method Detail

getCategories

public final Category[] getCategories()

Get the categories of the plant. If there is more than one, the first one is considered the "main" category.

Returns:

The categories of the plant.

isValidFoundation

public Category isValidFoundation(MinecraftWorld world,
                                  int x,
                                  int y,
                                  int height,
                                  boolean checkBlockBelow)

Determine whether the block at a particular location in a particular map is a valid foundation on which to place this plant. This will always be invoked by PlantLayerExporter before exporting a plant.

Parameters:

world - The map in which to check the foundation.

x - The X coordinate (in the WorldPainter coordinate system) to check.

y - The Y coordinate (in the WorldPainter coordinate system) to check.

height - The Z coordinate (in the WorldPainter coordinate system) to check.

checkBlockBelow - Whether the block underneath the plant should be checked for validity.

Returns:

The applicable category if this plant may be placed on the block at the specified location; null otherwise.

getMaxGrowth

public int getMaxGrowth()

Get the maximum growth stage of this plant, where 1 is the minimum growth stage. Should be 1 for plants without growth stages.

Returns:

The maximum growth stage of this plant.

getDefaultGrowth

public int getDefaultGrowth()

The default growth stage to present to the user. The intent is for this to be the maximum height of plants that vanilla Minecraft will generate, with maxGrowth optionally being higher.

Returns:

The default growth stage to present to the user.

realise

public Plant realise(int growth,
                     Platform platform)

Obtain a version of the plant suitable for actually placing in a map. This will always be invoked by PlantLayerExporter before exporting a plant. It is meant for plants with varying growth stages and/ or which will return different materials for different platforms. Implementations to which neither applies may simply return themselves.

Parameters:

growth - The growth stage of the plant to export. Always 1 for plants without growth stages.

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

Returns:

A version of the plant configured for the specified growth stage and platform.

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.

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.

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.

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.

clone

public WPObject 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 java.lang.Object

Returns:

A clone of the object.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object