Package org.bukkit
Class Location
java.lang.Object
org.bukkit.Location
- All Implemented Interfaces:
FinePosition
,Position
,Cloneable
,ConfigurationSerializable
Represents a 3-dimensional position in a world.
No constraints are placed on any angular values other than that they be specified in degrees. This means that negative angles or angles of greater magnitude than 360 are valid, but may be normalized to any other equivalent representation by the implementation.
No constraints are placed on any angular values other than that they be specified in degrees. This means that negative angles or angles of greater magnitude than 360 are valid, but may be normalized to any other equivalent representation by the implementation.
-
Field Summary
Fields inherited from interface io.papermc.paper.math.Position
BLOCK_ZERO, FINE_ZERO
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionadd
(double x, double y, double z) Adds the location by another.Adds the location by another.Takes the x/y/z from base and adds the specified x/y/z to it and returns selfAdds the location by a vector.void
Check if each component of this Location is finite.clone()
boolean
createExplosion
(float power) Creates explosion at this location with given powerboolean
createExplosion
(float power, boolean setFire) Creates explosion at this location with given power and optionally setting blocks on fire.boolean
createExplosion
(float power, boolean setFire, boolean breakBlocks) Creates explosion at this location with given power and optionally setting blocks on fire.boolean
createExplosion
(@Nullable Entity source, float power) Creates explosion at this location with given power, with the specified entity as the source.boolean
createExplosion
(@Nullable Entity source, float power, boolean setFire) Creates explosion at this location with given power and optionally setting blocks on fire, with the specified entity as the source.boolean
createExplosion
(@Nullable Entity source, float power, boolean setFire, boolean breakBlocks) Creates explosion at this location with given power and optionally setting blocks on fire, with the specified entity as the source.deserialize
(@NotNull Map<String, Object> args) Required method for deserializationdouble
Get the distance between this location and another.double
Get the squared distance between this location and another.boolean
getBlock()
Gets the block at the represented locationint
Gets the floored value of the X component, indicating the block that this location is contained with.int
Gets the floored value of the Y component, indicating the block that this location is contained with.int
Gets the floored value of the Z component, indicating the block that this location is contained with.getChunk()
Gets the chunk at the represented locationGets a unit-vector pointing in the direction that this Location is facing.getNearbyEntities
(double x, double y, double z) Returns a list of entities within a bounding box centered around a Location.<T extends Entity>
@NotNull Collection<T> getNearbyEntitiesByType
(@Nullable Class<? extends Entity> clazz, double xRadius, double yRadius, double zRadius, @Nullable Predicate<? super T> predicate) Gets all nearby entities of the specified type, within the specified radius (bounding box)<T extends Entity>
@NotNull Collection<T> getNearbyEntitiesByType
(@Nullable Class<? extends T> clazz, double radius) Gets all nearby entities of the specified type, within the specified radius (bounding box)<T extends Entity>
@NotNull Collection<T> getNearbyEntitiesByType
(@Nullable Class<? extends T> clazz, double xzRadius, double yRadius) Gets all nearby entities of the specified type, within the specified radius, with x and x radius matching (bounding box)<T extends Entity>
@NotNull Collection<T> getNearbyEntitiesByType
(@Nullable Class<? extends T> clazz, double xRadius, double yRadius, double zRadius) Gets all nearby entities of the specified type, within the specified radius (bounding box)<T extends Entity>
@NotNull Collection<T> getNearbyEntitiesByType
(@Nullable Class<? extends T> clazz, double xzRadius, double yRadius, @Nullable Predicate<? super T> predicate) Gets all nearby entities of the specified type, within the specified radius, with x and x radius matching (bounding box)<T extends Entity>
@NotNull Collection<T> getNearbyEntitiesByType
(@Nullable Class<? extends T> clazz, double radius, @Nullable Predicate<? super T> predicate) Gets all nearby entities of the specified type, within the specified radius (bounding box)getNearbyLivingEntities
(double radius) Gets nearby players within the specified radius (bounding box)getNearbyLivingEntities
(double xzRadius, double yRadius) Gets nearby players within the specified radius (bounding box)getNearbyLivingEntities
(double xRadius, double yRadius, double zRadius) Gets nearby players within the specified radius (bounding box)getNearbyLivingEntities
(double xRadius, double yRadius, double zRadius, @Nullable Predicate<? super LivingEntity> predicate) Gets nearby players within the specified radius (bounding box)getNearbyLivingEntities
(double xzRadius, double yRadius, @Nullable Predicate<? super LivingEntity> predicate) Gets nearby players within the specified radius (bounding box)getNearbyLivingEntities
(double radius, @Nullable Predicate<? super LivingEntity> predicate) Gets nearby players within the specified radius (bounding box)getNearbyPlayers
(double radius) Gets nearby players within the specified radius (bounding box)getNearbyPlayers
(double xzRadius, double yRadius) Gets nearby players within the specified radius (bounding box)getNearbyPlayers
(double xRadius, double yRadius, double zRadius) Gets nearby players within the specified radius (bounding box)getNearbyPlayers
(double xRadius, double yRadius, double zRadius, @Nullable Predicate<? super Player> predicate) Gets nearby players within the specified radius (bounding box)getNearbyPlayers
(double xzRadius, double yRadius, @Nullable Predicate<? super Player> predicate) Gets nearby players within the specified radius (bounding box)getNearbyPlayers
(double radius, @Nullable Predicate<? super Player> predicate) Gets nearby players within the specified radius (bounding box)float
getPitch()
Gets the pitch of this location, measured in degrees.getWorld()
Gets the world that this location resides indouble
getX()
Gets the x-coordinate of this locationdouble
getY()
Gets the y-coordinate of this locationfloat
getYaw()
Gets the yaw of this location, measured in degrees.double
getZ()
Gets the z-coordinate of this locationint
hashCode()
boolean
boolean
isFinite()
Checks if each component of this position is finite.boolean
Checks if aChunk
has been generated at this location.boolean
Checks if world in this location is present and loaded.double
length()
Gets the magnitude of the location, defined as sqrt(x^2+y^2+z^2).double
Gets the magnitude of the location squared.static int
locToBlock
(double loc) Safely converts a double (location coordinate) to an int (block coordinate)multiply
(double m) Performs scalar multiplication, multiplying all components with a scalar.static float
normalizePitch
(float pitch) Normalizes the given pitch angle to a value between+/-90
degrees.static float
normalizeYaw
(float yaw) Normalizes the given yaw angle to a value between+/-180
degrees.Creates a Map representation of this class.set
(double x, double y, double z) Sets the position of this Location and returns itselfsetDirection
(@NotNull Vector vector) void
setPitch
(float pitch) Sets the pitch of this location, measured in degrees.void
Sets the world that this location resides invoid
setX
(double x) Sets the x-coordinate of this locationvoid
setY
(double y) Sets the y-coordinate of this locationvoid
setYaw
(float yaw) Sets the yaw of this location, measured in degrees.void
setZ
(double z) Sets the z-coordinate of this locationsubtract
(double x, double y, double z) Subtracts the location by another.Subtracts the location by another.Takes the x/y/z from base and subtracts the specified x/y/z to it and returns selfSubtracts the location by a vector.long
Deprecated.only encodes y block ranges from -512 to 511 and represents an already changed implementation detailReturns a copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ())toHighestLocation
(@NotNull HeightMap heightMap) Returns a copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ(), heightMap)toLocation
(@NotNull World world) Creates a new location object at this position with the specified worldtoString()
toVector()
Constructs a newVector
based on this Locationdouble
x()
Gets the x value for this positiondouble
y()
Gets the y value for this positiondouble
z()
Gets the z value for this positionzero()
Zero this location's components.Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Constructor Details
-
Location
Constructs a new Location with the given coordinates- Parameters:
world
- The world in which this location residesx
- The x-coordinate of this new locationy
- The y-coordinate of this new locationz
- The z-coordinate of this new location
-
Location
public Location(@UndefinedNullability World world, double x, double y, double z, float yaw, float pitch) Constructs a new Location with the given coordinates and direction- Parameters:
world
- The world in which this location residesx
- The x-coordinate of this new locationy
- The y-coordinate of this new locationz
- The z-coordinate of this new locationyaw
- The absolute rotation on the x-plane, in degreespitch
- The absolute rotation on the y-plane, in degrees
-
-
Method Details
-
setWorld
Sets the world that this location resides in- Parameters:
world
- New world that this location resides in
-
isWorldLoaded
public boolean isWorldLoaded()Checks if world in this location is present and loaded.- Returns:
- true if is loaded, otherwise false
-
getWorld
Gets the world that this location resides in- Returns:
- World that contains this location, or
null
if it is not set - Throws:
IllegalArgumentException
- when world is unloaded- See Also:
-
getChunk
Gets the chunk at the represented location- Returns:
- Chunk at the represented location
-
getBlock
Gets the block at the represented location- Returns:
- Block at the represented location
-
setX
public void setX(double x) Sets the x-coordinate of this location- Parameters:
x
- X-coordinate
-
getX
public double getX()Gets the x-coordinate of this location- Returns:
- x-coordinate
-
getBlockX
public int getBlockX()Gets the floored value of the X component, indicating the block that this location is contained with.- Returns:
- block X
-
setY
public void setY(double y) Sets the y-coordinate of this location- Parameters:
y
- y-coordinate
-
getY
public double getY()Gets the y-coordinate of this location- Returns:
- y-coordinate
-
getBlockY
public int getBlockY()Gets the floored value of the Y component, indicating the block that this location is contained with.- Returns:
- block y
-
setZ
public void setZ(double z) Sets the z-coordinate of this location- Parameters:
z
- z-coordinate
-
getZ
public double getZ()Gets the z-coordinate of this location- Returns:
- z-coordinate
-
getBlockZ
public int getBlockZ()Gets the floored value of the Z component, indicating the block that this location is contained with.- Returns:
- block z
-
setYaw
public void setYaw(float yaw) Sets the yaw of this location, measured in degrees.- A yaw of 0 or 360 represents the positive z direction.
- A yaw of 180 represents the negative z direction.
- A yaw of 90 represents the negative x direction.
- A yaw of 270 represents the positive x direction.
- Parameters:
yaw
- new rotation's yaw
-
getYaw
public float getYaw()Gets the yaw of this location, measured in degrees.- A yaw of 0 or 360 represents the positive z direction.
- A yaw of 180 represents the negative z direction.
- A yaw of 90 represents the negative x direction.
- A yaw of 270 represents the positive x direction.
- Returns:
- the rotation's yaw
-
setPitch
public void setPitch(float pitch) Sets the pitch of this location, measured in degrees.- A pitch of 0 represents level forward facing.
- A pitch of 90 represents downward facing, or negative y direction.
- A pitch of -90 represents upward facing, or positive y direction.
- Parameters:
pitch
- new incline's pitch
-
getPitch
public float getPitch()Gets the pitch of this location, measured in degrees.- A pitch of 0 represents level forward facing.
- A pitch of 90 represents downward facing, or negative y direction.
- A pitch of -90 represents upward facing, or positive y direction.
- Returns:
- the incline's pitch
-
getDirection
Gets a unit-vector pointing in the direction that this Location is facing. -
setDirection
- Parameters:
vector
- the direction vector- Returns:
- the same location
-
add
Adds the location by another.- Parameters:
vec
- The other location- Returns:
- the same location
- Throws:
IllegalArgumentException
- for differing worlds- See Also:
-
add
Adds the location by a vector.- Parameters:
vec
- Vector to use- Returns:
- the same location
- See Also:
-
add
Adds the location by another. Not world-aware.- Parameters:
x
- X coordinatey
- Y coordinatez
- Z coordinate- Returns:
- the same location
- See Also:
-
subtract
Subtracts the location by another.- Parameters:
vec
- The other location- Returns:
- the same location
- Throws:
IllegalArgumentException
- for differing worlds- See Also:
-
subtract
Subtracts the location by a vector.- Parameters:
vec
- The vector to use- Returns:
- the same location
- See Also:
-
subtract
Subtracts the location by another. Not world-aware and orientation independent.- Parameters:
x
- X coordinatey
- Y coordinatez
- Z coordinate- Returns:
- the same location
- See Also:
-
length
public double length()Gets the magnitude of the location, defined as sqrt(x^2+y^2+z^2). The value of this method is not cached and uses a costly square-root function, so do not repeatedly call this method to get the location's magnitude. NaN will be returned if the inner result of the sqrt() function overflows, which will be caused if the length is too long. Not world-aware and orientation independent.- Returns:
- the magnitude
- See Also:
-
lengthSquared
public double lengthSquared()Gets the magnitude of the location squared. Not world-aware and orientation independent.- Returns:
- the magnitude
- See Also:
-
distance
Get the distance between this location and another. The value of this method is not cached and uses a costly square-root function, so do not repeatedly call this method to get the location's magnitude. NaN will be returned if the inner result of the sqrt() function overflows, which will be caused if the distance is too long.- Parameters:
o
- The other location- Returns:
- the distance
- Throws:
IllegalArgumentException
- for differing worlds- See Also:
-
distanceSquared
Get the squared distance between this location and another.- Parameters:
o
- The other location- Returns:
- the distance
- Throws:
IllegalArgumentException
- for differing worlds- See Also:
-
multiply
Performs scalar multiplication, multiplying all components with a scalar. Not world-aware.- Parameters:
m
- The factor- Returns:
- the same location
- See Also:
-
zero
Zero this location's components. Not world-aware.- Returns:
- the same location
- See Also:
-
isChunkLoaded
public boolean isChunkLoaded() -
isGenerated
public boolean isGenerated()Checks if aChunk
has been generated at this location.- Returns:
- true if a chunk has been generated at this location
-
set
Sets the position of this Location and returns itselfThis mutates this object, clone first.
- Parameters:
x
- X coordinatey
- Y coordinatez
- Z coordinate- Returns:
- self (not cloned)
-
add
@NotNull public @NotNull Location add(@NotNull @NotNull Location base, double x, double y, double z) Takes the x/y/z from base and adds the specified x/y/z to it and returns selfThis mutates this object, clone first.
- Parameters:
base
- The base coordinate to modifyx
- X coordinate to add to basey
- Y coordinate to add to basez
- Z coordinate to add to base- Returns:
- self (not cloned)
-
subtract
@NotNull public @NotNull Location subtract(@NotNull @NotNull Location base, double x, double y, double z) Takes the x/y/z from base and subtracts the specified x/y/z to it and returns selfThis mutates this object, clone first.
- Parameters:
base
- The base coordinate to modifyx
- X coordinate to subtract from basey
- Y coordinate to subtract from basez
- Z coordinate to subtract from base- Returns:
- self (not cloned)
-
toBlockLocation
- Returns:
- A new location where X/Y/Z are on the Block location (integer value of X/Y/Z)
-
toBlockKey
Deprecated.only encodes y block ranges from -512 to 511 and represents an already changed implementation detail- Returns:
- The block key for this location's block location.
- See Also:
-
toCenterLocation
- Returns:
- A new location where X/Y/Z are the center of the block
-
toHighestLocation
Returns a copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ())- Returns:
- A copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ())
- Throws:
NullPointerException
- if {getWorld()
} isnull
-
toHighestLocation
Returns a copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ(), heightMap)- Parameters:
heightMap
- The heightmap to use for finding the highest y location.- Returns:
- A copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ(), heightMap)
-
createExplosion
public boolean createExplosion(float power) Creates explosion at this location with given powerWill break blocks and ignite blocks on fire.
- Parameters:
power
- The power of explosion, where 4F is TNT- Returns:
- false if explosion was canceled, otherwise true
-
createExplosion
public boolean createExplosion(float power, boolean setFire) Creates explosion at this location with given power and optionally setting blocks on fire.Will break blocks.
- Parameters:
power
- The power of explosion, where 4F is TNTsetFire
- Whether to set blocks on fire- Returns:
- false if explosion was canceled, otherwise true
-
createExplosion
public boolean createExplosion(float power, boolean setFire, boolean breakBlocks) Creates explosion at this location with given power and optionally setting blocks on fire.- Parameters:
power
- The power of explosion, where 4F is TNTsetFire
- Whether to set blocks on firebreakBlocks
- Whether to have blocks be destroyed- Returns:
- false if explosion was canceled, otherwise true
-
createExplosion
Creates explosion at this location with given power, with the specified entity as the source.Will break blocks and ignite blocks on fire.
- Parameters:
source
- The source entity of the explosionpower
- The power of explosion, where 4F is TNT- Returns:
- false if explosion was canceled, otherwise true
-
createExplosion
Creates explosion at this location with given power and optionally setting blocks on fire, with the specified entity as the source.Will break blocks.
- Parameters:
source
- The source entity of the explosionpower
- The power of explosion, where 4F is TNTsetFire
- Whether to set blocks on fire- Returns:
- false if explosion was canceled, otherwise true
-
createExplosion
public boolean createExplosion(@Nullable @Nullable Entity source, float power, boolean setFire, boolean breakBlocks) Creates explosion at this location with given power and optionally setting blocks on fire, with the specified entity as the source.- Parameters:
source
- The source entity of the explosionpower
- The power of explosion, where 4F is TNTsetFire
- Whether to set blocks on firebreakBlocks
- Whether to have blocks be destroyed- Returns:
- false if explosion was canceled, otherwise true
-
getNearbyEntities
Returns a list of entities within a bounding box centered around a Location.Some implementations may impose artificial restrictions on the size of the search bounding box.
- Parameters:
x
- 1/2 the size of the box along the x-axisy
- 1/2 the size of the box along the y-axisz
- 1/2 the size of the box along the z-axis- Returns:
- the collection of entities near location. This will always be a non-null collection.
-
getNearbyLivingEntities
Gets nearby players within the specified radius (bounding box)- Parameters:
radius
- X Radius- Returns:
- the collection of entities near location. This will always be a non-null collection.
-
getNearbyLivingEntities
@NotNull public @NotNull Collection<LivingEntity> getNearbyLivingEntities(double xzRadius, double yRadius) Gets nearby players within the specified radius (bounding box)- Parameters:
xzRadius
- X/Z RadiusyRadius
- Y Radius- Returns:
- the collection of living entities near location. This will always be a non-null collection.
-
getNearbyLivingEntities
@NotNull public @NotNull Collection<LivingEntity> getNearbyLivingEntities(double xRadius, double yRadius, double zRadius) Gets nearby players within the specified radius (bounding box)- Parameters:
xRadius
- X RadiusyRadius
- Y RadiuszRadius
- Z radius- Returns:
- the collection of living entities near location. This will always be a non-null collection.
-
getNearbyLivingEntities
@NotNull public @NotNull Collection<LivingEntity> getNearbyLivingEntities(double radius, @Nullable @Nullable Predicate<? super LivingEntity> predicate) Gets nearby players within the specified radius (bounding box)- Parameters:
radius
- Radiuspredicate
- a predicate used to filter results- Returns:
- the collection of living entities near location. This will always be a non-null collection.
-
getNearbyLivingEntities
@NotNull public @NotNull Collection<LivingEntity> getNearbyLivingEntities(double xzRadius, double yRadius, @Nullable @Nullable Predicate<? super LivingEntity> predicate) Gets nearby players within the specified radius (bounding box)- Parameters:
xzRadius
- X/Z RadiusyRadius
- Y Radiuspredicate
- a predicate used to filter results- Returns:
- the collection of living entities near location. This will always be a non-null collection.
-
getNearbyLivingEntities
@NotNull public @NotNull Collection<LivingEntity> getNearbyLivingEntities(double xRadius, double yRadius, double zRadius, @Nullable @Nullable Predicate<? super LivingEntity> predicate) Gets nearby players within the specified radius (bounding box)- Parameters:
xRadius
- X RadiusyRadius
- Y RadiuszRadius
- Z radiuspredicate
- a predicate used to filter results- Returns:
- the collection of living entities near location. This will always be a non-null collection.
-
getNearbyPlayers
Gets nearby players within the specified radius (bounding box)- Parameters:
radius
- X/Y/Z Radius- Returns:
- the collection of players near location. This will always be a non-null collection.
-
getNearbyPlayers
Gets nearby players within the specified radius (bounding box)- Parameters:
xzRadius
- X/Z RadiusyRadius
- Y Radius- Returns:
- the collection of players near location. This will always be a non-null collection.
-
getNearbyPlayers
@NotNull public @NotNull Collection<Player> getNearbyPlayers(double xRadius, double yRadius, double zRadius) Gets nearby players within the specified radius (bounding box)- Parameters:
xRadius
- X RadiusyRadius
- Y RadiuszRadius
- Z Radius- Returns:
- the collection of players near location. This will always be a non-null collection.
-
getNearbyPlayers
@NotNull public @NotNull Collection<Player> getNearbyPlayers(double radius, @Nullable @Nullable Predicate<? super Player> predicate) Gets nearby players within the specified radius (bounding box)- Parameters:
radius
- X/Y/Z Radiuspredicate
- a predicate used to filter results- Returns:
- the collection of players near location. This will always be a non-null collection.
-
getNearbyPlayers
@NotNull public @NotNull Collection<Player> getNearbyPlayers(double xzRadius, double yRadius, @Nullable @Nullable Predicate<? super Player> predicate) Gets nearby players within the specified radius (bounding box)- Parameters:
xzRadius
- X/Z RadiusyRadius
- Y Radiuspredicate
- a predicate used to filter results- Returns:
- the collection of players near location. This will always be a non-null collection.
-
getNearbyPlayers
@NotNull public @NotNull Collection<Player> getNearbyPlayers(double xRadius, double yRadius, double zRadius, @Nullable @Nullable Predicate<? super Player> predicate) Gets nearby players within the specified radius (bounding box)- Parameters:
xRadius
- X RadiusyRadius
- Y RadiuszRadius
- Z Radiuspredicate
- a predicate used to filter results- Returns:
- the collection of players near location. This will always be a non-null collection.
-
getNearbyEntitiesByType
@NotNull public <T extends Entity> @NotNull Collection<T> getNearbyEntitiesByType(@Nullable @Nullable Class<? extends T> clazz, double radius) Gets all nearby entities of the specified type, within the specified radius (bounding box)- Type Parameters:
T
- the entity type- Parameters:
clazz
- Type to filter byradius
- X/Y/Z radius to search within- Returns:
- the collection of entities of type clazz near location. This will always be a non-null collection.
-
getNearbyEntitiesByType
@NotNull public <T extends Entity> @NotNull Collection<T> getNearbyEntitiesByType(@Nullable @Nullable Class<? extends T> clazz, double xzRadius, double yRadius) Gets all nearby entities of the specified type, within the specified radius, with x and x radius matching (bounding box)- Type Parameters:
T
- the entity type- Parameters:
clazz
- Type to filter byxzRadius
- X/Z radius to search withinyRadius
- Y radius to search within- Returns:
- the collection of entities near location. This will always be a non-null collection.
-
getNearbyEntitiesByType
@NotNull public <T extends Entity> @NotNull Collection<T> getNearbyEntitiesByType(@Nullable @Nullable Class<? extends T> clazz, double xRadius, double yRadius, double zRadius) Gets all nearby entities of the specified type, within the specified radius (bounding box)- Type Parameters:
T
- the entity type- Parameters:
clazz
- Type to filter byxRadius
- X RadiusyRadius
- Y RadiuszRadius
- Z Radius- Returns:
- the collection of entities near location. This will always be a non-null collection.
-
getNearbyEntitiesByType
@NotNull public <T extends Entity> @NotNull Collection<T> getNearbyEntitiesByType(@Nullable @Nullable Class<? extends T> clazz, double radius, @Nullable @Nullable Predicate<? super T> predicate) Gets all nearby entities of the specified type, within the specified radius (bounding box)- Type Parameters:
T
- the entity type- Parameters:
clazz
- Type to filter byradius
- X/Y/Z radius to search withinpredicate
- a predicate used to filter results- Returns:
- the collection of entities near location. This will always be a non-null collection.
-
getNearbyEntitiesByType
@NotNull public <T extends Entity> @NotNull Collection<T> getNearbyEntitiesByType(@Nullable @Nullable Class<? extends T> clazz, double xzRadius, double yRadius, @Nullable @Nullable Predicate<? super T> predicate) Gets all nearby entities of the specified type, within the specified radius, with x and x radius matching (bounding box)- Type Parameters:
T
- the entity type- Parameters:
clazz
- Type to filter byxzRadius
- X/Z radius to search withinyRadius
- Y radius to search withinpredicate
- a predicate used to filter results- Returns:
- the collection of entities near location. This will always be a non-null collection.
-
getNearbyEntitiesByType
@NotNull public <T extends Entity> @NotNull Collection<T> getNearbyEntitiesByType(@Nullable @Nullable Class<? extends Entity> clazz, double xRadius, double yRadius, double zRadius, @Nullable @Nullable Predicate<? super T> predicate) Gets all nearby entities of the specified type, within the specified radius (bounding box)- Type Parameters:
T
- the entity type- Parameters:
clazz
- Type to filter byxRadius
- X RadiusyRadius
- Y RadiuszRadius
- Z Radiuspredicate
- a predicate used to filter results- Returns:
- the collection of entities near location. This will always be a non-null collection.
-
equals
-
hashCode
public int hashCode() -
toString
-
toVector
Constructs a newVector
based on this Location -
clone
-
checkFinite
Check if each component of this Location is finite.- Throws:
IllegalArgumentException
- if any component is not finite
-
locToBlock
public static int locToBlock(double loc) Safely converts a double (location coordinate) to an int (block coordinate)- Parameters:
loc
- Precise coordinate- Returns:
- Block coordinate
-
serialize
Description copied from interface:ConfigurationSerializable
Creates a Map representation of this class.This class must provide a method to restore this class, as defined in the
ConfigurationSerializable
interface javadocs.- Specified by:
serialize
in interfaceConfigurationSerializable
- Returns:
- Map containing the current state of this class
-
deserialize
Required method for deserialization- Parameters:
args
- map to deserialize- Returns:
- deserialized location
- Throws:
IllegalArgumentException
- if the world don't exists- See Also:
-
normalizeYaw
public static float normalizeYaw(float yaw) Normalizes the given yaw angle to a value between+/-180
degrees.- Parameters:
yaw
- the yaw in degrees- Returns:
- the normalized yaw in degrees
- See Also:
-
normalizePitch
public static float normalizePitch(float pitch) Normalizes the given pitch angle to a value between+/-90
degrees.- Parameters:
pitch
- the pitch in degrees- Returns:
- the normalized pitch in degrees
- See Also:
-
x
public double x()Description copied from interface:Position
Gets the x value for this position -
y
public double y()Description copied from interface:Position
Gets the y value for this position -
z
public double z()Description copied from interface:Position
Gets the z value for this position -
isFinite
public boolean isFinite()Description copied from interface:Position
Checks if each component of this position is finite. -
toLocation
Description copied from interface:Position
Creates a new location object at this position with the specified world- Specified by:
toLocation
in interfacePosition
- Parameters:
world
- the world for the location object- Returns:
- a new location
-