FiniteChunkSource (modernbetaforge 1.12.2-1.7.1.0 API)

java.lang.Object
- mod.bespectacled.modernbetaforge.api.world.chunk.source.ChunkSource
- - mod.bespectacled.modernbetaforge.api.world.chunk.source.FiniteChunkSource

Direct Known Subclasses:: Classic23aChunkSource, IndevChunkSource

public abstract class FiniteChunkSource
extends ChunkSource

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FiniteChunkSource.LevelDataContainer

Nested Classes
Modifier and Type	Class and Description
`static class`	`FiniteChunkSource.LevelDataContainer`

Field Summary

Fields
Modifier and Type	Field and Description
`protected BiomeSource`	`biomeSource`
`protected float`	`levelCaveWidth`
`protected int`	`levelHeight`
`protected int[]`	`levelHeightmap`
`protected int`	`levelLength`
`protected int`	`levelWidth`
`protected static int`	`MAX_FLOODS`
`protected static net.minecraft.block.Block`	`PLACEHOLDER_BLOCK`

Fields inherited from class mod.bespectacled.modernbetaforge.api.world.chunk.source.ChunkSource
blockSources, DEEP_OCEAN_MIN_DEPTH, defaultBlock, defaultFluid, OCEAN_MIN_DEPTH, random, seaLevel, seed, settings, worldHeight

Constructor Summary

Constructors
Constructor and Description
`FiniteChunkSource(long seed, ModernBetaGeneratorSettings settings)` Constructs an abstract FiniteChunkSource with necessary level information.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`atLevelBounds(int x, int y, int z)` Indicates whether the given level coordinates are at the level bounds.
`void`	`buildHouse(net.minecraft.world.WorldServer world, net.minecraft.util.math.BlockPos spawnPos, boolean isBonusChestEnabled)` Generates the Indev starting house at the given coordinates.
`BiomeInjectionRules.Builder`	`createBiomeInjectionRules(BiomeSource biomeSource)` Creates the rule set builder used for biome injection.
`protected void`	`fillOblateSpheroid(float centerX, float centerY, float centerZ, float radius, net.minecraft.block.Block fillBlock)` Fills a space in level data in a spheroid shape.
`protected int`	`flood(int x, int y, int z, net.minecraft.block.Block fillBlock, net.minecraft.block.Block replaceBlock)` Floods the level downward and outward from a given starting position and fill/replace blocks.
`protected int`	`flood(int startX, int startY, int startZ, net.minecraft.block.Block fillBlock, net.minecraft.block.Block replaceBlock, net.minecraft.util.math.Vec3d[] floodedPositions)` Floods the level downward and outward from a given starting position and fill/replace blocks.
`protected abstract void`	`generateBorder(net.minecraft.world.chunk.ChunkPrimer chunkPrimer, int chunkX, int chunkZ)` Generates the world chunks outside of the level bounds.
`protected abstract int`	`getBorderHeight(int x, int z, HeightmapChunk.Type type)` Sample height at given x/z coordinate for coordinates outside of the level bounds.
`int`	`getHeight(int x, int z, HeightmapChunk.Type type)` Inherited from `getHeight`.
`net.minecraft.block.Block`	`getLevelBlock(int x, int y, int z)` Gets a block given coordinates from level data.
`int`	`getLevelHeight()` Gets the finite level height.
`int`	`getLevelHeight(int x, int z, HeightmapChunk.Type type)` Gets the height from level data given x/z coordinates and the heightmap type.
`int`	`getLevelLength()` Gets the finite level length.
`int`	`getLevelWidth()` Gets the finite level width.
`java.lang.String`	`getPhase()` Get the finite level generation phase.
`WorldSpawner`	`getWorldSpawner()` Gets the world spawner used to initially place the player spawn.
`boolean`	`hasPregenerated()` Indicates whether the level data has been generated.
`protected boolean`	`inLevelBounds(int x, int y, int z)` Indicates whether the given level coordinates are within the level area.
`boolean`	`inWorldBounds(int x, int z)` Indicates whether the given x/z world coordinates are within the level area.
`void`	`loadOrCreateLevelDataContainer(net.minecraft.world.World world)` Loads from file or creates new level data container.
`protected void`	`pregenerateLevelOrWait(FiniteChunkSource.LevelDataContainer levelDataContainer)` Checks if the level data has generated yet, if not, then generates the level data.
`protected abstract void`	`pregenerateTerrain()` Generates the level data.
`void`	`pregenerateTerrainOrWait()` Pregenerates the level terrain.
`void`	`provideInitialChunk(net.minecraft.world.chunk.ChunkPrimer chunkPrimer, int chunkX, int chunkZ)` Create initial chunk given chunk coordinates.
`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.
`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.
`void`	`saveLevelDataContainer(net.minecraft.world.World world)` Saves the level data container to file.
`void`	`setLevelBlock(int x, int y, int z, net.minecraft.block.Block block)` Sets a block into level data at the given coordinates.
`void`	`setLevelNotifier(java.util.function.Consumer<java.lang.String> levelNotifier)` Sets the level notifier consumer.
`protected void`	`setPhase(java.lang.String phase)` Sets the current generation phase for the level.
`protected void`	`setPhaseProgress(float phaseProgress)` Sets the current generation phase progress for the level.
`boolean`	`skipChunk(int chunkX, int chunkZ)` Indicate whether the chunk at the given coordinates should be skipped.

