Uses of Class
com.plotsquared.core.plot.PlotArea

Packages that use PlotArea

Package	Description
com.plotsquared.core
com.plotsquared.core.command
com.plotsquared.core.configuration.caption
com.plotsquared.core.database
com.plotsquared.core.events
com.plotsquared.core.generator
com.plotsquared.core.location
com.plotsquared.core.player
com.plotsquared.core.plot
com.plotsquared.core.plot.expiration
com.plotsquared.core.plot.world
com.plotsquared.core.queue
com.plotsquared.core.services.plots
com.plotsquared.core.setup
com.plotsquared.core.util
com.plotsquared.core.util.query
com.plotsquared.core.util.task

Uses of PlotArea in com.plotsquared.core

Methods in com.plotsquared.core that return types with arguments of type PlotArea

Modifier and Type	Method	Description
@NonNull Set<@NonNull PlotArea>	PlotAPI.getPlotAreas(@Nullable String world)	Gets a list of PlotAreas in the world.

Methods in com.plotsquared.core with parameters of type PlotArea

Modifier and Type	Method	Description
void	PlotAPI.addPlotArea(@NonNull PlotArea plotArea)	Adds a plot world.
void	PlotSquared.addPlotArea(@NonNull PlotArea plotArea)	Add a global reference to a plot world.
void	PlotSquared.removePlotArea(@NonNull PlotArea area)	Remove a plot world reference.
@NonNull List<Plot>	PlotSquared.sortPlots(@NonNull Collection<Plot> plots, @NonNull PlotSquared.SortType type, @Nullable PlotArea priorityArea)	Sort a collection of plots by world (with a priority world), then by hashcode.

Uses of PlotArea in com.plotsquared.core.command

Methods in com.plotsquared.core.command with parameters of type PlotArea

Modifier and Type	Method	Description
static boolean	Auto.checkAllowedPlots(PlotPlayer<?> player, PlotArea plotarea, @Nullable Integer allowedPlots, int sizeX, int sizeZ)
static byte[]	Template.getBytes(PlotArea plotArea)

Uses of PlotArea in com.plotsquared.core.configuration.caption

Methods in com.plotsquared.core.configuration.caption with parameters of type PlotArea

Modifier and Type	Method	Description
static @NonNull net.kyori.adventure.text.minimessage.Template	Templates.of(@NonNull String key, @NonNull PlotArea area)	Create a Template from a plot area

Uses of PlotArea in com.plotsquared.core.database

Methods in com.plotsquared.core.database with parameters of type PlotArea

Modifier and Type	Method	Description
void	AbstractDB.purge(PlotArea area, Set<PlotId> plotIds)	Purges a whole world.
static void	DBFunc.purge(PlotArea area, Set<PlotId> plotIds)
void	SQLManager.purge(PlotArea area, Set<PlotId> plots)

Uses of PlotArea in com.plotsquared.core.events

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

Modifier and Type	Method	Description
PlotArea	PlotUnlinkEvent.getArea()
PlotArea	PlayerAutoPlotEvent.getPlotArea()

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

Modifier	Constructor	Description
	PlayerAutoPlotEvent(PlotPlayer<?> player, PlotArea plotArea, @Nullable String schematic, int sizeX, int sizeZ)	PlayerAutoPlotEvent: called when a player attempts to auto claim a plot.
	PlotUnlinkEvent(@NonNull PlotArea area, Plot plot, boolean createRoad, boolean createSign, PlotUnlinkEvent.REASON reason)	PlotUnlinkEvent: Called when a mega plot is unlinked

Uses of PlotArea in com.plotsquared.core.generator

Subclasses of PlotArea in com.plotsquared.core.generator

Modifier and Type	Class	Description
class	ClassicPlotWorld
class	GridPlotWorld
class	HybridPlotWorld
class	SquarePlotWorld

Fields in com.plotsquared.core.generator declared as PlotArea

Modifier and Type	Field	Description
static PlotArea	HybridUtils.area

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

Modifier and Type	Method	Description
PlotArea	HybridGen.getNewPlotArea(String world, String id, PlotId min, PlotId max)
abstract PlotArea	IndependentPlotGenerator.getNewPlotArea(String world, String id, PlotId min, PlotId max)	Return a new PlotArea object.
PlotArea	SingleWorldGenerator.getNewPlotArea(String world, String id, PlotId min, PlotId max)

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

