Package com.seibel.distanthorizons.api.interfaces.override.worldGenerator

Class AbstractDhApiChunkWorldGenerator

java.lang.Object
com.seibel.distanthorizons.api.interfaces.override.worldGenerator.AbstractDhApiChunkWorldGenerator
All Implemented Interfaces:
IDhApiOverrideable, IDhApiWorldGenerator, IBindable, Closeable, AutoCloseable
public abstract class AbstractDhApiChunkWorldGenerator extends Object implements Closeable, IDhApiOverrideable, IDhApiWorldGenerator
Since:
API 1.0.0

  • Constructor Details

    • AbstractDhApiChunkWorldGenerator

      public AbstractDhApiChunkWorldGenerator()

  • Method Details

    • getSmallestDataDetailLevel

      public final byte getSmallestDataDetailLevel()
      Description copied from interface: IDhApiWorldGenerator
      Defines the smallest datapoint size that can be generated at a time.
      Minimum detail level is 0 (1 block)
      Default detail level is 0
      For more information on what detail levels represent see: EDhApiDetailLevel.

      TODO: System currently only supports 1x1 block per data.
      Specified by:
      getSmallestDataDetailLevel in interface IDhApiWorldGenerator
      See Also:

    • getLargestDataDetailLevel

      public final byte getLargestDataDetailLevel()
      Description copied from interface: IDhApiWorldGenerator
      Defines the largest datapoint size that can be generated at a time.
      Minimum detail level is 0 (1 block)
      Default detail level is 0
      For more information on what detail levels represent see: EDhApiDetailLevel.
      Specified by:
      getLargestDataDetailLevel in interface IDhApiWorldGenerator
      See Also:

    • getMinGenerationGranularity

      public final byte getMinGenerationGranularity()
      Description copied from interface: IDhApiWorldGenerator
      When creating generation requests the system will attempt to group nearby tasks together.

      What is the minimum size a single generation call can batch together?
      Minimum detail level is 4 (the size of a MC chunk)
      Default detail level is 4
      For more information on what detail levels represent see: EDhApiDetailLevel.
      Specified by:
      getMinGenerationGranularity in interface IDhApiWorldGenerator
      See Also:

    • getMaxGenerationGranularity

      public final byte getMaxGenerationGranularity()
      Description copied from interface: IDhApiWorldGenerator
      When creating generation requests the system will attempt to group nearby tasks together.

      What is the maximum size a single generation call can batch together?
      Minimum detail level is 4 (the size of a MC chunk)
      Default detail level is 6 (4x4 chunks)
      For more information on what detail levels represent see: EDhApiDetailLevel.
      Specified by:
      getMaxGenerationGranularity in interface IDhApiWorldGenerator
      See Also:

    • generateChunks

      public final CompletableFuture<Void> generateChunks(int chunkPosMinX, int chunkPosMinZ, byte granularity, byte targetDataDetail, EDhApiDistantGeneratorMode generatorMode, ExecutorService worldGeneratorThreadPool, Consumer<Object[]> resultConsumer) throws ClassCastException
      Description copied from interface: IDhApiWorldGenerator
      This method is called by Distant Horizons to generate terrain over a given area when IDhApiWorldGenerator.getReturnType() returns EDhApiWorldGeneratorReturnType.VANILLA_CHUNKS.

      After a chunk has been generated it (and any necessary supporting objects as listed below) should be passed into the resultConsumer's Consumer.accept(T) method. If the Consumer is given the wrong data type(s) it will disable the world generator and log an error with a list of objects it was expecting.
      Note: these objects are minecraft version dependent and will change without notice! Please run your generator in game at least once to confirm the objects you are returning are correct.

      Consumer expected inputs for each minecraft version (in order):
      1.16, 1.17, 1.18, 1.19, 1.20:
      - [net.minecraft.world.level.chunk.ChunkAccess]
      - [net.minecraft.world.level.ServerLevel] or [net.minecraft.world.level.ClientLevel]
      Specified by:
      generateChunks in interface IDhApiWorldGenerator
      Parameters:
      chunkPosMinX - the chunk X position closest to negative infinity
      chunkPosMinZ - the chunk Z position closest to negative infinity
      granularity - TODO find a central location to store the definition of granularity. For now it is stored in the Core method: WorldGenerationQueue#startGenerationEvent
      targetDataDetail - the LOD Detail level requested to generate. See EDhApiDetailLevel for additional information.
      generatorMode - how far into the world gen pipeline this method run. See EDhApiDistantGeneratorMode for additional documentation.
      worldGeneratorThreadPool - the thread pool that should be used when generating the returned CompletableFuture.
      resultConsumer - the consumer that should be fired whenever a chunk finishes generating.
      Returns:
      a future that should run on the worldGeneratorThreadPool and complete once the given generation task has completed.
      Throws:
      ClassCastException

    • generateChunk

      public abstract Object[] generateChunk(int chunkPosX, int chunkPosZ, EDhApiDistantGeneratorMode generatorMode)
      This method is called to generate terrain over a given area from a thread defined by Distant Horizons.

      Parameters:
      chunkPosX - the chunk X position in the level (not to be confused with the chunk's BlockPos in the level)
      chunkPosZ - the chunk Z position in the level (not to be confused with the chunk's BlockPos in the level)
      generatorMode - how far into the world gen pipeline this method run. See EDhApiDistantGeneratorMode for additional documentation.
      Returns:
      See IDhApiWorldGenerator.generateChunks for the list of Object's this method should return along with additional documentation.
      See Also: