io.github.opencubicchunks.cubicchunks.core.world.cube

Class Cube

java.lang.Object

io.github.opencubicchunks.cubicchunks.core.world.cube.Cube

All Implemented Interfaces:

XYZAddressable, ICube, net.minecraftforge.common.capabilities.ICapabilityProvider

Direct Known Subclasses:

BlankCube

@ParametersAreNonnullByDefault
 @MethodsReturnNonnullByDefault
public class Cube
extends java.lang.Object
implements ICube

A cube is our extension of minecraft's chunk system to three dimensions. Each cube encloses a cubic area in the world with a side length of ICube.SIZE, aligned to multiples of that length and stored within columns.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Cube.ICubeLightTrackingInfo

Nested classes/interfaces inherited from interface io.github.opencubicchunks.cubicchunks.api.world.ICube

ICube.ForcedLoadReason

Field Summary

Fields

Modifier and Type	Field and Description
protected static net.minecraft.world.chunk.storage.ExtendedBlockStorage	NULL_STORAGE
protected int	updateLCG Contains the current Linear Congruential Generator seed for block updates.

Fields inherited from interface io.github.opencubicchunks.cubicchunks.api.world.ICube

SIZE, SIZE_D

Constructor Summary

Constructors

Modifier	Constructor and Description
	Cube(net.minecraft.world.chunk.Chunk column, int cubeY) Create a new cube in the specified column at the specified location.
	Cube(net.minecraft.world.chunk.Chunk column, int cubeY, CubePrimer primer) Create a new cube at the specified location by copying blocks from a cube primer.
protected	Cube(TicketList tickets, net.minecraft.world.World world, net.minecraft.world.chunk.Chunk column, CubePos coords, net.minecraft.world.chunk.storage.ExtendedBlockStorage storage, EntityContainer entities, java.util.Map<net.minecraft.util.math.BlockPos,net.minecraft.tileentity.TileEntity> tileEntityMap, java.util.concurrent.ConcurrentLinkedQueue<net.minecraft.util.math.BlockPos> tileEntityPosQueue, Cube.ICubeLightTrackingInfo cubeLightData) Constructor to be used from subclasses to provide all field values

Method Summary

Modifier and Type	Method and Description
void	addEntity(net.minecraft.entity.Entity entity)
void	addTileEntity(net.minecraft.tileentity.TileEntity tileEntityIn) Add a tile entity to this cube
boolean	checkAndUpdateTick(long totalTime) Returns true if the cube still needs to be ticked this tick.
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)
byte[]	getBiomeArray()
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
int	getCachedLightFor(net.minecraft.world.EnumSkyBlock type, net.minecraft.util.math.BlockPos pos)
net.minecraftforge.common.capabilities.CapabilityDispatcher	getCapabilities()
<T> T	getCapability(net.minecraftforge.common.capabilities.Capability<T> capability, net.minecraft.util.EnumFacing facing)
<T extends net.minecraft.world.chunk.Chunk & IColumn> T	getColumn()
CubePos	getCoords()
Cube.ICubeLightTrackingInfo	getCubeLightData()
EntityContainer	getEntityContainer()
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 type, net.minecraft.util.math.BlockPos pos) Retrieve the raw light level at the specified location
net.minecraft.world.chunk.storage.ExtendedBlockStorage	getStorage()
TicketList	getTickets() Retrieve a list of tickets currently holding this cube loaded
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	hasBeenTicked()
boolean	hasCapability(net.minecraftforge.common.capabilities.Capability<?> capability, net.minecraft.util.EnumFacing facing)
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
void	markDirty() Mark this cube as one, who need to be saved to disk
void	markForRenderUpdate()
void	markSaved() Mark this cube as saved to disk
boolean	needsSaving() Check if any modifications happened to this cube since it was loaded from disk
void	onLoad() Finish the cube loading process
void	onUnload() Mark this cube as no longer part of this world
boolean	removeEntity(net.minecraft.entity.Entity entity)
void	setBiome(int localBiomeX, int localBiomeY, int localBiomeZ, net.minecraft.world.biome.Biome biome) Set biome at a cube-local 4x4x4 block segment.
void	setBiomeArray(byte[] biomeArray)
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	setClientCube() Mark this cube as a client side cube.
void	setCubeLoaded()
void	setFullyPopulated(boolean populated) Mark this cube as fully populated.
void	setInitialLightingDone(boolean initialLightingDone) Notify this cube that it's initial diffuse skylight has been calculated
void	setLightFor(net.minecraft.world.EnumSkyBlock lightType, net.minecraft.util.math.BlockPos pos, int light) Set the raw light level at the specified location
void	setPopulated(boolean populated) Mark this cube as populated.
net.minecraft.world.chunk.storage.ExtendedBlockStorage	setStorage(net.minecraft.world.chunk.storage.ExtendedBlockStorage ebs)
void	setStorageFromSave(net.minecraft.world.chunk.storage.ExtendedBlockStorage ebs)
void	setSurfaceTracked(boolean value) Sets internal isSurfaceTracked value.
void	tickCubeCommon(java.util.function.BooleanSupplier tryToTickFaster) Update light and tile entities of cube
void	tickCubeServer(java.util.function.BooleanSupplier tryToTickFaster, java.util.Random rand) Tick this cube on server side.
void	trackSurface()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.opencubicchunks.cubicchunks.api.world.ICube

