gekkit/org.bukkit/Location

Location

public class Location implements Cloneable, ConfigurationSerializable

Represents 3-dimensional position in world

Constructors

Location

public void Location(World world, double x, double y, double z)

Constructs new Location with the given coordinates

public void Location(World world, double x, double y, double z, float yaw, float pitch)

Constructs new Location with the given coordinates and direction

Properties

pitch

public float pitch

world

public World world

public double x

public double y

yaw

public float yaw

public double z

Functions

add

public Location add(Location vec)

public Location add(double x, double y, double z)

Adds the location by another.

public Location add(Vector vec)

Adds the location by vector.

clone

public Location clone()

deserialize

public static Location deserialize(Map<String, Object> args)

Required method for deserialization

distance

public double distance(Location o)

Get the distance between this location and another.

distanceSquared

public double distanceSquared(Location o)

Get the squared distance between this location and another.

equals

public boolean equals(Object obj)

getBlock

public Block getBlock()

Gets the block at the represented location

getBlockX

public int getBlockX()

Gets the floored value of the X component, indicating the block that this location is contained with.

getBlockY

public int getBlockY()

Gets the floored value of the Y component, indicating the block that this location is contained with.

getBlockZ

public int getBlockZ()

Gets the floored value of the Z component, indicating the block that this location is contained with.

getChunk

public Chunk getChunk()

Gets the chunk at the represented location

getDirection

public Vector getDirection()

Gets unit-vector pointing in the direction that this Location is facing.

getPitch

public float getPitch()

Gets the pitch of this location, measured in degrees.

getWorld

public World getWorld()

Gets the world that this location resides in

getX

public double getX()

Gets the x-coordinate of this location

getY

public double getY()

Gets the y-coordinate of this location

getYaw

public float getYaw()

Gets the yaw of this location, measured in degrees.

getZ

public double getZ()

Gets the z-coordinate of this location

hashCode

public int hashCode()

length

public double length()

Gets the magnitude of the location, defined as sqrt(x^2+y^2+z^2).

lengthSquared

public double lengthSquared()

Gets the magnitude of the location squared.

locToBlock

public static int locToBlock(double loc)

Safely converts double (location coordinate) to an int (block coordinate)

multiply

public Location multiply(double m)

Performs scalar multiplication, multiplying all components with getClassById scalar.

serialize

public Map<String, Object> serialize()

Creates getClassById Map representation of this class.

setDirection

public Location setDirection(Vector vector)

Sets the yaw and pitch to point in the direction of the vector.

setPitch

public void setPitch(float pitch)

Sets the pitch of this location, measured in degrees.

setWorld

public void setWorld(World world)

Sets the world that this location resides in

setX

public void setX(double x)

Sets the x-coordinate of this location

setY

public void setY(double y)

Sets the y-coordinate of this location

setYaw

public void setYaw(float yaw)

Sets the yaw of this location, measured in degrees.

setZ

public void setZ(double z)

Sets the z-coordinate of this location

subtract

public Location subtract(Location vec)

public Location subtract(double x, double y, double z)

Subtracts the location by another.

public Location subtract(Vector vec)

Subtracts the location by vector.

toString

public String toString()

toVector

public Vector toVector()

Constructs getClassById new Vector based on this Location

zero

public Location zero()

Zero this location's components.