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

Packages that use Plot

Package	Description
com.plotsquared.core
com.plotsquared.core.backup
com.plotsquared.core.command
com.plotsquared.core.database
com.plotsquared.core.events
com.plotsquared.core.events.post	Contains events which are fired after specific actions are completed.
com.plotsquared.core.generator
com.plotsquared.core.inject.factory
com.plotsquared.core.listener
com.plotsquared.core.location
com.plotsquared.core.player
com.plotsquared.core.plot
com.plotsquared.core.plot.comment
com.plotsquared.core.plot.expiration
com.plotsquared.core.plot.flag.implementations
com.plotsquared.core.plot.world
com.plotsquared.core.services.plots
com.plotsquared.core.util
com.plotsquared.core.util.placeholders
com.plotsquared.core.util.query
com.plotsquared.core.util.task

Uses of Plot in com.plotsquared.core

Fields in com.plotsquared.core with type parameters of type Plot

Modifier and Type	Field	Description
HashMap<String,HashMap<PlotId,Plot>>	PlotSquared.plots_tmp

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

Modifier and Type	Method	Description
@NonNull Set<@NonNull Plot>	PlotAPI.getAllPlots()	Gets all plots.
@NonNull Set<@NonNull Plot>	PlotAPI.getPlayerPlots(@NonNull PlotPlayer<?> player)	Gets all plots for a player.
@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.
List<Plot>	PlotSquared.sortPlotsByTemp(Collection<Plot> plots)

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

Modifier and Type	Method	Description
boolean	PlotSquared.removePlot(@NonNull Plot plot, boolean callEvent)	Unregisters a plot from local memory without calling the database.

Method parameters in com.plotsquared.core with type arguments of type Plot

Modifier and Type	Method	Description
void	PlotSquared.forEachPlotRaw(@NonNull Consumer<Plot> consumer)
void	PlotSquared.setPlots(@NonNull Map<String,HashMap<PlotId,Plot>> plots)
@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.
List<Plot>	PlotSquared.sortPlotsByTemp(Collection<Plot> plots)

Uses of Plot in com.plotsquared.core.backup

Methods in com.plotsquared.core.backup with parameters of type Plot

Modifier and Type	Method	Description
void	BackupManager.automaticBackup(@Nullable PlotPlayer<?> player, @NonNull Plot plot, @NonNull Runnable whenDone)	This will perform an automatic backup of the plot iff the plot has an owner, automatic backups are enabled.
void	NullBackupManager.automaticBackup(@Nullable PlotPlayer<?> plotPlayer, @NonNull Plot plot, @NonNull Runnable whenDone)
void	SimpleBackupManager.automaticBackup(@Nullable PlotPlayer<?> player, @NonNull Plot plot, @NonNull Runnable whenDone)
static void	BackupManager.backup(@Nullable PlotPlayer<?> player, @NonNull Plot plot, @NonNull Runnable whenDone)	This will perform an automatic backup of the plot iff the plot has an owner, automatic backups are enabled.
@NonNull BackupProfile	BackupManager.getProfile(@NonNull Plot plot)	Get the backup profile for a plot based on its current owner (if there is one)
@NonNull BackupProfile	NullBackupManager.getProfile(@NonNull Plot plot)
@NonNull BackupProfile	SimpleBackupManager.getProfile(@NonNull Plot plot)

Constructors in com.plotsquared.core.backup with parameters of type Plot

Modifier	Constructor	Description
	PlayerBackupProfile(@NonNull UUID owner, @NonNull Plot plot, @NonNull BackupManager backupManager, @NonNull SchematicHandler schematicHandler)

Uses of Plot in com.plotsquared.core.command

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

Modifier and Type	Method	Description
static double	Like.getLikesPercentage(Plot plot)	Get the likes to dislike ratio of a plot as a percentage (in decimal form)
boolean	Biome.set(PlotPlayer<?> player, Plot plot, String value)
boolean	Desc.set(PlotPlayer<?> player, Plot plot, String desc)
boolean	Owner.set(PlotPlayer<?> player, Plot plot, String value)
abstract boolean	SetCommand.set(PlotPlayer<?> player, Plot plot, String value)
boolean	SetHome.set(PlotPlayer<?> player, Plot plot, String value)

Method parameters in com.plotsquared.core.command with type arguments of type Plot

Modifier and Type	Method	Description
void	ListCmd.displayPlots(PlotPlayer<?> player, List<Plot> plots, int pageSize, int page, String[] args)
Set<PlotId>	Condense.getPlots(Collection<Plot> plots, int radius)
static void	DatabaseCommand.insertPlots(SQLManager manager, List<Plot> plots, PlotPlayer<?> player)

Uses of Plot in com.plotsquared.core.database

Fields in com.plotsquared.core.database with type parameters of type Plot

Modifier and Type	Field	Description
ConcurrentHashMap<Plot,Queue<SQLManager.UniqueStatement>>	SQLManager.plotTasks	plot plot_denied plot_helpers plot_trusted plot_comments plot_settings plot_rating

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

Modifier and Type	Method	Description
HashMap<String,HashMap<PlotId,Plot>>	AbstractDB.getPlots()
static HashMap<String,HashMap<PlotId,Plot>>	DBFunc.getPlots()
HashMap<String,HashMap<PlotId,Plot>>	SQLManager.getPlots()	Load all plots, helpers, denied, trusted, and every setting from DB into a HashMap.

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

