Package com.sk89q.worldedit.extent.buffer

Class ForgetfulExtentBuffer

java.lang.Object
com.sk89q.worldedit.extent.AbstractDelegateExtent
com.sk89q.worldedit.extent.buffer.ForgetfulExtentBuffer
All Implemented Interfaces:
Extent, InputExtent, OutputExtent, BiomePattern, Pattern
public class ForgetfulExtentBuffer extends AbstractDelegateExtent implements Pattern, BiomePattern
Buffers changes to an Extent and allows later retrieval for actual application of the changes.

This buffer will not attempt to return results from the buffer when accessor methods (such as AbstractDelegateExtent.getBlock(BlockVector3)) are called.

  • Constructor Details

    • ForgetfulExtentBuffer

      public ForgetfulExtentBuffer(Extent delegate)
      Create a new extent buffer that will buffer every change.
      Parameters:
      delegate - the delegate extent for InputExtent.getBlock(BlockVector3), etc. calls

    • ForgetfulExtentBuffer

      public ForgetfulExtentBuffer(Extent delegate, Mask mask)
      Create a new extent buffer that will buffer changes that meet the criteria of the given mask.
      Parameters:
      delegate - the delegate extent for InputExtent.getBlock(BlockVector3), etc. calls
      mask - the mask

  • Method Details

    • 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(BlockVector3 position, BiomeType biome)
      Description copied from interface: OutputExtent
      Set the biome.

      As implementation varies per Minecraft version, this may set more than this position's biome. On versions prior to 1.15, this will set the entire column. On later versions it will set the 4x4x4 cube.

      Specified by:
      setBiome in interface OutputExtent
      Overrides:
      setBiome in class AbstractDelegateExtent
      Parameters:
      position - the (x, y, z) location to set the biome at
      biome - the biome to set to
      Returns:
      true if the biome was successfully set (return value may not be accurate)

    • applyBlock

      public BaseBlock applyBlock(BlockVector3 pos)
      Description copied from interface: Pattern
      Return a BaseBlock for the given position.
      Specified by:
      applyBlock in interface Pattern
      Parameters:
      pos - the position
      Returns:
      a block

    • applyBiome

      public BiomeType applyBiome(BlockVector3 pos)
      Description copied from interface: BiomePattern
      Return a BiomeType for the given position.
      Specified by:
      applyBiome in interface BiomePattern
      Parameters:
      pos - the position
      Returns:
      a biome

    • asRegion

      public Region asRegion()
      Return a region representation of this buffer.
      Returns:
      a region