mod.bespectacled.modernbetaforge.api.world.chunk.source

Class ChunkSource

java.lang.Object

mod.bespectacled.modernbetaforge.api.world.chunk.source.ChunkSource

Direct Known Subclasses:

FiniteChunkSource, Infdev227ChunkSource, NoiseChunkSource

public abstract class ChunkSource
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<BlockSource>	blockSources
protected static int	DEEP_OCEAN_MIN_DEPTH
protected net.minecraft.block.state.IBlockState	defaultBlock
protected net.minecraft.block.state.IBlockState	defaultFluid
protected static int	OCEAN_MIN_DEPTH
protected java.util.Random	random
protected int	seaLevel
protected long	seed
protected ModernBetaGeneratorSettings	settings
protected int	worldHeight

Constructor Summary

Constructors

Constructor and Description
ChunkSource(long seed, ModernBetaGeneratorSettings settings) Constructs an abstract ChunkSource to hold basic underlying terrain generation information.

Method Summary

Modifier and Type	Method and Description
BiomeInjectionRules	buildBiomeInjectorRules(BiomeSource biomeSource) Deprecated.
BiomeInjectionRules.Builder	createBiomeInjectionRules(BiomeSource biomeSource) Creates the rule set builder used for biome injection.
protected java.util.Random	createRandom(long seed) Creates a new Random for world generation.
java.util.Optional<PerlinOctaveNoise>	getBeachOctaveNoise() Gets the PerlinOctaveNoise sampler used for beach generation.
net.minecraft.block.state.IBlockState	getDefaultBlock() Gets the default block for the chunk source, usually stone.
net.minecraft.block.state.IBlockState	getDefaultFluid() Gets the default fluid for the chunk source, either water or lava.
java.util.Optional<PerlinOctaveNoise>	getForestOctaveNoise() Gets the PerlinOctaveNoise sampler used for tree placement.
ModernBetaGeneratorSettings	getGeneratorSettings() Gets the chunk generator settings.
abstract int	getHeight(int x, int z, HeightmapChunk.Type type) Sample height at given x/z coordinate.
int	getSeaLevel() Gets the chunk source sea level set in the chunk generator settings.
long	getSeed() Gets the world seed.
java.util.Optional<PerlinOctaveNoise>	getSurfaceOctaveNoise() Gets the PerlinOctaveNoise sampler used for surface generation.
WorldSpawner	getWorldSpawner() Gets the world spawner used to initially place the player spawn.
abstract void	provideInitialChunk(net.minecraft.world.chunk.ChunkPrimer chunkPrimer, int chunkX, int chunkZ) Create initial chunk given chunk coordinates.
abstract void	provideProcessedChunk(net.minecraft.world.chunk.ChunkPrimer chunkPrimer, int chunkX, int chunkZ, java.util.List<net.minecraft.world.gen.structure.StructureComponent> structureComponents) Create processed chunk given chunk coordinates.
abstract void	provideSurface(net.minecraft.world.World world, net.minecraft.world.biome.Biome[] biomes, net.minecraft.world.chunk.ChunkPrimer chunkPrimer, int chunkX, int chunkZ) Build surface for given chunk primer and chunk coordinates.
void	pruneChunk(net.minecraft.world.World world, int chunkX, int chunkZ) Prunes the chuck at the given coordinates.
protected void	setBeachOctaveNoise(PerlinOctaveNoise beachOctaveNoise) Sets the default PerlinOctaveNoise sampler used for beach generation for the default surface generator in ModernBetaBiome.
protected void	setCloudHeight(int cloudHeight) Sets the cloud height in the ModernBetaWorldType world type.
protected void	setForestOctaveNoise(PerlinOctaveNoise forestOctaveNoise) Sets the PerlinOctaveNoise sampler used for tree placement.
protected void	setSurfaceOctaveNoise(PerlinOctaveNoise surfaceOctaveNoise) Sets the PerlinOctaveNoise sampler used for surface generation.
boolean	skipChunk(int chunkX, int chunkZ) Indicate whether the chunk at the given coordinates should be skipped.

