ForestGenerator (worldedit-core 7.3.0 API)

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

Description

ForestGenerator(EditSession editSession, TreeGenerator.TreeType treeType)

Create a new instance.
Method Summary

Modifier and Type

Method

Description

boolean

apply(BlockVector3 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 Details
- ForestGenerator
  
  public ForestGenerator(EditSession editSession, TreeGenerator.TreeType treeType)
  
  Create a new instance.
  
  Parameters:
  
  editSession - the edit session
  
  treeType - a tree generator
Method Details
- apply
  
  public boolean apply(BlockVector3 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