FlatRegionMaskingFilter (worldedit-core 7.3.0 API)

java.lang.Object

com.sk89q.worldedit.function.FlatRegionMaskingFilter

All Implemented Interfaces:: FlatRegionFunction

public class FlatRegionMaskingFilter extends Object implements FlatRegionFunction

Passes calls to apply(BlockVector2) to the delegate FlatRegionFunction if they match the given mask.

Constructor Summary

Constructors

Constructor

Description

FlatRegionMaskingFilter(Mask2D mask, FlatRegionFunction function)

Create a new masking filter.
Method Summary

Modifier and Type

Method

Description

boolean

apply(BlockVector2 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
- FlatRegionMaskingFilter
  
  public FlatRegionMaskingFilter(Mask2D mask, FlatRegionFunction function)
  
  Create a new masking filter.
  
  Parameters:
  
  mask - the mask
  
  function - the delegate function to call
Method Details
- apply
  
  public boolean apply(BlockVector2 position) throws WorldEditException
  
  Description copied from interface: FlatRegionFunction
  
  Apply the function to the given position.
  
  Specified by:
  
  apply in interface FlatRegionFunction
  
  Parameters:
  
  position - the position
  
  Returns:
  
  true if something was changed
  
  Throws:
  
  WorldEditException - thrown on an error