Chunk Location API

Note

Predominantly for use with PacketHandlers.

ChunkLocation

A chunk location, represented as (x, z) chunk coordinates. It’s an immutable record of chunk-space (x, z) coordinates, with helpers for converting to and from block coordinates and Bukkit chunks.

Construction

• of(int, int): Creates a ChunkLocation from chunk coordinates.
• fromBlockCoords(int, int): Creates a ChunkLocation from block coordinates, converting them to the containing chunk.

Comparison

• isChunk(Chunk): Checks whether this location matches the given Bukkit Chunk.
• isChunk(int, int): Checks whether this location matches the given chunk coordinates.
• isWithinRadius(ChunkLocation, int): Returns whether this location falls within radius chunks of another.

Transformation

• offset(int, int): Returns a new ChunkLocation shifted by the given x/z offsets.
• offset(ChunkLocation): Returns a new ChunkLocation shifted by another location’s coordinates.
• negate(): Returns a new ChunkLocation with both coordinates negated.

World lookups

These resolve against a live World and return a CompletableFuture, since the chunk may need to load asynchronously.

• toBukkitChunk(World): Resolves this location to a Bukkit Chunk in the given world.
• centerBlock(World): Gets the center block of this chunk in the given world.
• getCenterBiome(World): Gets the biome of this chunk’s center block in the given world.