Package com.sk89q.worldedit.extent.inventory

Class BlockBagExtent

java.lang.Object
com.sk89q.worldedit.extent.AbstractDelegateExtent
com.sk89q.worldedit.extent.inventory.BlockBagExtent
All Implemented Interfaces:
Extent, InputExtent, OutputExtent
public class BlockBagExtent extends AbstractDelegateExtent
Applies a BlockBag to operations.

  • Constructor Details

    • BlockBagExtent

      public BlockBagExtent(Extent extent, @Nullable BlockBag blockBag)
      Create a new instance.
      Parameters:
      extent - the extent
      blockBag - the block bag

  • Method Details

    • getBlockBag

      @Nullable public BlockBag getBlockBag()
      Get the block bag.
      Returns:
      a block bag, which may be null if none is used

    • setBlockBag

      public void setBlockBag(@Nullable BlockBag blockBag)
      Set the block bag.
      Parameters:
      blockBag - a block bag, which may be null if none is used

    • popMissing

      public Map<BlockType,Integer> popMissing()
      Gets the list of missing blocks and clears the list for the next operation.
      Returns:
      a map of missing blocks

    • setBlock

      public <B extends BlockStateHolder<B>> boolean setBlock(BlockVector3 position, 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:
      position - 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