com.sk89q.worldedit.function.mask

Class BiomeMask2D

java.lang.Object

com.sk89q.worldedit.function.mask.AbstractMask2D

com.sk89q.worldedit.function.mask.BiomeMask2D

All Implemented Interfaces:

Mask2D

public class BiomeMask2D
extends AbstractMask2D

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

Constructor Summary

Constructors

Constructor and Description
BiomeMask2D(Extent extent, BaseBiome... biome) Create a new biome mask.
BiomeMask2D(Extent extent, Collection<BaseBiome> biomes) Create a new biome mask.

Method Summary

Modifier and Type	Method and Description
void	add(BaseBiome... biome) Add the given biomes to the list of criteria.
void	add(Collection<BaseBiome> biomes) Add the given biomes to the list of criteria.
Collection<BaseBiome>	getBiomes() Get the list of biomes that are tested with.
boolean	test(Vector2D vector) Returns true if the criteria is met.

Methods inherited from class java.lang.Object

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

Constructor Detail

BiomeMask2D

public BiomeMask2D(Extent extent,
                   Collection<BaseBiome> biomes)

Create a new biome mask.

Parameters:

extent - the extent

biomes - a list of biomes to match

BiomeMask2D

public BiomeMask2D(Extent extent,
                   BaseBiome... biome)

Create a new biome mask.

Parameters:

extent - the extent

biome - an array of biomes to match

Method Detail

add

public void add(Collection<BaseBiome> biomes)

Add the given biomes to the list of criteria.

Parameters:

biomes - a list of biomes

add

public void add(BaseBiome... biome)

Add the given biomes to the list of criteria.

Parameters:

biome - an array of biomes

getBiomes

public Collection<BaseBiome> getBiomes()

Get the list of biomes that are tested with.

Returns:

a list of biomes

test

public boolean test(Vector2D vector)

Description copied from interface: Mask2D

Returns true if the criteria is met.

Parameters:

vector - the vector to test

Returns:

true if the criteria is met