Uses of Class
com.plotsquared.core.location.Location

Packages that use Location

Package	Description
com.plotsquared.core.events
com.plotsquared.core.generator
com.plotsquared.core.location
com.plotsquared.core.player
com.plotsquared.core.plot
com.plotsquared.core.plot.world
com.plotsquared.core.queue
com.plotsquared.core.util

Uses of Location in com.plotsquared.core.events

Methods in com.plotsquared.core.events that return Location

Modifier and Type	Method	Description
Location	PlayerTeleportToPlotEvent.getFrom()	Get the from location

Constructors in com.plotsquared.core.events with parameters of type Location

Modifier	Constructor	Description
	PlayerTeleportToPlotEvent(PlotPlayer<?> player, Location from, Plot plot)	Deprecated, for removal: This API element is subject to removal in a future version. use PlayerTeleportToPlotEvent(PlotPlayer, Location, Plot, TeleportCause).
	PlayerTeleportToPlotEvent(PlotPlayer<?> player, Location from, Plot plot, TeleportCause cause)	PlayerTeleportToPlotEvent: Called when a player teleports to a plot

Uses of Location in com.plotsquared.core.generator

Methods in com.plotsquared.core.generator that return Location

Modifier and Type	Method	Description
Location	SquarePlotManager.getPlotBottomLocAbs(@NonNull PlotId plotId)	Get the bottom plot loc (some basic math).
Location	SquarePlotManager.getPlotTopLocAbs(@NonNull PlotId plotId)
Location	ClassicPlotManager.getSignLoc(@NonNull Plot plot)	Retrieves the location of where a sign should be for a plot.
Location	HybridPlotManager.getSignLoc(@NonNull Plot plot)	Retrieves the location of where a sign should be for a plot.
Location	HybridPlotWorld.getSignLocation(@NonNull Plot plot)

Methods in com.plotsquared.core.generator with parameters of type Location

Modifier and Type	Method	Description
void	HybridPlotManager.pastePlotSchematic(@NonNull QueueCoordinator queue, @NonNull Location bottom, @NonNull Location top)

Uses of Location in com.plotsquared.core.location

Subclasses of Location in com.plotsquared.core.location

Modifier and Type	Class	Description
final class	UncheckedWorldLocation	Used internally for generation to reference locations in worlds that "don't exist yet".

Methods in com.plotsquared.core.location that return Location

Modifier and Type	Method	Description
@NonNull Location	Location.add(int x, int y, int z)	Return a new location offset by the given coordinates
static @NonNull Location	Location.at(@NonNull World<?> world, int x, int y, int z)	Construct a new location with yaw and pitch equal to 0
static @NonNull Location	Location.at(@NonNull World<?> world, int x, int y, int z, float yaw, float pitch)	Construct a new location
static @NonNull Location	Location.at(@NonNull World<?> world, @NonNull BlockVector3 blockVector3)	Construct a new location with yaw and pitch equal to 0
static @NonNull Location	Location.at(@NonNull World<?> world, @NonNull BlockVector3 blockVector3, float yaw, float pitch)	Construct a new location
static @NonNull Location	Location.at(@NonNull String world, int x, int y, int z)	Construct a new location with yaw and pitch equal to 0
static @NonNull Location	Location.at(@NonNull String world, int x, int y, int z, float yaw, float pitch)	Construct a new location
static @NonNull Location	Location.at(@NonNull String world, @NonNull BlockVector3 blockVector3)	Construct a new location with yaw and pitch equal to 0
static @NonNull Location	Location.at(@NonNull String world, @NonNull BlockVector3 blockVector3, float yaw, float pitch)	Construct a new location
@NonNull Location	Location.subtract(int x, int y, int z)	Return a new location offset by (-) the given coordinates
@NonNull Location	Location.withPitch(float pitch)	Return a new location using the given pitch
@NonNull Location	Location.withWorld(@NonNull String world)	Return a new location using the given world
@NonNull Location	Location.withX(int x)	Return a new location using the given X coordinate
@NonNull Location	Location.withY(int y)	Return a new location using the given Y coordinate
@NonNull Location	Location.withYaw(float yaw)	Return a new location using the given yaw
@NonNull Location	Location.withZ(int z)	Return a new location using the given Z coordinate

