Class AnvilLoader

java.lang.Object
net.minestom.server.instance.anvil.AnvilLoader
All Implemented Interfaces:
ChunkLoader
public class AnvilLoader extends Object implements ChunkLoader

  • Constructor Details

    • AnvilLoader

      public AnvilLoader(Path path, Key dimension)
      Creates a new AnvilLoader for the given world path and dimension.
      Parameters:
      path - The path to the world
      dimension - The key for the dimension. Use DimensionType for getting vanilla keys for dimensions.

    • AnvilLoader

      @Deprecated(forRemoval=true) public AnvilLoader(Path path)
      Deprecated, for removal: This API element is subject to removal in a future version.
      This creates the AnvilLoader for worlds created before 26.1. Use AnvilLoader(Path, Key) instead.
      Parameters:
      path - The path to the world

    • AnvilLoader

      @Deprecated(forRemoval=true) public AnvilLoader(String path)
      Deprecated, for removal: This API element is subject to removal in a future version.
      This creates the AnvilLoader for worlds created before 26.1. Use AnvilLoader(Path, Key) instead.
      Parameters:
      path - The path to the world

  • Method Details

    • loadInstance

      public void loadInstance(Instance instance)
      Description copied from interface: ChunkLoader
      Loads instance data from the loader.
      Specified by:
      loadInstance in interface ChunkLoader
      Parameters:
      instance - the instance to retrieve the data from

    • loadChunk

      @Nullable public @Nullable Chunk loadChunk(Instance instance, int chunkX, int chunkZ)
      Description copied from interface: ChunkLoader
      Loads a Chunk, all blocks should be set since the Generator is not applied.

      Implementations must not initiate another chunk load on the same Instance from this method. Doing so re-enters the instance's loading registry and may fail with an IllegalStateException. If loading a chunk requires data associated with neighboring chunks, read that data directly from the backing storage instead of calling Instance.loadChunk(int, int) or Instance.loadOptionalChunk(int, int).

      A loader must never wait for the same chunk it is currently loading. Requests for an in-progress chunk share the existing future, so waiting for that future from this method would wait for the current invocation.

      Specified by:
      loadChunk in interface ChunkLoader
      Parameters:
      instance - the Instance where the Chunk belong
      chunkX - the chunk X
      chunkZ - the chunk Z
      Returns:
      the chunk, or null if not present

    • saveInstance

      public void saveInstance(Instance instance)
      Specified by:
      saveInstance in interface ChunkLoader

    • saveChunk

      public void saveChunk(Chunk chunk)
      Description copied from interface: ChunkLoader
      Saves a Chunk with an optional callback for when it is done.
      Specified by:
      saveChunk in interface ChunkLoader
      Parameters:
      chunk - the Chunk to save

    • unloadChunk

      public void unloadChunk(Chunk chunk)
      Unload a given chunk. Also unloads a region when no chunk from that region is loaded.
      Specified by:
      unloadChunk in interface ChunkLoader
      Parameters:
      chunk - the chunk to unload

    • supportsParallelLoading

      public boolean supportsParallelLoading()
      Description copied from interface: ChunkLoader
      Supports for instance/chunk loading in virtual threads.

      When true, chunks may load in parallel on virtual threads. When false, ChunkLoader.loadChunk(Instance, int, int) runs synchronously on the thread requesting the load. The re-entrant loading restrictions documented on ChunkLoader.loadChunk(Instance, int, int) apply in either case.

      Specified by:
      supportsParallelLoading in interface ChunkLoader
      Returns:
      true if the chunk loader supports parallel loading

    • supportsParallelSaving

      public boolean supportsParallelSaving()
      Description copied from interface: ChunkLoader
      Supports for instance/chunk saving in virtual threads.
      Specified by:
      supportsParallelSaving in interface ChunkLoader
      Returns:
      true if the chunk loader supports parallel saving