Methods inherited from class mod.bespectacled.modernbetaforge.api.world.chunk.source.ChunkSource
buildBiomeInjectorRules, createRandom, getBeachOctaveNoise, getDefaultBlock, getDefaultFluid, getForestOctaveNoise, getGeneratorSettings, getSeaLevel, getSeed, getSurfaceOctaveNoise, setBeachOctaveNoise, setCloudHeight, setForestOctaveNoise, setSurfaceOctaveNoise

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PLACEHOLDER_BLOCK
```
protected static final net.minecraft.block.Block PLACEHOLDER_BLOCK
```
  - MAX_FLOODS
```
protected static final int MAX_FLOODS
```
    See Also:
    
    Constant Field Values
  - levelWidth
```
protected final int levelWidth
```
  - levelLength
```
protected final int levelLength
```
  - levelHeight
```
protected final int levelHeight
```
  - levelCaveWidth
```
protected final float levelCaveWidth
```
  - levelHeightmap
```
protected final int[] levelHeightmap
```
  - biomeSource
```
protected final BiomeSource biomeSource
```
- Constructor Detail
  - FiniteChunkSource
```
public FiniteChunkSource(long seed,
                         ModernBetaGeneratorSettings settings)
```
    Constructs an abstract FiniteChunkSource with necessary level information.
    
    Parameters:
    
    seed - The world seed.
    
    settings - The generator settings.
- Method Detail
  - getWorldSpawner
```
public final WorldSpawner getWorldSpawner()
```
    Description copied from class: ChunkSource
    
    Gets the world spawner used to initially place the player spawn.
    
    Overrides:
    
    getWorldSpawner in class ChunkSource
    
    Returns:
    
    The world spawner, WorldSpawner.DEFAULT by default.
  - provideInitialChunk
```
public void provideInitialChunk(net.minecraft.world.chunk.ChunkPrimer chunkPrimer,
                                int chunkX,
                                int chunkZ)
```
    Description copied from class: ChunkSource
    
    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.
    
    Specified by:
    
    provideInitialChunk in class ChunkSource
    
    Parameters:
    
    chunkPrimer - Chunk primer
    
    chunkX - x-coordinate in chunk coordinates
    
    chunkZ - z-coordinate in chunk coordinates
  - provideProcessedChunk
```
public void provideProcessedChunk(net.minecraft.world.chunk.ChunkPrimer chunkPrimer,
                                  int chunkX,
                                  int chunkZ,
                                  java.util.List<net.minecraft.world.gen.structure.StructureComponent> structureComponents)
```
    Description copied from class: ChunkSource
    
    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.
    
    Specified by:
    
    provideProcessedChunk in class ChunkSource
    
    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 final void provideSurface(net.minecraft.world.World world,
                                 net.minecraft.world.biome.Biome[] biomes,
                                 net.minecraft.world.chunk.ChunkPrimer chunkPrimer,
                                 int chunkX,
                                 int chunkZ)