Modifier and Type	Method	Description
void	GeneratorWrapper.augment(PlotArea area)
void	HybridGen.generateChunk(@NonNull ScopedQueueCoordinator result, @NonNull PlotArea settings)
abstract void	IndependentPlotGenerator.generateChunk(ScopedQueueCoordinator result, PlotArea settings)	Deprecated, for removal: This API element is subject to removal in a future version. ScopedQueueCoordinator will be renamed in v7.
void	SingleWorldGenerator.generateChunk(ScopedQueueCoordinator result, PlotArea settings)
PlotId	SquarePlotManager.getNearestPlotId(@NonNull PlotArea plotArea, int x, int y, int z)
void	HybridGen.initialize(PlotArea area)
abstract void	IndependentPlotGenerator.initialize(PlotArea area)	It is preferred for the PlotArea object to do most of the initialization necessary.
void	SingleWorldGenerator.initialize(PlotArea area)
boolean	HybridPlotWorld.isCompatible(@NonNull PlotArea plotArea)
boolean	HybridGen.populateChunk(ScopedQueueCoordinator result, PlotArea settings)
boolean	IndependentPlotGenerator.populateChunk(ScopedQueueCoordinator result, PlotArea settings)	Deprecated, for removal: This API element is subject to removal in a future version. ScopedQueueCoordinator will be renamed in v7.
void	HybridUtils.regeneratePlotWalls(PlotArea area)
boolean	HybridUtils.regenerateRoad(PlotArea area, BlockVector2 chunk, int extend)	Deprecated, for removal: This API element is subject to removal in a future version. use HybridUtils.regenerateRoad(PlotArea, BlockVector2, int, QueueCoordinator)
boolean	HybridUtils.regenerateRoad(PlotArea area, BlockVector2 chunk, int extend, @Nullable QueueCoordinator queueCoordinator)	Regenerate the road in a chunk in a plot area.
boolean	HybridUtils.scheduleRoadUpdate(PlotArea area, int extend)
boolean	HybridUtils.scheduleRoadUpdate(PlotArea area, Set<BlockVector2> regions, int extend, Set<BlockVector2> chunks)

Constructors in com.plotsquared.core.generator with parameters of type PlotArea

Modifier	Constructor	Description
	GridPlotManager(PlotArea plotArea)

Uses of PlotArea in com.plotsquared.core.location

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

Modifier and Type	Method	Description
@Nullable PlotArea	Location.getPlotArea()	Get the PlotArea, if any, that contains this location

Uses of PlotArea in com.plotsquared.core.player

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

Modifier and Type	Method	Description
PlotArea	PlotPlayer.getApplicablePlotArea()
@Nullable PlotArea	PlotPlayer.getPlotAreaAbs()	Return the PlotArea this player is currently in, or null.

Uses of PlotArea in com.plotsquared.core.plot

Fields in com.plotsquared.core.plot declared as PlotArea

Modifier and Type	Field	Description
PlotArea	PlotCluster.area

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

