com.sk89q.worldedit.function.mask

Class BoundedHeightMask

java.lang.Object

com.sk89q.worldedit.function.mask.AbstractMask

com.sk89q.worldedit.function.mask.BoundedHeightMask

All Implemented Interfaces:

Mask

public class BoundedHeightMask
extends AbstractMask

Has the criteria where the Y value of passed positions must be within a certain range of Y values (inclusive).

Constructor Summary

Constructors

Constructor and Description
BoundedHeightMask(int minY, int maxY) Create a new bounded height mask.

Method Summary

Modifier and Type	Method and Description
boolean	test(Vector 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

Constructor Detail

BoundedHeightMask

public BoundedHeightMask(int minY,
                         int maxY)

Create a new bounded height mask.

Parameters:

minY - the minimum Y

maxY - the maximum Y (must be equal to or greater than minY)

Method Detail

test

public boolean test(Vector 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