Package com.sk89q.worldedit.function.mask

Class ExpressionMask

java.lang.Object

com.sk89q.worldedit.function.mask.AbstractMask

com.sk89q.worldedit.function.mask.ExpressionMask

All Implemented Interfaces:

Mask

public class ExpressionMask
extends AbstractMask

A mask that evaluates an expression.

Expressions are evaluated as true if they return a value greater than 0.

Constructor Summary

Constructors

Constructor	Description
ExpressionMask(Expression expression)	Create a new instance.
ExpressionMask(Expression expression, IntSupplier timeout)
ExpressionMask(String expression)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
Mask	copy()	Returns a copy of the mask.
boolean	test(BlockVector3 vector)	Returns true if the criteria is met.
Mask2D	toMask2D()	Get the 2D version of this mask if one exists.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sk89q.worldedit.function.mask.Mask

inverse, optimize, replacesAir, toFilter, toFilter, tryCombine, tryOptimize, tryOr

Constructor Details

ExpressionMask

public ExpressionMask(String expression)
               throws ExpressionException

Create a new instance.

Parameters:

expression - the expression

Throws:

ExpressionException - thrown if there is an error with the expression

ExpressionMask

public ExpressionMask(Expression expression)

Create a new instance.

Parameters:

expression - the expression

ExpressionMask

public ExpressionMask(Expression expression,
 @Nullable
 IntSupplier timeout)

Method Details

test

public boolean test(BlockVector3 vector)

Description copied from interface: Mask

Returns true if the criteria is met.

Parameters:

vector - the vector to test

Returns:

true if the criteria is met

toMask2D

@Nullable
public Mask2D toMask2D()

Description copied from interface: Mask

Get the 2D version of this mask if one exists.

Returns:

a 2D mask version or null if this mask can't be 2D

copy

public Mask copy()

Description copied from interface: Mask

Returns a copy of the mask. Usually for multi-threaded operation

Returns:

a clone of the mask