com.bergerkiller.bukkit.common

Class BlockLocation

java.lang.Object

com.bergerkiller.bukkit.common.BlockLocation

public class BlockLocation
extends Object

Contains a world name and block coordinates

Field Summary

Fields

Modifier and Type	Field and Description
String	world
int	x
int	y
int	z

Constructor Summary

Constructors

Constructor and Description
BlockLocation(org.bukkit.block.Block block) Initializes a new Block Location using a Block
BlockLocation(ConfigurationNode node) Initializes a new Block Location using the data in the configuration node
BlockLocation(org.bukkit.Location location) Initializes a new Block Location using a Location
BlockLocation(String world, int x, int y, int z) Initializes a new Block Location using a world and x/y/z coordinate
BlockLocation(String world, IntVector3 coordinates) Initializes a new Block Location usinga world and coordinates pair
BlockLocation(org.bukkit.World world, int x, int y, int z) Initializes a new Block Location using a world and x/y/z coordinate

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
org.bukkit.block.Block	getBlock() Gets the Block this Location is in
org.bukkit.Chunk	getChunk() Gets the chunk this Block Location is in Will load the chunk if it isn't loaded
IntVector3	getCoordinates() Gets the x/y/z coordinates of this Block Location as an IntVector3
org.bukkit.Location	getLocation() Gets the Location from this Block Location
org.bukkit.World	getWorld() Gets the World this Location is in
int	hashCode()
boolean	isIn(BlockLocation point1, BlockLocation point2) Checks if this Block Location is within the boundaries of a cuboid
boolean	isIn(org.bukkit.Chunk chunk) Checks if this Block Location is within the boundaries of a chunk
boolean	isIn(org.bukkit.World world) Checks if this Location is in the World specified
boolean	isLoaded() Checks if this location is loaded
static BlockLocation	parseLocation(String value) Tries to parse a Block Location from a String value
void	save(ConfigurationNode node)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

x

public final int x

y

public final int y

z

public final int z

world

public final String world

Constructor Detail

BlockLocation

public BlockLocation(ConfigurationNode node)

Initializes a new Block Location using the data in the configuration node

Parameters:

node - to use

BlockLocation

public BlockLocation(org.bukkit.block.Block block)

Initializes a new Block Location using a Block

Parameters:

block - to use

BlockLocation

public BlockLocation(org.bukkit.Location location)

Initializes a new Block Location using a Location

Parameters:

location - to use

BlockLocation

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

Initializes a new Block Location using a world and x/y/z coordinate

Parameters:

world - to use the name of

x - - coordinate

y - - coordinate

z - - coordinate

BlockLocation

public BlockLocation(String world,
                     int x,
                     int y,
                     int z)

Initializes a new Block Location using a world and x/y/z coordinate

Parameters:

world - name to use

x - - coordinate

y - - coordinate

z - - coordinate

BlockLocation

public BlockLocation(String world,
                     IntVector3 coordinates)

Initializes a new Block Location usinga world and coordinates pair

Parameters:

world - name to use

coordinates - to use

Method Detail

parseLocation

public static BlockLocation parseLocation(String value)

Tries to parse a Block Location from a String value

Parameters:

value - to parse

Returns:

Block Location, or null if it could not be parsed

getChunk

public org.bukkit.Chunk getChunk()

Gets the chunk this Block Location is in
Will load the chunk if it isn't loaded

Returns:

the Chunk, or null if the world this location is in is not loaded

getCoordinates

public IntVector3 getCoordinates()

Gets the x/y/z coordinates of this Block Location as an IntVector3

Returns:

block coordinates vector

getLocation

public org.bukkit.Location getLocation()

Gets the Location from this Block Location

Returns:

the Location of the middle of the Block, or null if the world is not loaded

getBlock

public org.bukkit.block.Block getBlock()

Gets the Block this Location is in

Returns:

the Block, or null if the world this location is in is not loaded

getWorld

public org.bukkit.World getWorld()

Gets the World this Location is in

Returns:

the World, or null if it is not loaded

isLoaded

public boolean isLoaded()

Checks if this location is loaded

Returns:

True if it is loaded, False if not

isIn

public boolean isIn(org.bukkit.World world)

Checks if this Location is in the World specified

Parameters:

world - to check

Returns:

True if it is in the world, False if not

isIn

public boolean isIn(org.bukkit.Chunk chunk)

Checks if this Block Location is within the boundaries of a chunk

Parameters:

chunk - to check

Returns:

True if within, False if not

isIn

public boolean isIn(BlockLocation point1,
                    BlockLocation point2)

Checks if this Block Location is within the boundaries of a cuboid

Parameters:

point1 - of the Cuboid

point2 - of the Cuboid

Returns:

True if within, False if not

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

save

public void save(ConfigurationNode node)