Class MaskingExtent

All Implemented Interfaces:
Filter, IBatchProcessor, Extent, InputExtent, OutputExtent

public class MaskingExtent extends AbstractDelegateExtent implements IBatchProcessor, Filter
Requires that all mutating methods pass a given Mask.
  • Constructor Details

    • MaskingExtent

      public MaskingExtent(Extent extent, Mask mask)
      Create a new instance.
      Parameters:
      extent - the extent
      mask - the mask
  • Method Details

    • getMask

      public Mask getMask()
      Get the mask.
      Returns:
      the mask
    • setMask

      public void setMask(Mask mask)
      Set a mask.
      Parameters:
      mask - a mask
    • setBlock

      public <B extends BlockStateHolder<B>> boolean setBlock(BlockVector3 location, B block) throws WorldEditException
      Description copied from interface: OutputExtent
      Change the block at the given location to the given block. The operation may not tie the given BlockStateHolder to the world, so future changes to the BlockStateHolder do not affect the world until this method is called again.

      The return value of this method indicates whether the change was probably successful. It may not be successful if, for example, the location is out of the bounds of the extent. It may be unsuccessful if the block passed is the same as the one in the world. However, the return value is only an estimation and it may be incorrect, but it could be used to count, for example, the approximate number of changes.

      Specified by:
      setBlock in interface OutputExtent
      Overrides:
      setBlock in class AbstractDelegateExtent
      Parameters:
      location - position of the block
      block - block to set
      Returns:
      true if the block was successfully set (return value may not be accurate)
      Throws:
      WorldEditException - thrown on an error
    • setBiome

      public boolean setBiome(int x, int y, int z, BiomeType biome)
      Specified by:
      setBiome in interface OutputExtent
      Overrides:
      setBiome in class AbstractDelegateExtent
    • processSet

      public IChunkSet processSet(IChunk chunk, IChunkGet get, IChunkSet set)
      Description copied from interface: IBatchProcessor
      Process a chunk that has been set.
      Specified by:
      processSet in interface IBatchProcessor
    • applyBlock

      public void applyBlock(FilterBlock block)
      Description copied from interface: Filter
      Make changes to the block here
      - e.g., block.setId(...)
      - Note: Performance is critical here
      Specified by:
      applyBlock in interface Filter
    • construct

      public Extent construct(Extent child)
      Description copied from interface: IBatchProcessor
      Convert this processor into an Extent based processor instead of a queue batch based one.
      Specified by:
      construct in interface IBatchProcessor
    • fork

      public Filter fork()
      Description copied from interface: Filter
      Fork this for use by another thread - Typically filters are simple and don't need to create another copy to be thread safe here
      Specified by:
      fork in interface Filter
      Returns:
      this
    • getScope

      public ProcessorScope getScope()
      Description copied from interface: IBatchProcessor
      Default to CUSTOM ProcessorScope as we want custom processors people add to be before we write history, but after FAWE does it's own stuff.
      Specified by:
      getScope in interface IBatchProcessor