io.github.opencubicchunks.cubicchunks.core.worldgen.generator.vanilla

Class VanillaCompatibilityGenerator

java.lang.Object

io.github.opencubicchunks.cubicchunks.core.worldgen.generator.vanilla.VanillaCompatibilityGenerator

All Implemented Interfaces:

ICubeGenerator

@ParametersAreNonnullByDefault
 @MethodsReturnNonnullByDefault
public class VanillaCompatibilityGenerator
extends java.lang.Object
implements ICubeGenerator

A cube generator that tries to mirror vanilla world generation. Cubes in the normal world range will be copied from a vanilla chunk generator, cubes above and below that will be filled with the most common block in the topmost/bottommost layers.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.opencubicchunks.cubicchunks.api.worldgen.ICubeGenerator

ICubeGenerator.GeneratorReadyState

Field Summary

Fields inherited from interface io.github.opencubicchunks.cubicchunks.api.worldgen.ICubeGenerator

NO_REQUIREMENT, RECOMMENDED_FULL_POPULATOR_REQUIREMENT, RECOMMENDED_GENERATE_POPULATOR_REQUIREMENT

Constructor Summary

Constructors

Constructor and Description
VanillaCompatibilityGenerator(net.minecraft.world.gen.IChunkGenerator vanilla, net.minecraft.world.World world) Create a new VanillaCompatibilityGenerator

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) Generate a new cube
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 creatureType, net.minecraft.util.math.BlockPos pos) Retrieve a list of creature classes eligible for spawning at the specified location.
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.

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.worldgen.ICubeGenerator

pollAsyncColumnGenerator, pollAsyncCubeGenerator, pollAsyncCubePopulator, supportsConcurrentColumnGeneration, supportsConcurrentCubeGeneration, tryGenerateColumn, tryGenerateCube

Constructor Detail

VanillaCompatibilityGenerator

public VanillaCompatibilityGenerator(net.minecraft.world.gen.IChunkGenerator vanilla,
                                     net.minecraft.world.World world)

Create a new VanillaCompatibilityGenerator

Parameters:

vanilla - The vanilla generator to mirror

world - The world in which cubes are being generated

Method Detail

generateColumn

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

Description copied from interface: ICubeGenerator

Generate column-global information such as biome data

Specified by:

generateColumn in interface ICubeGenerator

Parameters:

column - the target column

recreateStructures

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

Description copied from interface: ICubeGenerator

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

Specified by:

recreateStructures in interface ICubeGenerator

Parameters:

column - The column being loaded

See Also:

for the 3D-equivalent of this method

generateCube

public CubePrimer generateCube(int cubeX,
                               int cubeY,
                               int cubeZ)

Description copied from interface: ICubeGenerator

Generate a new cube

Specified by:

generateCube in interface ICubeGenerator

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

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

Description copied from interface: ICubeGenerator

Generate a new cube

Specified by:

generateCube in interface ICubeGenerator

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

populate

public void populate(ICube cube)

Description copied from interface: ICubeGenerator

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 ICubeGenerator.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

Specified by:

populate in interface ICubeGenerator

Parameters:

cube - the cube to populate

getFullPopulationRequirements

public Box getFullPopulationRequirements(ICube cube)

Description copied from interface: ICubeGenerator

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 ICubeGenerator.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}

Specified by:

getFullPopulationRequirements in interface ICubeGenerator

Parameters:

cube - The target cube

Returns:

The bounding box of all cubes potentially writing to cube

getPopulationPregenerationRequirements

public Box getPopulationPregenerationRequirements(ICube cube)

Description copied from interface: ICubeGenerator

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.

Specified by:

getPopulationPregenerationRequirements in interface ICubeGenerator

Parameters:

cube - The target cube

Returns:

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

recreateStructures

public void recreateStructures(ICube cube)

Description copied from interface: ICubeGenerator

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

Specified by:

recreateStructures in interface ICubeGenerator

Parameters:

cube - The cube being loaded

See Also:

for the 2D-equivalent of this method

getPossibleCreatures

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

Description copied from interface: ICubeGenerator

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

Specified by:

getPossibleCreatures in interface ICubeGenerator

Parameters:

creatureType - 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

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

Description copied from interface: ICubeGenerator

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

Specified by:

getClosestStructure in interface ICubeGenerator

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