Methods inherited from class java.lang.Object

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

Field Detail

OCEAN_MIN_DEPTH

protected static final int OCEAN_MIN_DEPTH

See Also:

Constant Field Values

DEEP_OCEAN_MIN_DEPTH

protected static final int DEEP_OCEAN_MIN_DEPTH

See Also:

Constant Field Values

seed

protected final long seed

settings

protected final ModernBetaGeneratorSettings settings

random

protected final java.util.Random random

defaultBlock

protected final net.minecraft.block.state.IBlockState defaultBlock

defaultFluid

protected final net.minecraft.block.state.IBlockState defaultFluid

worldHeight

protected final int worldHeight

seaLevel

protected final int seaLevel

blockSources

protected final java.util.List<BlockSource> blockSources

Constructor Detail

ChunkSource

public ChunkSource(long seed,
                   ModernBetaGeneratorSettings settings)

Constructs an abstract ChunkSource to hold basic underlying terrain generation information.

Parameters:

seed - The world seed.

settings - The generator settings.

Method Detail

provideInitialChunk

public abstract void provideInitialChunk(net.minecraft.world.chunk.ChunkPrimer chunkPrimer,
                                         int chunkX,
                                         int chunkZ)

Create initial chunk given chunk coordinates. Used to sample for biome injection and creation of initial biome map. If using biomes for chunk generation, DO NOT use BiomeProvider.getBiome() from World. At this stage, the biomes have not actually been set for ModernBetaBiome to sample from. Instead, get the biome provider, cast to ModernBetaBiomeProvider and use ModernBetaBiomeProvider.getBiomeSource() to sample biomes, or do final generation in processedChunk to get processed biome map.

Parameters:

chunkPrimer - Chunk primer

chunkX - x-coordinate in chunk coordinates

chunkZ - z-coordinate in chunk coordinates

provideProcessedChunk

public abstract void provideProcessedChunk(net.minecraft.world.chunk.ChunkPrimer chunkPrimer,
                                           int chunkX,
                                           int chunkZ,
                                           java.util.List<net.minecraft.world.gen.structure.StructureComponent> structureComponents)

Create processed chunk given chunk coordinates. This exists to allow terrain to be modified or regenerated for village placement, which needs to occur after provideInitialChunk so villages can be placed correctly. This does not need to be implemented and can be left empty, if you don't wish to do additional processing.

Parameters:

chunkPrimer - Chunk primer

chunkX - x-coordinate in chunk coordinates

chunkZ - z-coordinate in chunk coordinates

structureComponents - The list of structure components that at least partially occupy this chunk.

provideSurface

public abstract void provideSurface(net.minecraft.world.World world,
                                    net.minecraft.world.biome.Biome[] biomes,
                                    net.minecraft.world.chunk.ChunkPrimer chunkPrimer,
                                    int chunkX,
                                    int chunkZ)

Build surface for given chunk primer and chunk coordinates.

Parameters:

world - The world object

biomes - Biome array for chunk

chunkPrimer - Chunk primer

chunkX - x-coordinate in chunk coordinates

chunkZ - z-coordinate in chunk coordinates

getHeight

public abstract int getHeight(int x,
                              int z,
                              HeightmapChunk.Type type)

Sample height at given x/z coordinate.

Parameters:

x - x-coordinate in block coordinates.

z - z-coordinate in block coordinates.

type - HeightmapChunk.Type.

Returns:

The y-coordinate of top block at x/z.

getSeaLevel

public int getSeaLevel()

Gets the chunk source sea level set in the chunk generator settings.

Returns:

The chunk source sea level.

getDefaultBlock

public net.minecraft.block.state.IBlockState getDefaultBlock()

Gets the default block for the chunk source, usually stone.

Returns:

The default block blockstate.

getDefaultFluid

public net.minecraft.block.state.IBlockState getDefaultFluid()

Gets the default fluid for the chunk source, either water or lava.

Returns:

The default fluid blockstate.

getGeneratorSettings

public ModernBetaGeneratorSettings getGeneratorSettings()

Gets the chunk generator settings.

Returns:

The ModernBetaGeneratorSettings settings.

getWorldSpawner

public WorldSpawner getWorldSpawner()

Gets the world spawner used to initially place the player spawn.

Returns:

The world spawner, WorldSpawner.DEFAULT by default.

getBeachOctaveNoise

public java.util.Optional<PerlinOctaveNoise> getBeachOctaveNoise()

Gets the PerlinOctaveNoise sampler used for beach generation.

Returns:

An optional containing the noise sampler, may be null.

getSurfaceOctaveNoise

public java.util.Optional<PerlinOctaveNoise> getSurfaceOctaveNoise()

Gets the PerlinOctaveNoise sampler used for surface generation.

Returns:

An optional containing the noise sampler, may be null.

getForestOctaveNoise

public java.util.Optional<PerlinOctaveNoise> getForestOctaveNoise()

Gets the PerlinOctaveNoise sampler used for tree placement.

Returns:

An optional containing the noise sampler, may be null.

getSeed

public long getSeed()

Gets the world seed.

Returns:

The world seed.

skipChunk

public boolean skipChunk(int chunkX,
                         int chunkZ)

Indicate whether the chunk at the given coordinates should be skipped. This is called in several generation methods and used by FiniteChunkSource.

Parameters:

chunkX - x-coordinate in chunk coordinates

chunkZ - z-coordinate in chunk coordinates

Returns:

Whether the chunk should be skipped.

pruneChunk

public void pruneChunk(net.minecraft.world.World world,
                       int chunkX,
                       int chunkZ)

Prunes the chuck at the given coordinates. This is used by FiniteChunkSource.

Parameters:

world - The world object

chunkX - x-coordinate in chunk coordinates

chunkZ - z-coordinate in chunk coordinates

buildBiomeInjectorRules

@Deprecated
public BiomeInjectionRules buildBiomeInjectorRules(BiomeSource biomeSource)

Deprecated.

Builds the ruleset used for biome injection. This is deprecated, override createBiomeInjectionRules instead.

Parameters:

biomeSource - The biome source.

Returns:

The built biome injection rules.

createBiomeInjectionRules

public BiomeInjectionRules.Builder createBiomeInjectionRules(BiomeSource biomeSource)

Creates the rule set builder used for biome injection.

Parameters:

biomeSource - The biome source.

Returns:

The biome injection rules.

createRandom

protected java.util.Random createRandom(long seed)

Creates a new Random for world generation.

Parameters:

seed - The world seed

Returns:

A new Random initialized with the world seed.

setCloudHeight

protected void setCloudHeight(int cloudHeight)

Sets the cloud height in the ModernBetaWorldType world type.

Parameters:

cloudHeight - y-coordinate of the new cloud height, in block coordinates.

setBeachOctaveNoise

protected void setBeachOctaveNoise(PerlinOctaveNoise beachOctaveNoise)

Sets the default PerlinOctaveNoise sampler used for beach generation for the default surface generator in ModernBetaBiome.

Parameters:

beachOctaveNoise - The noise sampler, may be null.

setSurfaceOctaveNoise

protected void setSurfaceOctaveNoise(PerlinOctaveNoise surfaceOctaveNoise)

Sets the PerlinOctaveNoise sampler used for surface generation.

Parameters:

surfaceOctaveNoise - The noise sampler, may be null.

setForestOctaveNoise

protected void setForestOctaveNoise(PerlinOctaveNoise forestOctaveNoise)

Sets the PerlinOctaveNoise sampler used for tree placement.

Parameters:

forestOctaveNoise - The noise sampler, may be null.