org.pepsoft.minecraft

Interface ChunkProvider

All Superinterfaces:

java.lang.AutoCloseable

All Known Subinterfaces:

ChunkStore, MinecraftWorld

All Known Implementing Classes:

CachingMinecraftWorld, InvertedWorld, JavaChunkStore, JavaMinecraftWorld, MC115AnvilChunk, MC118AnvilChunk, MC12AnvilChunk, MemoryChunk, MinecraftWorldObject, WorldRegion

public interface ChunkProvider
extends java.lang.AutoCloseable

A provider of Minecraft chunks.

This API's coordinate system is the Minecraft coordinate system (W <- x -> E, N <- z -> S).

Method Summary

Modifier and Type	Method and Description
void	close() Close the chunk provider, flushing any changes and closing any system resources.
Chunk	getChunk(int x, int z) Retrieve a chunk.
Chunk	getChunkForEditing(int x, int z) Retrieve a chunk for editing.
boolean	isChunkPresent(int x, int z) Determine whether a chunk is present.

Method Detail

isChunkPresent

boolean isChunkPresent(int x,
                       int z)

Determine whether a chunk is present.

Parameters:

x - The X coordinate to check.

z - The Z coordinate to check.

Returns:

true if the chunk provider contains a chunk at the specified coordinates.

getChunk

Chunk getChunk(int x,
               int z)

Retrieve a chunk. If the chunk does not exist, null is returned. The returned chunk may be read-only.

Parameters:

x - The X coordinate of the chunk to retrieve.

z - The Z coordinate of the chunk to retrieve.

Returns:

The specified chunk, or null if there is no chunk at the specified coordinates.

getChunkForEditing

Chunk getChunkForEditing(int x,
                         int z)

Retrieve a chunk for editing. If the chunk does not exist, null may be returned, or the provider may create a new, empty chunk. The returned chunk is guaranteed not to be read-only.

Parameters:

x - The X coordinate of the chunk to retrieve.

z - The Z coordinate of the chunk to retrieve.

Returns:

The specified chunk, or null if there is no chunk at the specified coordinates, and this chunk provider does not create new chunks.

close

void close()

Close the chunk provider, flushing any changes and closing any system resources.

Specified by:

close in interface java.lang.AutoCloseable