Uses of Class
org.bukkit.Location
Package
Description
The root package of the Bukkit API, contains generalized API classes.
Classes used to manipulate the voxels in a
world
,
including special states.Generalized BlockData classes.
Classes concerning the creation of boss bars that appear at the top of the
player's screen.
Classes relating to handling specialized non-chat player input.
Classes dedicated to handling a plugin's runtime configuration.
Interfaces for non-voxel objects that can exist in a
world
, including all players, monsters, projectiles, etc.Classes concerning an entity's persistent memory.
Events
relating to programmatic state
changes on the server.Events
relating to vehicular entities
.Classes to facilitate
world
generation
implementation.Classes involved in manipulating player inventories and item interactions.
The interfaces used when manipulating extra data can can be stored inside
item stacks
.Classes relevant to loot table manipulation and generation.
Classes related to creating or using
structures
without creating Structure
blocks
in the world.Multi and single purpose classes to facilitate various programmatic
concepts.
Spigot-specific player events.
-
Uses of Location in com.destroystokyo.paper
Modifier and TypeMethodDescriptionSets the location of where to spawn the particle -
Uses of Location in com.destroystokyo.paper.entity
Modifier and TypeMethodDescriptionPathfinder.PathResult.getFinalPoint()
Pathfinder.PathResult.getNextPoint()
Modifier and TypeMethodDescriptionPathfinder.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, seePathfinder.PathResult.getNextPointIndex()
Modifier and TypeMethodDescriptionCalculates a destination for the Entity to navigate to, but does not set it as the current target.default boolean
Calculates a destination for the Entity to navigate to, and sets it with default speed as the current target.default boolean
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
Modifier and TypeMethodDescriptionEntityPathfindEvent.getLoc()
The Location of where the entity is about to move to.TurtleLayEggEvent.getLocation()
Get the location where the eggs are being laidTurtleStartDiggingEvent.getLocation()
Get the location where the turtle is diggingPreSpawnerSpawnEvent.getSpawnerLocation()
PreCreatureSpawnEvent.getSpawnLocation()
ModifierConstructorDescriptionEntityTeleportEndGatewayEvent
(@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
Modifier and TypeMethodDescriptionPlayerJumpEvent.getFrom()
Gets the location this player jumped fromPlayerSetSpawnEvent.getLocation()
Gets the location that the spawn is set to.PlayerPostRespawnEvent.getRespawnedLocation()
Returns the location of the respawned playerPlayerJumpEvent.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.Modifier and TypeMethodDescriptionvoid
Sets the location to mark as where the player jumped fromvoid
PlayerSetSpawnEvent.setLocation
(@Nullable Location location) Sets the location to be set as the spawn location.ModifierConstructorDescriptionPlayerInitialSpawnEvent
(@NotNull Player who, @NotNull Location spawnLocation) Deprecated.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
ModifierConstructorDescriptionAsyncTabCompleteEvent
(@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
Modifier and TypeMethodDescriptionEntityMoveEvent.getFrom()
Gets the location this entity moved fromEntityMoveEvent.getTo()
Gets the location this entity moved toModifier and TypeMethodDescriptionvoid
Sets the location to mark as where the entity moved fromvoid
Sets the location that this entity will move toModifierConstructorDescriptionEntityMoveEvent
(@NotNull LivingEntity entity, @NotNull Location from, @NotNull Location to) -
Uses of Location in io.papermc.paper.event.world
Modifier and TypeMethodDescriptionStructureLocateEvent.getOrigin()
Deprecated, for removal: This API element is subject to removal in a future version.Gets theLocation
from which the search is to be conducted.StructuresLocateEvent.getOrigin()
Gets theLocation
from which the search is to be conducted.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.StructuresLocateEvent.Result.position()
Returns the value of theposition
record component.Modifier and TypeMethodDescriptionvoid
Deprecated, for removal: This API element is subject to removal in a future version.Sets the resultLocation
.ModifierConstructorDescriptionResult
(@NotNull Location position, @NotNull ConfiguredStructure configuredStructure) Creates an instance of aResult
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
Modifier and TypeMethodDescriptionWorldBorderCenterChangeEvent.getNewCenter()
Gets the new center location for the world border.WorldBorderCenterChangeEvent.getOldCenter()
Gets the original center location of the world border.Modifier and TypeMethodDescriptionvoid
WorldBorderCenterChangeEvent.setNewCenter
(@NotNull Location newCenter) Sets the new center location for the world border.ModifierConstructorDescriptionWorldBorderCenterChangeEvent
(@NotNull World world, @NotNull WorldBorder worldBorder, @NotNull Location oldCenter, @NotNull Location newCenter) -
Uses of Location in io.papermc.paper.math
Modifier and TypeMethodDescriptionPosition.toLocation
(@NotNull World world) Creates a new location object at this position with the specified worldModifier and TypeMethodDescriptionstatic @NotNull BlockPosition
Creates a position from the location.static @NotNull FinePosition
Creates a position from the location. -
Uses of Location in me.totalfreedom.scissors.event.block
-
Uses of Location in org.bukkit
Modifier and TypeMethodDescriptionLocation.add
(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 self This mutates this object, clone first.Adds the location by a vector.Location.clone()
Location.deserialize
(@NotNull Map<String, Object> args) Required method for deserializationWorld.findLightningRod
(@NotNull Location location) Finds the location of the nearest unobstructed Lightning Rod in a 128-block radius around the given location.World.findLightningTarget
(@NotNull Location location) Finds a targetLocation
for lightning to strike.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.WorldBorder.getCenter()
Gets the current border center.OfflinePlayer.getLastDeathLocation()
Gets the player's last death location.Raid.getLocation()
Gets the center location where the raid occurs.Vibration.Destination.BlockDestination.getLocation()
World.getLocationAtKey
(long key) Gets theLocation
at the given block keyVibration.getOrigin()
Deprecated, for removal: This API element is subject to removal in a future version.unused as of 1.19World.getSpawnLocation()
Gets the default spawnLocation
of this worldWorld.locateNearestBiome
(@NotNull Location origin, @NotNull Biome biome, int radius) Locates the nearest biome based on an origin, biome type, and radius to search.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 stepWorld.locateNearestStructure
(@NotNull Location origin, StructureType structureType, int radius, boolean findUnexplored) Location.multiply
(double m) Performs scalar multiplication, multiplying all components with a scalar.Location.set
(double x, double y, double z) Sets the position of this Location and returns itself This mutates this object, clone first.Location.setDirection
(@NotNull Vector vector) Location.subtract
(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 self This mutates this object, clone first.Subtracts the location by a vector.Location.toBlockLocation()
Location.toCenterLocation()
Location.toHighestLocation()
Returns a copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ())Location.toHighestLocation
(@NotNull HeightMap heightMap) Returns a copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ(), heightMap)Location.toHighestLocation
(HeightmapType heightmap) Deprecated.Location.toLocation
(@NotNull World world) Location.zero()
Zero this location's components.Modifier and TypeMethodDescriptionAdds the location by another.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.Bukkit.createExplorerMap
(@NotNull World world, @NotNull Location location, @NotNull StructureType structureType) Create a new explorer map targeting the closest nearby structure of a givenStructureType
.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 givenStructureType
.Server.createExplorerMap
(@NotNull World world, @NotNull Location location, @NotNull StructureType structureType) Create a new explorer map targeting the closest nearby structure of a givenStructureType
.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 givenStructureType
.boolean
World.createExplosion
(@NotNull Location loc, float power) Creates explosion at given coordinates with given powerboolean
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
Get the distance between this location and another.double
Location.distanceSquared
(@NotNull Location o) Get the squared distance between this location and another.Drops an item at the specifiedLocation
World.dropItem
(@NotNull Location location, @NotNull ItemStack item, @Nullable Consumer<Item> function) Drops an item at the specifiedLocation
Note that functions will run before the entity is spawnedWorld.dropItemNaturally
(@NotNull Location location, @NotNull ItemStack item) Drops an item at the specifiedLocation
with a random offsetWorld.dropItemNaturally
(@NotNull Location location, @NotNull ItemStack item, @Nullable Consumer<Item> function) Drops an item at the specifiedLocation
with a random offset Note that functions will run before the entity is spawnedWorld.findLightningRod
(@NotNull Location location) Finds the location of the nearest unobstructed Lightning Rod in a 128-block radius around the given location.World.findLightningTarget
(@NotNull Location location) Finds a targetLocation
for lightning to strike.boolean
RegionAccessor.generateTree
(@NotNull Location location, @NotNull Random random, @NotNull TreeType type) Creates a tree at the givenLocation
boolean
RegionAccessor.generateTree
(@NotNull Location location, @NotNull Random random, @NotNull TreeType type, @Nullable Predicate<BlockState> statePredicate) Creates a tree at the givenLocation
boolean
RegionAccessor.generateTree
(@NotNull Location location, @NotNull Random random, @NotNull TreeType type, @Nullable Consumer<BlockState> stateConsumer) Creates a tree at the givenLocation
boolean
World.generateTree
(@NotNull Location location, @NotNull TreeType type) Creates a tree at the givenLocation
boolean
World.generateTree
(@NotNull Location loc, @NotNull TreeType type, @NotNull BlockChangeDelegate delegate) Deprecated.this method does not handle tile entities (bee nests)World.getBlockAt
(@NotNull Location location) RegionAccessor.getBlockData
(@NotNull Location location) RegionAccessor.getBlockState
(@NotNull Location location) Gets theBlockState
at the givenLocation
.World.getChunkAt
(@NotNull Location location) default CompletableFuture<Chunk>
World.getChunkAtAsync
(@NotNull Location loc) Requests aChunk
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 aChunk
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) default void
World.getChunkAtAsync
(@NotNull Location loc, @NotNull World.ChunkLoadCallback cb) Deprecated.Use either the Future or the Consumer based methodsdefault void
World.getChunkAtAsync
(@NotNull Location loc, Consumer<Chunk> cb) default CompletableFuture<Chunk>
World.getChunkAtAsyncUrgently
(@NotNull Location loc) Requests aChunk
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 aChunk
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) World.getHighestBlockAt
(@NotNull Location location) Gets the highest non-empty (impassable) block at the given coordinates.World.getHighestBlockAt
(@NotNull Location location, @NotNull HeightMap heightMap) Gets the highest block corresponding to theHeightMap
at the given coordinates.World.getHighestBlockAt
(@NotNull Location location, HeightmapType heightmap) Deprecated.Upstream has added support for this, useWorld.getHighestBlockAt(Location, HeightMap)
int
World.getHighestBlockYAt
(@NotNull Location location) Gets the highest non-empty (impassable) coordinate at the givenLocation
.int
World.getHighestBlockYAt
(@NotNull Location location, @NotNull HeightMap heightMap) default int
World.getHighestBlockYAt
(@NotNull Location location, HeightmapType heightmap) Deprecated.Upstream has added support for this, useWorld.getHighestBlockYAt(Location, HeightMap)
World.getNearbyEntities
(@NotNull Location location, double x, double y, double z) Returns a list of entities within a bounding box centered around a Location.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>
Gets nearby players within the specified radius (bounding box)Gets the type of the block at the givenLocation
.default boolean
WorldBorder.isInBounds
(@NotNull Location location) Deprecated.useWorldBorder.isInside(Location)
for an upstream compatible replacementboolean
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 locationsWorld.locateNearestBiome
(@NotNull Location origin, @NotNull Biome biome, int radius) Locates the nearest biome based on an origin, biome type, and radius to search.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 stepWorld.locateNearestRaid
(@NotNull Location location, int radius) Finds the nearest raid close to the given location.World.locateNearestStructure
(@NotNull Location origin, @NotNull Structure structure, int radius, boolean findUnexplored) Find the closest nearby structure of a givenStructure
.World.locateNearestStructure
(@NotNull Location origin, @NotNull StructureType structureType, int radius, boolean findUnexplored) Find the closest nearby structure of a givenStructureType
.World.locateNearestStructure
(@NotNull Location origin, StructureType structureType, int radius, boolean findUnexplored) 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
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
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.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.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.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.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.World.rayTraceEntities
(@NotNull Location start, @NotNull Vector direction, double maxDistance) Performs a ray trace that checks for entity collisions.World.rayTraceEntities
(@NotNull Location start, @NotNull Vector direction, double maxDistance, double raySize) Performs a ray trace that checks for entity collisions.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.World.rayTraceEntities
(@NotNull Location start, @NotNull Vector direction, double maxDistance, @Nullable Predicate<Entity> filter) Performs a ray trace that checks for entity collisions.void
void
RegionAccessor.setBlockData
(@NotNull Location location, @NotNull BlockData blockData) void
Sets the new border center.boolean
World.setSpawnLocation
(@NotNull Location location) Sets the spawn location of the world.void
<T extends Entity>
TSpawn an entity of a specific class at the givenLocation
<T extends Entity>
TRegionAccessor.spawn
(@NotNull Location location, @NotNull Class<T> clazz, boolean randomizeData, @Nullable Consumer<T> function) Creates a new entity at the givenLocation
with the supplied function run before the entity is added to the world.default <T extends Entity>
TRegionAccessor.spawn
(@NotNull Location location, @NotNull Class<T> clazz, @Nullable Consumer<T> function) Spawn an entity of a specific class at the givenLocation
, with the supplied function run before the entity is added to the world.<T extends Entity>
TRegionAccessor.spawn
(@NotNull Location location, @NotNull Class<T> clazz, @Nullable Consumer<T> function, CreatureSpawnEvent.SpawnReason reason) default <T extends Entity>
TRegionAccessor.spawn
(@NotNull Location location, @NotNull Class<T> clazz, CreatureSpawnEvent.SpawnReason reason) default <T extends Entity>
TRegionAccessor.spawn
(@NotNull Location location, @NotNull Class<T> clazz, CreatureSpawnEvent.SpawnReason reason, @Nullable Consumer<T> function) World.spawnArrow
(@NotNull Location location, @NotNull Vector direction, float speed, float spread) <T extends AbstractArrow>
TWorld.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 givenLocation
RegionAccessor.spawnEntity
(@NotNull Location location, @NotNull EntityType type) Creates a entity at the givenLocation
RegionAccessor.spawnEntity
(@NotNull Location loc, @NotNull EntityType type, boolean randomizeData) Creates a new entity at the givenLocation
.RegionAccessor.spawnEntity
(@NotNull Location loc, EntityType type, CreatureSpawnEvent.SpawnReason reason) RegionAccessor.spawnEntity
(@NotNull Location loc, EntityType type, CreatureSpawnEvent.SpawnReason reason, @Nullable Consumer<Entity> function) World.spawnFallingBlock
(@NotNull Location location, @NotNull BlockData data) World.spawnFallingBlock
(@NotNull Location location, @NotNull MaterialData data) Deprecated.World.spawnFallingBlock
(@NotNull Location location, @NotNull Material material, byte data) Deprecated.Magic valuevoid
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.World.Spigot.strikeLightning
(@NotNull Location loc, boolean isSilent) Strikes lightning at the givenLocation
and possibly without soundWorld.strikeLightning
(@NotNull Location loc) Strikes lightning at the givenLocation
World.Spigot.strikeLightningEffect
(@NotNull Location loc, boolean isSilent) Strikes lightning at the givenLocation
without doing damage and possibly without soundWorld.strikeLightningEffect
(@NotNull Location loc) Strikes lightning at the givenLocation
without doing damageSubtracts the location by another.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.ModifierConstructorDescriptionBlockDestination
(@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
Modifier and TypeMethodDescriptionEndGateway.getExitLocation()
Gets the location that entities are teleported to when entering the gateway portal.Beehive.getFlower()
Get the hive's flower location.Block.getLocation()
Gets the Location of the blockBlock.getLocation
(@Nullable Location loc) Stores the location of the block in the provided Location object.BlockState.getLocation()
Gets the location of this block state.BlockState.getLocation
(@Nullable Location loc) Stores the location of this block state in the provided Location object.DoubleChest.getLocation()
Modifier and TypeMethodDescriptionBlock.getLocation
(@Nullable Location loc) Stores the location of the block in the provided Location object.BlockState.getLocation
(@Nullable Location loc) Stores the location of this block state in the provided Location object.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
Set the hive's flower location. -
Uses of Location in org.bukkit.block.data
Modifier and TypeMethodDescriptionboolean
BlockData.isSupported
(@NotNull Location location) Checks if this state would be properly supported if it were placed at the block at the givenLocation
. -
Uses of Location in org.bukkit.boss
Modifier and TypeMethodDescriptionDragonBattle.getEndPortalLocation()
Get the location of the end portal. -
Uses of Location in org.bukkit.command
Modifier and TypeMethodDescriptionCommand.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.CommandMap.tabComplete
(@NotNull CommandSender sender, @NotNull String cmdLine, @Nullable Location location) Looks for the requested command and executes an appropriate tab-completer if found.SimpleCommandMap.tabComplete
(@NotNull CommandSender sender, @NotNull String cmdLine, @Nullable Location location) -
Uses of Location in org.bukkit.configuration
Modifier and TypeMethodDescriptionConfigurationSection.getLocation
(@NotNull String path) Gets the requested Location by path.ConfigurationSection.getLocation
(@NotNull String path, @Nullable Location def) Gets the requestedLocation
by path, returning a default value if not found.MemorySection.getLocation
(@NotNull String path) MemorySection.getLocation
(@NotNull String path, @Nullable Location def) -
Uses of Location in org.bukkit.entity
Modifier and TypeMethodDescriptionPhantom.getAnchorLocation()
Gets the location that this phantom circles around when not attacking a player This will be changed after attacking a player.EnderCrystal.getBeamTarget()
Gets the location that this end crystal is pointing its beam to.HumanEntity.getBedLocation()
Gets the location of the bed the player is currently sleeping inPlayer.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.Vex.getBound()
Gets the bound of this entity.Player.getCompassTarget()
Get the previously set compass target.LivingEntity.getEyeLocation()
Get a Location detailing the current eye position of the living entity.Bee.getFlower()
Get the bee's flower location.Bee.getHive()
Get the bee's hive location.Turtle.getHome()
Get the turtle's home locationAllay.getJukebox()
Gets the jukebox the allay is set to dance to.HumanEntity.getLastDeathLocation()
Gets the player's last death location.Entity.getLocation()
Gets the entity's current positionEntity.getLocation
(@Nullable Location loc) Stores the entity's current position in the provided Location object.Entity.getOrigin()
Gets the location where this entity originates from.EnderDragon.getPodium()
Get the podium location used by the ender dragon.HumanEntity.getPotentialBedLocation()
Gets the Location of the player's bed, null if they have not slept in one.default Location
FallingBlock.getSourceLoc()
Deprecated.replaced byEntity.getOrigin()
default Location
TNTPrimed.getSourceLoc()
Deprecated.replaced byEntity.getOrigin()
Bat.getTargetLocation()
Gets the location that this bat is currently trying to move towards.EnderSignal.getTargetLocation()
Get the location this EnderSignal is moving towards.Dolphin.getTreasureLocation()
Gets the treasure location this dolphin tries to guide players to.WanderingTrader.getWanderingTowards()
Gets the location that this wandering trader is currently wandering towards.Modifier and TypeMethodDescriptionboolean
Entity.collidesAt
(@NotNull Location location) Checks for any collisions with the entity's bounding box at the provided 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
Instruct this Mob to look at a specific Locationvoid
Instruct this Mob to look at a specific Locationdefault void
Player.lookAt
(@NotNull Location location, LookAnchor playerAnchor) Causes the player to look towards the given location.Opens an empty anvil inventory window with the player's inventory on the bottom.HumanEntity.openCartographyTable
(@Nullable Location location, boolean force) Opens an empty cartography table inventory window with the player's inventory on the bottom.HumanEntity.openEnchanting
(@Nullable Location location, boolean force) Opens an empty enchanting inventory window with the player's inventory on the bottom.HumanEntity.openGrindstone
(@Nullable Location location, boolean force) Opens an empty grindstone inventory window with the player's inventory on the bottom.Opens an empty loom inventory window with the player's inventory on the bottom.HumanEntity.openSmithingTable
(@Nullable Location location, boolean force) Opens an empty smithing table inventory window with the player's inventory on the bottom.HumanEntity.openStonecutter
(@Nullable Location location, boolean force) Opens an empty stonecutter inventory window with the player's inventory on the bottom.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
Deprecated.Magic valuevoid
Play a note for a player at a location.void
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
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 valuevoid
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.void
Deprecated.void
Player.sendSignChange
(@NotNull Location loc, @Nullable String[] lines, @NotNull DyeColor dyeColor, boolean hasGlowingText) Deprecated.Deprecated in favour ofPlayer.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
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 playervoid
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
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
Set the bee's flower location.void
Set the bee's hive location.void
Set the turtle's home locationvoid
HumanEntity.setLastDeathLocation
(@Nullable Location location) Sets the player's last death location.void
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 theLocation
this EnderSignal is moving towards.void
EnderSignal.setTargetLocation
(@NotNull Location location, boolean update) Set theLocation
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
Attempts to make the entity sleep at the given location.boolean
Attempts to make this villager sleep at the given location.default boolean
Spawns the entity in the world at the givenLocation
with the default spawn reason.boolean
Entity.spawnAt
(@NotNull Location location, CreatureSpawnEvent.SpawnReason reason) Spawns the entity in the world at the givenLocation
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
Teleports this entity to the given location.default boolean
Teleports this entity to the given location.default boolean
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.Modifier and TypeMethodDescriptiondefault 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
Modifier and TypeFieldDescriptionMemoryKey.HOME
MemoryKey.JOB_SITE
MemoryKey.LIKED_NOTEBLOCK_POSITION
MemoryKey.MEETING_POINT
MemoryKey.POTENTIAL_JOB_SITE
-
Uses of Location in org.bukkit.event.block
-
Uses of Location in org.bukkit.event.entity
Modifier and TypeMethodDescriptionEntityTeleportEvent.getFrom()
Gets the location that this entity moved fromEntityExplodeEvent.getLocation()
Returns the location where the explosion happened.EntityPortalEnterEvent.getLocation()
Gets the portal block the entity is touchingEntitySpawnEvent.getLocation()
Gets the location at which the entity is spawning.ItemDespawnEvent.getLocation()
Gets the location at which the item is despawning.EntityTeleportEvent.getTo()
Gets the location that this entity moved toModifier and TypeMethodDescriptionvoid
Sets the location that this entity moved fromvoid
Sets the location that this entity moved toModifierConstructorDescriptionEntityExplodeEvent
(@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, int searchRadius) EntityPortalExitEvent
(@NotNull Entity entity, @NotNull Location from, @NotNull Location to, @NotNull Vector before, @NotNull Vector after) ItemDespawnEvent
(@NotNull Item despawnee, @NotNull Location loc) ItemSpawnEvent
(@NotNull Item spawnee, Location loc) Deprecated. -
Uses of Location in org.bukkit.event.player
Modifier and TypeMethodDescriptionPlayerMoveEvent.getFrom()
Gets the location this player moved fromPlayerInteractEvent.getInteractionPoint()
The exact point at which the interaction occurred.PlayerRespawnEvent.getRespawnLocation()
Gets the current respawn locationPlayerMoveEvent.getTo()
Gets the location this player moved toModifier and TypeMethodDescriptionvoid
Sets the location to mark as where the player moved fromvoid
PlayerRespawnEvent.setRespawnLocation
(@NotNull Location respawnLocation) Sets the new respawn locationvoid
Sets the location that this player will move toModifierConstructorDescriptionPlayerInteractEvent
(@NotNull Player who, @NotNull Action action, @Nullable ItemStack item, @Nullable Block clickedBlock, @NotNull BlockFace clickedFace, @Nullable EquipmentSlot hand, @Nullable Location interactionPoint) 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, @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
ModifierConstructorDescriptionTabCompleteEvent
(@NotNull CommandSender sender, @NotNull String buffer, @NotNull List<String> completions, boolean isCommand, Location location) -
Uses of Location in org.bukkit.event.vehicle
-
Uses of Location in org.bukkit.event.world
Modifier and TypeMethodDescriptionGenericGameEvent.getLocation()
Get the location where the event occurred.StructureGrowEvent.getLocation()
Gets the location of the structure.SpawnChangeEvent.getPreviousLocation()
Gets the previous spawn locationModifierConstructorDescriptionGenericGameEvent
(@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
Modifier and TypeMethodDescriptionChunkGenerator.getFixedSpawnLocation
(@NotNull World world, @NotNull Random random) Gets a fixed spawn location to use for a given world.Modifier and TypeMethodDescriptionboolean
LimitedRegion.isInRegion
(@NotNull Location location) Checks if the givenLocation
is in the region. -
Uses of Location in org.bukkit.inventory
Modifier and TypeMethodDescriptionInventory.getLocation()
Get the location of the block or entity which corresponds to this inventory. -
Uses of Location in org.bukkit.inventory.meta
Modifier and TypeMethodDescriptionCompassMeta.getLodestone()
Gets the location that this compass will point to.Modifier and TypeMethodDescriptionvoid
CompassMeta.setLodestone
(@Nullable Location lodestone) Sets the location this lodestone compass will point to. -
Uses of Location in org.bukkit.loot
Modifier and TypeMethodDescriptionLootContext.getLocation()
TheLocation
to store where the loot will be generated.ModifierConstructorDescriptionCreates a new LootContext.Builder instance to facilitate easy creation ofLootContext
s. -
Uses of Location in org.bukkit.structure
Modifier and TypeMethodDescriptionvoid
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
Modifier and TypeMethodDescriptionStructureSearchResult.getLocation()
Return the location of the structure.Vector.toLocation
(@NotNull World world) Gets a Location version of this vector with yaw and pitch being 0.Vector.toLocation
(@NotNull World world, float yaw, float pitch) Gets a Location version of this vector.Modifier and TypeMethodDescriptionstatic @NotNull BoundingBox
Creates a new bounding box using the given center and extents.static @NotNull BoundingBox
Creates a new bounding box using the coordinates of the given locations as corners.Shifts this bounding box by the given amounts.Expands this bounding box to contain (or border) the specified position.ModifierConstructorDescriptionConstructs 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
Modifier and TypeMethodDescriptionPlayerSpawnLocationEvent.getSpawnLocation()
Gets player's spawn location.Modifier and TypeMethodDescriptionvoid
PlayerSpawnLocationEvent.setSpawnLocation
(@NotNull Location location) Sets player's spawn location.ModifierConstructorDescriptionPlayerSpawnLocationEvent
(@NotNull Player who, @NotNull Location spawnLocation)