```
    Description copied from class: ChunkSource
    
    Build surface for given chunk primer and chunk coordinates.
    
    Specified by:
    
    provideSurface in class ChunkSource
    
    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 int getHeight(int x,
                     int z,
                     HeightmapChunk.Type type)
```
    Inherited from getHeight. Samples height from the generated level data.
    
    Specified by:
    
    getHeight in class ChunkSource
    
    Parameters:
    
    x - x-coordinate in block coordinates.
    
    z - z-coordinate in block coordinates.
    
    type - HeightmapChunk heightmap type.
    
    Returns:
    
    The y-coordinate of top block at x/z.
  - getLevelBlock
```
public net.minecraft.block.Block getLevelBlock(int x,
                                               int y,
                                               int z)
```
    Gets a block given coordinates from level data.
    
    Parameters:
    
    x - x-coordinate in block coordinates.
    
    y - y-coordinate in block coordinates.
    
    z - z-coordinate in block coordinates.
    
    Returns:
    
    The block at the given coordinates.
  - setLevelBlock
```
public void setLevelBlock(int x,
                          int y,
                          int z,
                          net.minecraft.block.Block block)
```
    Sets a block into level data at the given coordinates.
    
    Parameters:
    
    x - x-coordinate in block coordinates.
    
    y - y-coordinate in block coordinates.
    
    z - z-coordinate in block coordinates.
    
    block - The block to set in level data.
  - getLevelHeight
```
public int getLevelHeight(int x,
                          int z,
                          HeightmapChunk.Type type)
```
    Gets the height from level data given x/z coordinates and the heightmap type.
    
    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.
  - getLevelWidth
```
public int getLevelWidth()
```
    Gets the finite level width.
    
    Returns:
    
    The level width.
  - getLevelLength
```
public int getLevelLength()
```
    Gets the finite level length.
    
    Returns:
    
    The level length.
  - getLevelHeight
```
public int getLevelHeight()
```
    Gets the finite level height.
    
    Returns:
    
    The level height.
  - getPhase
```
public java.lang.String getPhase()
```
    Get the finite level generation phase.
    
    Returns:
    
    The current generation phase.
  - setLevelNotifier
```
public void setLevelNotifier(java.util.function.Consumer<java.lang.String> levelNotifier)
```
    Sets the level notifier consumer.
    
    Parameters:
    
    levelNotifier - The level notifier consuming a String.
  - loadOrCreateLevelDataContainer
```
public void loadOrCreateLevelDataContainer(net.minecraft.world.World world)
```
    Loads from file or creates new level data container.
    
    Parameters:
    
    world - The world object
  - saveLevelDataContainer
```
public void saveLevelDataContainer(net.minecraft.world.World world)
```
    Saves the level data container to file.
    
    Parameters:
    
    world - The world object
  - pregenerateTerrainOrWait
```
public void pregenerateTerrainOrWait()
```
    Pregenerates the level terrain.
  - buildHouse
```
public void buildHouse(net.minecraft.world.WorldServer world,
                       net.minecraft.util.math.BlockPos spawnPos,
                       boolean isBonusChestEnabled)
```
    Generates the Indev starting house at the given coordinates.
    
    Parameters:
    
    world - The world object.
    
    spawnPos - The player spawn block position.
    
    isBonusChestEnabled - Whether the bonus chest should be generated in the house.
  - inWorldBounds
```
public boolean inWorldBounds(int x,
                             int z)
```
    Indicates whether the given x/z world coordinates are within the level area.
    
    Parameters:
    
    x - x-coordinate in block coordinates in world space.
    
    z - z-coordinate in block coordinates in world space.
    
    Returns:
    
    Whether the given x/z coordinates are within the level area.
  - hasPregenerated
```
public boolean hasPregenerated()
```
    Indicates whether the level data has been generated.
    
    Returns:
    
    Whether the level is generated and data can be fetched from the level data.
  - skipChunk
