Package com.plotsquared.core.plot.world

Class SinglePlotArea

java.lang.Object

com.plotsquared.core.plot.PlotArea

com.plotsquared.core.generator.GridPlotWorld

com.plotsquared.core.plot.world.SinglePlotArea

All Implemented Interfaces:

net.kyori.adventure.text.ComponentLike

public class SinglePlotArea
extends GridPlotWorld

Field Summary

Fields

Modifier and Type	Field	Description
boolean	VOID

Fields inherited from class com.plotsquared.core.generator.GridPlotWorld

SIZE

Fields inherited from class com.plotsquared.core.plot.PlotArea

plots

Constructor Summary

Constructors

Constructor	Description
SinglePlotArea(@NonNull PlotAreaManager plotAreaManager, @NonNull EventDispatcher eventDispatcher, @NonNull PlotListener plotListener, @NonNull YamlConfiguration worldConfiguration, @NonNull GlobalBlockQueue globalBlockQueue)

Method Summary

Modifier and Type	Method	Description
protected Plot	adapt(Plot p)
boolean	addPlot(@NonNull Plot plot)
boolean	addPlotAbs(@NonNull Plot plot)
boolean	addPlotIfAbsent(@NonNull Plot plot)
boolean	allowSigns()	Get whether plot signs are allowed or not.
protected @NonNull PlotManager	createManager()
@Nullable Plot	getOwnedPlot(@NonNull Location location)	Get the owned base plot at a location.
@Nullable Plot	getOwnedPlotAbs(@NonNull Location location)	Get the owned plot at a location.
@Nullable Plot	getPlot(@NonNull Location location)	Gets the base plot at a location.
@Nullable Plot	getPlot(@NonNull PlotId id)
@Nullable Plot	getPlotAbs(@NonNull Location location)	Gets the Plot at a location.
@Nullable Plot	getPlotAbs(@NonNull PlotId id)
QueueCoordinator	getQueue()	Single Plot Areas must provide a different QueueCoordinator than other plot areas, otherwise plot deletion fails.
ConfigurationNode[]	getSettingNodes()	Used for the /plot setup command Return null if you do not want to support this feature
static boolean	isSinglePlotWorld(String worldName)	Returns true if the given string matches the naming system used to identify single plot worlds e.g.
void	loadConfiguration(ConfigurationSection config)
void	loadWorld(PlotId id)
void	saveConfiguration(ConfigurationSection config)	Saving core PlotArea settings.

Methods inherited from class com.plotsquared.core.plot.PlotArea

addCluster, asComponent, buildRangeContainsY, canClaim, contains, contains, contains, defaultHome, deleteMeta, equals, forEachBasePlot, getBasePlots, getBorder, getBorder, getBorderSize, getCluster, getCluster, getClusters, getFirstIntersectingCluster, getFlag, getFlag, getFlagContainer, getGameMode, getGenerator, getId, getMax, getMaxBuildHeight, getMaxComponentHeight, getMaxGenHeight, getMeta, getMeta, getMin, getMinBuildHeight, getMinComponentHeight, getMinGenHeight, getNextFreePlot, getOwnedPlot, getOwnedPlotAbs, getPlotBiome, getPlotCount, getPlotCount, getPlotCount, getPlotEntries, getPlotManager, getPlots, getPlots, getPlots, getPlotsAbs, getPlotSelectionOwned, getPlotsRaw, getPrices, getRegion, getRoadFlag, getRoadFlag, getRoadFlagContainer, getSchematicFile, getSchematics, getSignMaterial, getTerrain, getType, getWorldHash, getWorldName, hashCode, hasPlot, hasSchematic, hasWorldBorder, isAutoMerge, isCompatible, isForcingPlotChat, isHomeAllowNonmember, isMiscSpawnUnowned, isMobSpawnerSpawning, isMobSpawning, isPlotChat, isRoadFlags, isSchematicClaimSpecify, isSchematicOnClaim, isSpawnBreeding, isSpawnCustom, isSpawnEggs, legacySignMaterial, loadDefaultConfiguration, mergePlots, mergePlots, nonmemberHome, notifyIfOutsideBuildArea, removeCluster, removePlot, setAllowSigns, setDefaultHome, setMeta, setTerrain, setType, setupBorder, signMaterial, toString, useEconomy

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

