Package org.popcraft.chunky.api

Interface ChunkyAPI

public interface ChunkyAPI
The Chunky API

  • Method Details

    • version

      int version()
      Gets the current API version.
      Returns:
      The api version

    • isRunning

      boolean isRunning(String world)
      Gets whether a generation task is currently running for a world.
      Parameters:
      world - The world identifier
      Returns:
      If a task is running in that world

    • startTask

      boolean startTask(String world, String shape, double centerX, double centerZ, double radiusX, double radiusZ, String pattern)
      Starts a generation task with a given selection in a world.
      Parameters:
      world - The world identifier
      shape - The selection shape
      centerX - The center x coordinate
      centerZ - The center z coordinate
      radiusX - The primary radius (x-axis)
      radiusZ - The secondary radius (z-axis) (only used for certain shapes)
      pattern - The generation pattern
      Returns:
      If the task was created and started successfully

    • pauseTask

      boolean pauseTask(String world)
      Pauses a generation task in a world.
      Parameters:
      world - The world identifier
      Returns:
      If the task was paused

    • continueTask

      boolean continueTask(String world)
      Continues a generation task in a world.
      Parameters:
      world - The world identifier
      Returns:
      If the task was continued

    • cancelTask

      boolean cancelTask(String world)
      Cancels a generation task in a world.
      Parameters:
      world - The world identifier
      Returns:
      If the task was cancelled

    • onGenerationProgress

      void onGenerationProgress(Consumer<GenerationProgressEvent> listener)
      Register a listener for generation progress events.
      Parameters:
      listener - The listener

    • onGenerationComplete

      void onGenerationComplete(Consumer<GenerationCompleteEvent> listener)
      Register a listener for generation complete events.
      Parameters:
      listener - The listener