Package com.plotsquared.core.generator

Class IndependentPlotGenerator

java.lang.Object
com.plotsquared.core.generator.IndependentPlotGenerator
Direct Known Subclasses:
HybridGen, SingleWorldGenerator
public abstract class IndependentPlotGenerator extends Object
This class allows for implementation independent world generation. - Sponge/Bukkit API Use the specify method to get the generator for that platform.

  • Constructor Details

  • Method Details

    • getName

      public abstract String getName()
      Get the name of this generator.
      Returns:
      generator name

    • generateChunk

      public abstract void generateChunk(ZeroedDelegateScopedQueueCoordinator result, PlotArea settings, boolean biomes)
      Generate chunk block data
      Parameters:
      result - Queue to write to
      settings - PlotArea (settings)
      biomes - If biomes should be generated
      Since:
      7.0.0

    • populateChunk

      public void populateChunk(ZeroedDelegateScopedQueueCoordinator result, PlotArea setting)
      Populate a chunk-queue with tile entities, entities, etc.
      Parameters:
      result - Queue to write to
      setting - PlotArea (settings)
      Since:
      7.0.0

    • getNewPlotArea

      public abstract PlotArea getNewPlotArea(String world, String id, PlotId min, PlotId max)
      Return a new PlotArea object.
      Parameters:
      world - world name
      id - (May be null) Area name
      min - Min plot id (may be null)
      max - Max plot id (may be null)
      Returns:
      new plot area

    • processAreaSetup

      public void processAreaSetup(PlotAreaBuilder builder)
      If any additional setup options need to be changed before world creation. - e.g. If setup doesn't support some standard options
      Parameters:
      builder - the area builder to modify

    • initialize

      public abstract void initialize(PlotArea area)
      It is preferred for the PlotArea object to do most of the initialization necessary.
      Parameters:
      area - area

    • specify

      public <T> GeneratorWrapper<T> specify(@NonNull String world)
      Get the generator for your specific implementation (bukkit/sponge).
      - e.g. YourIndependentGenerator.<ChunkGenerator>specify() - Would return a ChunkGenerator object
      Type Parameters:
      T - world
      Parameters:
      world - ChunkGenerator Implementation
      Returns:
      Chunk generator

    • getBiome

      public abstract BiomeType getBiome(PlotArea settings, int x, int y, int z)
      Get the biome to be generated at a specific point
      Parameters:
      settings - PlotArea settings to provide biome
      x - World x position
      y - World y position
      z - World z position
      Returns:
      Biome type to be generated
      Since:
      7.0.0

    • toString

      public String toString()
      Overrides:
      toString in class Object