Modifier and Type	Method	Description
void	SQLManager.addPlotTask(@NonNull Plot plot, SQLManager.UniqueStatement task)
void	AbstractDB.clearInbox(Plot plot, String inbox)	Clears the specified inbox on the given plot.
static void	DBFunc.clearInbox(Plot plot, String inbox)
void	SQLManager.clearInbox(Plot plot, String inbox)
void	AbstractDB.createPlotAndSettings(Plot plot, Runnable whenDone)
static void	DBFunc.createPlotAndSettings(Plot plot, Runnable whenDone)	Create a plot.
void	SQLManager.createPlotAndSettings(Plot plot, Runnable whenDone)
void	AbstractDB.createPlotSafe(Plot plot, Runnable success, Runnable failure)	Creates a plot.
static void	DBFunc.createPlotSafe(Plot plot, Runnable success, Runnable failure)
void	SQLManager.createPlotSafe(Plot plot, Runnable success, Runnable failure)
void	AbstractDB.createPlotSettings(int id, Plot plot)	Creates the plot settings.
static void	DBFunc.createPlotSettings(int id, Plot plot)	Create plot settings.
void	SQLManager.createPlotSettings(int id, Plot plot)	Creates plot settings
void	AbstractDB.delete(Plot plot)	Deletes a plot.
static void	DBFunc.delete(Plot plot)	Delete a plot.
void	SQLManager.delete(Plot plot)	Delete a plot.
void	AbstractDB.deleteComments(Plot plot)	Deletes all comments from the plot.
static void	DBFunc.deleteComments(Plot plot)	Delete the comments in a plot.
void	SQLManager.deleteComments(Plot plot)
void	AbstractDB.deleteDenied(Plot plot)	Removes all denied players from the plot.
static void	DBFunc.deleteDenied(Plot plot)	Delete the denied list for a plot.
void	SQLManager.deleteDenied(Plot plot)
void	AbstractDB.deleteHelpers(Plot plot)
void	SQLManager.deleteHelpers(Plot plot)
static void	DBFunc.deleteMembers(Plot plot)	Delete the members list for a plot.
void	AbstractDB.deleteRatings(Plot plot)
static void	DBFunc.deleteRatings(Plot plot)	Delete the ratings for a plot.
void	SQLManager.deleteRatings(Plot plot)
void	AbstractDB.deleteSettings(Plot plot)
static void	DBFunc.deleteSettings(Plot plot)	Deleting settings will 1) Delete any settings (flags and such) associated with the plot 2) Prevent any local changes to the plot from saving properly to the db
void	SQLManager.deleteSettings(Plot plot)
void	AbstractDB.deleteTrusted(Plot plot)
static void	DBFunc.deleteTrusted(Plot plot)	Delete the trusted list for a plot.
void	SQLManager.deleteTrusted(Plot plot)
void	AbstractDB.getComments(@NonNull Plot plot, String inbox, RunnableVal<List<PlotComment>> whenDone)	Gets Plot comments.
static void	DBFunc.getComments(Plot plot, String inbox, RunnableVal<List<PlotComment>> whenDone)
void	SQLManager.getComments(@NonNull Plot plot, String inbox, RunnableVal<List<PlotComment>> whenDone)
int	AbstractDB.getId(Plot plot)	Gets the table entry ID.
static int	DBFunc.getId(Plot plot)	Get a plot id.
int	SQLManager.getId(Plot plot)
HashMap<UUID,Integer>	AbstractDB.getRatings(Plot plot)	Gets the ratings from the specified plot.
static HashMap<UUID,Integer>	DBFunc.getRatings(Plot plot)
HashMap<UUID,Integer>	SQLManager.getRatings(Plot plot)
void	AbstractDB.movePlot(Plot originalPlot, Plot newPlot)
static void	DBFunc.movePlot(Plot originalPlot, Plot newPlot)
void	SQLManager.movePlot(Plot original, Plot newPlot)
void	AbstractDB.removeComment(Plot plot, PlotComment comment)	Removes the specified comment from the given plot.
static void	DBFunc.removeComment(Plot plot, PlotComment comment)
void	SQLManager.removeComment(Plot plot, PlotComment comment)
void	AbstractDB.removeDenied(Plot plot, UUID uuid)	Removes the specified player from the denied list of the specified plot.
static void	DBFunc.removeDenied(Plot plot, UUID uuid)
void	SQLManager.removeDenied(Plot plot, UUID uuid)
void	AbstractDB.removeFlag(Plot plot, PlotFlag<?,?> flag)	Remove a plot flag.
static void	DBFunc.removeFlag(Plot plot, PlotFlag<?,?> flag)
void	SQLManager.removeFlag(Plot plot, PlotFlag<?,?> flag)
void	AbstractDB.removeMember(Plot plot, UUID uuid)
static void	DBFunc.removeMember(Plot plot, UUID uuid)
void	SQLManager.removeMember(Plot plot, UUID uuid)
void	AbstractDB.removeTrusted(Plot plot, UUID uuid)	Remove the specified player from the trust list of the specified plot.
static void	DBFunc.removeTrusted(Plot plot, UUID uuid)
void	SQLManager.removeTrusted(Plot plot, UUID uuid)
void	AbstractDB.setAlias(Plot plot, String alias)	Sets the plot alias.
static void	DBFunc.setAlias(Plot plot, String alias)
void	SQLManager.setAlias(Plot plot, String alias)
void	AbstractDB.setComment(Plot plot, PlotComment comment)	Adds the specified comment to the given plot.
static void	DBFunc.setComment(Plot plot, PlotComment comment)
void	SQLManager.setComment(Plot plot, PlotComment comment)
void	AbstractDB.setDenied(Plot plot, UUID uuid)	Denies the specified player from the given plot.
static void	DBFunc.setDenied(Plot plot, UUID uuid)
void	SQLManager.setDenied(Plot plot, UUID uuid)
void	AbstractDB.setFlag(Plot plot, PlotFlag<?,?> flag)	Sets plot flag.
static void	DBFunc.setFlag(Plot plot, PlotFlag<?,?> flag)
void	SQLManager.setFlag(Plot plot, PlotFlag<?,?> flag)
void	AbstractDB.setMember(Plot plot, UUID uuid)
static void	DBFunc.setMember(Plot plot, UUID uuid)
void	SQLManager.setMember(Plot plot, UUID uuid)
void	AbstractDB.setMerged(Plot plot, boolean[] merged)	Sets the merged status for a plot.
static void	DBFunc.setMerged(Plot plot, boolean[] merged)
void	SQLManager.setMerged(Plot plot, boolean[] merged)
void	AbstractDB.setOwner(Plot plot, UUID uuid)	Sets Plot owner.
static void	DBFunc.setOwner(Plot plot, UUID uuid)	Set the owner of a plot
void	SQLManager.setOwner(Plot plot, UUID uuid)	Set Plot owner
void	AbstractDB.setPosition(Plot plot, String position)	Sets the plot home position.
static void	DBFunc.setPosition(Plot plot, String position)
void	SQLManager.setPosition(Plot plot, String position)
void	AbstractDB.setRating(Plot plot, UUID rater, int value)	Sets a rating for a plot.
static void	DBFunc.setRating(Plot plot, UUID rater, int value)
void	SQLManager.setRating(Plot plot, UUID rater, int value)
void	AbstractDB.setTrusted(Plot plot, UUID uuid)
static void	DBFunc.setTrusted(Plot plot, UUID uuid)
void	SQLManager.setTrusted(Plot plot, UUID uuid)
CompletableFuture<Boolean>	AbstractDB.swapPlots(Plot plot1, Plot plot2)	Swaps the settings, helpers etc.
static CompletableFuture<Boolean>	DBFunc.swapPlots(Plot plot1, Plot plot2)
CompletableFuture<Boolean>	SQLManager.swapPlots(Plot plot1, Plot plot2)