Methods in com.plotsquared.core.location with parameters of type Location

Modifier and Type	Method	Description
int	Location.compareTo(@NonNull Location o)
double	Location.getEuclideanDistance(@NonNull Location l2)
double	Location.getEuclideanDistanceSquared(@NonNull Location l2)

Uses of Location in com.plotsquared.core.player

Fields in com.plotsquared.core.player with type parameters of type Location

Modifier and Type	Field	Description
static final MetaDataKey<Location>	PlayerMetaDataKeys.TEMPORARY_LOCATION
static final MetaDataKey<Location>	PlayerMetaDataKeys.TEMPORARY_MUSIC

Methods in com.plotsquared.core.player that return Location

Modifier and Type	Method	Description
@NonNull Location	ConsolePlayer.getLocation()
@NonNull Location	PlotPlayer.getLocation()	Get this player's last recorded location or null if they don't any plot relevant location.
Location	ConsolePlayer.getLocationFull()
abstract Location	PlotPlayer.getLocationFull()	Get this player's full location (including yaw/pitch)

Methods in com.plotsquared.core.player with parameters of type Location

Modifier and Type	Method	Description
boolean	ConsolePlayer.canTeleport(@NonNull Location location)
boolean	PlotPlayer.canTeleport(@NonNull Location location)
void	ConsolePlayer.playMusic(@NonNull Location location, @NonNull ItemType id)
abstract void	PlotPlayer.playMusic(@NonNull Location location, @NonNull ItemType id)	Play music at a location for this player.
void	PlotPlayer.plotkick(Location location)	Kick this player to a location
void	ConsolePlayer.setCompassTarget(Location location)
abstract void	PlotPlayer.setCompassTarget(Location location)	Set this compass target.
void	ConsolePlayer.teleport(Location location, TeleportCause cause)
void	PlotPlayer.teleport(Location location)	Teleport this player to a location.
abstract void	PlotPlayer.teleport(Location location, TeleportCause cause)	Teleport this player to a location.

Uses of Location in com.plotsquared.core.plot

Methods in com.plotsquared.core.plot that return Location

Modifier and Type	Method	Description
Location	Plot.getBottom()	Deprecated. in favor of getCorners()[0];
Location	Plot.getBottomAbs()	Returns the bottom location for the plot.
Location	Plot.getCenterSynchronous()	Deprecated. May cause synchronous chunk loads
Location	PlotCluster.getClusterBottom()
Location	PlotCluster.getClusterTop()
Location[]	Plot.getCorners()	Deprecated. as merged plots no longer need to be rectangular
Location	Plot.getDefaultHomeSynchronous(boolean member)	Deprecated. May cause synchronous chunk loads
Location	Plot.getExtendedBottomAbs()	Gets the bot loc of a plot (if mega, returns bot loc of that mega plot) - If you would like each plot treated as a small plot use Plot.getBottomAbs()
Location	Plot.getExtendedTopAbs()	Gets the top loc of a plot (if mega, returns top loc of that mega plot) - If you would like each plot treated as a small plot use Plot.getTopAbs()
Location	Plot.getHomeSynchronous()	Deprecated. May cause synchronous chunk loading
abstract Location	PlotManager.getPlotBottomLocAbs(@NonNull PlotId plotId)
abstract Location	PlotManager.getPlotTopLocAbs(@NonNull PlotId plotId)
Location	Plot.getSideSynchronous()	Deprecated. May cause synchronous chunk loads
abstract Location	PlotManager.getSignLoc(@NonNull Plot plot)	Retrieves the location of where a sign should be for a plot.
Location	Plot.getTop()	Deprecated. in favor of getCorners()[1];
Location	Plot.getTopAbs()	Returns the top location for the plot.

Methods in com.plotsquared.core.plot with parameters of type Location

