io.github.opencubicchunks.cubicchunks.core.world.column

Class CubeMap

java.lang.Object

io.github.opencubicchunks.cubicchunks.core.world.column.CubeMap

All Implemented Interfaces:

java.lang.Iterable<Cube>

@ParametersAreNonnullByDefault
 @MethodsReturnNonnullByDefault
public class CubeMap
extends java.lang.Object
implements java.lang.Iterable<Cube>

Stores cubes for columns

Constructor Summary

Constructors

Constructor and Description
CubeMap()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<Cube>	all() Retrieve a collection of all cubes within this storage.
java.lang.Iterable<Cube>	cubes(int startY, int endY) Iterate over all cubes between startY and endY in this storage in order.
void	enqueueRelightChecks()
net.minecraft.world.chunk.storage.ExtendedBlockStorage[]	getStoragesToTick()
boolean	isEmpty() Check if this storage is empty
java.util.Iterator<Cube>	iterator() Iterate over all cubes in this storage
void	put(Cube cube) Adds a cube
Cube	remove(int cubeY) Removes the cube at cubeY

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CubeMap

public CubeMap()

Method Detail

remove

@Nullable
public Cube remove(int cubeY)

Removes the cube at cubeY

Parameters:

cubeY - cube y position

Returns:

the removed cube if it existed, otherwise null

put

public void put(Cube cube)

Adds a cube

Parameters:

cube - the cube to add

cubes

public java.lang.Iterable<Cube> cubes(int startY,
                                      int endY)

Iterate over all cubes between startY and endY in this storage in order. If startY < endY, order is bottom to top, otherwise order is top to bottom.

Parameters:

startY - initial cube y position

endY - last cube y position

Returns:

an iterator over the cubes

iterator

public java.util.Iterator<Cube> iterator()

Iterate over all cubes in this storage

Specified by:

iterator in interface java.lang.Iterable<Cube>

Returns:

the iterator

all

public java.util.Collection<Cube> all()

Retrieve a collection of all cubes within this storage. The collection is non-modifiable

Returns:

the collection

isEmpty

public boolean isEmpty()

Check if this storage is empty

Returns:

true if there are no cubes in this storage, false otherwise

getStoragesToTick

public net.minecraft.world.chunk.storage.ExtendedBlockStorage[] getStoragesToTick()

Returns:

An array of EBSs from cubes that need ticking

enqueueRelightChecks

public void enqueueRelightChecks()