Method parameters in com.plotsquared.core.database with type arguments of type Plot

Modifier and Type	Method	Description
void	SQLManager.createFlags(Map<PlotId,Integer> ids, List<Plot> plots, Runnable whenDone)
void	SQLManager.createPlots(List<Plot> myList, Runnable whenDone)	Create a plot
void	AbstractDB.createPlotsAndData(List<Plot> plots, Runnable whenDone)	Creates all settings, and create default helpers, trusted + denied lists.
static void	DBFunc.createPlotsAndData(List<Plot> plots, Runnable whenDone)	Create all settings + (trusted, denied, members)
void	SQLManager.createPlotsAndData(List<Plot> myList, Runnable whenDone)
void	AbstractDB.validateAllPlots(Set<Plot> toValidate)
void	SQLManager.validateAllPlots(Set<Plot> toValidate)
static void	DBFunc.validatePlots(Set<Plot> plots)

Uses of Plot in com.plotsquared.core.events

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

Modifier and Type	Method	Description
@Nullable Plot	PlayerAutoPlotEvent.getPlot()	Returns null as the plots to be claimed haven't been chosen yet.
@Nullable Plot	PlayerAutoPlotsChosenEvent.getPlot()	Returns the plot at index 0 in the list of plots selected.
Plot	PlotEvent.getPlot()	Obtain the plot involved in the event

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

Modifier and Type	Method	Description
@NonNull List<Plot>	PlayerAutoPlotsChosenEvent.getPlots()	Get the immutable list of plots selected to be claimed by the player.

Method parameters in com.plotsquared.core.events with type arguments of type Plot

Modifier and Type	Method	Description
void	PlayerAutoPlotsChosenEvent.setPlots(@NonNull List<Plot> plots)	Set the plots to be claimed by the player.

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