VOID

public boolean VOID

Constructor Details

SinglePlotArea

public SinglePlotArea(@NonNull PlotAreaManager plotAreaManager,
 @NonNull EventDispatcher eventDispatcher,
 @NonNull PlotListener plotListener,
 @NonNull YamlConfiguration worldConfiguration,
 @NonNull GlobalBlockQueue globalBlockQueue)

Method Details

isSinglePlotWorld

public static boolean isSinglePlotWorld(String worldName)

Returns true if the given string matches the naming system used to identify single plot worlds e.g. -1_5 represents plot id *;-1;5. "*" being the plot area name given to single plot world PlotArea.

Since:

6.1.4

createManager

protected @NonNull PlotManager createManager()

Specified by:

createManager in class PlotArea

getQueue

public QueueCoordinator getQueue()

Single Plot Areas must provide a different QueueCoordinator than other plot areas, otherwise plot deletion fails. When deleting plots, the PlotModificationManager retrieves a QueueCoordinator from the associated PlotArea, which accesses the plots world. For SinglePlotAreas this world is null at this point, as the whole world is deleted (and the areas world name being `*`).
The queue doesn't know when it's used, so this always provides a QueueCoordinator that doesn't do anything and doesn't contain any tasks. This isn't really bad, as SinglePlotAreas don't utilize the Queue as of now.

Overrides:

getQueue in class PlotArea

Returns:

a QueueCoordinator for SinglePlotAreas

loadConfiguration

public void loadConfiguration(ConfigurationSection config)

Specified by:

loadConfiguration in class PlotArea

saveConfiguration

public void saveConfiguration(ConfigurationSection config)

Description copied from class: PlotArea

Saving core PlotArea settings.

Overrides:

saveConfiguration in class PlotArea

Parameters:

config - Configuration Section

loadWorld

public void loadWorld(PlotId id)

getSettingNodes

public ConfigurationNode[] getSettingNodes()

Description copied from class: PlotArea

Used for the /plot setup command Return null if you do not want to support this feature

Specified by:

getSettingNodes in class PlotArea

Returns:

ConfigurationNode[]

getOwnedPlot

public @Nullable Plot getOwnedPlot(@NonNull Location location)

Description copied from class: PlotArea

Get the owned base plot at a location.

Overrides:

getOwnedPlot in class PlotArea

Parameters:

location - the location

Returns:

the base plot or null

getOwnedPlotAbs

public @Nullable Plot getOwnedPlotAbs(@NonNull Location location)

Description copied from class: PlotArea

Get the owned plot at a location.

Overrides:

getOwnedPlotAbs in class PlotArea

Parameters:

location - the location

Returns:

Plot or null

getPlot

public @Nullable Plot getPlot(@NonNull Location location)

Description copied from class: PlotArea

Gets the base plot at a location.

Overrides:

getPlot in class PlotArea

Parameters:

location - the location

Returns:

base Plot

getPlotAbs

public @Nullable Plot getPlotAbs(@NonNull Location location)

Description copied from class: PlotArea

Gets the Plot at a location.

Overrides:

getPlotAbs in class PlotArea

Parameters:

location - the location

Returns:

the Plot or null if none exists

addPlot

public boolean addPlot(@NonNull Plot plot)

Overrides:

addPlot in class PlotArea

addPlotAbs

public boolean addPlotAbs(@NonNull Plot plot)

Overrides:

addPlotAbs in class PlotArea

addPlotIfAbsent

public boolean addPlotIfAbsent(@NonNull Plot plot)

Overrides:

addPlotIfAbsent in class PlotArea

allowSigns

public boolean allowSigns()

Description copied from class: PlotArea

Get whether plot signs are allowed or not.

Overrides:

allowSigns in class PlotArea

Returns:

true if plot signs are allowed, false otherwise.

adapt

protected Plot adapt(Plot p)

getPlotAbs

public @Nullable Plot getPlotAbs(@NonNull PlotId id)

Overrides:

getPlotAbs in class PlotArea

getPlot

public @Nullable Plot getPlot(@NonNull PlotId id)

Overrides:

getPlot in class PlotArea