io.github.bananapuncher714.cartographer.core.api

Class ChunkLocation

java.lang.Object

io.github.bananapuncher714.cartographer.core.api.ChunkLocation

public class ChunkLocation
extends java.lang.Object

Represents a Bukkit chunk's location.

Author:

BananaPuncher714

Constructor Summary

Constructors

Constructor and Description
ChunkLocation(org.bukkit.Chunk chunk) Create a ChunkLocation from a Bukkit chunk.
ChunkLocation(ChunkLocation location) Copy a ChunkLocation.
ChunkLocation(org.bukkit.ChunkSnapshot snapshot) Create a ChunkLocation from a ChunkSnapshot.
ChunkLocation(org.bukkit.Location location) Construct a ChunkLocation from a Location.
ChunkLocation(org.bukkit.World world, int x, int z) Create a ChunkLocation from chunk coordinates.

Method Summary

Modifier and Type	Method and Description
ChunkLocation	add(int x, int z) Add coordinates from current coordinates.
boolean	equals(java.lang.Object obj)
boolean	exists() Check if this chunk exists.
org.bukkit.Chunk	getChunk() Get the chunk this location represents.
org.bukkit.World	getWorld() Get the world.
int	getX() Get the x coordinate.
int	getZ() Get the z coordinate.
int	hashCode()
boolean	isLoaded() Check if the chunk that this location represents is loaded.
void	load() Load the chunk that this location represents.
void	setWorld(org.bukkit.World world) Set the world.
ChunkLocation	setX(int x) Set the x coordinate.
ChunkLocation	setZ(int z) Set the z coordinate.
ChunkLocation	subtract(int x, int z) Subtract coordinates from current coordinates.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ChunkLocation

public ChunkLocation(org.bukkit.Location location)

Construct a ChunkLocation from a Location.

Parameters:

location - Cannot be null.

ChunkLocation

public ChunkLocation(ChunkLocation location)

Copy a ChunkLocation.

Parameters:

location - Cannot be null.

ChunkLocation

public ChunkLocation(org.bukkit.World world,
                     int x,
                     int z)

Create a ChunkLocation from chunk coordinates.

Parameters:

world - Cannot be null.

x - Chunk coordinate x value.

z - Chunk coordinate z value.

ChunkLocation

public ChunkLocation(org.bukkit.Chunk chunk)

Create a ChunkLocation from a Bukkit chunk.

Parameters:

chunk - Cannot be null.

ChunkLocation

public ChunkLocation(org.bukkit.ChunkSnapshot snapshot)

Create a ChunkLocation from a ChunkSnapshot.

Parameters:

snapshot - Cannot be null. The world will not be cached, only the world name.

Method Detail

getX

public int getX()

Get the x coordinate.

Returns:

Chunk coordinate x value.

setX

public ChunkLocation setX(int x)

Set the x coordinate.

Parameters:

x - Chunk coordinate x value.

getZ

public int getZ()

Get the z coordinate.

Returns:

Chunk coordinate z value.

setZ

public ChunkLocation setZ(int z)

Set the z coordinate.

Parameters:

z - Chunk coordinate z value.

add

public ChunkLocation add(int x,
                         int z)

Add coordinates from current coordinates.

Parameters:

x - Chunk x coordinate value.

z - Chunk z coordinate value.

Returns:

This location.

subtract

public ChunkLocation subtract(int x,
                              int z)

Subtract coordinates from current coordinates.

Parameters:

x - Chunk x coordinate value.

z - Chunk z coordinate value.

Returns:

This location.

getWorld

public org.bukkit.World getWorld()

Get the world.

Returns:

A non-null world, will fetch and cache the world if not cached already.

setWorld

public void setWorld(org.bukkit.World world)

Set the world.

Parameters:

world - Cannot be null.

getChunk

public org.bukkit.Chunk getChunk()

Get the chunk this location represents.

Returns:

May load the chunk.

isLoaded

public boolean isLoaded()

Check if the chunk that this location represents is loaded.

Returns:

If the chunk is loaded. Does not load the chunk.

load

public void load()

Load the chunk that this location represents.

exists

public boolean exists()

Check if this chunk exists.

Returns:

Checks if the chunk exists, does not have to be loaded.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object