```
public boolean skipChunk(int chunkX,
                         int chunkZ)
```
    Indicate whether the chunk at the given coordinates should be skipped. The chunk is skipped if the chunk coordinates being tested are outside of level bounds.
    
    Overrides:
    
    skipChunk in class ChunkSource
    
    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. The chunk is pruned if the chunk coordinates being tested are outside of level bounds.
    
    Overrides:
    
    pruneChunk in class ChunkSource
    
    Parameters:
    
    chunkX - x-coordinate in chunk coordinates
    
    chunkZ - z-coordinate in chunk coordinates
    
    world - The world object
  - createBiomeInjectionRules
```
public BiomeInjectionRules.Builder createBiomeInjectionRules(BiomeSource biomeSource)
```
    Description copied from class: ChunkSource
    
    Creates the rule set builder used for biome injection.
    
    Overrides:
    
    createBiomeInjectionRules in class ChunkSource
    
    Parameters:
    
    biomeSource - The biome source.
    
    Returns:
    
    The biome injection rules.
  - pregenerateTerrain
```
protected abstract void pregenerateTerrain()
```
    Generates the level data.
  - generateBorder
```
protected abstract void generateBorder(net.minecraft.world.chunk.ChunkPrimer chunkPrimer,
                                       int chunkX,
                                       int chunkZ)
```
    Generates the world chunks outside of the level bounds.
    
    Parameters:
    
    chunkPrimer - The chunk primer.
    
    chunkX - x-coordinate in chunk coordinates
    
    chunkZ - z-coordinate in chunk coordinates
  - getBorderHeight
```
protected abstract int getBorderHeight(int x,
                                       int z,
                                       HeightmapChunk.Type type)
```
    Sample height at given x/z coordinate for coordinates outside of the level bounds.
    
    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 outside of the level bounds.
  - pregenerateLevelOrWait
```
protected void pregenerateLevelOrWait(FiniteChunkSource.LevelDataContainer levelDataContainer)
```
    Checks if the level data has generated yet, if not, then generates the level data. If `saveIndevLevels` has been enabled, then the level will be saved to disk after generation.
    
    Parameters:
    
    levelDataContainer - The level data container.
  - inLevelBounds
```
protected boolean inLevelBounds(int x,
                                int y,
                                int z)
```
    Indicates whether the given level coordinates are within the level area.
    
    Parameters:
    
    x - x-coordinate in block coordinates in level space.
    
    y - y-coordinate in block coordinates in level space.
    
    z - z-coordinate in block coordinates in level space.
    
    Returns:
    
    Whether the given x/z coordinates are within the level area.
  - atLevelBounds
```
protected boolean atLevelBounds(int x,
                                int y,
                                int z)
```
    Indicates whether the given level coordinates are at the level bounds.
    
    Parameters:
    
    x - x-coordinate in block coordinates in level space.
    
    y - y-coordinate in block coordinates in level space.
    
    z - z-coordinate in block coordinates in level space.
    
    Returns:
    
    Whether the given x/z coordinates are at the level bounds.
  - fillOblateSpheroid
```
protected void fillOblateSpheroid(float centerX,
                                  float centerY,
                                  float centerZ,
                                  float radius,
                                  net.minecraft.block.Block fillBlock)
```
    Fills a space in level data in a spheroid shape. Used to carve caves.
    
    Parameters:
    
    centerX - x-coordinate in block coordinates in level space.
    
    centerY - y-coordinate in block coordinates in level space.
    
    centerZ - z-coordinate in block coordinates in level space.
    
    radius - Radius of spheroid shape.
    
    fillBlock - Block to fill into space.
  - flood
```
protected int flood(int x,
                    int y,
                    int z,
                    net.minecraft.block.Block fillBlock,
                    net.minecraft.block.Block replaceBlock)
```
    Floods the level downward and outward from a given starting position and fill/replace blocks. Does not provide the array of flooded positions to keep track, thus it will attempt to flood as many blocks as possible.
    
    Parameters:
    
    x - x-coordinate in block coordinates in level space.
    
    y - y-coordinate in block coordinates in level space.
    
    z - z-coordinate in block coordinates in level space.
    
    fillBlock - The block to fill the space with.
    
    replaceBlock - The block to replace.
    
    Returns:
    
    Number of flooded blocks if not exceeding MAX_FLOODS or if floodedPositions is null. -1 otherwise.
  - flood
