# Uses of Class
org.bukkit.Location

Packages that use Location
Package
Description
com.destroystokyo.paper
com.destroystokyo.paper.entity
com.destroystokyo.paper.event.entity
com.destroystokyo.paper.event.player
com.destroystokyo.paper.event.server
io.papermc.paper.event.entity
io.papermc.paper.event.world
io.papermc.paper.event.world.border
io.papermc.paper.math
me.totalfreedom.scissors.event.block
org.bukkit
The root package of the Bukkit API, contains generalized API classes.
org.bukkit.block
Classes used to manipulate the voxels in a `world`, including special states.
org.bukkit.block.data
Generalized BlockData classes.
org.bukkit.boss
Classes concerning the creation of boss bars that appear at the top of the player's screen.
org.bukkit.command
Classes relating to handling specialized non-chat player input.
org.bukkit.configuration
Classes dedicated to handling a plugin's runtime configuration.
org.bukkit.entity
Interfaces for non-voxel objects that can exist in a `world`, including all players, monsters, projectiles, etc.
org.bukkit.entity.memory
Classes concerning an entity's persistent memory.
org.bukkit.event.block
`Events` relating to when a `block` is changed or interacts with the `world`.
org.bukkit.event.entity
`Events` relating to `entities`, excluding some directly referencing some more specific entity types.
org.bukkit.event.player
`Events` relating to `players`.
org.bukkit.event.server
`Events` relating to programmatic state changes on the server.
org.bukkit.event.vehicle
`Events` relating to `vehicular entities`.
org.bukkit.event.world
`Events` triggered by various `world` states or changes.
org.bukkit.generator
Classes to facilitate `world` generation implementation.
org.bukkit.inventory
Classes involved in manipulating player inventories and item interactions.
org.bukkit.inventory.meta
The interfaces used when manipulating extra data can can be stored inside `item stacks`.
org.bukkit.loot
Classes relevant to loot table manipulation and generation.
org.bukkit.structure
Classes related to creating or using `structures` without creating `Structure blocks` in the world.
org.bukkit.util
Multi and single purpose classes to facilitate various programmatic concepts.
org.spigotmc.event.player
Spigot-specific player events.

## Uses of Location in com.destroystokyo.paper

Methods in com.destroystokyo.paper that return Location
Modifier and Type
Method
Description
`@Nullable Location`
ParticleBuilder.`location()`
Methods in com.destroystokyo.paper with parameters of type Location
Modifier and Type
Method
Description
`@NotNull ParticleBuilder`
ParticleBuilder.`location(@NotNull Location location)`
Sets the location of where to spawn the particle

## Uses of Location in com.destroystokyo.paper.entity

Methods in com.destroystokyo.paper.entity that return Location
Modifier and Type
Method
Description
`@Nullable Location`
Pathfinder.PathResult.`getFinalPoint()`
`@Nullable Location`
Pathfinder.PathResult.`getNextPoint()`
Methods in com.destroystokyo.paper.entity that return types with arguments of type Location
Modifier and Type
Method
Description
`@NotNull List<Location>`
Pathfinder.PathResult.`getPoints()`
All currently calculated points to follow along the path to reach the destination location Will return points the entity has already moved past, see `Pathfinder.PathResult.getNextPointIndex()`
Methods in com.destroystokyo.paper.entity with parameters of type Location
Modifier and Type
Method
Description
`@Nullable Pathfinder.PathResult`
Pathfinder.`findPath(@NotNull Location loc)`
Calculates a destination for the Entity to navigate to, but does not set it as the current target.
`default boolean`
Pathfinder.`moveTo(@NotNull Location loc)`
Calculates a destination for the Entity to navigate to, and sets it with default speed as the current target.
`default boolean`
Pathfinder.`moveTo(@NotNull Location loc, double speed)`
Calculates a destination for the Entity to navigate to, with desired speed as the current target.

## Uses of Location in com.destroystokyo.paper.event.entity

Methods in com.destroystokyo.paper.event.entity that return Location
Modifier and Type
Method
Description
`@NotNull Location`
EntityPathfindEvent.`getLoc()`
The Location of where the entity is about to move to.
`@NotNull Location`
TurtleLayEggEvent.`getLocation()`
Get the location where the eggs are being laid
`@NotNull Location`
TurtleStartDiggingEvent.`getLocation()`
Get the location where the turtle is digging
`@NotNull Location`
PreSpawnerSpawnEvent.`getSpawnerLocation()`
`@NotNull Location`
PreCreatureSpawnEvent.`getSpawnLocation()`
Constructors in com.destroystokyo.paper.event.entity with parameters of type Location
Modifier
Constructor
Description
``
`EntityPathfindEvent(@NotNull Entity entity, @NotNull Location loc, @Nullable Entity targetEntity)`
``
`EntityTeleportEndGatewayEvent(@NotNull Entity what, @NotNull Location from, @NotNull Location to, @NotNull EndGateway gateway)`
``
`PhantomPreSpawnEvent(@NotNull Location location, @NotNull Entity entity, CreatureSpawnEvent.SpawnReason reason)`
``
`PreCreatureSpawnEvent(@NotNull Location location, @NotNull EntityType type, CreatureSpawnEvent.SpawnReason reason)`
``
`PreSpawnerSpawnEvent(@NotNull Location location, @NotNull EntityType type, @NotNull Location spawnerLocation)`
``
`TurtleLayEggEvent(@NotNull Turtle turtle, @NotNull Location location, int eggCount)`
``
`TurtleStartDiggingEvent(@NotNull Turtle turtle, @NotNull Location location)`

## Uses of Location in com.destroystokyo.paper.event.player

Methods in com.destroystokyo.paper.event.player that return Location
Modifier and Type
Method
Description
`@NotNull Location`
PlayerJumpEvent.`getFrom()`
Gets the location this player jumped from
`@Nullable Location`
PlayerSetSpawnEvent.`getLocation()`
Gets the location that the spawn is set to.
`@NotNull Location`
PlayerPostRespawnEvent.`getRespawnedLocation()`
Returns the location of the respawned player
`@NotNull Location`
PlayerJumpEvent.`getTo()`
Gets the location this player jumped to This information is based on what the client sends, it typically has little relation to the arc of the jump at any given point.
Methods in com.destroystokyo.paper.event.player with parameters of type Location
Modifier and Type
Method
Description
`void`
PlayerJumpEvent.`setFrom(@NotNull Location from)`
Sets the location to mark as where the player jumped from
`void`
PlayerSetSpawnEvent.`setLocation(@Nullable Location location)`
Sets the location to be set as the spawn location.
Constructors in com.destroystokyo.paper.event.player with parameters of type Location
Modifier
Constructor
Description
``
`PlayerInitialSpawnEvent(@NotNull Player who, @NotNull Location spawnLocation)`
Deprecated.
``
`PlayerJumpEvent(@NotNull Player player, @NotNull Location from, @NotNull Location to)`
``
`PlayerPostRespawnEvent(@NotNull Player respawnPlayer, @NotNull Location respawnedLocation, boolean isBedSpawn)`
``
`PlayerSetSpawnEvent(@NotNull Player who, @NotNull PlayerSetSpawnEvent.Cause cause, @Nullable Location location, boolean forced, boolean notifyPlayer, @Nullable Component notification)`
``
`PlayerTeleportEndGatewayEvent(@NotNull Player player, @NotNull Location from, @NotNull Location to, @NotNull EndGateway gateway)`

## Uses of Location in com.destroystokyo.paper.event.server

Methods in com.destroystokyo.paper.event.server that return Location
Modifier and Type
Method
Description
`@Nullable Location`
AsyncTabCompleteEvent.`getLocation()`
Constructors in com.destroystokyo.paper.event.server with parameters of type Location
Modifier
Constructor
Description
``
`AsyncTabCompleteEvent(@NotNull CommandSender sender, @NotNull String buffer, boolean isCommand, @Nullable Location loc)`
``
`AsyncTabCompleteEvent(@NotNull CommandSender sender, @NotNull List<String> completions, @NotNull String buffer, boolean isCommand, @Nullable Location loc)`
Deprecated.

## Uses of Location in io.papermc.paper.event.entity

Methods in io.papermc.paper.event.entity that return Location
Modifier and Type
Method
Description
`@NotNull Location`
EntityMoveEvent.`getFrom()`
Gets the location this entity moved from
`@NotNull Location`
EntityMoveEvent.`getTo()`
Gets the location this entity moved to
Methods in io.papermc.paper.event.entity with parameters of type Location
Modifier and Type
Method
Description
`void`
EntityMoveEvent.`setFrom(@NotNull Location from)`
Sets the location to mark as where the entity moved from
`void`
EntityMoveEvent.`setTo(@NotNull Location to)`
Sets the location that this entity will move to
Constructors in io.papermc.paper.event.entity with parameters of type Location
Modifier
Constructor
Description
``
`EntityMoveEvent(@NotNull LivingEntity entity, @NotNull Location from, @NotNull Location to)`