setBiome

Field Detail

NULL_STORAGE

@Nullable
protected static final net.minecraft.world.chunk.storage.ExtendedBlockStorage NULL_STORAGE

updateLCG

protected int updateLCG

Contains the current Linear Congruential Generator seed for block updates. Used with an A value of 3 and a C value of 0x3c6ef35f, producing a highly planar series of values ill-suited for choosing random blocks in a 16x16x16 field.

Constructor Detail

Cube

public Cube(net.minecraft.world.chunk.Chunk column,
            int cubeY)

Create a new cube in the specified column at the specified location. The newly created cube will only contain air blocks.

Parameters:

column - column of this cube

cubeY - cube y position

Cube

public Cube(net.minecraft.world.chunk.Chunk column,
            int cubeY,
            CubePrimer primer)

Create a new cube at the specified location by copying blocks from a cube primer.

Parameters:

column - column of this cube

cubeY - cube y position

primer - primer containing the blocks for this cube

Cube

protected Cube(TicketList tickets,
               net.minecraft.world.World world,
               net.minecraft.world.chunk.Chunk column,
               CubePos coords,
               net.minecraft.world.chunk.storage.ExtendedBlockStorage storage,
               EntityContainer entities,
               java.util.Map<net.minecraft.util.math.BlockPos,net.minecraft.tileentity.TileEntity> tileEntityMap,
               java.util.concurrent.ConcurrentLinkedQueue<net.minecraft.util.math.BlockPos> tileEntityPosQueue,
               Cube.ICubeLightTrackingInfo cubeLightData)

Constructor to be used from subclasses to provide all field values

Parameters:

tickets - cube ticket list

world - the world instance

column - the column this cube belongs to

coords - position of this cube

storage - block storage

entities - entity container

tileEntityMap - tile entity storage

tileEntityPosQueue - queue for updating tile entities

cubeLightData - cube light tracking data

Method Detail

getBlockState

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

Description copied from interface: ICube

Retrieve the block state at the specified location

Specified by:

getBlockState in interface ICube

Parameters:

pos - target location

Returns:

The block state

See Also:

ICube.getBlockState(int, int, int)

setBlockState

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

Description copied from interface: ICube

Set the block state at the specified location

Specified by:

setBlockState in interface ICube

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

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

Description copied from interface: ICube

Retrieve the block state at the specified location

Specified by:

getBlockState in interface ICube

Parameters:

blockX - block x position

localOrBlockY - block or local y position

blockZ - block z position

Returns:

The block state

See Also:

ICube.getBlockState(BlockPos)

getLightFor

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

Description copied from interface: ICube

Retrieve the raw light level at the specified location

Specified by:

getLightFor in interface ICube

Parameters:

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

pos - The position at which light should be checked

Returns:

the light level

getCachedLightFor

