com.sk89q.worldedit.generator

Class GardenPatchGenerator

java.lang.Object

com.sk89q.worldedit.generator.GardenPatchGenerator

All Implemented Interfaces:

RegionFunction

public class GardenPatchGenerator
extends Object
implements RegionFunction

Constructor Summary

Constructors

Constructor and Description
GardenPatchGenerator(EditSession editSession) Create a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	apply(Vector position) Apply the function to the given position.
int	getAffected() Get the number of affected blocks.
static Pattern	getMelonPattern() Get a pattern that creates melons.
Pattern	getPlant() Get the plant pattern that is placed.
static Pattern	getPumpkinPattern() Get a pattern that creates pumpkins with different faces.
void	setPlant(Pattern plant) Set the plant pattern that is placed.

Methods inherited from class java.lang.Object

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

Constructor Detail

GardenPatchGenerator

public GardenPatchGenerator(EditSession editSession)

Create a new instance.

Parameters:

editSession - the edit session

Method Detail

getPlant

public Pattern getPlant()

Get the plant pattern that is placed.

Returns:

the plant pattern

setPlant

public void setPlant(Pattern plant)

Set the plant pattern that is placed.

Parameters:

plant - the plant pattern

getAffected

public int getAffected()

Get the number of affected blocks.

Returns:

affected count

apply

public boolean apply(Vector position)
              throws WorldEditException

Description copied from interface: RegionFunction

Apply the function to the given position.

Specified by:

apply in interface RegionFunction

Parameters:

position - the position

Returns:

true if something was changed

Throws:

WorldEditException - thrown on an error

getPumpkinPattern

public static Pattern getPumpkinPattern()

Get a pattern that creates pumpkins with different faces.

Returns:

a pumpkin pattern

getMelonPattern

public static Pattern getMelonPattern()

Get a pattern that creates melons.

Returns:

a melon pattern