public class BlockTransformExtent extends AbstractDelegateExtent
Constructor and Description |
---|
BlockTransformExtent(Extent extent,
Transform transform,
BlockRegistry blockRegistry)
Create a new instance.
|
Modifier and Type | Method and Description |
---|---|
BaseBlock |
getBlock(Vector position)
Get a snapshot of the block at the given location.
|
BaseBlock |
getLazyBlock(Vector position)
Get a lazy, immutable snapshot of the block at the given location that only
immediately contains information about the block's type (and metadata).
|
Transform |
getTransform()
Get the transform.
|
boolean |
setBlock(Vector location,
BaseBlock block)
Change the block at the given location to the given block.
|
static BaseBlock |
transform(BaseBlock block,
Transform transform,
BlockRegistry registry)
Transform the given block using the given transform.
|
commit, commitBefore, createEntity, getBiome, getEntities, getEntities, getExtent, getMaximumPoint, getMinimumPoint, setBiome
public BlockTransformExtent(Extent extent, Transform transform, BlockRegistry blockRegistry)
extent
- the extentblockRegistry
- the block registry used for block direction datapublic Transform getTransform()
public BaseBlock getBlock(Vector position)
InputExtent
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 mutable 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.
Calls to this method can actually be quite expensive, so cache results
whenever it is possible, while being aware of the mutability aspect.
The cost, however, depends on the implementation and particular extent.
If only basic information about the block is required, then use of
InputExtent.getLazyBlock(Vector)
is recommended.
getBlock
in interface InputExtent
getBlock
in class AbstractDelegateExtent
position
- position of the blockpublic BaseBlock getLazyBlock(Vector position)
InputExtent
Further information (such as NBT data) will be available by the time of access. Therefore, it is not recommended that this method is used if the world is being simulated at the time of call. If the block needs to be stored for future use, then this method should definitely not be used. Moreover, the block that is returned is immutable (or should be), and therefore modifications should not be attempted on it. If a modifiable copy is required, then the block should be cloned.
This method exists because it is sometimes important to inspect the block
at a given location, but InputExtent.getBlock(Vector)
may be too expensive in
the underlying implementation. It is also not possible to implement
caching if the returned object is mutable, so this methods allows caching
implementations to be used.
getLazyBlock
in interface InputExtent
getLazyBlock
in class AbstractDelegateExtent
position
- position of the blockpublic boolean setBlock(Vector location, BaseBlock block) throws WorldEditException
OutputExtent
BaseBlock
to the world, so future changes to the
BaseBlock
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.
setBlock
in interface OutputExtent
setBlock
in class AbstractDelegateExtent
location
- position of the blockblock
- block to setWorldEditException
- thrown on an errorpublic static BaseBlock transform(BaseBlock block, Transform transform, BlockRegistry registry)
The provided block is modified.
block
- the blocktransform
- the transformregistry
- the registry