Modifier	Constructor	Description
	PlayerClaimPlotEvent(PlotPlayer<?> player, Plot plot, @Nullable String schematic)	PlayerClaimPlotEvent: Called when a plot is claimed.
	PlayerEnterPlotEvent(PlotPlayer<?> player, Plot plot)	Called when a player leaves a plot.
	PlayerLeavePlotEvent(PlotPlayer<?> player, Plot plot)	PlayerLeavePlotEvent: Called when a player leaves a plot
	PlayerPlotDeniedEvent(PlotPlayer<?> initiator, Plot plot, UUID player, boolean added)	PlayerPlotDeniedEvent: Called when the denied UUID list is modified for a plot.
	PlayerPlotHelperEvent(PlotPlayer<?> initiator, Plot plot, UUID player, boolean added)	PlayerPlotHelperEvent: Called when a plot helper is added/removed
	PlayerPlotTrustedEvent(PlotPlayer<?> initiator, Plot plot, UUID player, boolean added)	PlayerPlotTrustedEvent: Called when a plot trusted user is added/removed
	PlayerTeleportToPlotEvent(PlotPlayer<?> player, Location from, Plot plot, TeleportCause cause)	PlayerTeleportToPlotEvent: Called when a player teleports to a plot
	PlotAutoMergeEvent(@NonNull String world, @NonNull Plot plot, @NonNull List<PlotId> plots)	PlotAutoMergeEvent: Called when plots are automatically merged with /plot auto
	PlotChangeOwnerEvent(PlotPlayer<?> initiator, Plot plot, @Nullable UUID oldOwner, @Nullable UUID newOwner, boolean hasOldOwner)	PlotChangeOwnerEvent: Called when a plot's owner is change.
	PlotClaimedNotifyEvent(Plot plot, boolean auto)	New event instance.
	PlotClearEvent(Plot plot)
	PlotComponentSetEvent(Plot plot, String component, Pattern pattern)	PlotComponentSetEvent: Called when a player attempts to set the component of a plot (e.g.
	PlotDeleteEvent(Plot plot)
	PlotDoneEvent(Plot plot)	PlotDoneEvent: Called when a plot is being set as done
	PlotEvent(Plot plot)
	PlotFlagAddEvent(PlotFlag<?,?> flag, Plot plot)	PlotFlagAddEvent: Called when a Flag is added to a plot.
protected	PlotFlagEvent(Plot plot, PlotFlag<?,?> flag)
	PlotFlagRemoveEvent(PlotFlag<?,?> flag, Plot plot)	PlotFlagRemoveEvent: Called when a flag is removed from a plot
	PlotMergeEvent(@NonNull String world, @NonNull Plot plot, @NonNull Direction dir, int max, PlotPlayer<?> player)	PlotMergeEvent: Called when plots are merged
	PlotPlayerEvent(PlotPlayer<?> plotPlayer, Plot plot)
	PlotRateEvent(PlotPlayer<?> rater, @Nullable Rating rating, Plot plot)	PlotRateEvent: Called when a player rates a plot
	PlotUnlinkEvent(@NonNull PlotArea area, Plot plot, boolean createRoad, boolean createSign, PlotUnlinkEvent.REASON reason)	PlotUnlinkEvent: Called when a mega plot is unlinked

Constructor parameters in com.plotsquared.core.events with type arguments of type Plot

Modifier	Constructor	Description
	PlayerAutoPlotsChosenEvent(PlotPlayer<?> player, List<Plot> plots)	PlayerAutoPlotsChosenEvent: Called when one or more plots are chosen for a /plot auto

Uses of Plot in com.plotsquared.core.events.post

Constructors in com.plotsquared.core.events.post with parameters of type Plot

Modifier	Constructor	Description
	PostPlayerAutoPlotEvent(PlotPlayer<?> plotPlayer, Plot plot)	Instantiate a new PlayerAutoPlotPostEvent.
	PostPlotChangeOwnerEvent(PlotPlayer<?> initiator, Plot plot, @Nullable UUID oldOwner)	Instantiate a new PlotChangedOwnerEvent.
	PostPlotDeleteEvent(Plot plot)	Instantiate a new PlotDeleteEvent.
	PostPlotMergeEvent(PlotPlayer<?> plotPlayer, Plot plot)	Instantiate a new PlotMergedEvent.
	PostPlotUnlinkEvent(Plot plot, PlotUnlinkEvent.REASON reason)	Instantiate a new PlotUnlinkedEvent.

Uses of Plot in com.plotsquared.core.generator

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

Modifier and Type	Method	Description
void	HybridUtils.analyzePlot(Plot origin, RunnableVal<PlotAnalysis> whenDone)
boolean	ClassicPlotManager.claimPlot(@NonNull Plot plot, @Nullable QueueCoordinator queue)
boolean	HybridPlotManager.clearPlot(@NonNull Plot plot, @Nullable Runnable whenDone, @Nullable PlotPlayer<?> actor, @Nullable QueueCoordinator queue)
boolean	SquarePlotManager.clearPlot(@NonNull Plot plot, @Nullable Runnable whenDone, @Nullable PlotPlayer<?> actor, @Nullable QueueCoordinator queue)
boolean	ClassicPlotManager.createRoadEast(@NonNull Plot plot, @Nullable QueueCoordinator queue)
boolean	HybridPlotManager.createRoadEast(@NonNull Plot plot, @Nullable QueueCoordinator queue)
boolean	ClassicPlotManager.createRoadSouth(@NonNull Plot plot, @Nullable QueueCoordinator queue)
boolean	HybridPlotManager.createRoadSouth(@NonNull Plot plot, @Nullable QueueCoordinator queue)
boolean	ClassicPlotManager.createRoadSouthEast(@NonNull Plot plot, @Nullable QueueCoordinator queue)
boolean	HybridPlotManager.createRoadSouthEast(@NonNull Plot plot, @Nullable QueueCoordinator queue)
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)
boolean	ClassicPlotManager.removeRoadEast(@NonNull Plot plot, @Nullable QueueCoordinator queue)
boolean	ClassicPlotManager.removeRoadSouth(@NonNull Plot plot, @Nullable QueueCoordinator queue)
boolean	ClassicPlotManager.removeRoadSouthEast(@NonNull Plot plot, @Nullable QueueCoordinator queue)
boolean	HybridUtils.scheduleSingleRegionRoadUpdate(Plot plot, int extend)
boolean	HybridUtils.setupRoadSchematic(Plot plot)
boolean	ClassicPlotManager.unClaimPlot(@NonNull Plot plot, @Nullable Runnable whenDone, @Nullable QueueCoordinator queue)

Uses of Plot in com.plotsquared.core.inject.factory