Modifier and Type	Method	Description
@Nullable PlotArea	Plot.getArea()	Gets the plot world object for this plot - The generic PlotArea object can be casted to its respective class for more control (e.g.
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.

Methods in com.plotsquared.core.plot that return types with arguments of type PlotArea

Modifier and Type	Method	Description
abstract @NonNull Collection<PlotArea>	PlotWorld.getAreas()	Get all plot areas in the world
abstract @NonNull Collection<PlotArea>	PlotWorld.getAreasInRegion(@NonNull CuboidRegion region)	Get all plot areas in a specified region

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

Modifier and Type	Method	Description
void	PlotWorld.addArea(@NonNull PlotArea area)	Register a new area in the world
static @Nullable Plot	Plot.fromString(@Nullable PlotArea defaultArea, @NonNull String string)	Gets a plot from a string e.g.
Plot	Plot.getRelative(PlotArea area, int x, int y)
boolean	PlotArea.isCompatible(@NonNull PlotArea plotArea)	Check if a PlotArea is compatible (move/copy etc.).
void	PlotWorld.removeArea(@NonNull PlotArea area)	Remove an area from the world
void	Plot.setArea(@NonNull PlotArea area)	Assigns this plot to a plot area. (Mostly used during startup when worlds are being created)
void	PlotCluster.setArea(PlotArea plotArea)

Constructors in com.plotsquared.core.plot with parameters of type PlotArea

Modifier	Constructor	Description
	Plot(@NonNull PlotArea area, @NonNull PlotId id)	Constructor for an unowned plot.
	Plot(@NonNull PlotId id, UUID owner, HashSet<UUID> trusted, HashSet<UUID> members, HashSet<UUID> denied, String alias, BlockLoc position, Collection<PlotFlag<?,?>> flags, PlotArea area, boolean[] merged, long timestamp, int temp)	Constructor for a saved plots (Used by the database manager when plots are fetched)
	Plot(PlotArea area, @NonNull PlotId id, UUID owner)	Constructor for a new plot.
	Plot(PlotArea area, @NonNull PlotId id, UUID owner, int temp)	Constructor for a temporary plot (use -1 for temp) The database will ignore any queries regarding temporary plots.
	PlotCluster(PlotArea area, PlotId pos1, PlotId pos2, UUID owner)
	PlotCluster(PlotArea area, PlotId pos1, PlotId pos2, UUID owner, int temp)
	PlotManager(@NonNull PlotArea plotArea)

Uses of PlotArea in com.plotsquared.core.plot.expiration

Methods in com.plotsquared.core.plot.expiration with parameters of type PlotArea

Modifier and Type	Method	Description
boolean	ExpiryTask.allowsArea(PlotArea area)
boolean	ExpiryTask.applies(PlotArea area)
ArrayDeque<ExpiryTask>	ExpireManager.getTasks(PlotArea area)

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

Subclasses of PlotArea in com.plotsquared.core.plot.world

Modifier and Type	Class	Description
class	SinglePlotArea

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

Modifier and Type	Method	Description
@NonNull PlotArea[]	DefaultPlotAreaManager.getAllPlotAreas()
@NonNull PlotArea[]	PlotAreaManager.getAllPlotAreas()	Get all plot areas recognized by PlotSquared
@NonNull PlotArea[]	SinglePlotAreaManager.getAllPlotAreas()
@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 PlotArea	DefaultPlotAreaManager.getPlotArea(@NonNull Location location)
PlotArea	DefaultPlotAreaManager.getPlotArea(@NonNull String world, @Nullable String id)
@Nullable PlotArea	PlotAreaManager.getPlotArea(@NonNull Location location)	Get the plot area, if there is any, for the given location.
@Nullable PlotArea	PlotAreaManager.getPlotArea(@NonNull String world, @Nullable String id)	Get the plot area in a world with an (optional ID).
@Nullable PlotArea	SinglePlotAreaManager.getPlotArea(@NonNull Location location)
@Nullable PlotArea	SinglePlotAreaManager.getPlotArea(@NonNull String world, @NonNull String id)
default @Nullable PlotArea	PlotAreaManager.getPlotAreaByString(@NonNull String search)	Get a plot area from a search string in the format "world;id" or "world,id" where the ID portion is optional
@NonNull PlotArea[]	DefaultPlotAreaManager.getPlotAreas(@NonNull String world, @Nullable CuboidRegion region)
@NonNull PlotArea[]	PlotAreaManager.getPlotAreas(@NonNull String world, @Nullable CuboidRegion region)	Get all plot areas in a world, with an optional region constraint
@NonNull PlotArea[]	SinglePlotAreaManager.getPlotAreas(@NonNull String world, @NonNull CuboidRegion region)

Methods in com.plotsquared.core.plot.world that return types with arguments of type PlotArea

Modifier and Type	Method	Description
@NonNull Collection<PlotArea>	ScatteredPlotWorld.getAreas()
@NonNull Collection<PlotArea>	StandardPlotWorld.getAreas()
@NonNull Collection<PlotArea>	ScatteredPlotWorld.getAreasInRegion(@NonNull CuboidRegion region)
@NonNull Collection<PlotArea>	StandardPlotWorld.getAreasInRegion(@NonNull CuboidRegion region)
default @NonNull Set<@NonNull PlotArea>	PlotAreaManager.getPlotAreasSet(@NonNull String world)	Method identical to PlotAreaManager.getPlotAreasSet(String, CuboidRegion) but that does not take in a region, and returns a modifiable set
default @NonNull Set<@NonNull PlotArea>	PlotAreaManager.getPlotAreasSet(@NonNull String world, @Nullable CuboidRegion region)	Method that delegates to PlotAreaManager.getPlotAreas(String, CuboidRegion) but returns an immutable set, instead of an array

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

Modifier and Type	Method	Description
void	ScatteredPlotWorld.addArea(@NonNull PlotArea area)
void	DefaultPlotAreaManager.addPlotArea(@NonNull PlotArea plotArea)
void	PlotAreaManager.addPlotArea(@NonNull PlotArea area)	Add a plot area
void	SinglePlotAreaManager.addPlotArea(@NonNull PlotArea area)
void	ScatteredPlotWorld.removeArea(@NonNull PlotArea area)
void	DefaultPlotAreaManager.removePlotArea(@NonNull PlotArea area)
void	PlotAreaManager.removePlotArea(@NonNull PlotArea area)	Remove a plot area
void	SinglePlotAreaManager.removePlotArea(@NonNull PlotArea area)

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

Modifier and Type	Method	Description
default void	PlotAreaManager.forEachPlotArea(@NonNull Consumer<? super PlotArea> action)	Perform an action on each recognized plot area

Constructors in com.plotsquared.core.plot.world with parameters of type PlotArea

Modifier	Constructor	Description
	SinglePlot(@NonNull PlotArea area, @NonNull PlotId id)
	SinglePlot(PlotId id, UUID owner, HashSet<UUID> trusted, HashSet<UUID> members, HashSet<UUID> denied, String alias, BlockLoc position, Collection<PlotFlag<?,?>> flags, PlotArea area, boolean[] merged, long timestamp, int temp)
	SinglePlotManager(@NonNull PlotArea plotArea)
	StandardPlotWorld(@NonNull String world, @Nullable PlotArea area)

Uses of PlotArea in com.plotsquared.core.queue

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

Modifier and Type	Method	Description
PlotArea	AreaBoundDelegateQueueCoordinator.getArea()	Gets the plot area block settings is limited to

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

Modifier	Constructor	Description
	AreaBoundDelegateQueueCoordinator(@NonNull PlotArea area, @Nullable QueueCoordinator parent)

Uses of PlotArea in com.plotsquared.core.services.plots

Methods in com.plotsquared.core.services.plots that return PlotArea

Modifier and Type	Method	Description
@NonNull PlotArea	AutoService.AutoQuery.getPlotArea()	Get the plot area to search in

Constructors in com.plotsquared.core.services.plots with parameters of type PlotArea

Modifier	Constructor	Description
	AutoQuery(@NonNull PlotPlayer<?> player, @Nullable PlotId startId, int sizeX, int sizeZ, @NonNull PlotArea plotArea)	Crate a new auto query

Uses of PlotArea in com.plotsquared.core.setup

Methods in com.plotsquared.core.setup with parameters of type PlotArea

Modifier and Type	Method	Description
static PlotAreaBuilder	PlotAreaBuilder.ofPlotArea(PlotArea area)

Uses of PlotArea in com.plotsquared.core.util

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

Modifier and Type	Method	Description
PlayerAutoPlotEvent	EventDispatcher.callAuto(PlotPlayer<?> player, PlotArea area, String schematic, int size_x, int size_z)
PlotUnlinkEvent	EventDispatcher.callUnlink(PlotArea area, Plot plot, boolean createRoad, boolean createSign, PlotUnlinkEvent.REASON reason)
abstract String	SetupUtils.getGenerator(PlotArea plotArea)
double	PlotAreaConverter.getMax(int axis, PlotArea area)
double	PlotAreaConverter.getMin(int axis, PlotArea area)
static <T> boolean	PlotFlagUtil.isAreaRoadFlagsAndFlagEquals(PlotArea area, Class<? extends PlotFlag<T,?>> flagClass, T value)	Check if the value of a PlotFlag matches the given value.
abstract boolean	EconHandler.isEnabled(PlotArea plotArea)	Returns whether economy is enabled in the given plot area or not.
void	RegionManager.setBiome(CuboidRegion region, int extendBiome, BiomeType biome, PlotArea area, Runnable whenDone)	Set a region to a biome type.
boolean	RegionManager.setCuboids(@NonNull PlotArea area, @NonNull Set<CuboidRegion> regions, @NonNull Pattern blocks, int minY, int maxY, @Nullable PlotPlayer<?> actor, @Nullable QueueCoordinator queue)	Set a number of cuboids to a certain block between two y values.

Uses of PlotArea in com.plotsquared.core.util.query

Methods in com.plotsquared.core.util.query with parameters of type PlotArea

Modifier and Type	Method	Description
@NonNull PlotQuery	PlotQuery.inArea(@NonNull PlotArea area)	Query for plots in a single area
@NonNull PlotQuery	PlotQuery.relativeToArea(@NonNull PlotArea plotArea)	Defines the area around which plots may be sorted, depending on the sorting strategy

Method parameters in com.plotsquared.core.util.query with type arguments of type PlotArea

Modifier and Type	Method	Description
@NonNull PlotQuery	PlotQuery.inAreas(@NonNull Collection<PlotArea> areas)	Query for plots in specific areas

Uses of PlotArea in com.plotsquared.core.util.task

Constructors in com.plotsquared.core.util.task with parameters of type PlotArea

Modifier	Constructor	Description
	AutoClaimFinishTask(PlotPlayer<?> player, Plot plot, PlotArea area, String schematic, EventDispatcher eventDispatcher)