Package com.sk89q.worldedit.extent
Interface InputExtent
- All Known Subinterfaces:
Clipboard
,Extent
,IChunk
,IChunkExtent<T>
,IChunkGet
,IQueueChunk<T>
,IQueueExtent<T>
,ReorderingExtent
,SimpleWorld
,World
- All Known Implementing Classes:
AbstractBufferingExtent
,AbstractDelegateExtent
,AbstractExtentFilterBlock
,AbstractFilterBlock
,AbstractSingleFilterBlock
,AbstractWorld
,ArrayFilterBlock
,BiomeQuirkExtent
,BlockArrayClipboard
,BlockBagExtent
,BlockChangeLimiter
,BlockQuirkExtent
,BlockTransformExtent
,BlockTranslateExtent
,ChangeSetExtent
,CharFilterBlock
,CharGetBlocks
,ChunkBatchingExtent
,ChunkFilterBlock
,ChunkHolder
,ChunkLoadingExtent
,CPUOptimizedClipboard
,DataValidatorExtent
,DisallowedBlocksExtent
,DiskOptimizedClipboard
,EditSession
,EmptyClipboard
,ExtentBatchProcessorHolder
,ExtentBuffer
,ExtentFilterBlock
,ExtentHeightCacher
,FaweRegionExtent
,FilterBlock
,ForgetfulExtentBuffer
,FuzzyRegionSelector
,HeightBoundExtent
,HistoryExtent
,LastAccessExtentCache
,LimitExtent
,Linear3DTransform
,LinearClipboard
,LinearTransform
,MaskingExtent
,MemoryCheckingExtent
,MemoryOptimizedClipboard
,MultiRegionExtent
,MultiStageReorder
,MultiTransform
,NullChunk
,NullChunkGet
,NullExtent
,NullExtent
,NullWorld
,OffsetTransform
,ParallelQueueExtent
,PassthroughExtent
,PatternTransform
,PositionTransformExtent
,ProcessedWEExtent
,RandomOffsetTransform
,RandomTransform
,ReadOnlyClipboard
,RequestExtent
,ResettableExtent
,ScaleTransform
,SelectTransform
,SideEffectExtent
,SimpleClipboard
,SingleFilterBlock
,SingleRegionExtent
,SingleThreadQueueExtent
,SlowExtent
,SourceMaskExtent
,StripNBTExtent
,SupplyingExtent
,SurvivalModeExtent
,TemporalExtent
,TracingExtent
,TransformExtent
,VectorizedCharFilterBlock
,WatchdogTickingExtent
,WorldCopyClipboard
,WorldWrapper
public interface InputExtent
Provides the current state of blocks, entities, and so on.
-
Method Summary
Modifier and TypeMethodDescriptiondefault BiomeType
getBiome
(BlockVector2 position) Deprecated.default BiomeType
getBiome
(BlockVector3 position) Get the biome at the given location.default BiomeType
getBiomeType
(int x, int y, int z) default BlockState
getBlock
(int x, int y, int z) default BlockState
getBlock
(BlockVector3 position) Get a snapshot of the block at the given location.default int
getBrightness
(int x, int y, int z) default int
getBrightness
(MutableBlockVector3 position) default int
getEmittedLight
(int x, int y, int z) default int
getEmittedLight
(BlockVector3 position) Get the light level at the given location.default BaseBlock
getFullBlock
(int x, int y, int z) default BaseBlock
getFullBlock
(BlockVector3 position) Get an immutable snapshot of the block at the given location.default int[]
getHeightMap
(HeightMapType type) default int
getOpacity
(int x, int y, int z) default int
getOpacity
(MutableBlockVector3 position) default int
getSkyLight
(int x, int y, int z) default int
getSkyLight
(MutableBlockVector3 position) Get the sky light level at the given location.
-
Method Details
-
getBlock
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.- Parameters:
position
- position of the block- Returns:
- the block
-
getBlock
-
getFullBlock
Get an immutable snapshot of the block at the given location.- Parameters:
position
- position of the block- Returns:
- the block
-
getFullBlock
-
getBiome
Deprecated.Biomes in Minecraft are 3D now, usegetBiome(BlockVector3)
Get the biome at the given location.If there is no biome available, then the ocean biome should be returned.
- Parameters:
position
- the (x, z) location to check the biome at- Returns:
- the biome at the location
-
getBiomeType
-
getBiome
@NonAbstractForCompatibility(delegateName="getBiome", delegateParams=BlockVector2.class) default BiomeType getBiome(BlockVector3 position) Get the biome at the given location.If there is no biome available, then the ocean biome should be returned.
As implementation varies per Minecraft version, this may not exactly get this positions biome. On versions prior to 1.15, this will get the entire column. On later versions it will get the 4x4x4 cube's biome.
- Parameters:
position
- the (x, y, z) location to check the biome at- Returns:
- the biome at the location
- See Also:
-
getEmittedLight
Get the light level at the given location.- Parameters:
position
- location- Returns:
- the light level at the location
-
getEmittedLight
default int getEmittedLight(int x, int y, int z) -
getSkyLight
Get the sky light level at the given location.- Parameters:
position
- location- Returns:
- the sky light level at the location
-
getSkyLight
default int getSkyLight(int x, int y, int z) -
getBrightness
-
getBrightness
default int getBrightness(int x, int y, int z) -
getOpacity
-
getOpacity
default int getOpacity(int x, int y, int z) -
getHeightMap
-
getBiome(BlockVector3)