Class BlockBagExtent
java.lang.Object
com.sk89q.worldedit.extent.AbstractDelegateExtent
com.sk89q.worldedit.extent.inventory.BlockBagExtent
- All Implemented Interfaces:
Extent
,InputExtent
,OutputExtent
Applies a
BlockBag
to operations.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the block bag.Gets the list of missing blocks and clears the list for the next operation.<B extends BlockStateHolder<B>>
booleansetBlock
(BlockVector3 position, B block) Change the block at the given location to the given block.void
setBlockBag
(BlockBag blockBag) Set the block bag.Methods inherited from class com.sk89q.worldedit.extent.AbstractDelegateExtent
commit, commitBefore, createEntity, fullySupports3DBiomes, getBiome, getBlock, getEntities, getEntities, getExtent, getFullBlock, getMaximumPoint, getMinimumPoint, setBiome
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.sk89q.worldedit.extent.InputExtent
getBiome
Methods inherited from interface com.sk89q.worldedit.extent.OutputExtent
setBiome
-
Constructor Details
-
BlockBagExtent
Create a new instance.- Parameters:
extent
- the extentblockBag
- the block bag
-
-
Method Details
-
getBlockBag
Get the block bag.- Returns:
- a block bag, which may be null if none is used
-
setBlockBag
Set the block bag.- Parameters:
blockBag
- a block bag, which may be null if none is used
-
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 givenBlockStateHolder
to the world, so future changes to theBlockStateHolder
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 interfaceOutputExtent
- Overrides:
setBlock
in classAbstractDelegateExtent
- Parameters:
position
- position of the blockblock
- block to set- Returns:
- true if the block was successfully set (return value may not be accurate)
- Throws:
WorldEditException
- thrown on an error
-