com.sk89q.worldedit.function

Class RegionMaskingFilter

java.lang.Object

com.sk89q.worldedit.function.RegionMaskingFilter

All Implemented Interfaces:

RegionFunction

public class RegionMaskingFilter
extends Object
implements RegionFunction

Passes calls to apply(com.sk89q.worldedit.Vector) to the delegate RegionFunction if they match the given mask.

Constructor Summary

Constructors

Constructor and Description
RegionMaskingFilter(Mask mask, RegionFunction function) Create a new masking filter.

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

RegionMaskingFilter

public RegionMaskingFilter(Mask mask,
                           RegionFunction function)

Create a new masking filter.

Parameters:

mask - the mask

function - the function

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