io.github.opencubicchunks.cubicchunks.api.world

Interface ICube

All Superinterfaces:

net.minecraftforge.common.capabilities.ICapabilityProvider, XYZAddressable

@ParametersAreNonnullByDefault
 @MethodsReturnNonnullByDefault
public interface ICube
extends XYZAddressable, net.minecraftforge.common.capabilities.ICapabilityProvider

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ICube.ForcedLoadReason

Field Summary

Fields

Modifier and Type	Field and Description
static int	SIZE Side length of a cube
static double	SIZE_D

Method Summary

Modifier and Type	Method and Description
void	addEntity(net.minecraft.entity.Entity entity)
void	addTileEntity(net.minecraft.tileentity.TileEntity tileEntity) Add a tile entity to this cube
boolean	containsBlockPos(net.minecraft.util.math.BlockPos blockPos) Check whether a given global block position is contained in this cube
net.minecraft.world.biome.Biome	getBiome(net.minecraft.util.math.BlockPos pos)
net.minecraft.block.state.IBlockState	getBlockState(net.minecraft.util.math.BlockPos pos) Retrieve the block state at the specified location
net.minecraft.block.state.IBlockState	getBlockState(int blockX, int localOrBlockY, int blockZ) Retrieve the block state at the specified location
net.minecraftforge.common.capabilities.CapabilityDispatcher	getCapabilities()
<T extends net.minecraft.world.chunk.Chunk & IColumn> T	getColumn()
CubePos	getCoords()
net.minecraft.util.ClassInheritanceMultiMap<net.minecraft.entity.Entity>	getEntitySet() Returns the internal entity container.
java.util.EnumSet<ICube.ForcedLoadReason>	getForceLoadStatus() Returns a set of reasons this cube is forced to remain loaded if it's forced to remain loaded, or empty enum set if it can be unloaded.
int	getLightFor(net.minecraft.world.EnumSkyBlock lightType, net.minecraft.util.math.BlockPos pos) Retrieve the raw light level at the specified location
net.minecraft.world.chunk.storage.ExtendedBlockStorage	getStorage()
net.minecraft.tileentity.TileEntity	getTileEntity(net.minecraft.util.math.BlockPos pos, net.minecraft.world.chunk.Chunk.EnumCreateEntityType createType) Retrieve the tile entity at the specified location
java.util.Map<net.minecraft.util.math.BlockPos,net.minecraft.tileentity.TileEntity>	getTileEntityMap() Retrieve a map of positions to their respective tile entities
<T extends net.minecraft.world.World & ICubicWorld> T	getWorld()
int	getX() Retrieve this cube's x coordinate in cube space
int	getY() Retrieve this cube's y coordinate in cube space
int	getZ() Retrieve this cube's z coordinate in cube space
boolean	hasLightUpdates()
boolean	isCubeLoaded()
boolean	isEmpty() Check if there are any non-air blocks in this cube
boolean	isFullyPopulated() Check whether this cube was fully populated, i.e.
boolean	isInitialLightingDone() Check whether this cube's initial diffuse skylight has been calculated
boolean	isPopulated() Check whether this cube was populated, i.e.
boolean	isSurfaceTracked() Gets internal isSurfaceTracked value.
net.minecraft.util.math.BlockPos	localAddressToBlockPos(int localAddress) Convert an integer-encoded address to a local block to a global block position
boolean	needsSaving() Check if any modifications happened to this cube since it was loaded from disk
boolean	removeEntity(net.minecraft.entity.Entity entity)
default void	setBiome(int localBiomeX, int localBiomeZ, net.minecraft.world.biome.Biome biome) Deprecated. Due to changes in Minecraft 1.15.x, biome storage will be changed to 1 biome per 4x4x4 blocks. Use setBiome(int, int, int, Biome)
void	setBiome(int localBiomeX, int localBiomeY, int localBiomeZ, net.minecraft.world.biome.Biome biome) Set biome at a cube-local 4x4x4 block segment.
net.minecraft.block.state.IBlockState	setBlockState(net.minecraft.util.math.BlockPos pos, net.minecraft.block.state.IBlockState newstate) Set the block state at the specified location
void	setLightFor(net.minecraft.world.EnumSkyBlock lightType, net.minecraft.util.math.BlockPos pos, int light) Set the raw light level at the specified location

