Package com.sk89q.worldedit.function.mask

Interface Mask

All Known Implementing Classes:
AbstractExtentMask, AbstractMask, BiomeMask, BlockCategoryMask, BlockMask, BlockStateMask, BlockTypeMask, BoundedHeightMask, ExistingBlockMask, ExpressionMask, MaskIntersection, MaskMemoizer, MaskUnion, NoiseFilter, OffsetMask, OffsetsMask, RegionMask, SolidBlockMask, SplatterMask
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface Mask
Tests whether a given vector meets a criteria.

  • Method Summary

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

  • Method Details

    • test

      boolean test(BlockVector3 vector)
      Returns true if the criteria is met.
      Parameters:
      vector - the vector to test
      Returns:
      true if the criteria is met

    • toMask2D

      @Nullable default Mask2D toMask2D()
      Get the 2D version of this mask if one exists.
      Returns:
      a 2D mask version or null if this mask can't be 2D