## Uses of Location in io.papermc.paper.event.world

Methods in io.papermc.paper.event.world that return Location
Modifier and Type
Method
Description
`@NotNull Location`
StructureLocateEvent.`getOrigin()`
Deprecated, for removal: This API element is subject to removal in a future version.
Gets the `Location` from which the search is to be conducted.
`@NotNull Location`
StructuresLocateEvent.`getOrigin()`
Gets the `Location` from which the search is to be conducted.
`@Nullable Location`
StructureLocateEvent.`getResult()`
Deprecated, for removal: This API element is subject to removal in a future version.
Gets the location set as the structure location, if it was defined.
`@NotNull Location`
StructuresLocateEvent.Result.`position()`
Returns the value of the `position` record component.
Methods in io.papermc.paper.event.world with parameters of type Location
Modifier and Type
Method
Description
`void`
StructureLocateEvent.`setResult(@Nullable Location result)`
Deprecated, for removal: This API element is subject to removal in a future version.
Sets the result `Location`.
Constructors in io.papermc.paper.event.world with parameters of type Location
Modifier
Constructor
Description
``
`Result(@NotNull Location position, @NotNull ConfiguredStructure configuredStructure)`
Creates an instance of a `Result` record class.
``
`StructureLocateEvent(@NotNull World world, @NotNull Location origin, @NotNull StructureType structureType, int radius, boolean findUnexplored)`
Deprecated, for removal: This API element is subject to removal in a future version.
``
`StructuresLocateEvent(@NotNull World world, @NotNull Location origin, @NotNull List<ConfiguredStructure> configuredStructures, int radius, boolean findUnexplored)`

## Uses of Location in io.papermc.paper.event.world.border

Methods in io.papermc.paper.event.world.border that return Location
Modifier and Type
Method
Description
`@NotNull Location`
WorldBorderCenterChangeEvent.`getNewCenter()`
Gets the new center location for the world border.
`@NotNull Location`
WorldBorderCenterChangeEvent.`getOldCenter()`
Gets the original center location of the world border.
Methods in io.papermc.paper.event.world.border with parameters of type Location
Modifier and Type
Method
Description
`void`
WorldBorderCenterChangeEvent.`setNewCenter(@NotNull Location newCenter)`
Sets the new center location for the world border.
Constructors in io.papermc.paper.event.world.border with parameters of type Location
Modifier
Constructor
Description
``
`WorldBorderCenterChangeEvent(@NotNull World world, @NotNull WorldBorder worldBorder, @NotNull Location oldCenter, @NotNull Location newCenter)`

## Uses of Location in io.papermc.paper.math

Methods in io.papermc.paper.math that return Location
Modifier and Type
Method
Description
`default @NotNull Location`
Position.`toLocation(@NotNull World world)`
Creates a new location object at this position with the specified world
Methods in io.papermc.paper.math with parameters of type Location
Modifier and Type
Method
Description
`static @NotNull BlockPosition`
Position.`block(@NotNull Location location)`
Creates a position from the location.
`static @NotNull FinePosition`
Position.`fine(@NotNull Location location)`
Creates a position from the location.

## Uses of Location in me.totalfreedom.scissors.event.block

Methods in me.totalfreedom.scissors.event.block that return Location
Modifier and Type
Method
Description
`@NotNull Location`
MasterBlockFireEvent.`getAt()`
Constructors in me.totalfreedom.scissors.event.block with parameters of type Location
Modifier
Constructor
Description
``
`MasterBlockFireEvent(@NotNull Location at)`

## Uses of Location in org.bukkit