Methods inherited from interface net.minecraftforge.common.capabilities.ICapabilityProvider

getCapability, hasCapability

Field Detail

SIZE

static final int SIZE

Side length of a cube

See Also:

Constant Field Values

SIZE_D

static final double SIZE_D

See Also:

Constant Field Values

Method Detail

getBlockState

net.minecraft.block.state.IBlockState getBlockState(net.minecraft.util.math.BlockPos pos)

Retrieve the block state at the specified location

Parameters:

pos - target location

Returns:

The block state

See Also:

getBlockState(int, int, int)

setBlockState

@Nullable
net.minecraft.block.state.IBlockState setBlockState(net.minecraft.util.math.BlockPos pos,
                                                              net.minecraft.block.state.IBlockState newstate)

Set the block state at the specified location

Parameters:

pos - target location

newstate - target state of the block at that position

Returns:

The the old state of the block at the position, or null if there was no change

See Also:

Chunk.setBlockState(BlockPos, IBlockState)

getBlockState

net.minecraft.block.state.IBlockState getBlockState(int blockX,
                                                    int localOrBlockY,
                                                    int blockZ)

Retrieve the block state at the specified location

Parameters:

blockX - block x position

localOrBlockY - block or local y position

blockZ - block z position

Returns:

The block state

See Also:

getBlockState(BlockPos)

getLightFor

int getLightFor(net.minecraft.world.EnumSkyBlock lightType,
                net.minecraft.util.math.BlockPos pos)

Retrieve the raw light level at the specified location

Parameters:

lightType - The type of light (sky or block light)

pos - The position at which light should be checked

Returns:

the light level

setLightFor

void setLightFor(net.minecraft.world.EnumSkyBlock lightType,
                 net.minecraft.util.math.BlockPos pos,
                 int light)

Set the raw light level at the specified location

Parameters:

lightType - The type of light (sky or block light)

pos - The position at which light should be updated

light - the light level

getTileEntity

@Nullable
net.minecraft.tileentity.TileEntity getTileEntity(net.minecraft.util.math.BlockPos pos,
                                                            net.minecraft.world.chunk.Chunk.EnumCreateEntityType createType)

Retrieve the tile entity at the specified location

Parameters:

pos - target location

createType - how fast the tile entity is needed

Returns:

the tile entity at the specified location, or null if there is no entity and createType was not Chunk.EnumCreateEntityType#IMMEDIATE

addTileEntity

void addTileEntity(net.minecraft.tileentity.TileEntity tileEntity)

Add a tile entity to this cube

Parameters:

tileEntity - The tile entity to add

isEmpty

boolean isEmpty()

Check if there are any non-air blocks in this cube

Returns:

true if this cube contains only air blocks, false otherwise

localAddressToBlockPos

net.minecraft.util.math.BlockPos localAddressToBlockPos(int localAddress)

Convert an integer-encoded address to a local block to a global block position

Parameters:

localAddress - the address of the block

Returns:

the block position

getWorld

<T extends net.minecraft.world.World & ICubicWorld> T getWorld()

Type Parameters:

T - dummy generic parameter to return a type that is both World and ICubicWorld

Returns:

this cube's world

getColumn

<T extends net.minecraft.world.chunk.Chunk & IColumn> T getColumn()

Type Parameters:

T - dummy generic parameter to return a type that is both Chunk and IColumn

Returns:

this cube's column

getX

int getX()

Retrieve this cube's x coordinate in cube space

Specified by:

getX in interface XYZAddressable

Returns:

cube x position

getY

int getY()

Retrieve this cube's y coordinate in cube space

Specified by:

