Package com.sk89q.worldedit.extent.reorder

Class ChunkBatchingExtent

java.lang.Object
com.sk89q.worldedit.extent.AbstractDelegateExtent
com.sk89q.worldedit.extent.AbstractBufferingExtent
com.sk89q.worldedit.extent.reorder.ChunkBatchingExtent
All Implemented Interfaces:
Extent, InputExtent, OutputExtent
public class ChunkBatchingExtent extends AbstractBufferingExtent
A special extent that batches changes into Minecraft chunks. This helps improve the speed of setting the blocks, since chunks do not need to be loaded repeatedly, however it does take more memory due to caching the blocks.

  • Constructor Details

    • ChunkBatchingExtent

      public ChunkBatchingExtent(Extent extent)

    • ChunkBatchingExtent

      public ChunkBatchingExtent(Extent extent, boolean enabled)

  • Method Details

    • isEnabled

      public boolean isEnabled()

    • setEnabled

      public void setEnabled(boolean enabled)

    • commitRequired

      public boolean commitRequired()

    • 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
      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

    • 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

    • commitBefore

      protected Operation commitBefore()
      Overrides:
      commitBefore in class AbstractDelegateExtent