Modifier and Type	Method	Description
boolean	PlotArea.contains(@NonNull Location location)
abstract @Nullable PlotArea	PlotWorld.getArea(@NonNull Location location)	Get the plot area that contains the given location, or null if the location is not a part of a plot area.
@Nullable PlotCluster	PlotArea.getCluster(@NonNull Location location)
@Nullable Plot	PlotArea.getOwnedPlot(@NonNull Location location)	Get the owned base plot at a location.
@Nullable Plot	PlotArea.getOwnedPlotAbs(@NonNull Location location)	Get the owned plot at a location.
static @Nullable Plot	Plot.getPlot(@NonNull Location location)	Return a new/cached plot object at a given location.
@Nullable Plot	PlotArea.getPlot(@NonNull Location location)	Gets the base plot at a location.
@Nullable Plot	PlotArea.getPlotAbs(@NonNull Location location)	Gets the Plot at a location.

Method parameters in com.plotsquared.core.plot with type arguments of type Location

Modifier and Type	Method	Description
void	Plot.getCenter(Consumer<Location> result)
void	Plot.getDefaultHome(boolean member, Consumer<Location> result)
void	Plot.getDefaultHome(Consumer<Location> result)	Gets the default home location for a plot - Ignores any home location set for that specific plot
void	Plot.getHome(Consumer<Location> result)	Return the home location for the plot
void	PlotCluster.getHome(@NonNull Consumer<Location> result)
void	Plot.getSide(Consumer<Location> result)

Uses of Location in com.plotsquared.core.plot.world

Methods in com.plotsquared.core.plot.world that return Location

Modifier and Type	Method	Description
Location	SinglePlotManager.getPlotBottomLocAbs(@NonNull PlotId plotId)
Location	SinglePlotManager.getPlotTopLocAbs(@NonNull PlotId plotId)
Location	SinglePlotManager.getSignLoc(@NonNull Plot plot)

Methods in com.plotsquared.core.plot.world with parameters of type Location

Modifier and Type	Method	Description
@Nullable PlotArea	DefaultPlotAreaManager.getApplicablePlotArea(@Nullable Location location)
@Nullable PlotArea	PlotAreaManager.getApplicablePlotArea(@Nullable Location location)	Get the plot area for a particular location.
@Nullable PlotArea	SinglePlotAreaManager.getApplicablePlotArea(@Nullable Location location)
@Nullable PlotArea	ScatteredPlotWorld.getArea(@NonNull Location location)
@Nullable PlotArea	StandardPlotWorld.getArea(@NonNull Location location)
@Nullable Plot	SinglePlotArea.getOwnedPlot(@NonNull Location location)
@Nullable Plot	SinglePlotArea.getOwnedPlotAbs(@NonNull Location location)
@Nullable Plot	SinglePlotArea.getPlot(@NonNull Location location)
@Nullable Plot	SinglePlotArea.getPlotAbs(@NonNull Location location)
@Nullable PlotArea	DefaultPlotAreaManager.getPlotArea(@NonNull Location location)
@Nullable PlotArea	PlotAreaManager.getPlotArea(@NonNull Location location)	Get the plot area, if there is any, for the given location.
@Nullable PlotArea	SinglePlotAreaManager.getPlotArea(@NonNull Location location)

Method parameters in com.plotsquared.core.plot.world with type arguments of type Location

Modifier and Type	Method	Description
void	SinglePlot.getSide(Consumer<Location> result)

Uses of Location in com.plotsquared.core.queue

Methods in com.plotsquared.core.queue that return Location

Modifier and Type	Method	Description
@NonNull Location	BlockArrayCacheScopedQueueCoordinator.getMax()
@NonNull Location	ChunkQueueCoordinator.getMax()	Deprecated, for removal: This API element is subject to removal in a future version.
@NonNull Location	ScopedQueueCoordinator.getMax()	Deprecated, for removal: This API element is subject to removal in a future version.
@NonNull Location	BlockArrayCacheScopedQueueCoordinator.getMin()
@NonNull Location	ChunkQueueCoordinator.getMin()	Deprecated, for removal: This API element is subject to removal in a future version.
@NonNull Location	ScopedQueueCoordinator.getMin()	Deprecated, for removal: This API element is subject to removal in a future version.

Methods in com.plotsquared.core.queue with parameters of type Location

