com.sk89q.worldedit.function.generator

Class ForestGenerator

java.lang.Object

com.sk89q.worldedit.function.generator.ForestGenerator

All Implemented Interfaces:

RegionFunction

public class ForestGenerator
extends Object
implements RegionFunction

Generates forests by searching for the ground starting from the given upper Y coordinate for every column given.

Constructor Summary

Constructors

Constructor and Description
ForestGenerator(EditSession editSession, TreeGenerator treeGenerator) Create a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	apply(Vector position) Apply the function to the given position.

Methods inherited from class java.lang.Object

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

Constructor Detail

ForestGenerator

public ForestGenerator(EditSession editSession,
                       TreeGenerator treeGenerator)

Create a new instance.

Parameters:

editSession - the edit session

treeGenerator - a tree generator

Method Detail

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