RegionMaskingFilter (worldedit-core 7.3.1 API)

java.lang.Object

com.sk89q.worldedit.function.RegionMaskingFilter

All Implemented Interfaces:: RegionFunction

public class RegionMaskingFilter extends Object implements RegionFunction

Passes calls to apply(BlockVector3) to the delegate RegionFunction if they match the given mask.

Constructor Summary

Constructors

Constructor

Description

RegionMaskingFilter(Mask mask, RegionFunction function)

Create a new masking filter.
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
- RegionMaskingFilter
  
  public RegionMaskingFilter(Mask mask, RegionFunction function)
  
  Create a new masking filter.
  
  Parameters:
  
  mask - the mask
  
  function - the function
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