Class AbstractFlatGenerator

java.lang.Object
org.bukkit.generator.ChunkGenerator
ua.mcchickenstudio.opencreative.utils.world.generators.WorldGenerator
ua.mcchickenstudio.opencreative.utils.world.generators.AbstractFlatGenerator
All Implemented Interfaces:
ExtensionContent
Direct Known Subclasses:
CustomFlatGenerator
public abstract class AbstractFlatGenerator extends WorldGenerator

AbstractFlatGenerator

This class represents a flat world generator, that will generate layers of blocks. To add layers, just put them in blocks map, that contains Y coordinates and materials of blocks.

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.bukkit.generator.ChunkGenerator

    org.bukkit.generator.ChunkGenerator.BiomeGrid, org.bukkit.generator.ChunkGenerator.ChunkData

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.bukkit.block.Biome
    biome
     
    protected final Map<Integer, org.bukkit.Material>
    blocks
     
    protected boolean
    generateTrees
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractFlatGenerator(@NotNull String id, @NotNull org.bukkit.inventory.ItemStack displayIcon)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    afterCreation(@NotNull org.bukkit.World world)
    Executes world operations, when it's created or loaded.
    boolean
    canSpawn(@NotNull org.bukkit.World world, int x, int z)
     
    void
    generateSurface(@NotNull org.bukkit.generator.WorldInfo worldInfo, @NotNull Random random, int chunkX, int chunkZ, @NotNull org.bukkit.generator.ChunkGenerator.ChunkData chunkData)
     
    @Nullable org.bukkit.generator.BiomeProvider
    getDefaultBiomeProvider(@NotNull org.bukkit.generator.WorldInfo worldInfo)
     
    @NotNull List<org.bukkit.generator.BlockPopulator>
    getDefaultPopulators(@NotNull org.bukkit.World world)
     
    @Nullable org.bukkit.Location
    getFixedSpawnLocation(@NotNull org.bukkit.World world, @NotNull Random random)
     
    void
    modifyWorldCreator(@NotNull org.bukkit.WorldCreator creator, @NotNull String biome)
    Changes world creator before creating or loading world.

    Methods inherited from class WorldGenerator

    getDisplayIcon, getID, getLocaleName, getName
    Modifier and Type
    Method
    Description
    org.bukkit.inventory.ItemStack
    getDisplayIcon()
    Returns an icon that will be used in world generation menu.
    final @NotNull String
    getID()
    Returns id of world generator, that will be used to find it in registry.
    @NotNull String
    getLocaleName()
    Returns localized name for displaying.
    @NotNull String
    getName()
    Returns name of world generator for displaying in registry by converting id.

    Methods inherited from class org.bukkit.generator.ChunkGenerator

    createChunkData, generateBedrock, generateCaves, generateChunkData, generateNoise, getBaseHeight, isParallelCapable, shouldGenerateBedrock, shouldGenerateCaves, shouldGenerateCaves, shouldGenerateDecorations, shouldGenerateDecorations, shouldGenerateMobs, shouldGenerateMobs, shouldGenerateNoise, shouldGenerateNoise, shouldGenerateStructures, shouldGenerateStructures, shouldGenerateSurface, shouldGenerateSurface

    Methods inherited from class Object

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

    Methods inherited from interface ExtensionContent

    getDescription, getExtensionId
    Modifier and Type
    Method
    Description
    @NotNull String
    getDescription()
    Returns description of extension content.
    @NotNull String
    getExtensionId()
    Returns lower-cased simple id of extension.

  • Field Details

    • blocks

      protected final Map<Integer, org.bukkit.Material> blocks

    • biome

      protected org.bukkit.block.Biome biome

    • generateTrees

      protected boolean generateTrees

  • Constructor Details

    • AbstractFlatGenerator

      public AbstractFlatGenerator(@NotNull @NotNull String id, @NotNull @NotNull org.bukkit.inventory.ItemStack displayIcon)

  • Method Details

    • modifyWorldCreator

      public void modifyWorldCreator(@NotNull @NotNull org.bukkit.WorldCreator creator, @NotNull @NotNull String biome)
      Description copied from class: WorldGenerator
      Changes world creator before creating or loading world. Useful to set generator as itself, if it overrides generateSurface method.
      Specified by:
      modifyWorldCreator in class WorldGenerator
      Parameters:
      creator - creator to change.
      biome - selected biome.

    • getFixedSpawnLocation

      @Nullable public @Nullable org.bukkit.Location getFixedSpawnLocation(@NotNull @NotNull org.bukkit.World world, @NotNull @NotNull Random random)
      Overrides:
      getFixedSpawnLocation in class org.bukkit.generator.ChunkGenerator

    • canSpawn

      public boolean canSpawn(@NotNull @NotNull org.bukkit.World world, int x, int z)
      Overrides:
      canSpawn in class org.bukkit.generator.ChunkGenerator

    • afterCreation

      public void afterCreation(@NotNull @NotNull org.bukkit.World world)
      Description copied from class: WorldGenerator
      Executes world operations, when it's created or loaded.
      Specified by:
      afterCreation in class WorldGenerator
      Parameters:
      world - world to execute code in it.

    • generateSurface

      public void generateSurface(@NotNull @NotNull org.bukkit.generator.WorldInfo worldInfo, @NotNull @NotNull Random random, int chunkX, int chunkZ, @NotNull @NotNull org.bukkit.generator.ChunkGenerator.ChunkData chunkData)
      Overrides:
      generateSurface in class org.bukkit.generator.ChunkGenerator

    • getDefaultBiomeProvider

      @Nullable public @Nullable org.bukkit.generator.BiomeProvider getDefaultBiomeProvider(@NotNull @NotNull org.bukkit.generator.WorldInfo worldInfo)
      Overrides:
      getDefaultBiomeProvider in class org.bukkit.generator.ChunkGenerator

    • getDefaultPopulators

      @NotNull public @NotNull List<org.bukkit.generator.BlockPopulator> getDefaultPopulators(@NotNull @NotNull org.bukkit.World world)
      Overrides:
      getDefaultPopulators in class org.bukkit.generator.ChunkGenerator