io.github.opencubicchunks.cubicchunks.api.worldgen

Interface ICubeGenerator

@ParametersAreNonnullByDefault
 @MethodsReturnNonnullByDefault
public interface ICubeGenerator

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ICubeGenerator.GeneratorReadyState

Field Summary

Fields

Modifier and Type	Field and Description
static Box	NO_REQUIREMENT
static Box	RECOMMENDED_FULL_POPULATOR_REQUIREMENT
static Box	RECOMMENDED_GENERATE_POPULATOR_REQUIREMENT

Method Summary

Modifier and Type	Method and Description
void	generateColumn(net.minecraft.world.chunk.Chunk column) Generate column-global information such as biome data
CubePrimer	generateCube(int cubeX, int cubeY, int cubeZ) Deprecated. generators are advised to implement generateCube(int, int, int, CubePrimer)
default CubePrimer	generateCube(int cubeX, int cubeY, int cubeZ, CubePrimer primer) Generate a new cube
net.minecraft.util.math.BlockPos	getClosestStructure(java.lang.String name, net.minecraft.util.math.BlockPos pos, boolean findUnexplored) Gets the closest structure with name name.
Box	getFullPopulationRequirements(ICube cube) Get the bounding box defining a range of cubes whose population contributes to cube being fully populated.
Box	getPopulationPregenerationRequirements(ICube cube) Get the Box will all the cubes that populating this cube will affect this cube.
java.util.List<net.minecraft.world.biome.Biome.SpawnListEntry>	getPossibleCreatures(net.minecraft.entity.EnumCreatureType type, net.minecraft.util.math.BlockPos pos) Retrieve a list of creature classes eligible for spawning at the specified location.
default ICubeGenerator.GeneratorReadyState	pollAsyncColumnGenerator(int chunkX, int chunkZ) Checks whether the generator is ready to generate a given column.
default ICubeGenerator.GeneratorReadyState	pollAsyncCubeGenerator(int cubeX, int cubeY, int cubeZ) Checks whether the generator is ready to generate a given cube.
default ICubeGenerator.GeneratorReadyState	pollAsyncCubePopulator(int cubeX, int cubeY, int cubeZ) Checks whether the generator is ready to generate a given column.
void	populate(ICube cube) Populate a cube with multi-block structures that can cross cube boundaries such as trees and ore veins.
void	recreateStructures(net.minecraft.world.chunk.Chunk column) Called to reload structures that apply to column.
void	recreateStructures(ICube cube) Called to reload structures that apply to cube.
default boolean	supportsConcurrentColumnGeneration()
default boolean	supportsConcurrentCubeGeneration()
default java.util.Optional<net.minecraft.world.chunk.Chunk>	tryGenerateColumn(net.minecraft.world.World world, int columnX, int columnZ, net.minecraft.world.chunk.ChunkPrimer primer, boolean forceGenerate)
default java.util.Optional<CubePrimer>	tryGenerateCube(int cubeX, int cubeY, int cubeZ, CubePrimer primer, boolean forceGenerate)

Field Detail

RECOMMENDED_FULL_POPULATOR_REQUIREMENT

static final Box RECOMMENDED_FULL_POPULATOR_REQUIREMENT

RECOMMENDED_GENERATE_POPULATOR_REQUIREMENT

static final Box RECOMMENDED_GENERATE_POPULATOR_REQUIREMENT

NO_REQUIREMENT

static final Box NO_REQUIREMENT

Method Detail

generateCube

@Deprecated
CubePrimer generateCube(int cubeX,
                                    int cubeY,
                                    int cubeZ)

Deprecated. generators are advised to implement generateCube(int, int, int, CubePrimer)

Generate a new cube

Parameters:

cubeX - the cube's X coordinate

cubeY - the cube's Y coordinate

cubeZ - the cube's Z coordinate

Returns:

A CubePrimer with the generated blocks

generateCube

default CubePrimer generateCube(int cubeX,
                                int cubeY,
                                int cubeZ,
                                CubePrimer primer)

Generate a new cube

Parameters:

cubeX - the cube's X coordinate

cubeY - the cube's Y coordinate

cubeZ - the cube's Z coordinate

primer - a CubePrimer which may be used for generating the new cube. Note that generators are allowed to return an arbitrary CubePrimer, this parameter is simply a hint to help reduce allocations. However, if a different primer is to be returned, the given primer's state must remain unmodified.

Returns:

A CubePrimer with the generated blocks

generateColumn

void generateColumn(net.minecraft.world.chunk.Chunk column)

Generate column-global information such as biome data

Parameters:

column - the target column

populate

void populate(ICube cube)

Populate a cube with multi-block structures that can cross cube boundaries such as trees and ore veins. Population should* be done with the restriction that it may not affect cubes whose call to getFullPopulationRequirements(ICube) would does include cube. Note: Unlike vanilla this method will NEVER cause recursive generation, thus the area that it populates is not as strict. Generation should still be restricted as the player might see something generate in a chunk they have already been sent

Parameters:

cube - the cube to populate

tryGenerateCube

default java.util.Optional<CubePrimer> tryGenerateCube(int cubeX,
                                                       int cubeY,
                                                       int cubeZ,
                                                       CubePrimer primer,
                                                       boolean forceGenerate)

tryGenerateColumn

default java.util.Optional<net.minecraft.world.chunk.Chunk> tryGenerateColumn(net.minecraft.world.World world,
                                                                              int columnX,
                                                                              int columnZ,
                                                                              net.minecraft.world.chunk.ChunkPrimer primer,
                                                                              boolean forceGenerate)

supportsConcurrentCubeGeneration

default boolean supportsConcurrentCubeGeneration()

supportsConcurrentColumnGeneration

default boolean supportsConcurrentColumnGeneration()

pollAsyncCubeGenerator

default ICubeGenerator.GeneratorReadyState pollAsyncCubeGenerator(int cubeX,
                                                                  int cubeY,
                                                                  int cubeZ)

Checks whether the generator is ready to generate a given cube.

Parameters:

cubeX - X coordinate of the cube

cubeY - Y coordinate of the cube

cubeZ - Z coordinate of the cube

Returns:

The generator state. READY means that the asynchronous part of generation is done. WAITING means that async part is in progress. FAIL if cube cannot be generated

pollAsyncColumnGenerator

default ICubeGenerator.GeneratorReadyState pollAsyncColumnGenerator(int chunkX,
                                                                    int chunkZ)

Checks whether the generator is ready to generate a given column.

Parameters:

chunkX - X coordinate of the column

chunkZ - Z coordinate of the column

Returns:

The generator state. READY means that the asynchronous part of generation is done. WAITING means that async part is in progress. FAIL if cube cannot be generated

pollAsyncCubePopulator

default ICubeGenerator.GeneratorReadyState pollAsyncCubePopulator(int cubeX,
                                                                  int cubeY,
                                                                  int cubeZ)

Checks whether the generator is ready to generate a given column.

Parameters:

cubeX - X coordinate of the cube

cubeY - Y coordinate of the cube

cubeZ - Z coordinate of the cube

Returns:

The generator state. READY means that the asynchronous part of generation is done. WAITING means that async part is in progress. FAIL if cube cannot be generated

getFullPopulationRequirements

Box getFullPopulationRequirements(ICube cube)

Get the bounding box defining a range of cubes whose population contributes to cube being fully populated. The requested cubes will all be generated and populated when the cube that they affect needs to be fully populated. Consider the following example: A call to some implementation of populate(ICube) populates a 16x16x16 block area in a 2x2x2 area of cubes around the center.

 Shown: Which cubes affect the current cube (marked with dots), and their corresponding areas of population.

 +----------+----------+  . .  The chunk provided as a parameter
 |          | . . . . .|  . .  to this method (getFullPopulationRequirements).
 |          | . . . . .|
 |     #####|#####. . .|  x x  The chunk provided as a parameter
 |     #####|#####. . .|  x x  to populate()
 +----------+----------+
 | x x #####|#####     |  ###  The area being populated by 'x'
 | x x #####|#####     |  ###
 | x x x x x|          |
 | x x x x x|          |
 +----------+----------+

 +----------+----------+  . .  The chunk provided as a parameter
 |          | . . . . .|  . .  to this method (getFullPopulationRequirements).
 |          | . . . . .|
 |          | . . #####|  x x  The chunk provided as a parameter
 |          | . . #####|  x x  to populate()
 +----------+----------+
 |          | x x #####|  ###  The area being populated by 'x'
 |          | x x #####|  ###
 |          | x x x x x|
 |          | x x x x x|
 +----------+----------+

 +----------+----------+  . .  The chunk provided as a parameter
 | x x #####|#####. . .|  . .  to this method (getFullPopulationRequirements).
 | x x #####|#####. . .|
 | x x x x x| . . . . .|  x x  The chunk provided as a parameter
 | x x x x x| . . . . .|  x x  to populate()
 +----------+----------+
 |          |          |  ###  The area being populated by 'x'
 |          |          |  ###
 |          |          |
 |          |          |
 +----------+----------+

 

This method would return {(-1,-1,-1), (0, 0, 0)}, indicating that populate calls to all cubes in that area write to this cube.

Note: Large ranges are not recommended. If you need to generate a large structure like a nether fort, look at how MInecraft generates such structures Also @{see #getPopulationPregenerationRequirements}

Parameters:

cube - The target cube

Returns:

The bounding box of all cubes potentially writing to cube

getPopulationPregenerationRequirements

Box getPopulationPregenerationRequirements(ICube cube)

Get the Box will all the cubes that populating this cube will affect this cube. These cubes will be generated before the cube is populated, even if it's not full population.

Parameters:

cube - The target cube

Returns:

The bounding box of all cubes that the target cube may modify or use

recreateStructures

void recreateStructures(ICube cube)

Called to reload structures that apply to cube. Mostly used to prepare calls to getPossibleCreatures(EnumCreatureType, BlockPos)

Parameters:

cube - The cube being loaded

See Also:

for the 2D-equivalent of this method

recreateStructures

void recreateStructures(net.minecraft.world.chunk.Chunk column)

Called to reload structures that apply to column. Mostly used to prepare calls to getPossibleCreatures(EnumCreatureType, BlockPos)

Parameters:

column - The column being loaded

See Also:

for the 3D-equivalent of this method

getPossibleCreatures

java.util.List<net.minecraft.world.biome.Biome.SpawnListEntry> getPossibleCreatures(net.minecraft.entity.EnumCreatureType type,
                                                                                    net.minecraft.util.math.BlockPos pos)

Retrieve a list of creature classes eligible for spawning at the specified location.

Parameters:

type - the creature type that we are interested in spawning

pos - the position we want to spawn creatures at

Returns:

a list of creature classes that can spawn here. Example: Calling this method inside a nether fortress returns EntityBlaze, EntityPigZombie, EntitySkeleton, and EntityMagmaCube

getClosestStructure

@Nullable
net.minecraft.util.math.BlockPos getClosestStructure(java.lang.String name,
                                                               net.minecraft.util.math.BlockPos pos,
                                                               boolean findUnexplored)

Gets the closest structure with name name. This is primarily used when an eye of ender is trying to find a stronghold.

Parameters:

name - the name of the structure

pos - find the structure closest to this position

findUnexplored - true if should also find not yet generated structures

Returns:

the position of the structure, or null if none could be found