Package com.sk89q.worldedit.function.mask

Class ExistingBlockMask

java.lang.Object

com.sk89q.worldedit.function.mask.AbstractMask

com.sk89q.worldedit.function.mask.AbstractExtentMask

com.sk89q.worldedit.function.mask.ExistingBlockMask

All Implemented Interfaces:

Mask

public class ExistingBlockMask
extends AbstractExtentMask

A mask that returns true whenever the block at the location is not an air block (it contains some other block).

Constructor Summary

Constructors

Constructor	Description
ExistingBlockMask(Extent extent)	Create a new existing block map.

Method Summary

Modifier and Type	Method	Description
Mask	copy()	Returns a copy of the mask.
boolean	test(Extent extent, BlockVector3 vector)
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 com.sk89q.worldedit.function.mask.AbstractExtentMask

getExtent, setExtent

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

ExistingBlockMask

public ExistingBlockMask(Extent extent)

Create a new existing block map.

Parameters:

extent - the extent to check

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

test

public boolean test(Extent extent,
 BlockVector3 vector)

Specified by:

test in class AbstractExtentMask

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