net.glowstone.generator.objects.trees

Class SwampTree

java.lang.Object

net.glowstone.generator.objects.trees.GenericTree

net.glowstone.generator.objects.trees.JungleTree

net.glowstone.generator.objects.trees.CocoaTree

net.glowstone.generator.objects.trees.SwampTree

All Implemented Interfaces:

TerrainObject

public class SwampTree
extends CocoaTree

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.collect.ImmutableList<org.bukkit.Material>	WATER_BLOCK_TYPES

Fields inherited from class net.glowstone.generator.objects.trees.GenericTree

delegate, height, leavesType, logType, overridables

Fields inherited from interface net.glowstone.generator.objects.TerrainObject

PLANT_TYPES

Constructor Summary

Constructors

Constructor and Description
SwampTree(Random random, BlockStateDelegate delegate) Initializes this tree with a random height, preparing it to attempt to generate.

Method Summary

Modifier and Type	Method and Description
boolean	canPlace(int baseX, int baseY, int baseZ, org.bukkit.World world) Checks whether this tree has enough space to grow.
boolean	canPlaceOn(org.bukkit.block.BlockState soil) Checks whether this tree can grow on top of the given block.
boolean	generate(org.bukkit.World world, Random random, int blockX, int blockY, int blockZ) Generates this feature.

Methods inherited from class net.glowstone.generator.objects.trees.CocoaTree

addVinesOnLeaves

Methods inherited from class net.glowstone.generator.objects.trees.GenericTree

blockTypeAt, canHeightFit, cannotGenerateAt, generate, replaceIfAirOrLeaves, setHeight, setOverridables, setTypes

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.glowstone.generator.objects.TerrainObject

killPlantAbove

Field Detail

WATER_BLOCK_TYPES

public static final com.google.common.collect.ImmutableList<org.bukkit.Material> WATER_BLOCK_TYPES

Constructor Detail

SwampTree

public SwampTree(Random random,
                 BlockStateDelegate delegate)

Initializes this tree with a random height, preparing it to attempt to generate.

Parameters:

random - the PRNG

delegate - the BlockStateDelegate used to check for space and to fill wood and

Method Detail

canPlaceOn

public boolean canPlaceOn(org.bukkit.block.BlockState soil)

Description copied from class: GenericTree

Checks whether this tree can grow on top of the given block.

Overrides:

canPlaceOn in class GenericTree

Parameters:

soil - the block we're growing on

Returns:

true if this tree can grow on the type of block below it; false otherwise

canPlace

public boolean canPlace(int baseX,
                        int baseY,
                        int baseZ,
                        org.bukkit.World world)

Description copied from class: GenericTree

Checks whether this tree has enough space to grow.

Overrides:

canPlace in class GenericTree

Parameters:

baseX - the X coordinate of the base of the trunk

baseY - the Y coordinate of the base of the trunk

baseZ - the Z coordinate of the base of the trunk

world - the world to grow in

Returns:

true if this tree has space to grow; false otherwise

generate

public boolean generate(org.bukkit.World world,
                        Random random,
                        int blockX,
                        int blockY,
                        int blockZ)

Description copied from interface: TerrainObject

Generates this feature.

Specified by:

generate in interface TerrainObject

Overrides:

generate in class CocoaTree

Parameters:

world - the world to generate in

random - the PRNG that will choose the size and a few details of the shape

blockX - the base X coordinate

blockY - the base Y coordinate

blockZ - the base Z coordinate

Returns:

true if successfully generated