Methods in org.bukkit that return Location
Modifier and Type
Method
Description
`@NotNull Location`
Location.`add(double x, double y, double z)`
Adds the location by another.
`@NotNull Location`
Location.`add(@NotNull Location vec)`
Adds the location by another.
`@NotNull Location`
Location.`add(@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 self This mutates this object, clone first.
`@NotNull Location`
Location.`add(@NotNull Vector vec)`
Adds the location by a vector.
`@NotNull Location`
Location.`clone()`
`static @NotNull Location`
Location.`deserialize(@NotNull Map<String,Object> args)`
Required method for deserialization
`@Nullable Location`
World.`findLightningRod(@NotNull Location location)`
Finds the location of the nearest unobstructed Lightning Rod in a 128-block radius around the given location.
`@Nullable Location`
World.`findLightningTarget(@NotNull Location location)`
Finds a target `Location` for lightning to strike.
`@Nullable Location`
OfflinePlayer.`getBedSpawnLocation()`
Gets the Location where the player will spawn at their bed, null if they have not slept in one or their current bed spawn is invalid.
`@NotNull Location`
WorldBorder.`getCenter()`
Gets the current border center.
`@Nullable Location`
OfflinePlayer.`getLastDeathLocation()`
Gets the player's last death location.
`@NotNull Location`
Raid.`getLocation()`
Gets the center location where the raid occurs.
`@NotNull Location`
Vibration.Destination.BlockDestination.`getLocation()`
`default @NotNull Location`
World.`getLocationAtKey(long key)`
Gets the `Location` at the given block key
`@NotNull Location`
Vibration.`getOrigin()`
Deprecated, for removal: This API element is subject to removal in a future version.
unused as of 1.19
`@NotNull Location`
World.`getSpawnLocation()`
Gets the default spawn `Location` of this world
`@Nullable Location`
World.`locateNearestBiome(@NotNull Location origin, @NotNull Biome biome, int radius)`
Locates the nearest biome based on an origin, biome type, and radius to search.
`@Nullable Location`
World.`locateNearestBiome(@NotNull Location origin, @NotNull Biome biome, int radius, int step)`
Locates the nearest biome based on an origin, biome type, and radius to search and step
`@Nullable Location`
World.`locateNearestStructure(@NotNull Location origin, StructureType structureType, int radius, boolean findUnexplored)`
Deprecated.
Use `World.locateNearestStructure(Location, Structure, int, boolean)` or `World.locateNearestStructure(Location, StructureType, int, boolean)` instead.
`@NotNull Location`
Location.`multiply(double m)`
Performs scalar multiplication, multiplying all components with a scalar.
`@NotNull Location`
Location.`set(double x, double y, double z)`
Sets the position of this Location and returns itself This mutates this object, clone first.
`@NotNull Location`
Location.`setDirection(@NotNull Vector vector)`
Sets the `yaw` and `pitch` to point in the direction of the vector.
`@NotNull Location`
Location.`subtract(double x, double y, double z)`
Subtracts the location by another.
`@NotNull Location`
Location.`subtract(@NotNull Location vec)`
Subtracts the location by another.
`@NotNull Location`
Location.`subtract(@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 self This mutates this object, clone first.
`@NotNull Location`
Location.`subtract(@NotNull Vector vec)`
Subtracts the location by a vector.
`@NotNull Location`
Location.`toBlockLocation()`
`@NotNull Location`
Location.`toCenterLocation()`
`@NotNull Location`
Location.`toHighestLocation()`
Returns a copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ())
`@NotNull Location`
Location.`toHighestLocation(@NotNull HeightMap heightMap)`
Returns a copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ(), heightMap)
`@NotNull Location`
Location.`toHighestLocation(HeightmapType heightmap)`
Deprecated.
Use `toHighestLocation(HeightMap)`
`@NotNull Location`
Location.`toLocation(@NotNull World world)`
`@NotNull Location`
Location.`zero()`
Zero this location's components.
Methods in org.bukkit with parameters of type Location
Modifier and Type
Method
Description
`@NotNull Location`
Location.`add(@NotNull Location vec)`
Adds the location by another.
`@NotNull Location`
Location.`add(@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 self This mutates this object, clone first.
`static @NotNull ItemStack`
Bukkit.`createExplorerMap(@NotNull World world, @NotNull Location location, @NotNull StructureType structureType)`
Create a new explorer map targeting the closest nearby structure of a given `StructureType`.
`static @NotNull ItemStack`
Bukkit.`createExplorerMap(@NotNull World world, @NotNull Location location, @NotNull StructureType structureType, int radius, boolean findUnexplored)`
Create a new explorer map targeting the closest nearby structure of a given `StructureType`.
`@NotNull ItemStack`
Server.`createExplorerMap(@NotNull World world, @NotNull Location location, @NotNull StructureType structureType)`
Create a new explorer map targeting the closest nearby structure of a given `StructureType`.
`@NotNull ItemStack`
Server.`createExplorerMap(@NotNull World world, @NotNull Location location, @NotNull StructureType structureType, int radius, boolean findUnexplored)`
Create a new explorer map targeting the closest nearby structure of a given `StructureType`.
`boolean`
World.`createExplosion(@NotNull Location loc, float power)`
Creates explosion at given coordinates with given power
`boolean`
World.`createExplosion(@NotNull Location loc, float power, boolean setFire)`
Creates explosion at given coordinates with given power and optionally setting blocks on fire.
`boolean`
World.`createExplosion(@NotNull Location loc, float power, boolean setFire, boolean breakBlocks)`
Creates explosion at given coordinates with given power and optionally setting blocks on fire or breaking blocks.
`boolean`
World.`createExplosion(@NotNull Location loc, float power, boolean setFire, boolean breakBlocks, @Nullable Entity source)`
Creates explosion at given coordinates with given power and optionally setting blocks on fire or breaking blocks.
`default boolean`
World.`createExplosion(@Nullable Entity source, @NotNull Location loc, float power)`
Creates explosion at given location with given power, with the specified entity as the source.
`default boolean`
World.`createExplosion(@Nullable Entity source, @NotNull Location loc, float power, boolean setFire)`
Creates explosion at given location with given power and optionally setting blocks on fire, with the specified entity as the source.
`boolean`
World.`createExplosion(@Nullable Entity source, @NotNull Location loc, float power, boolean setFire, boolean breakBlocks)`
Creates explosion at given location with given power and optionally setting blocks on fire, with the specified entity as the source.
`double`
Location.`distance(@NotNull Location o)`
Get the distance between this location and another.
`double`
Location.`distanceSquared(@NotNull Location o)`
Get the squared distance between this location and another.
`@NotNull Item`
World.`dropItem(@NotNull Location location, @NotNull ItemStack item)`
Drops an item at the specified `Location`
`@NotNull Item`
World.`dropItem(@NotNull Location location, @NotNull ItemStack item, @Nullable Consumer<Item> function)`
Drops an item at the specified `Location` Note that functions will run before the entity is spawned
`@NotNull Item`
World.`dropItemNaturally(@NotNull Location location, @NotNull ItemStack item)`
Drops an item at the specified `Location` with a random offset
`@NotNull Item`
World.`dropItemNaturally(@NotNull Location location, @NotNull ItemStack item, @Nullable Consumer<Item> function)`
Drops an item at the specified `Location` with a random offset Note that functions will run before the entity is spawned
`@Nullable Location`
World.`findLightningRod(@NotNull Location location)`
Finds the location of the nearest unobstructed Lightning Rod in a 128-block radius around the given location.
`@Nullable Location`
World.`findLightningTarget(@NotNull Location location)`
Finds a target `Location` for lightning to strike.
`boolean`
RegionAccessor.`generateTree(@NotNull Location location, @NotNull Random random, @NotNull TreeType type)`
Creates a tree at the given `Location`
`boolean`
RegionAccessor.`generateTree(@NotNull Location location, @NotNull Random random, @NotNull TreeType type, @Nullable Predicate<BlockState> statePredicate)`
Creates a tree at the given `Location`
`boolean`
RegionAccessor.`generateTree(@NotNull Location location, @NotNull Random random, @NotNull TreeType type, @Nullable Consumer<BlockState> stateConsumer)`
Creates a tree at the given `Location`
`boolean`
World.`generateTree(@NotNull Location location, @NotNull TreeType type)`
Creates a tree at the given `Location`
`boolean`
World.`generateTree(@NotNull Location loc, @NotNull TreeType type, @NotNull BlockChangeDelegate delegate)`
Deprecated.
this method does not handle tile entities (bee nests)
`@NotNull Biome`
RegionAccessor.`getBiome(@NotNull Location location)`
Gets the `Biome` at the given `Location`.
`@NotNull Block`
World.`getBlockAt(@NotNull Location location)`
Gets the `Block` at the given `Location`
`@NotNull BlockData`
RegionAccessor.`getBlockData(@NotNull Location location)`
Gets the `BlockData` at the given `Location`.
`@NotNull BlockState`
RegionAccessor.`getBlockState(@NotNull Location location)`
Gets the `BlockState` at the given `Location`.
`@NotNull Chunk`
World.`getChunkAt(@NotNull Location location)`
Gets the `Chunk` at the given `Location`
`default CompletableFuture<Chunk>`
World.`getChunkAtAsync(@NotNull Location loc)`
Requests a `Chunk` to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.
`default CompletableFuture<Chunk>`
World.`getChunkAtAsync(@NotNull Location loc, boolean gen)`
Requests a `Chunk` to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.
`default void`
World.`getChunkAtAsync(@NotNull Location loc, boolean gen, Consumer<Chunk> cb)`
Requests a `Chunk` to be loaded at the given `Location` This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.
`default void`
World.`getChunkAtAsync(@NotNull Location loc, @NotNull World.ChunkLoadCallback cb)`
Deprecated.
Use either the Future or the Consumer based methods
`default void`
World.`getChunkAtAsync(@NotNull Location loc, Consumer<Chunk> cb)`
Requests a `Chunk` to be loaded at the given `Location` This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.
`default CompletableFuture<Chunk>`
World.`getChunkAtAsyncUrgently(@NotNull Location loc)`
Requests a `Chunk` to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.
`default CompletableFuture<Chunk>`
World.`getChunkAtAsyncUrgently(@NotNull Location loc, boolean gen)`
Requests a `Chunk` to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.
`static long`
Chunk.`getChunkKey(@NotNull Location loc)`
`@NotNull Block`
World.`getHighestBlockAt(@NotNull Location location)`
Gets the highest non-empty (impassable) block at the given coordinates.
`@NotNull Block`
World.`getHighestBlockAt(@NotNull Location location, @NotNull HeightMap heightMap)`
Gets the highest block corresponding to the `HeightMap` at the given coordinates.
`default @NotNull Block`
World.`getHighestBlockAt(@NotNull Location location, HeightmapType heightmap)`
Deprecated.
Upstream has added support for this, use `World.getHighestBlockAt(Location, HeightMap)`
`int`
World.`getHighestBlockYAt(@NotNull Location location)`
Gets the highest non-empty (impassable) coordinate at the given `Location`.
`int`
World.`getHighestBlockYAt(@NotNull Location location, @NotNull HeightMap heightMap)`
Gets the highest coordinate corresponding to the `HeightMap` at the given `Location`.
`default int`
World.`getHighestBlockYAt(@NotNull Location location, HeightmapType heightmap)`
Deprecated.
Upstream has added support for this, use `World.getHighestBlockYAt(Location, HeightMap)`
`@NotNull Collection<Entity>`
World.`getNearbyEntities(@NotNull Location location, double x, double y, double z)`
Returns a list of entities within a bounding box centered around a Location.
`@NotNull Collection<Entity>`
World.`getNearbyEntities(@NotNull Location location, double x, double y, double z, @Nullable Predicate<Entity> filter)`
Returns a list of entities within a bounding box centered around a Location.
`default <T extends Entity>
@NotNull Collection<T>`
World.`getNearbyEntitiesByType(@Nullable Class<? extends Entity> clazz, @NotNull Location loc, double xRadius, double yRadius, double zRadius, @Nullable Predicate<T> predicate)`
Gets all nearby entities of the specified type, within the specified radius (bounding box)
`default <T extends Entity>
@NotNull Collection<T>`
World.`getNearbyEntitiesByType(@Nullable Class<? extends T> clazz, @NotNull Location loc, double radius)`
Gets all nearby entities of the specified type, within the specified radius (bounding box)
`default <T extends Entity>
@NotNull Collection<T>`
World.`getNearbyEntitiesByType(@Nullable Class<? extends T> clazz, @NotNull Location loc, double xzRadius, double yRadius)`
Gets all nearby entities of the specified type, within the specified radius, with x and x radius matching (bounding box)
`default <T extends Entity>
@NotNull Collection<T>`
World.`getNearbyEntitiesByType(@Nullable Class<? extends T> clazz, @NotNull Location loc, double xRadius, double yRadius, double zRadius)`
Gets all nearby entities of the specified type, within the specified radius (bounding box)
`default <T extends Entity>
@NotNull Collection<T>`
World.`getNearbyEntitiesByType(@Nullable Class<? extends T> clazz, @NotNull Location loc, double xzRadius, double yRadius, @Nullable Predicate<T> predicate)`
Gets all nearby entities of the specified type, within the specified radius, with x and x radius matching (bounding box)
`default <T extends Entity>
@NotNull Collection<T>`
World.`getNearbyEntitiesByType(@Nullable Class<? extends T> clazz, @NotNull Location loc, double radius, @Nullable Predicate<T> predicate)`
Gets all nearby entities of the specified type, within the specified radius (bounding box)
`default @NotNull Collection<LivingEntity>`
World.`getNearbyLivingEntities(@NotNull Location loc, double radius)`
Gets nearby LivingEntities within the specified radius (bounding box)
`default @NotNull Collection<LivingEntity>`
World.`getNearbyLivingEntities(@NotNull Location loc, double xzRadius, double yRadius)`
Gets nearby LivingEntities within the specified radius (bounding box)
`default @NotNull Collection<LivingEntity>`
World.`getNearbyLivingEntities(@NotNull Location loc, double xRadius, double yRadius, double zRadius)`
Gets nearby LivingEntities within the specified radius (bounding box)
`default @NotNull Collection<LivingEntity>`
World.`getNearbyLivingEntities(@NotNull Location loc, double xRadius, double yRadius, double zRadius, @Nullable Predicate<LivingEntity> predicate)`
Gets nearby LivingEntities within the specified radius (bounding box)
`default @NotNull Collection<LivingEntity>`
World.`getNearbyLivingEntities(@NotNull Location loc, double xzRadius, double yRadius, @Nullable Predicate<LivingEntity> predicate)`
Gets nearby LivingEntities within the specified radius (bounding box)
`default @NotNull Collection<LivingEntity>`
World.`getNearbyLivingEntities(@NotNull Location loc, double radius, @Nullable Predicate<LivingEntity> predicate)`
Gets nearby LivingEntities within the specified radius (bounding box)
`default @NotNull Collection<Player>`
World.`getNearbyPlayers(@NotNull Location loc, double radius)`
Gets nearby players within the specified radius (bounding box)
`default @NotNull Collection<Player>`
World.`getNearbyPlayers(@NotNull Location loc, double xzRadius, double yRadius)`
Gets nearby players within the specified radius (bounding box)
`default @NotNull Collection<Player>`
World.`getNearbyPlayers(@NotNull Location loc, double xRadius, double yRadius, double zRadius)`
Gets nearby players within the specified radius (bounding box)
`default @NotNull Collection<Player>`
World.`getNearbyPlayers(@NotNull Location loc, double xRadius, double yRadius, double zRadius, @Nullable Predicate<Player> predicate)`
Gets nearby players within the specified radius (bounding box)
`default @NotNull Collection<Player>`
World.`getNearbyPlayers(@NotNull Location loc, double xzRadius, double yRadius, @Nullable Predicate<Player> predicate)`
Gets nearby players within the specified radius (bounding box)
`default @NotNull Collection<Player>`
World.`getNearbyPlayers(@NotNull Location loc, double radius, @Nullable Predicate<Player> predicate)`
Gets nearby players within the specified radius (bounding box)
`@NotNull Material`
RegionAccessor.`getType(@NotNull Location location)`
Gets the type of the block at the given `Location`.
`default boolean`
WorldBorder.`isInBounds(@NotNull Location location)`
Deprecated.
use `WorldBorder.isInside(Location)` for an upstream compatible replacement
`boolean`
WorldBorder.`isInside(@NotNull Location location)`
Check if the specified location is inside this border.
`boolean`
RegionAccessor.`lineOfSightExists(@NotNull Location from, @NotNull Location to)`
Tell whether a line of sight exists between the given locations
`@Nullable Location`
World.`locateNearestBiome(@NotNull Location origin, @NotNull Biome biome, int radius)`
Locates the nearest biome based on an origin, biome type, and radius to search.
`@Nullable Location`
World.`locateNearestBiome(@NotNull Location origin, @NotNull Biome biome, int radius, int step)`
Locates the nearest biome based on an origin, biome type, and radius to search and step
`@Nullable Raid`
World.`locateNearestRaid(@NotNull Location location, int radius)`
Finds the nearest raid close to the given location.
`@Nullable StructureSearchResult`
World.`locateNearestStructure(@NotNull Location origin, @NotNull Structure structure, int radius, boolean findUnexplored)`
Find the closest nearby structure of a given `Structure`.
`@Nullable StructureSearchResult`
World.`locateNearestStructure(@NotNull Location origin, @NotNull StructureType structureType, int radius, boolean findUnexplored)`
Find the closest nearby structure of a given `StructureType`.
`@Nullable Location`
World.`locateNearestStructure(@NotNull Location origin, StructureType structureType, int radius, boolean findUnexplored)`
Deprecated.
Use `World.locateNearestStructure(Location, Structure, int, boolean)` or `World.locateNearestStructure(Location, StructureType, int, boolean)` instead.
`void`
World.`playEffect(@NotNull Location location, @NotNull Effect effect, int data)`
Plays an effect to all players within a default radius around a given location.
`void`
World.`playEffect(@NotNull Location location, @NotNull Effect effect, int data, int radius)`
Plays an effect to all players within a given radius around a location.
`<T> void`
World.`playEffect(@NotNull Location location, @NotNull Effect effect, T data)`
Plays an effect to all players within a default radius around a given location.
`<T> void`
World.`playEffect(@NotNull Location location, @NotNull Effect effect, T data, int radius)`
Plays an effect to all players within a given radius around a location.
`void`
World.`playSound(@NotNull Location location, @NotNull String sound, float volume, float pitch)`
Play a Sound at the provided Location in the World.
`void`
World.`playSound(@NotNull Location location, @NotNull String sound, @NotNull SoundCategory category, float volume, float pitch)`
Play a Sound at the provided Location in the World.
`void`
World.`playSound(@NotNull Location location, @NotNull Sound sound, float volume, float pitch)`
Play a Sound at the provided Location in the World.
`void`
World.`playSound(@NotNull Location location, @NotNull Sound sound, @NotNull SoundCategory category, float volume, float pitch)`
Play a Sound at the provided Location in the World.
`@Nullable RayTraceResult`
World.`rayTrace(@NotNull Location start, @NotNull Vector direction, double maxDistance, @NotNull FluidCollisionMode fluidCollisionMode, boolean ignorePassableBlocks, double raySize, @Nullable Predicate<Entity> filter)`
Performs a ray trace that checks for both block and entity collisions.
`@Nullable RayTraceResult`
World.`rayTraceBlocks(@NotNull Location start, @NotNull Vector direction, double maxDistance)`
Performs a ray trace that checks for block collisions using the blocks' precise collision shapes.
`@Nullable RayTraceResult`
World.`rayTraceBlocks(@NotNull Location start, @NotNull Vector direction, double maxDistance, @NotNull FluidCollisionMode fluidCollisionMode)`
Performs a ray trace that checks for block collisions using the blocks' precise collision shapes.
`@Nullable RayTraceResult`
World.`rayTraceBlocks(@NotNull Location start, @NotNull Vector direction, double maxDistance, @NotNull FluidCollisionMode fluidCollisionMode, boolean ignorePassableBlocks)`
Performs a ray trace that checks for block collisions using the blocks' precise collision shapes.
`@Nullable RayTraceResult`
World.`rayTraceEntities(@NotNull Location start, @NotNull Vector direction, double maxDistance)`
Performs a ray trace that checks for entity collisions.
`@Nullable RayTraceResult`
World.`rayTraceEntities(@NotNull Location start, @NotNull Vector direction, double maxDistance, double raySize)`
Performs a ray trace that checks for entity collisions.
`@Nullable RayTraceResult`
World.`rayTraceEntities(@NotNull Location start, @NotNull Vector direction, double maxDistance, double raySize, @Nullable Predicate<Entity> filter)`
Performs a ray trace that checks for entity collisions.
`@Nullable RayTraceResult`
World.`rayTraceEntities(@NotNull Location start, @NotNull Vector direction, double maxDistance, @Nullable Predicate<Entity> filter)`
Performs a ray trace that checks for entity collisions.
`void`
RegionAccessor.`setBiome(@NotNull Location location, @NotNull Biome biome)`
Sets the `Biome` at the given `Location`.
`void`
RegionAccessor.`setBlockData(@NotNull Location location, @NotNull BlockData blockData)`
Sets the `BlockData` at the given `Location`.
`void`
WorldBorder.`setCenter(@NotNull Location location)`
Sets the new border center.
`boolean`
World.`setSpawnLocation(@NotNull Location location)`
Sets the spawn location of the world.
`void`
RegionAccessor.`setType(@NotNull Location location, @NotNull Material material)`
Sets the `Material` at the given `Location`.
`<T extends Entity>
T`
RegionAccessor.`spawn(@NotNull Location location, @NotNull Class<T> clazz)`
Spawn an entity of a specific class at the given `Location`
`<T extends Entity>
T`
RegionAccessor.`spawn(@NotNull Location location, @NotNull Class<T> clazz, boolean randomizeData, @Nullable Consumer<T> function)`
Creates a new entity at the given `Location` with the supplied function run before the entity is added to the world.
`default <T extends Entity>
T`
RegionAccessor.`spawn(@NotNull Location location, @NotNull Class<T> clazz, @Nullable Consumer<T> function)`
Spawn an entity of a specific class at the given `Location`, with the supplied function run before the entity is added to the world.
`<T extends Entity>
T`
RegionAccessor.`spawn(@NotNull Location location, @NotNull Class<T> clazz, @Nullable Consumer<T> function, CreatureSpawnEvent.SpawnReason reason)`
`default <T extends Entity>
T`
RegionAccessor.`spawn(@NotNull Location location, @NotNull Class<T> clazz, CreatureSpawnEvent.SpawnReason reason)`
`default <T extends Entity>
T`
RegionAccessor.`spawn(@NotNull Location location, @NotNull Class<T> clazz, CreatureSpawnEvent.SpawnReason reason, @Nullable Consumer<T> function)`
`@NotNull Arrow`
World.`spawnArrow(@NotNull Location location, @NotNull Vector direction, float speed, float spread)`
Creates an `Arrow` entity at the given `Location`
`<T extends AbstractArrow>
T`
World.`spawnArrow(@NotNull Location location, @NotNull Vector direction, float speed, float spread, @NotNull Class<T> clazz)`
Creates an arrow entity of the given class at the given `Location`
`@NotNull Entity`
RegionAccessor.`spawnEntity(@NotNull Location location, @NotNull EntityType type)`
Creates a entity at the given `Location`
`@NotNull Entity`
RegionAccessor.`spawnEntity(@NotNull Location loc, @NotNull EntityType type, boolean randomizeData)`
Creates a new entity at the given `Location`.
`default @NotNull Entity`
RegionAccessor.`spawnEntity(@NotNull Location loc, EntityType type, CreatureSpawnEvent.SpawnReason reason)`
`default @NotNull Entity`
RegionAccessor.`spawnEntity(@NotNull Location loc, EntityType type, CreatureSpawnEvent.SpawnReason reason, @Nullable Consumer<Entity> function)`
`@NotNull FallingBlock`
World.`spawnFallingBlock(@NotNull Location location, @NotNull BlockData data)`
Spawn a `FallingBlock` entity at the given `Location` of the specified `Material`.
`@NotNull FallingBlock`
World.`spawnFallingBlock(@NotNull Location location, @NotNull MaterialData data)`
Deprecated.
use `World.spawnFallingBlock(Location, BlockData)`
`@NotNull FallingBlock`
World.`spawnFallingBlock(@NotNull Location location, @NotNull Material material, byte data)`
Deprecated.
Magic value
`void`
World.`spawnParticle(@NotNull Particle particle, @NotNull Location location, int count)`
Spawns the particle (the number of times specified by count) at the target location.
`void`
World.`spawnParticle(@NotNull Particle particle, @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ)`
Spawns the particle (the number of times specified by count) at the target location.
`void`
World.`spawnParticle(@NotNull Particle particle, @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ, double extra)`
Spawns the particle (the number of times specified by count) at the target location.
`<T> void`
World.`spawnParticle(@NotNull Particle particle, @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ, double extra, T data)`
Spawns the particle (the number of times specified by count) at the target location.
`<T> void`
World.`spawnParticle(@NotNull Particle particle, @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ, double extra, T data, boolean force)`
Spawns the particle (the number of times specified by count) at the target location.
`<T> void`
World.`spawnParticle(@NotNull Particle particle, @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ, T data)`
Spawns the particle (the number of times specified by count) at the target location.
`<T> void`
World.`spawnParticle(@NotNull Particle particle, @NotNull Location location, int count, T data)`
Spawns the particle (the number of times specified by count) at the target location.
`@NotNull LightningStrike`
World.Spigot.`strikeLightning(@NotNull Location loc, boolean isSilent)`
Strikes lightning at the given `Location` and possibly without sound
`@NotNull LightningStrike`
World.`strikeLightning(@NotNull Location loc)`
Strikes lightning at the given `Location`
`@NotNull LightningStrike`
World.Spigot.`strikeLightningEffect(@NotNull Location loc, boolean isSilent)`
Strikes lightning at the given `Location` without doing damage and possibly without sound
`@NotNull LightningStrike`
World.`strikeLightningEffect(@NotNull Location loc)`
Strikes lightning at the given `Location` without doing damage
`@NotNull Location`
Location.`subtract(@NotNull Location vec)`
Subtracts the location by another.
`@NotNull Location`
Location.`subtract(@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 self This mutates this object, clone first.
Constructors in org.bukkit with parameters of type Location
Modifier
Constructor
Description
``
`BlockDestination(@NotNull Location block)`
``
`Vibration(@NotNull Location origin, @NotNull Vibration.Destination destination, int arrivalTime)`
Deprecated, for removal: This API element is subject to removal in a future version.

## Uses of Location in org.bukkit.block

Methods in org.bukkit.block that return Location
Modifier and Type
Method
Description
`@Nullable Location`
EndGateway.`getExitLocation()`
Gets the location that entities are teleported to when entering the gateway portal.
`@Nullable Location`
Beehive.`getFlower()`
Get the hive's flower location.
`@NotNull Location`
Block.`getLocation()`
Gets the Location of the block
`@Nullable Location`
Block.`getLocation(@Nullable Location loc)`
Stores the location of the block in the provided Location object.
`@NotNull Location`
BlockState.`getLocation()`
Gets the location of this block state.
`@Nullable Location`
BlockState.`getLocation(@Nullable Location loc)`
Stores the location of this block state in the provided Location object.
`@NotNull Location`
DoubleChest.`getLocation()`
Methods in org.bukkit.block with parameters of type Location
Modifier and Type
Method
Description
`@Nullable Location`
Block.`getLocation(@Nullable Location loc)`
Stores the location of the block in the provided Location object.
`@Nullable Location`
BlockState.`getLocation(@Nullable Location loc)`
Stores the location of this block state in the provided Location object.
`@Nullable RayTraceResult`
Block.`rayTrace(@NotNull Location start, @NotNull Vector direction, double maxDistance, @NotNull FluidCollisionMode fluidCollisionMode)`
Performs a ray trace that checks for collision with this specific block in its current state using its precise collision shape.
`void`
EndGateway.`setExitLocation(@Nullable Location location)`
Sets the exit location that entities are teleported to when they enter the gateway portal.
`void`
Beehive.`setFlower(@Nullable Location location)`
Set the hive's flower location.

## Uses of Location in org.bukkit.block.data

Methods in org.bukkit.block.data with parameters of type Location
Modifier and Type
Method
Description
`boolean`
BlockData.`isSupported(@NotNull Location location)`
Checks if this state would be properly supported if it were placed at the block at the given `Location`.

## Uses of Location in org.bukkit.boss

Methods in org.bukkit.boss that return Location
Modifier and Type
Method
Description
`@Nullable Location`
DragonBattle.`getEndPortalLocation()`
Get the location of the end portal.

## Uses of Location in org.bukkit.command

Methods in org.bukkit.command with parameters of type Location
Modifier and Type
Method
Description
`@NotNull List<String>`
Command.`tabComplete(@NotNull CommandSender sender, @NotNull String alias, @NotNull String[] args, @Nullable Location location)`
Executed on tab completion for this command, returning a list of options the player can tab through.
`@Nullable List<String>`
CommandMap.`tabComplete(@NotNull CommandSender sender, @NotNull String cmdLine, @Nullable Location location)`
Looks for the requested command and executes an appropriate tab-completer if found.
`@Nullable List<String>`
SimpleCommandMap.`tabComplete(@NotNull CommandSender sender, @NotNull String cmdLine, @Nullable Location location)`

## Uses of Location in org.bukkit.configuration

Methods in org.bukkit.configuration that return Location
Modifier and Type
Method
Description
`@Nullable Location`
ConfigurationSection.`getLocation(@NotNull String path)`
Gets the requested Location by path.
`@Nullable Location`
ConfigurationSection.`getLocation(@NotNull String path, @Nullable Location def)`
Gets the requested `Location` by path, returning a default value if not found.
`@Nullable Location`
MemorySection.`getLocation(@NotNull String path)`
`@Nullable Location`
MemorySection.`getLocation(@NotNull String path, @Nullable Location def)`
Methods in org.bukkit.configuration with parameters of type Location
Modifier and Type
Method
Description
`@Nullable Location`
ConfigurationSection.`getLocation(@NotNull String path, @Nullable Location def)`
Gets the requested `Location` by path, returning a default value if not found.
`@Nullable Location`
MemorySection.`getLocation(@NotNull String path, @Nullable Location def)`

## Uses of Location in org.bukkit.entity

Methods in org.bukkit.entity that return Location
Modifier and Type
Method
Description
`Location`
Phantom.`getAnchorLocation()`
Gets the location that this phantom circles around when not attacking a player This will be changed after attacking a player.
`@Nullable Location`
EnderCrystal.`getBeamTarget()`
Gets the location that this end crystal is pointing its beam to.
`@NotNull Location`
HumanEntity.`getBedLocation()`
Gets the location of the bed the player is currently sleeping in
`@Nullable Location`
Player.`getBedSpawnLocation()`
Gets the Location where the player will spawn at their bed, null if they have not slept in one or their current bed spawn is invalid.
`@Nullable Location`
Vex.`getBound()`
Gets the bound of this entity.
`@NotNull Location`
Player.`getCompassTarget()`
Get the previously set compass target.
`@NotNull Location`
LivingEntity.`getEyeLocation()`
Get a Location detailing the current eye position of the living entity.
`@Nullable Location`
Bee.`getFlower()`
Get the bee's flower location.
`@Nullable Location`
Bee.`getHive()`
Get the bee's hive location.
`@NotNull Location`
Turtle.`getHome()`
Get the turtle's home location
`@Nullable Location`
Allay.`getJukebox()`
Gets the jukebox the allay is set to dance to.
`@Nullable Location`
HumanEntity.`getLastDeathLocation()`
Gets the player's last death location.
`@NotNull Location`
Entity.`getLocation()`
Gets the entity's current position
`@Nullable Location`
Entity.`getLocation(@Nullable Location loc)`
Stores the entity's current position in the provided Location object.
`@Nullable Location`
Entity.`getOrigin()`
Gets the location where this entity originates from.
`Location`
EnderDragon.`getPodium()`
Get the podium location used by the ender dragon.
`@Nullable Location`
HumanEntity.`getPotentialBedLocation()`
Gets the Location of the player's bed, null if they have not slept in one.
`default Location`
FallingBlock.`getSourceLoc()`
Deprecated.
replaced by `Entity.getOrigin()`
`default Location`
TNTPrimed.`getSourceLoc()`
Deprecated.
replaced by `Entity.getOrigin()`
`Location`
Bat.`getTargetLocation()`
Gets the location that this bat is currently trying to move towards.
`@NotNull Location`
EnderSignal.`getTargetLocation()`
Get the location this EnderSignal is moving towards.
`@NotNull Location`
Dolphin.`getTreasureLocation()`
Gets the treasure location this dolphin tries to guide players to.
`Location`
WanderingTrader.`getWanderingTowards()`
Gets the location that this wandering trader is currently wandering towards.
Methods in org.bukkit.entity with parameters of type Location
Modifier and Type
Method
Description
`boolean`
Entity.`collidesAt(@NotNull Location location)`
Checks for any collisions with the entity's bounding box at the provided location.
`@Nullable Location`
Entity.`getLocation(@Nullable Location loc)`
Stores the entity's current position in the provided Location object.
`boolean`
LivingEntity.`hasLineOfSight(@NotNull Location location)`
Checks whether the living entity has block line of sight to the given block.
`void`
Mob.`lookAt(Location location)`
Instruct this Mob to look at a specific Location
`void`
Mob.`lookAt(Location location, float headRotationSpeed, float maxHeadPitch)`
Instruct this Mob to look at a specific Location
`default void`
Player.`lookAt(@NotNull Location location, LookAnchor playerAnchor)`
Causes the player to look towards the given location.
`@Nullable InventoryView`
HumanEntity.`openAnvil(@Nullable Location location, boolean force)`
Opens an empty anvil inventory window with the player's inventory on the bottom.
`@Nullable InventoryView`
HumanEntity.`openCartographyTable(@Nullable Location location, boolean force)`
Opens an empty cartography table inventory window with the player's inventory on the bottom.
`@Nullable InventoryView`
HumanEntity.`openEnchanting(@Nullable Location location, boolean force)`
Opens an empty enchanting inventory window with the player's inventory on the bottom.
`@Nullable InventoryView`
HumanEntity.`openGrindstone(@Nullable Location location, boolean force)`
Opens an empty grindstone inventory window with the player's inventory on the bottom.
`@Nullable InventoryView`
HumanEntity.`openLoom(@Nullable Location location, boolean force)`
Opens an empty loom inventory window with the player's inventory on the bottom.
`@Nullable InventoryView`
HumanEntity.`openSmithingTable(@Nullable Location location, boolean force)`
Opens an empty smithing table inventory window with the player's inventory on the bottom.
`@Nullable InventoryView`
HumanEntity.`openStonecutter(@Nullable Location location, boolean force)`
Opens an empty stonecutter inventory window with the player's inventory on the bottom.
`@Nullable InventoryView`
HumanEntity.`openWorkbench(@Nullable Location location, boolean force)`
Opens an empty workbench inventory window with the player's inventory on the bottom.
`void`
Player.`playEffect(@NotNull Location loc, @NotNull Effect effect, int data)`
Deprecated.
Magic value
`<T> void`
Player.`playEffect(@NotNull Location loc, @NotNull Effect effect, T data)`
Plays an effect to just this player.
`void`
Player.`playNote(@NotNull Location loc, byte instrument, byte note)`
Deprecated.
Magic value
`void`
Player.`playNote(@NotNull Location loc, @NotNull Instrument instrument, @NotNull Note note)`
Play a note for a player at a location.
`void`
Player.`playSound(@NotNull Location location, @NotNull String sound, float volume, float pitch)`
Play a sound for a player at the location.
`void`
Player.`playSound(@NotNull Location location, @NotNull String sound, @NotNull SoundCategory category, float volume, float pitch)`
Play a sound for a player at the location.
`void`
Player.`playSound(@NotNull Location location, @NotNull Sound sound, float volume, float pitch)`
Play a sound for a player at the location.
`void`
Player.`playSound(@NotNull Location location, @NotNull Sound sound, @NotNull SoundCategory category, float volume, float pitch)`
Play a sound for a player at the location.
`void`
Player.`sendBlockChange(@NotNull Location loc, @NotNull BlockData block)`
Send a block change.
`void`
Player.`sendBlockChange(@NotNull Location loc, @NotNull Material material, byte data)`
Deprecated.
Magic value
`void`
Player.`sendBlockDamage(@NotNull Location loc, float progress)`
Send block damage.
`void`
Player.`sendBlockDamage(@NotNull Location loc, float progress, int destroyerIdentity)`
Send block damage.
`void`
Player.`sendSignChange(@NotNull Location loc, @Nullable String[] lines)`
Deprecated.
in favour of `Player.sendSignChange(org.bukkit.Location, java.util.List)`
`void`
Player.`sendSignChange(@NotNull Location loc, @Nullable String[] lines, @NotNull DyeColor dyeColor)`
Deprecated.
in favour of `Player.sendSignChange(org.bukkit.Location, java.util.List, org.bukkit.DyeColor)`
`void`
Player.`sendSignChange(@NotNull Location loc, @Nullable String[] lines, @NotNull DyeColor dyeColor, boolean hasGlowingText)`
Deprecated.
Deprecated in favour of `Player.sendSignChange(Location, java.util.List, DyeColor, boolean)`
`default void`
Player.`sendSignChange(@NotNull Location loc, List<Component> lines)`
Send a sign change.
`default void`
Player.`sendSignChange(@NotNull Location loc, List<Component> lines, boolean hasGlowingText)`
Send a sign change.
`default void`
Player.`sendSignChange(@NotNull Location loc, List<Component> lines, @NotNull DyeColor dyeColor)`
Send a sign change.
`void`
Player.`sendSignChange(@NotNull Location loc, List<Component> lines, @NotNull DyeColor dyeColor, boolean hasGlowingText)`
Send a sign change.
`void`
Phantom.`setAnchorLocation(Location location)`
Sets the location that this phantom circles around when not attacking a player
`void`
EnderCrystal.`setBeamTarget(@Nullable Location location)`
Sets the location that this end crystal is pointing to.
`void`
Player.`setBedSpawnLocation(@Nullable Location location)`
Sets the Location where the player will spawn at their bed.
`void`
Player.`setBedSpawnLocation(@Nullable Location location, boolean force)`
Sets the Location where the player will spawn at their bed.
`void`
Vex.`setBound(@Nullable Location location)`
Sets the bound of this entity.
`void`
Player.`setCompassTarget(@NotNull Location loc)`
Set the target of the player's compass.
`void`
Warden.`setDisturbanceLocation(@NotNull Location location)`
Make the warden sense a disturbance in the force at the location given.
`void`
Bee.`setFlower(@Nullable Location location)`
Set the bee's flower location.
`void`
Bee.`setHive(@Nullable Location location)`
Set the bee's hive location.
`void`
Turtle.`setHome(@NotNull Location location)`
Set the turtle's home location
`void`
HumanEntity.`setLastDeathLocation(@Nullable Location location)`
Sets the player's last death location.
`void`
EnderDragon.`setPodium(Location location)`
Sets the location of the podium for the ender dragon.
`void`
Bat.`setTargetLocation(Location location)`
Sets the location that this bat is currently trying to move towards.
`void`
EnderSignal.`setTargetLocation(@NotNull Location location)`
Set the `Location` this EnderSignal is moving towards.
`void`
EnderSignal.`setTargetLocation(@NotNull Location location, boolean update)`
Set the `Location` this EnderSignal is moving towards.
`void`
Dolphin.`setTreasureLocation(@NotNull Location location)`
Sets the treasure location that this dolphin will try to lead the player to.
`void`
WanderingTrader.`setWanderingTowards(Location location)`
Sets the location that this wandering trader is currently wandering towards.
`boolean`
HumanEntity.`sleep(@NotNull Location location, boolean force)`
Attempts to make the entity sleep at the given location.
`boolean`
Villager.`sleep(@NotNull Location location)`
Attempts to make this villager sleep at the given location.
`default boolean`
Entity.`spawnAt(@NotNull Location location)`
Spawns the entity in the world at the given `Location` with the default spawn reason.
`boolean`
Entity.`spawnAt(@NotNull Location location, CreatureSpawnEvent.SpawnReason reason)`
Spawns the entity in the world at the given `Location` with the reason given.
`void`
Player.`spawnParticle(@NotNull Particle particle, @NotNull Location location, int count)`
Spawns the particle (the number of times specified by count) at the target location.
`void`
Player.`spawnParticle(@NotNull Particle particle, @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ)`
Spawns the particle (the number of times specified by count) at the target location.
`void`
Player.`spawnParticle(@NotNull Particle particle, @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ, double extra)`
Spawns the particle (the number of times specified by count) at the target location.
`<T> void`
Player.`spawnParticle(@NotNull Particle particle, @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ, double extra, T data)`
Spawns the particle (the number of times specified by count) at the target location.
`<T> void`
Player.`spawnParticle(@NotNull Particle particle, @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ, T data)`
Spawns the particle (the number of times specified by count) at the target location.
`<T> void`
Player.`spawnParticle(@NotNull Particle particle, @NotNull Location location, int count, T data)`
Spawns the particle (the number of times specified by count) at the target location.
`void`
Allay.`startDancing(@NotNull Location location)`
Causes the allay to start dancing because of the provided jukebox location.
`boolean`
Entity.`teleport(@NotNull Location location)`
Teleports this entity to the given location.
`default boolean`
Entity.`teleport(@NotNull Location location, boolean ignorePassengers)`
Teleports this entity to the given location.
`default boolean`
Entity.`teleport(@NotNull Location location, boolean ignorePassengers, boolean dismount)`
Teleports this entity to the given location.
`boolean`
Entity.`teleport(@NotNull Location location, @NotNull PlayerTeleportEvent.TeleportCause cause)`
Teleports this entity to the given location.
`default boolean`
Entity.`teleport(@NotNull Location location, @NotNull PlayerTeleportEvent.TeleportCause cause, boolean ignorePassengers)`
Teleports this entity to the given location.
`boolean`
Entity.`teleport(@NotNull Location location, @NotNull PlayerTeleportEvent.TeleportCause cause, boolean ignorePassengers, boolean dismount)`
Teleports this entity to the given location.
`boolean`
Player.`teleport(@NotNull Location location, PlayerTeleportEvent.TeleportCause cause, boolean ignorePassengers, boolean dismount, @NotNull RelativeTeleportFlag @NotNull ... teleportFlags)`
Teleports this entity to the given location.
`default CompletableFuture<Boolean>`
Entity.`teleportAsync(@NotNull Location loc)`
Loads/Generates(in 1.13+) the Chunk asynchronously, and then teleports the entity when the chunk is ready.
`default CompletableFuture<Boolean>`
Entity.`teleportAsync(@NotNull Location loc, @NotNull PlayerTeleportEvent.TeleportCause cause)`
Loads/Generates(in 1.13+) the Chunk asynchronously, and then teleports the entity when the chunk is ready.
Method parameters in org.bukkit.entity with type arguments of type Location
Modifier and Type
Method
Description
`default void`
Player.`sendMultiBlockChange(Map<Location,BlockData> blockChanges)`
Send multiple block changes.
`void`
Player.`sendMultiBlockChange(Map<Location,BlockData> blockChanges, boolean suppressLightUpdates)`
Send multiple block changes.

## Uses of Location in org.bukkit.entity.memory

Fields in org.bukkit.entity.memory with type parameters of type Location
Modifier and Type
Field
Description
`static final MemoryKey<Location>`
MemoryKey.`HOME`
`static final MemoryKey<Location>`
MemoryKey.`JOB_SITE`
`static final MemoryKey<Location>`
MemoryKey.`LIKED_NOTEBLOCK_POSITION`
`static final MemoryKey<Location>`
MemoryKey.`MEETING_POINT`
`static final MemoryKey<Location>`
MemoryKey.`POTENTIAL_JOB_SITE`

## Uses of Location in org.bukkit.event.block

Methods in org.bukkit.event.block that return Location
Modifier and Type
Method
Description
`@NotNull Location`
BlockPistonRetractEvent.`getRetractLocation()`
Deprecated.

## Uses of Location in org.bukkit.event.entity

Methods in org.bukkit.event.entity that return Location
Modifier and Type
Method
Description
`@NotNull Location`
EntityTeleportEvent.`getFrom()`
Gets the location that this entity moved from
`@NotNull Location`
EntityExplodeEvent.`getLocation()`
Returns the location where the explosion happened.
`@NotNull Location`
EntityPortalEnterEvent.`getLocation()`
Gets the portal block the entity is touching
`@NotNull Location`
EntitySpawnEvent.`getLocation()`
Gets the location at which the entity is spawning.
`@NotNull Location`
ItemDespawnEvent.`getLocation()`
Gets the location at which the item is despawning.
`@Nullable Location`
EntityTeleportEvent.`getTo()`
Gets the location that this entity moved to
Methods in org.bukkit.event.entity with parameters of type Location
Modifier and Type
Method
Description
`void`
EntityTeleportEvent.`setFrom(@NotNull Location from)`
Sets the location that this entity moved from
`void`
EntityTeleportEvent.`setTo(@Nullable Location to)`
Sets the location that this entity moved to
Constructors in org.bukkit.event.entity with parameters of type Location
Modifier
Constructor
Description
``
`EntityExplodeEvent(@NotNull Entity what, @NotNull Location location, @NotNull List<Block> blocks, float yield)`
``
`EntityPortalEnterEvent(@NotNull Entity entity, @NotNull Location location)`
``
`EntityPortalEvent(@NotNull Entity entity, @NotNull Location from, @Nullable Location to)`
``
`EntityPortalEvent(@NotNull Entity entity, @NotNull Location from, @Nullable Location to, int searchRadius)`
``
`EntityPortalExitEvent(@NotNull Entity entity, @NotNull Location from, @NotNull Location to, @NotNull Vector before, @NotNull Vector after)`
``
`EntityTeleportEvent(@NotNull Entity what, @NotNull Location from, @Nullable Location to)`
``
`ItemDespawnEvent(@NotNull Item despawnee, @NotNull Location loc)`
``
`ItemSpawnEvent(@NotNull Item spawnee, Location loc)`
Deprecated.

## Uses of Location in org.bukkit.event.player

Methods in org.bukkit.event.player that return Location
Modifier and Type
Method
Description
`@NotNull Location`
PlayerMoveEvent.`getFrom()`
Gets the location this player moved from
`@Nullable Location`
PlayerInteractEvent.`getInteractionPoint()`
The exact point at which the interaction occurred.
`@NotNull Location`
PlayerRespawnEvent.`getRespawnLocation()`
Gets the current respawn location
`@NotNull Location`
PlayerMoveEvent.`getTo()`
Gets the location this player moved to
Methods in org.bukkit.event.player with parameters of type Location
Modifier and Type
Method
Description
`void`
PlayerMoveEvent.`setFrom(@NotNull Location from)`
Sets the location to mark as where the player moved from
`void`
PlayerRespawnEvent.`setRespawnLocation(@NotNull Location respawnLocation)`
Sets the new respawn location
`void`
PlayerMoveEvent.`setTo(@NotNull Location to)`
Sets the location that this player will move to
Constructors in org.bukkit.event.player with parameters of type Location
Modifier
Constructor
Description
``
`PlayerInteractEvent(@NotNull Player who, @NotNull Action action, @Nullable ItemStack item, @Nullable Block clickedBlock, @NotNull BlockFace clickedFace, @Nullable EquipmentSlot hand, @Nullable Location interactionPoint)`
``
`PlayerMoveEvent(@NotNull Player player, @NotNull Location from, @Nullable Location to)`
``
`PlayerPortalEvent(@NotNull Player player, @NotNull Location from, @Nullable Location to)`
``
`PlayerPortalEvent(@NotNull Player player, @NotNull Location from, @Nullable Location to, @NotNull PlayerTeleportEvent.TeleportCause cause)`
``
`PlayerPortalEvent(@NotNull Player player, @NotNull Location from, @Nullable Location to, @NotNull PlayerTeleportEvent.TeleportCause cause, int getSearchRadius, boolean canCreatePortal, int creationRadius)`
``
`PlayerRespawnEvent(@NotNull Player respawnPlayer, @NotNull Location respawnLocation, boolean isBedSpawn)`
Deprecated.
``
`PlayerRespawnEvent(@NotNull Player respawnPlayer, @NotNull Location respawnLocation, boolean isBedSpawn, boolean isAnchorSpawn)`
Deprecated.
``
`PlayerRespawnEvent(@NotNull Player respawnPlayer, @NotNull Location respawnLocation, boolean isBedSpawn, boolean isAnchorSpawn, ImmutableSet.Builder<PlayerRespawnEvent.RespawnFlag> respawnFlags)`
``
`PlayerTeleportEvent(@NotNull Player player, @NotNull Location from, @Nullable Location to)`
``
`PlayerTeleportEvent(@NotNull Player player, @NotNull Location from, @Nullable Location to, @NotNull PlayerTeleportEvent.TeleportCause cause)`
``
`PlayerTeleportEvent(@NotNull Player player, @NotNull Location from, @Nullable Location to, @NotNull PlayerTeleportEvent.TeleportCause cause, boolean dismounted, Set<@NotNull RelativeTeleportFlag> teleportFlagSet)`

## Uses of Location in org.bukkit.event.server

Methods in org.bukkit.event.server that return Location
Modifier and Type
Method
Description
`Location`
TabCompleteEvent.`getLocation()`
Constructors in org.bukkit.event.server with parameters of type Location
Modifier
Constructor
Description
``
`TabCompleteEvent(@NotNull CommandSender sender, @NotNull String buffer, @NotNull List<String> completions, boolean isCommand, Location location)`

## Uses of Location in org.bukkit.event.vehicle

Methods in org.bukkit.event.vehicle that return Location
Modifier and Type
Method
Description
`@NotNull Location`
VehicleMoveEvent.`getFrom()`
Get the previous position.
`@NotNull Location`
VehicleMoveEvent.`getTo()`
Get the next position.
Constructors in org.bukkit.event.vehicle with parameters of type Location
Modifier
Constructor
Description
``
`VehicleMoveEvent(@NotNull Vehicle vehicle, @NotNull Location from, @NotNull Location to)`

## Uses of Location in org.bukkit.event.world

Methods in org.bukkit.event.world that return Location
Modifier and Type
Method
Description
`@NotNull Location`
GenericGameEvent.`getLocation()`
Get the location where the event occurred.
`@NotNull Location`
StructureGrowEvent.`getLocation()`
Gets the location of the structure.
`@NotNull Location`
SpawnChangeEvent.`getPreviousLocation()`
Gets the previous spawn location
Constructors in org.bukkit.event.world with parameters of type Location
Modifier
Constructor
Description
``
`GenericGameEvent(@NotNull GameEvent event, @NotNull Location location, @Nullable Entity entity, int radius, boolean isAsync)`
``
`SpawnChangeEvent(@NotNull World world, @NotNull Location previousLocation)`
``
`StructureGrowEvent(@NotNull Location location, @NotNull TreeType species, boolean bonemeal, @Nullable Player player, @NotNull List<BlockState> blocks)`

## Uses of Location in org.bukkit.generator

Methods in org.bukkit.generator that return Location
Modifier and Type
Method
Description
`@Nullable Location`
ChunkGenerator.`getFixedSpawnLocation(@NotNull World world, @NotNull Random random)`
Gets a fixed spawn location to use for a given world.
Methods in org.bukkit.generator with parameters of type Location
Modifier and Type
Method
Description
`boolean`
LimitedRegion.`isInRegion(@NotNull Location location)`
Checks if the given `Location` is in the region.

## Uses of Location in org.bukkit.inventory

Methods in org.bukkit.inventory that return Location
Modifier and Type
Method
Description
`@Nullable Location`
Inventory.`getLocation()`
Get the location of the block or entity which corresponds to this inventory.

## Uses of Location in org.bukkit.inventory.meta

Methods in org.bukkit.inventory.meta that return Location
Modifier and Type
Method
Description
`@Nullable Location`
CompassMeta.`getLodestone()`
Gets the location that this compass will point to.
Methods in org.bukkit.inventory.meta with parameters of type Location
Modifier and Type
Method
Description
`void`
CompassMeta.`setLodestone(@Nullable Location lodestone)`
Sets the location this lodestone compass will point to.

## Uses of Location in org.bukkit.loot

Methods in org.bukkit.loot that return Location
Modifier and Type
Method
Description
`@NotNull Location`
LootContext.`getLocation()`
The `Location` to store where the loot will be generated.
Constructors in org.bukkit.loot with parameters of type Location
Modifier
Constructor
Description
``
`Builder(@NotNull Location location)`
Creates a new LootContext.Builder instance to facilitate easy creation of `LootContext`s.

## Uses of Location in org.bukkit.structure

Methods in org.bukkit.structure with parameters of type Location
Modifier and Type
Method
Description
`void`
Structure.`fill(@NotNull Location corner1, @NotNull Location corner2, boolean includeEntities)`
Fills the structure from an area in a world.
`void`
Structure.`fill(@NotNull Location origin, @NotNull BlockVector size, boolean includeEntities)`
Fills the Structure from an area in a world, starting at the specified origin and extending in each axis according to the specified size vector.
`void`
Structure.`place(@NotNull Location location, boolean includeEntities, @NotNull StructureRotation structureRotation, @NotNull Mirror mirror, int palette, float integrity, @NotNull Random random)`
Place a structure in the world.

## Uses of Location in org.bukkit.util

Methods in org.bukkit.util that return Location
Modifier and Type
Method
Description
`@NotNull Location`
StructureSearchResult.`getLocation()`
Return the location of the structure.
`@NotNull Location`
Vector.`toLocation(@NotNull World world)`
Gets a Location version of this vector with yaw and pitch being 0.
`@NotNull Location`
Vector.`toLocation(@NotNull World world, float yaw, float pitch)`
Gets a Location version of this vector.
Methods in org.bukkit.util with parameters of type Location
Modifier and Type
Method
Description
`static @NotNull BoundingBox`
BoundingBox.`of(@NotNull Location center, double x, double y, double z)`
Creates a new bounding box using the given center and extents.
`static @NotNull BoundingBox`
BoundingBox.`of(@NotNull Location corner1, @NotNull Location corner2)`
Creates a new bounding box using the coordinates of the given locations as corners.
`@NotNull BoundingBox`
BoundingBox.`shift(@NotNull Location shift)`
Shifts this bounding box by the given amounts.
`@NotNull BoundingBox`
BoundingBox.`union(@NotNull Location position)`
Expands this bounding box to contain (or border) the specified position.
Constructors in org.bukkit.util with parameters of type Location
Modifier
Constructor
Description
``
`BlockIterator(@NotNull Location loc)`
Constructs the BlockIterator.
``
`BlockIterator(@NotNull Location loc, double yOffset)`
Constructs the BlockIterator.
``
`BlockIterator(@NotNull Location loc, double yOffset, int maxDistance)`
Constructs the BlockIterator.

## Uses of Location in org.spigotmc.event.player

Methods in org.spigotmc.event.player that return Location
Modifier and Type
Method
Description
`@NotNull Location`
PlayerSpawnLocationEvent.`getSpawnLocation()`
Gets player's spawn location.
Methods in org.spigotmc.event.player with parameters of type Location
Modifier and Type
Method
Description
`void`
PlayerSpawnLocationEvent.`setSpawnLocation(@NotNull Location location)`
Sets player's spawn location.
Constructors in org.spigotmc.event.player with parameters of type Location
Modifier
Constructor
Description
``
`PlayerSpawnLocationEvent(@NotNull Player who, @NotNull Location spawnLocation)`