```
protected int flood(int startX,
                    int startY,
                    int startZ,
                    net.minecraft.block.Block fillBlock,
                    net.minecraft.block.Block replaceBlock,
                    net.minecraft.util.math.Vec3d[] floodedPositions)
```
    Floods the level downward and outward from a given starting position and fill/replace blocks. If `floodedPositions` is provided, then the method will only fill up to MAX_FLOODS positions and then return. The intent is to use a test block as the `fillBlock` (see PLACEHOLDER_BLOCK), then fill with the actual fill block if the number of floods is below MAX_FLOODS. Otherwise you should refill with the original block using the array positions. More comments below: Not the original algorithm, but did extensive testing/reverse engineering against a modded instance of Indev, so this is accurate except in one case -- doing edge floods for Inland worlds; this shouldn't seem possible given that the edges should never be exposed, but for some reason some underground pockets along the level edge still flood. The algorithm should basically just be flooding downwards and outwards given a starting position, however, what I'm fairly certain the original algorithm does when flooding along map edges: Flooding can touch edges of the map (x = 0 / z = 0 / x = levelWidth - 1 / z = levelLength - 1 / y = 0 / y = levelHeight - 1) if doing edge floods (does a check for filler block id 255 which is only done for random position floods), otherwise cancel the flood. However, there seems to be a bug where the check if x = levelWidth - 1 does not actually use x, so the original level generator allows water to generate where x = levelWidth - 1 above ground. This bug is fixed here, because I'm not sure how to consistently reproduce it.
    
    Parameters:
    
    startX - x-coordinate in block coordinates in level space.
    
    startY - y-coordinate in block coordinates in level space.
    
    startZ - z-coordinate in block coordinates in level space.
    
    fillBlock - The block to fill the space with.
    
    replaceBlock - The block to replace.
    
    floodedPositions - The array of Vec3d positions that have been filled. This is used to track positions to quickly fill with another block type.
    
    Returns:
    
    Number of flooded blocks if not exceeding MAX_FLOODS or if floodedPositions is null. -1 otherwise.
  - setPhase
```
protected void setPhase(java.lang.String phase)
```
    Sets the current generation phase for the level. This is printed to the console and the level loading screen.
    
    Parameters:
    
    phase - Generation phase.
  - setPhaseProgress
```
protected void setPhaseProgress(float phaseProgress)
```
    Sets the current generation phase progress for the level. Currently unused.
    
    Parameters:
    
    phaseProgress - The decimal phase progress. (i.e. 50% equals 0.5)

Class FiniteChunkSource

Nested Class Summary

Field Summary

Fields inherited from class mod.bespectacled.modernbetaforge.api.world.chunk.source.ChunkSource

Constructor Summary

Method Summary

Methods inherited from class mod.bespectacled.modernbetaforge.api.world.chunk.source.ChunkSource

Methods inherited from class java.lang.Object

Field Detail

PLACEHOLDER_BLOCK

MAX_FLOODS

levelWidth

levelLength

levelHeight

levelCaveWidth

levelHeightmap

biomeSource

Constructor Detail

FiniteChunkSource

Method Detail

getWorldSpawner

provideInitialChunk

provideProcessedChunk

provideSurface

getHeight

getLevelBlock

setLevelBlock

getLevelHeight

getLevelWidth

getLevelLength

getLevelHeight

getPhase

setLevelNotifier

loadOrCreateLevelDataContainer

saveLevelDataContainer

pregenerateTerrainOrWait

buildHouse

inWorldBounds

hasPregenerated

skipChunk

pruneChunk

createBiomeInjectionRules

pregenerateTerrain

generateBorder

getBorderHeight

pregenerateLevelOrWait

inLevelBounds

atLevelBounds

fillOblateSpheroid

flood

flood

setPhase

setPhaseProgress