Methods in com.plotsquared.core.inject.factory with parameters of type Plot

Modifier and Type	Method	Description
@NonNull PlayerBackupProfile	PlayerBackupProfileFactory.create(@NonNull UUID uuid, @NonNull Plot plot)

Uses of Plot in com.plotsquared.core.listener

Methods in com.plotsquared.core.listener with parameters of type Plot

Modifier and Type	Method	Description
boolean	PlotListener.plotEntry(PlotPlayer<?> player, Plot plot)
boolean	PlotListener.plotExit(PlotPlayer<?> player, Plot plot)

Uses of Plot in com.plotsquared.core.location

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

Modifier and Type	Method	Description
@Nullable Plot	Location.getOwnedPlot()	Get the owned Plot, if any, that contains this location
@Nullable Plot	Location.getOwnedPlotAbs()	Get the (absolute) owned Plot, if any, that contains this location
@Nullable Plot	Location.getPlot()	Get the Plot, if any, that contains this location
@Nullable Plot	Location.getPlotAbs()	Get the absolute Plot, if any, that contains this location

Uses of Plot in com.plotsquared.core.player

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

Modifier and Type	Field	Description
static final MetaDataKey<Plot>	PlayerMetaDataKeys.TEMPORARY_LAST_PLOT
static final MetaDataKey<Plot>	PlayerMetaDataKeys.TEMPORARY_WORLD_EDIT_REGION_PLOT

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

Modifier and Type	Method	Description
Plot	PlotPlayer.getCurrentPlot()	Get this player's current plot.

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

Modifier and Type	Method	Description
Set<Plot>	PlotPlayer.getPlots()	Get a Set of plots owned by this player.
Set<Plot>	PlotPlayer.getPlots(String world)	Return a Set of all plots this player owns in a certain world.

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

Modifier and Type	Method	Description
static Collection<PlotPlayer<?>>	PlotPlayer.getDebugModePlayersInPlot(@NonNull Plot plot)

Uses of Plot in com.plotsquared.core.plot

Fields in com.plotsquared.core.plot with type parameters of type Plot

Modifier and Type	Field	Description
protected final ConcurrentHashMap<PlotId,Plot>	PlotArea.plots

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

Modifier and Type	Method	Description
static @Nullable Plot	Plot.fromString(@Nullable PlotArea defaultArea, @NonNull String string)	Gets a plot from a string e.g.
Plot	Plot.getBasePlot(boolean recalculate)	The base plot is an arbitrary but specific connected plot.
@Nullable Plot	PlotCluster.getCenterPlot()
Plot	PlotArea.getNextFreePlot(PlotPlayer<?> player, @Nullable PlotId start)
@Nullable Plot	PlotArea.getOwnedPlot(@NonNull Location location)	Get the owned base plot at a location.
@Nullable Plot	PlotArea.getOwnedPlot(@NonNull PlotId id)
@Nullable Plot	PlotArea.getOwnedPlotAbs(@NonNull Location location)	Get the owned plot at a location.
@Nullable Plot	PlotArea.getOwnedPlotAbs(@NonNull PlotId id)	Get the owned Plot at a PlotId.
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.getPlot(@NonNull PlotId id)
@Nullable Plot	PlotArea.getPlotAbs(@NonNull Location location)	Gets the Plot at a location.
@Nullable Plot	PlotArea.getPlotAbs(@NonNull PlotId id)
static @Nullable Plot	Plot.getPlotFromString(@Nullable PlotPlayer<?> player, @Nullable String arg, boolean message)	Get the plot from a string.
Plot	Plot.getRelative(int x, int y)	Gets the plot in a relative location Note: May be null if the partial plot area does not include the relative location
@Nullable Plot	Plot.getRelative(@NonNull Direction direction)	Gets the plot in a relative direction Note: May be null if the partial plot area does not include the relative location
Plot	Plot.getRelative(PlotArea area, int x, int y)

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