Modifier and Type	Method	Description
void	BasicQueueCoordinator.setBiomeCuboid(@NonNull Location pos1, @NonNull Location pos2, @NonNull BiomeType biome)
void	QueueCoordinator.setBiomeCuboid(@NonNull Location pos1, @NonNull Location pos2, @NonNull BiomeType biome)	Fill a cuboid between two positions with a BiomeType
void	QueueCoordinator.setCuboid(@NonNull Location pos1, @NonNull Location pos2, @NonNull Pattern blocks)	Fill a cuboid between two positions with a Pattern
void	QueueCoordinator.setCuboid(@NonNull Location pos1, @NonNull Location pos2, @NonNull BlockState block)	Fill a cuboid between two positions with a BlockState
@NonNull ChunkCoordinatorBuilder	ChunkCoordinatorBuilder.withRegion(@NonNull Location pos1, @NonNull Location pos2)	Add chunks within a region to be accessed

Constructors in com.plotsquared.core.queue with parameters of type Location

Modifier	Constructor	Description
	BlockArrayCacheScopedQueueCoordinator(Location min, Location max)	Construct a new instance
	ScopedQueueCoordinator(@Nullable QueueCoordinator parent, @NonNull Location min, @NonNull Location max)	Deprecated, for removal: This API element is subject to removal in a future version. Create a new ScopedQueueCoordinator instance that delegates to a given QueueCoordinator.

Uses of Location in com.plotsquared.core.util

Methods in com.plotsquared.core.util that return Location

Modifier and Type	Method	Description
static @NonNull Location[]	RegionUtil.getCorners(@NonNull String world, @NonNull CuboidRegion region)
static @NonNull Location[]	RegionUtil.getCorners(String world, Collection<CuboidRegion> regions)
abstract @NonNull Location	WorldUtil.getSpawn(@NonNull String world)	Get the world spawn location

Methods in com.plotsquared.core.util with parameters of type Location

Modifier and Type	Method	Description
PlayerTeleportToPlotEvent	EventDispatcher.callTeleport(PlotPlayer<?> player, Location from, Plot plot, TeleportCause cause)
boolean	EventDispatcher.checkPlayerBlockEvent(PlotPlayer<?> player, @NonNull PlayerBlockEventType type, Location location, BlockType blockType, boolean notifyPerms)
abstract void	RegionManager.clearAllEntities(Location pos1, Location pos2)
boolean	RegionManager.copyRegion(@NonNull Location pos1, @NonNull Location pos2, @NonNull Location newPos, @Nullable PlotPlayer<?> actor, @NonNull Runnable whenDone)	Copy a region to a new location (in the same world)
abstract void	WorldUtil.getBlock(@NonNull Location location, @NonNull Consumer<BlockState> result)	Get the block at a given location (asynchronously)
abstract @NonNull BlockState	WorldUtil.getBlockSynchronous(@NonNull Location location)	Deprecated. Use WorldUtil.getBlock(Location, Consumer)
static BlockVector2	RegionManager.getRegion(Location location)
abstract @NonNull String[]	WorldUtil.getSignSynchronous(@NonNull Location location)	Deprecated. May result in synchronous chunk loading
static boolean	ChunkUtil.isWholeChunk(@NonNull Location pos1, @NonNull Location pos2, @NonNull BlockVector2 chunk)	Deprecated, for removal: This API element is subject to removal in a future version. Unused internally.
abstract boolean	RegionManager.regenerateRegion(Location pos1, Location pos2, boolean ignoreAugment, Runnable whenDone)	Assumptions: - pos1 and pos2 are in the same plot It can be harmful to the world if parameters outside this scope are provided
abstract void	WorldUtil.setSign(@NonNull Location location, @NonNull Caption[] lines, @NonNull net.kyori.adventure.text.minimessage.Template... replacements)	Set the block at the specified location to a sign, with given text
abstract void	WorldUtil.setSpawn(@NonNull Location location)	Set the world spawn location
void	RegionManager.swap(Location pos1, Location pos2, Location swapPos, @Nullable PlotPlayer<?> actor, Runnable whenDone)	Swap two regions within the same world