Package com.sk89q.worldedit.extent.world
Class SideEffectExtent
java.lang.Object
com.sk89q.worldedit.extent.AbstractDelegateExtent
com.sk89q.worldedit.extent.world.SideEffectExtent
- All Implemented Interfaces:
Extent
,InputExtent
,OutputExtent
An extent that sets blocks in the world, with a
SideEffectSet
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected Operation
boolean
boolean
boolean
setBiome
(BlockVector3 position, BiomeType biome) Set the biome.<B extends BlockStateHolder<B>>
booleansetBlock
(BlockVector3 location, B block) Change the block at the given location to the given block.void
setPostEditSimulationEnabled
(boolean enabled) void
setSideEffectSet
(SideEffectSet sideEffectSet) Methods inherited from class com.sk89q.worldedit.extent.AbstractDelegateExtent
commit, createEntity, fullySupports3DBiomes, getBiome, getBlock, getEntities, getEntities, getExtent, getFullBlock, getMaximumPoint, getMinimumPoint
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
-
SideEffectExtent
Create a new instance.- Parameters:
world
- the world
-
-
Method Details
-
isPostEditSimulationEnabled
public boolean isPostEditSimulationEnabled() -
setPostEditSimulationEnabled
public void setPostEditSimulationEnabled(boolean enabled) -
getSideEffectSet
-
setSideEffectSet
-
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
-
setBiome
Description copied from interface:OutputExtent
Set the biome.As implementation varies per Minecraft version, this may set more than this position's biome. On versions prior to 1.15, this will set the entire column. On later versions it will set the 4x4x4 cube.
- Specified by:
setBiome
in interfaceOutputExtent
- Overrides:
setBiome
in classAbstractDelegateExtent
- Parameters:
position
- the (x, y, z) location to set the biome atbiome
- the biome to set to- Returns:
- true if the biome was successfully set (return value may not be accurate)
-
commitRequired
public boolean commitRequired() -
commitBefore
- Overrides:
commitBefore
in classAbstractDelegateExtent
-