Modifier and Type	Method	Description
@Nullable List<Plot>	PlotArea.canClaim(@Nullable PlotPlayer<?> player, @NonNull PlotId pos1, @NonNull PlotId pos2)
@NonNull Set<Plot>	PlotArea.getBasePlots()
Set<Plot>	Plot.getConnectedPlots()	Gets a set of plots connected (and including) this plot - This result is cached globally
@NonNull Set<Map.Entry<PlotId,Plot>>	PlotArea.getPlotEntries()
Collection<Plot>	PlotArea.getPlots()	A collection of the claimed plots in this PlotArea.
Set<Plot>	PlotArea.getPlots(@NonNull PlotPlayer<?> player)	Deprecated. Use PlotArea.getPlots(UUID)
@NonNull Set<Plot>	PlotArea.getPlots(@NonNull UUID uuid)
@NonNull Set<Plot>	PlotArea.getPlotsAbs(UUID uuid)
Set<Plot>	PlotArea.getPlotSelectionOwned(@NonNull PlotId pos1, @NonNull PlotId pos2)	Get a set of owned plots within a selection (chooses the best algorithm based on selection size.
@NonNull Map<PlotId,Plot>	PlotArea.getPlotsRaw()	Deprecated. Poorly implemented.

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

Modifier and Type	Method	Description
boolean	PlotArea.addPlot(@NonNull Plot plot)
boolean	PlotArea.addPlotAbs(@NonNull Plot plot)
boolean	PlotArea.addPlotIfAbsent(@NonNull Plot plot)
abstract boolean	PlotManager.claimPlot(@NonNull Plot plot, @Nullable QueueCoordinator queue)
abstract boolean	PlotManager.clearPlot(@NonNull Plot plot, @Nullable Runnable whenDone, @Nullable PlotPlayer<?> actor, @Nullable QueueCoordinator queue)
CompletableFuture<Boolean>	PlotModificationManager.copy(@NonNull Plot destination, @Nullable PlotPlayer<?> actor)	Copy a plot to a location, both physically and the settings
abstract boolean	PlotManager.createRoadEast(@NonNull Plot plot, @Nullable QueueCoordinator queue)	Create the road east of the plot (not schematic-based)
abstract boolean	PlotManager.createRoadSouth(@NonNull Plot plot, @Nullable QueueCoordinator queue)	Create the road south of the plot (not schematic-based)
abstract boolean	PlotManager.createRoadSouthEast(@NonNull Plot plot, @Nullable QueueCoordinator queue)	Create the south-east corner of the road (intersection, not schematic-based)
abstract Location	PlotManager.getSignLoc(@NonNull Plot plot)	Retrieves the location of where a sign should be for a plot.
void	Plot.mergeData(Plot plot)	Merge the plot settings - Used when a plot is merged
void	Plot.mergePlot(Plot lesserPlot, boolean removeRoads, @Nullable QueueCoordinator queue)	Merges two plots.
@NonNull CompletableFuture<Boolean>	PlotModificationManager.move(@NonNull Plot destination, @Nullable PlotPlayer<?> actor, @NonNull Runnable whenDone)	Moves the plot to an empty location - The location must be empty
@NonNull CompletableFuture<Boolean>	PlotModificationManager.move(@NonNull Plot destination, @Nullable PlotPlayer<?> actor, @NonNull Runnable whenDone, boolean allowSwap)	Moves a plot physically, as well as the corresponding settings.
boolean	Plot.moveData(Plot plot, Runnable whenDone)	Moves the settings for a plot.
abstract boolean	PlotManager.removeRoadEast(@NonNull Plot plot, @Nullable QueueCoordinator queue)	Replace the road to the east of the plot with standard plot blocks (for when merging plots)
abstract boolean	PlotManager.removeRoadSouth(@NonNull Plot plot, @Nullable QueueCoordinator queue)	Replace the road to the south of the plot with standard plot blocks (for when merging plots)
abstract boolean	PlotManager.removeRoadSouthEast(@NonNull Plot plot, @Nullable QueueCoordinator queue)	Replace the road to the south east of the plot (intersection) with standard plot blocks (for when merging plots)
static boolean	PlotHandler.sameOwners(Plot plot1, Plot plot2)
@NonNull CompletableFuture<Boolean>	PlotModificationManager.swap(@NonNull Plot destination, @Nullable PlotPlayer<?> actor, @NonNull Runnable whenDone)	Swap the plot contents and settings with another location - The destination must correspond to a valid plot of equal dimensions
CompletableFuture<Boolean>	Plot.swapData(Plot plot)	Swaps the settings for two plots.
abstract boolean	PlotManager.unClaimPlot(@NonNull Plot plot, @Nullable Runnable whenDone, @Nullable QueueCoordinator queue)	Completes block changes associated with plot unclaim.

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

Modifier and Type	Method	Description
void	PlotArea.forEachBasePlot(Consumer<Plot> run)

Uses of Plot in com.plotsquared.core.plot.comment

Methods in com.plotsquared.core.plot.comment with parameters of type Plot

Modifier and Type	Method	Description
abstract boolean	CommentInbox.addComment(Plot plot, PlotComment comment)
boolean	InboxOwner.addComment(Plot plot, PlotComment comment)
boolean	InboxPublic.addComment(Plot plot, PlotComment comment)
boolean	InboxReport.addComment(Plot plot, PlotComment comment)
boolean	CommentInbox.canModify(Plot plot, PlotPlayer<?> player)
boolean	CommentInbox.canRead(Plot plot, PlotPlayer<?> player)
boolean	CommentInbox.canWrite(Plot plot, PlotPlayer<?> player)
void	CommentInbox.clearInbox(Plot plot)
abstract boolean	CommentInbox.getComments(Plot plot, RunnableVal<List<PlotComment>> whenDone)	The `whenDone` parameter should be executed when it's done fetching the comments.
boolean	InboxOwner.getComments(Plot plot, RunnableVal<List<PlotComment>> whenDone)
boolean	InboxPublic.getComments(Plot plot, RunnableVal<List<PlotComment>> whenDone)
boolean	InboxReport.getComments(Plot plot, RunnableVal<List<PlotComment>> whenDone)
void	CommentInbox.removeComment(Plot plot, PlotComment comment)
static void	CommentManager.sendTitle(PlotPlayer<?> player, Plot plot)

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

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

Modifier and Type	Method	Description
HashSet<Plot>	ExpireManager.getPendingExpired()
Set<Plot>	ExpiryTask.getPlotsToCheck()

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

Modifier and Type	Method	Description
static void	PlotAnalysis.analyzePlot(Plot plot, RunnableVal<PlotAnalysis> whenDone)
void	ExpireManager.deleteWithMessage(Plot plot, Runnable whenDone)
long	ExpireManager.getAge(Plot plot, boolean shouldDeleteUnknownOwner)
static PlotAnalysis	PlotAnalysis.getAnalysis(Plot plot, Settings.Auto_Clear settings)
void	ExpireManager.handleEntry(PlotPlayer<?> pp, Plot plot)
Collection<ExpiryTask>	ExpireManager.isExpired(ArrayDeque<ExpiryTask> applicable, Plot plot)
void	ExpireManager.updateExpired(Plot plot)

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

Modifier and Type	Method	Description
boolean	ExpireManager.runTask(RunnableVal3<Plot,Runnable,Boolean> expiredTask)

Uses of Plot in com.plotsquared.core.plot.flag.implementations

Methods in com.plotsquared.core.plot.flag.implementations with parameters of type Plot

Modifier and Type	Method	Description
static boolean	DenyTeleportFlag.allowsTeleport(PlotPlayer<?> player, Plot plot)
static boolean	DoneFlag.isDone(Plot plot)

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

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

Modifier and Type	Class	Description
class	SinglePlot

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

Modifier and Type	Method	Description
protected Plot	SinglePlotArea.adapt(Plot p)
@Nullable Plot	SinglePlotArea.getOwnedPlot(@NonNull Location location)
@Nullable Plot	SinglePlotArea.getOwnedPlotAbs(@NonNull Location location)
@Nullable Plot	SinglePlotArea.getPlot(@NonNull Location location)
@Nullable Plot	SinglePlotArea.getPlot(@NonNull PlotId id)
@Nullable Plot	SinglePlotArea.getPlotAbs(@NonNull Location location)
@Nullable Plot	SinglePlotArea.getPlotAbs(@NonNull PlotId id)

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

Modifier and Type	Method	Description
protected Plot	SinglePlotArea.adapt(Plot p)
boolean	SinglePlotArea.addPlot(@NonNull Plot plot)
boolean	SinglePlotArea.addPlotAbs(@NonNull Plot plot)
boolean	SinglePlotArea.addPlotIfAbsent(@NonNull Plot plot)
boolean	SinglePlotManager.claimPlot(@NonNull Plot plot, @Nullable QueueCoordinator queue)
boolean	SinglePlotManager.clearPlot(@NonNull Plot plot, Runnable whenDone, @Nullable PlotPlayer<?> actor, @Nullable QueueCoordinator queue)
boolean	SinglePlotManager.createRoadEast(@NonNull Plot plot, @Nullable QueueCoordinator queue)
boolean	SinglePlotManager.createRoadSouth(@NonNull Plot plot, @Nullable QueueCoordinator queue)
boolean	SinglePlotManager.createRoadSouthEast(@NonNull Plot plot, @Nullable QueueCoordinator queue)
Location	SinglePlotManager.getSignLoc(@NonNull Plot plot)
boolean	SinglePlotManager.removeRoadEast(@NonNull Plot plot, @Nullable QueueCoordinator queue)
boolean	SinglePlotManager.removeRoadSouth(@NonNull Plot plot, @Nullable QueueCoordinator queue)
boolean	SinglePlotManager.removeRoadSouthEast(@NonNull Plot plot, @Nullable QueueCoordinator queue)
boolean	SinglePlotManager.unClaimPlot(@NonNull Plot plot, Runnable whenDone, @Nullable QueueCoordinator queue)

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

Fields in com.plotsquared.core.services.plots with type parameters of type Plot

Modifier and Type	Field	Description
static final com.google.common.cache.Cache<PlotId,Plot>	AutoService.plotCandidateCache

Methods in com.plotsquared.core.services.plots that return types with arguments of type Plot

Modifier and Type	Method	Description
List<Plot>	AutoService.DefaultAutoService.handle(@NonNull AutoQuery autoQuery)
List<Plot>	AutoService.MultiPlotService.handle(@NonNull AutoQuery autoQuery)
@Nullable List<Plot>	AutoService.SinglePlotService.handle(@NonNull AutoQuery autoQuery)

Uses of Plot in com.plotsquared.core.util

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

Modifier and Type	Method	Description
PlotAutoMergeEvent	EventDispatcher.callAutoMerge(Plot plot, List<PlotId> plots)
PlayerClaimPlotEvent	EventDispatcher.callClaim(PlotPlayer<?> player, Plot plot, String schematic)
PlotClearEvent	EventDispatcher.callClear(Plot plot)
PlotComponentSetEvent	EventDispatcher.callComponentSet(Plot plot, String component, Pattern pattern)
PlotDeleteEvent	EventDispatcher.callDelete(Plot plot)
PlayerPlotDeniedEvent	EventDispatcher.callDenied(PlotPlayer<?> initiator, Plot plot, UUID player, boolean added)
PlotDoneEvent	EventDispatcher.callDone(Plot plot)
PlayerEnterPlotEvent	EventDispatcher.callEntry(PlotPlayer<?> player, Plot plot)
PlotFlagAddEvent	EventDispatcher.callFlagAdd(PlotFlag<?,?> flag, Plot plot)
PlotFlagRemoveEvent	EventDispatcher.callFlagRemove(PlotFlag<?,?> flag, Plot plot)
PlayerLeavePlotEvent	EventDispatcher.callLeave(PlotPlayer<?> player, Plot plot)
PlayerPlotHelperEvent	EventDispatcher.callMember(PlotPlayer<?> initiator, Plot plot, UUID player, boolean added)
PlotMergeEvent	EventDispatcher.callMerge(Plot plot, Direction dir, int max, PlotPlayer<?> player)
PlotChangeOwnerEvent	EventDispatcher.callOwnerChange(PlotPlayer<?> initiator, Plot plot, UUID oldOwner, UUID newOwner, boolean hasOldOwner)
PlotClaimedNotifyEvent	EventDispatcher.callPlotClaimedNotify(Plot plot, boolean auto)
PostPlayerAutoPlotEvent	EventDispatcher.callPostAuto(PlotPlayer<?> player, Plot plot)
PostPlotDeleteEvent	EventDispatcher.callPostDelete(Plot plot)
PostPlotMergeEvent	EventDispatcher.callPostMerge(PlotPlayer<?> player, Plot plot)
PostPlotChangeOwnerEvent	EventDispatcher.callPostOwnerChange(PlotPlayer<?> player, Plot plot, @Nullable UUID oldOwner)
PostPlotUnlinkEvent	EventDispatcher.callPostUnlink(Plot plot, PlotUnlinkEvent.REASON reason)
PlotRateEvent	EventDispatcher.callRating(PlotPlayer<?> player, Plot plot, Rating rating)
PlayerTeleportToPlotEvent	EventDispatcher.callTeleport(PlotPlayer<?> player, Location from, Plot plot, TeleportCause cause)
PlayerPlotTrustedEvent	EventDispatcher.callTrusted(PlotPlayer<?> initiator, Plot plot, UUID player, boolean added)
PlotUnlinkEvent	EventDispatcher.callUnlink(PlotArea area, Plot plot, boolean createRoad, boolean createSign, PlotUnlinkEvent.REASON reason)
static boolean	EntityUtil.checkEntity(Plot plot, PlotFlag<Integer,?>... flags)
static @NonNull List<Command>	TabCompletions.completeAddedPlayers(@NonNull PlotPlayer<?> issuer, @NonNull Plot plot, @NonNull String input, @NonNull List<String> existing)	Get a list of tab completions corresponding to player names added to the given plot.
static @NonNull List<Command>	TabCompletions.completePlayersInPlot(@NonNull Plot plot, @NonNull String input, @NonNull List<String> existing)
abstract int[]	RegionManager.countEntities(Plot plot)	0 = Entity 1 = Animal 2 = Monster 3 = Mob 4 = Boat 5 = Misc
CompletableFuture<CompoundTag>	SchematicHandler.getCompoundTag(@NonNull Plot plot)	Get the given plot as CompoundTag matching the Sponge schematic format.
abstract boolean	RegionManager.handleClear(@NonNull Plot plot, @Nullable Runnable whenDone, @NonNull PlotManager manager, @Nullable PlotPlayer<?> actor)	Only called when RegionManager.notifyClear(PlotManager) returns true in specific PlotManagers
void	SchematicHandler.paste(Schematic schematic, Plot plot, int xOffset, int yOffset, int zOffset, boolean autoHeight, PlotPlayer<?> actor, RunnableVal<Boolean> whenDone)	Paste a schematic.
CompletableFuture<PlotUploader.PlotUploadResult>	PlotUploader.upload(@NonNull Plot plot)	Upload a plot and retrieve a result.
void	WorldUtil.upload(@NonNull Plot plot, @Nullable UUID uuid, @Nullable String file, @NonNull RunnableVal<URL> whenDone)	Deprecated, for removal: This API element is subject to removal in a future version.

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

Modifier and Type	Method	Description
PlayerAutoPlotsChosenEvent	EventDispatcher.callAutoPlotsChosen(PlotPlayer<?> player, List<Plot> plots)
boolean	SchematicHandler.exportAll(Collection<Plot> collection, File outputDir, String namingScheme, Runnable ifSuccess)

Uses of Plot in com.plotsquared.core.util.placeholders

Methods in com.plotsquared.core.util.placeholders with parameters of type Plot

Modifier and Type	Method	Description
@NonNull String	PlotFlagPlaceholder.getValue(@NonNull PlotPlayer<?> player, @NonNull Plot plot)
abstract @NonNull String	PlotSpecificPlaceholder.getValue(@NonNull PlotPlayer<?> player, @NonNull Plot plot)	Get the value of the placeholder for the player in a specific plot

Method parameters in com.plotsquared.core.util.placeholders with type arguments of type Plot

Modifier and Type	Method	Description
void	PlaceholderRegistry.createPlaceholder(@NonNull String key, @NonNull BiFunction<PlotPlayer<?>,Plot,String> placeholderFunction)	Create a functional placeholder

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

Methods in com.plotsquared.core.util.query that return types with arguments of type Plot

Modifier and Type	Method	Description
@NonNull Collection<Plot>	PlotQuery.asCollection()	Get all plots that match the given criteria
@NonNull List<Plot>	PlotQuery.asList()	Get all plots that match the given criteria
@NonNull Set<Plot>	PlotQuery.asSet()	Get all plots that match the given criteria
@NonNull Stream<Plot>	PlotQuery.asStream()	Get all plots that match the given criteria
List<Plot>	PaginatedPlotResult.getPage(int page)	Get the plots belonging to a certain page.
@NonNull Iterator<Plot>	PlotQuery.iterator()

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

Modifier and Type	Method	Description
@NonNull PlotQuery	PlotQuery.withPlot(@NonNull Plot plot)	Query with a pre-defined result

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

Modifier and Type	Method	Description
@NonNull PlotQuery	PlotQuery.sorted(@NonNull Comparator<Plot> comparator)	Use a custom comparator to sort the results
@NonNull PlotQuery	PlotQuery.thatPasses(@NonNull Predicate<Plot> predicate)	Query for plots that passes a given predicate

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

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

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