public int getCachedLightFor(net.minecraft.world.EnumSkyBlock type,
                             net.minecraft.util.math.BlockPos pos)

setLightFor

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

Description copied from interface: ICube

Set the raw light level at the specified location

Specified by:

setLightFor in interface ICube

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
public net.minecraft.tileentity.TileEntity getTileEntity(net.minecraft.util.math.BlockPos pos,
                                                                   net.minecraft.world.chunk.Chunk.EnumCreateEntityType createType)

Description copied from interface: ICube

Retrieve the tile entity at the specified location

Specified by:

getTileEntity in interface ICube

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

public void addTileEntity(net.minecraft.tileentity.TileEntity tileEntityIn)

Description copied from interface: ICube

Add a tile entity to this cube

Specified by:

addTileEntity in interface ICube

Parameters:

tileEntityIn - The tile entity to add

tickCubeCommon

public void tickCubeCommon(java.util.function.BooleanSupplier tryToTickFaster)

Update light and tile entities of cube

Parameters:

tryToTickFaster - Whether costly calculations should be skipped in order to catch up with ticks

tickCubeServer

public void tickCubeServer(java.util.function.BooleanSupplier tryToTickFaster,
                           java.util.Random rand)

Tick this cube on server side. Block tick updates launched here.

Parameters:

tryToTickFaster - - returns true when running out of reserved tick time

rand - - World specific Random

getBiome

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

Specified by:

getBiome in interface ICube

Returns:

biome or null if blockBiomeArray is not generated by cube generator

setBiome

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

Description copied from interface: ICube

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

Specified by:

setBiome in interface ICube

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

getBiomeArray

@Nullable
public byte[] getBiomeArray()

setBiomeArray

public void setBiomeArray(byte[] biomeArray)

isEmpty

public boolean isEmpty()

Description copied from interface: ICube

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

Specified by:

isEmpty in interface ICube

Returns:

true if this cube contains only air blocks, false otherwise

localAddressToBlockPos

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

Description copied from interface: ICube

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

Specified by:

localAddressToBlockPos in interface ICube

Parameters:

localAddress - the address of the block

Returns:

the block position

getWorld

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

Specified by:

getWorld in interface ICube

Type Parameters:

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

Returns:

this cube's world

getColumn

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

Specified by:

getColumn in interface ICube

Type Parameters:

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

Returns:

this cube's column

getX

public int getX()

Description copied from interface: ICube

Retrieve this cube's x coordinate in cube space

Specified by:

getX in interface XYZAddressable

Specified by:

getX in interface ICube

Returns:

cube x position

getY

public int getY()

Description copied from interface: ICube

Retrieve this cube's y coordinate in cube space

Specified by:

getY in interface XYZAddressable

Specified by:

getY in interface ICube

Returns:

cube y position

getZ

public int getZ()

Description copied from interface: ICube

Retrieve this cube's z coordinate in cube space

Specified by:

getZ in interface XYZAddressable

Specified by:

getZ in interface ICube

Returns:

cube z position

getCoords

public CubePos getCoords()

Specified by:

getCoords in interface ICube

Returns:

this cube's position

containsBlockPos

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

Description copied from interface: ICube

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

Specified by:

containsBlockPos in interface ICube

Parameters:

blockPos - the position of the block

Returns:

true if the position is within this cube, false otherwise

getStorage

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

Specified by:

getStorage in interface ICube

setStorage

@Nullable
public net.minecraft.world.chunk.storage.ExtendedBlockStorage setStorage(@Nullable
                                                                                   net.minecraft.world.chunk.storage.ExtendedBlockStorage ebs)

setStorageFromSave

public void setStorageFromSave(@Nullable
                               net.minecraft.world.chunk.storage.ExtendedBlockStorage ebs)

getTileEntityMap

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

Description copied from interface: ICube

Retrieve a map of positions to their respective tile entities

Specified by:

getTileEntityMap in interface ICube

Returns:

a map containing all tile entities in this cube

getEntitySet

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

Description copied from interface: ICube

Returns the internal entity container.

Specified by:

getEntitySet in interface ICube

