Package com.sk89q.worldedit.extent

Class AbstractBufferingExtent

java.lang.Object
com.sk89q.worldedit.extent.AbstractDelegateExtent
com.sk89q.worldedit.extent.AbstractBufferingExtent
All Implemented Interfaces:
Extent, InputExtent, OutputExtent
Direct Known Subclasses:
ChunkBatchingExtent, ExtentBuffer, MultiStageReorder
public abstract class AbstractBufferingExtent extends AbstractDelegateExtent
Base extent class for buffering changes between setBlock(BlockVector3, BlockStateHolder) and the delegate extent. This class ensures that getBlock(BlockVector3) is properly handled, by returning buffered blocks.

  • Constructor Details

    • AbstractBufferingExtent

      protected AbstractBufferingExtent(Extent extent)
      Create a new instance.
      Parameters:
      extent - the extent

  • Method Details

    • setBlock

      public abstract <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
      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

    • setDelegateBlock

      protected final <T extends BlockStateHolder<T>> boolean setDelegateBlock(BlockVector3 location, T block) throws WorldEditException
      Throws:
      WorldEditException

    • getBlock

      public BlockState getBlock(BlockVector3 position)
      Description copied from interface: InputExtent
      Get a snapshot of the block at the given location.

      If the given position is out of the bounds of the extent, then the behavior is undefined (an air block could be returned). However, null should not be returned.

      The returned block is immutable and is a snapshot of the block at the time of call. It has no position attached to it, so it could be reused in Patterns and so on.

      Specified by:
      getBlock in interface InputExtent
      Overrides:
      getBlock in class AbstractDelegateExtent
      Parameters:
      position - position of the block
      Returns:
      the block

    • getFullBlock

      public BaseBlock getFullBlock(BlockVector3 position)
      Description copied from interface: InputExtent
      Get an immutable snapshot of the block at the given location.
      Specified by:
      getFullBlock in interface InputExtent
      Overrides:
      getFullBlock in class AbstractDelegateExtent
      Parameters:
      position - position of the block
      Returns:
      the block

    • getBufferedBlock

      @Deprecated protected Optional<BaseBlock> getBufferedBlock(BlockVector3 position)
      Deprecated.
      New subclasses should override getBufferedFullBlock(BlockVector3) instead
      Gets a block from the buffer.

    • getBufferedFullBlock

      @NonAbstractForCompatibility(delegateName="getBufferedBlock", delegateParams=BlockVector3.class) @Nullable protected BaseBlock getBufferedFullBlock(BlockVector3 position)
      Gets a block from the buffer, or null if not buffered.
      Parameters:
      position - The position
      Returns:
      The buffered block, or null