Package com.sk89q.worldedit.extent.buffer

Class ExtentBuffer

java.lang.Object
com.sk89q.worldedit.extent.AbstractDelegateExtent
com.sk89q.worldedit.extent.AbstractBufferingExtent
com.sk89q.worldedit.extent.buffer.ExtentBuffer
All Implemented Interfaces:
Extent, InputExtent, OutputExtent
public class ExtentBuffer extends AbstractBufferingExtent
Buffers changes to an Extent and allows retrieval of the changed blocks, without modifying the underlying extent.

  • Constructor Details

    • ExtentBuffer

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

    • ExtentBuffer

      public ExtentBuffer(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

    • getBufferedFullBlock

      protected BaseBlock getBufferedFullBlock(BlockVector3 position)
      Description copied from class: AbstractBufferingExtent
      Gets a block from the buffer, or null if not buffered.
      Overrides:
      getBufferedFullBlock in class AbstractBufferingExtent
      Parameters:
      position - The position
      Returns:
      The buffered block, or null

    • setBlock

      public <T extends BlockStateHolder<T>> boolean setBlock(BlockVector3 location, T 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
      Specified by:
      setBlock in class AbstractBufferingExtent
      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