getY in interface XYZAddressable

Returns:

cube y position

getZ

int getZ()

Retrieve this cube's z coordinate in cube space

Specified by:

getZ in interface XYZAddressable

Returns:

cube z position

getCoords

CubePos getCoords()

Returns:

this cube's position

containsBlockPos

boolean containsBlockPos(net.minecraft.util.math.BlockPos blockPos)

Check whether a given global block position is contained in this cube

Parameters:

blockPos - the position of the block

Returns:

true if the position is within this cube, false otherwise

getStorage

@Nullable
net.minecraft.world.chunk.storage.ExtendedBlockStorage getStorage()

getTileEntityMap

java.util.Map<net.minecraft.util.math.BlockPos,net.minecraft.tileentity.TileEntity> getTileEntityMap()

Retrieve a map of positions to their respective tile entities

Returns:

a map containing all tile entities in this cube

getEntitySet

net.minecraft.util.ClassInheritanceMultiMap<net.minecraft.entity.Entity> getEntitySet()

Returns the internal entity container.

Returns:

the entity container

addEntity

void addEntity(net.minecraft.entity.Entity entity)

removeEntity

boolean removeEntity(net.minecraft.entity.Entity entity)

needsSaving

boolean needsSaving()

Check if any modifications happened to this cube since it was loaded from disk

Returns:

true if this cube should be written back to disk

isPopulated

boolean isPopulated()

Check whether this cube was populated, i.e. if this cube was passed as argument to ICubeGenerator.populate(ICube). Check there for more information regarding population.

Returns:

true if this cube has been populated, false otherwise

isFullyPopulated

boolean isFullyPopulated()

Check whether this cube was fully populated, i.e. if any cube potentially writing to this cube was passed as an argument to ICubeGenerator.populate(ICube). Check there for more information regarding population

Returns:

true if this cube has been populated, false otherwise

isSurfaceTracked

boolean isSurfaceTracked()

Gets internal isSurfaceTracked value. Intended to be used only for serialization.

Returns:

true if the contents of thic cube have already been supplied to surface tracker

isInitialLightingDone

boolean isInitialLightingDone()

Check whether this cube's initial diffuse skylight has been calculated

Returns:

true if it has been calculated, false otherwise

isCubeLoaded

boolean isCubeLoaded()

hasLightUpdates

boolean hasLightUpdates()

getBiome

net.minecraft.world.biome.Biome getBiome(net.minecraft.util.math.BlockPos pos)

setBiome

void setBiome(int localBiomeX,
              int localBiomeY,
              int localBiomeZ,
              net.minecraft.world.biome.Biome biome)

Set biome at a cube-local 4x4x4 block segment.

Parameters:

localBiomeX - cube-local X coordinate. One unit is 4 blocks

localBiomeY - cube-local Y coordinate. One unit is 4 blocks

localBiomeZ - cube-local Z coordinate. One unit is 4 blocks

biome - biome at the given cube coordinates

setBiome

@Deprecated
default void setBiome(int localBiomeX,
                                  int localBiomeZ,
                                  net.minecraft.world.biome.Biome biome)

Deprecated. Due to changes in Minecraft 1.15.x, biome storage will be changed to 1 biome per 4x4x4 blocks. Use setBiome(int, int, int, Biome)

Set biome at a cube-local 2x2 block column.

Parameters:

localBiomeX - cube-local X coordinate. One unit is 2 blocks

localBiomeZ - cube-local Z coordinate. One unit is 2 blocks

biome - biome at the given cube coordinates

getCapabilities

@Nullable
net.minecraftforge.common.capabilities.CapabilityDispatcher getCapabilities()

getForceLoadStatus

java.util.EnumSet<ICube.ForcedLoadReason> getForceLoadStatus()

Returns a set of reasons this cube is forced to remain loaded if it's forced to remain loaded, or empty enum set if it can be unloaded.

Returns:

EnumSet of reasons for this cube to stay loaded. Empty if it can be unloaded.