Class BlockTransformExtent
- All Implemented Interfaces:
Extent
,InputExtent
,OutputExtent
-
Constructor Summary
ConstructorDescriptionBlockTransformExtent
(Extent extent, Transform transform) Create a new instance. -
Method Summary
Modifier and TypeMethodDescriptiongetBlock
(BlockVector3 position) Get a snapshot of the block at the given location.getFullBlock
(BlockVector3 position) Get a immutable snapshot of the block at the given location.Get the transform.<B extends BlockStateHolder<B>>
booleansetBlock
(BlockVector3 location, B block) Change the block at the given location to the given block.static <B extends BlockStateHolder<B>>
BTransform the given block using the given transform.Methods inherited from class com.sk89q.worldedit.extent.AbstractDelegateExtent
commit, commitBefore, createEntity, fullySupports3DBiomes, getBiome, getEntities, getEntities, getExtent, 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
-
BlockTransformExtent
Create a new instance.- Parameters:
extent
- the extent
-
-
Method Details
-
getTransform
Get the transform.- Returns:
- the transform
-
getBlock
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
Pattern
s and so on.- Specified by:
getBlock
in interfaceInputExtent
- Overrides:
getBlock
in classAbstractDelegateExtent
- Parameters:
position
- position of the block- Returns:
- the block
-
getFullBlock
Description copied from interface:InputExtent
Get a immutable snapshot of the block at the given location.- Specified by:
getFullBlock
in interfaceInputExtent
- Overrides:
getFullBlock
in classAbstractDelegateExtent
- Parameters:
position
- position of the block- Returns:
- the block
-
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 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:
location
- 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
-
transform
Transform the given block using the given transform.The provided block is not modified.
- Parameters:
block
- the blocktransform
- the transform- Returns:
- the same block
-