Package com.sk89q.worldedit.extent.validation

Class BlockChangeLimiter

java.lang.Object
com.sk89q.worldedit.extent.AbstractDelegateExtent
com.sk89q.worldedit.extent.validation.BlockChangeLimiter
All Implemented Interfaces:
Extent, InputExtent, OutputExtent
public class BlockChangeLimiter extends AbstractDelegateExtent
Limits the number of blocks that can be changed before a MaxChangedBlocksException is thrown.

  • Constructor Details

    • BlockChangeLimiter

      public BlockChangeLimiter(Extent extent, int limit)
      Create a new instance.
      Parameters:
      extent - the extent
      limit - the limit (>= 0) or -1 for no limit

  • Method Details

    • getLimit

      public int getLimit()
      Get the limit.
      Returns:
      the limit (>= 0) or -1 for no limit

    • setLimit

      public void setLimit(int limit)
      Set the limit.
      Parameters:
      limit - the limit (>= 0) or -1 for no limit

    • getCount

      public int getCount()
      Get the number of blocks that have been counted so far.
      Returns:
      the number of blocks

    • 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