Returns:

the entity container

addEntity

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

Specified by:

addEntity in interface ICube

removeEntity

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

Specified by:

removeEntity in interface ICube

getEntityContainer

public EntityContainer getEntityContainer()

checkAndUpdateTick

public boolean checkAndUpdateTick(long totalTime)

Returns true if the cube still needs to be ticked this tick.

Parameters:

totalTime - world time

Returns:

true if cube still needs to be ticked at this world time

onLoad

public void onLoad()

Finish the cube loading process

trackSurface

public void trackSurface()

onUnload

public void onUnload()

Mark this cube as no longer part of this world

needsSaving

public boolean needsSaving()

Description copied from interface: ICube

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

Specified by:

needsSaving in interface ICube

Returns:

true if this cube should be written back to disk

markSaved

public void markSaved()

Mark this cube as saved to disk

markDirty

public void markDirty()

Mark this cube as one, who need to be saved to disk

getTickets

public TicketList getTickets()

Retrieve a list of tickets currently holding this cube loaded

Returns:

the list of tickets

markForRenderUpdate

public void markForRenderUpdate()

getCubeLightData

public Cube.ICubeLightTrackingInfo getCubeLightData()

setClientCube

public void setClientCube()

Mark this cube as a client side cube. Less work is done in this case, as we expect to receive updates from the server

isPopulated

public boolean isPopulated()

Description copied from interface: ICube

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.

Specified by:

isPopulated in interface ICube

Returns:

true if this cube has been populated, false otherwise

setPopulated

public void setPopulated(boolean populated)

Mark this cube as populated. This means that this cube was passed as argument to ICubeGenerator.populate(ICube). Check there for more information regarding population.

Parameters:

populated - whether this cube was populated

isFullyPopulated

public boolean isFullyPopulated()

Description copied from interface: ICube

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

Specified by:

isFullyPopulated in interface ICube

Returns:

true if this cube has been populated, false otherwise

setFullyPopulated

public void setFullyPopulated(boolean populated)

Mark this cube as fully populated. This means that any cube potentially writing to this cube was passed as an argument to ICubeGenerator.populate(ICube). Check there for more information regarding population

Parameters:

populated - whether this cube was fully populated

setSurfaceTracked

public void setSurfaceTracked(boolean value)

Sets internal isSurfaceTracked value. Intended to be used only for deserialization.

Parameters:

value - true if surface is already tracked

isSurfaceTracked

public boolean isSurfaceTracked()

Description copied from interface: ICube

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

Specified by:

isSurfaceTracked in interface ICube

Returns:

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

isInitialLightingDone

public boolean isInitialLightingDone()

Description copied from interface: ICube

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

Specified by:

isInitialLightingDone in interface ICube

Returns:

true if it has been calculated, false otherwise

setInitialLightingDone

public void setInitialLightingDone(boolean initialLightingDone)

Notify this cube that it's initial diffuse skylight has been calculated

Parameters:

initialLightingDone - true if initial lighting is done

setCubeLoaded

public void setCubeLoaded()

isCubeLoaded

public boolean isCubeLoaded()

Specified by:

isCubeLoaded in interface ICube

hasLightUpdates

public boolean hasLightUpdates()

Specified by:

hasLightUpdates in interface ICube

hasBeenTicked

public boolean hasBeenTicked()

getCapabilities

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

Specified by:

getCapabilities in interface ICube

getForceLoadStatus

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

Description copied from interface: ICube

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.

Specified by:

getForceLoadStatus in interface ICube

Returns:

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

hasCapability

public boolean hasCapability(net.minecraftforge.common.capabilities.Capability<?> capability,
                             @Nullable
                             net.minecraft.util.EnumFacing facing)

Specified by:

hasCapability in interface net.minecraftforge.common.capabilities.ICapabilityProvider

getCapability

@Nullable
public <T> T getCapability(net.minecraftforge.common.capabilities.Capability<T> capability,
                                     @Nullable
                                     net.minecraft.util.EnumFacing facing)

Specified by:

getCapability in interface net.minecraftforge.common.capabilities.ICapabilityProvider