Class BiomeMask

java.lang.Object

com.sk89q.worldedit.function.mask.AbstractMask

com.sk89q.worldedit.function.mask.AbstractExtentMask

com.sk89q.worldedit.function.mask.BiomeMask

All Implemented Interfaces:

Mask

public class BiomeMask
extends AbstractExtentMask

Tests true if the biome at applied points is the same as the one given.

Constructor Summary

Constructors

Constructor	Description
BiomeMask(Extent extent, BiomeType... biome)	Create a new biome mask.
BiomeMask(Extent extent, Collection<BiomeType> biomes)	Create a new biome mask.

Method Summary

Modifier and Type	Method	Description
void	add(BiomeType... biome)	Add the given biomes to the list of criteria.
void	add(Collection<BiomeType> biomes)	Add the given biomes to the list of criteria.
Mask	copy()	Returns a copy of the mask.
Collection<BiomeType>	getBiomes()	Get the list of biomes that are tested with.
boolean	test(Extent extent, BlockVector3 position)
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 AbstractExtentMask

getExtent, setExtent

Methods inherited from class Object

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

Methods inherited from interface Mask

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

Constructor Details

BiomeMask

public BiomeMask(Extent extent,
 Collection<BiomeType> biomes)

Create a new biome mask.

Parameters:

extent - the extent

biomes - a list of biomes to match

BiomeMask

public BiomeMask(Extent extent,
 BiomeType... biome)

Create a new biome mask.

Parameters:

extent - the extent

biome - an array of biomes to match

Method Details

add

public void add(Collection<BiomeType> biomes)

Add the given biomes to the list of criteria.

Parameters:

biomes - a list of biomes

add

public void add(BiomeType... biome)

Add the given biomes to the list of criteria.

Parameters:

biome - an array of biomes

getBiomes

public Collection<BiomeType> getBiomes()

Get the list of biomes that are tested with.

Returns:

a list of biomes

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

test

public boolean test(Extent extent,
 BlockVector3 position)

Specified by:

test in class AbstractExtentMask