Package com.plotsquared.core.util

Class RegionManager

java.lang.Object

com.plotsquared.core.util.RegionManager

public abstract class RegionManager
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static RegionManager	manager
protected final WorldUtil	worldUtil

Constructor Summary

Constructors

Constructor	Description
RegionManager(@NonNull WorldUtil worldUtil, @NonNull GlobalBlockQueue blockQueue, @NonNull ProgressSubscriberFactory subscriberFactory)

Method Summary

Modifier and Type	Method	Description
abstract void	clearAllEntities(Location pos1, Location pos2)
boolean	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 int[]	countEntities(Plot plot)	0 = Entity 1 = Animal 2 = Monster 3 = Mob 4 = Boat 5 = Misc
void	deleteRegionFiles(String world, Collection<BlockVector2> chunks, Runnable whenDone)
static BlockVector2	getRegion(Location location)
abstract boolean	handleClear(@NonNull Plot plot, @Nullable Runnable whenDone, @NonNull PlotManager manager, @Nullable PlotPlayer<?> actor)	Only called when notifyClear(PlotManager) returns true in specific PlotManagers
boolean	notifyClear(PlotManager manager)	Notify any plugins that may want to modify clear behaviour that a clear is occuring
abstract boolean	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
void	setBiome(CuboidRegion region, int extendBiome, BiomeType biome, PlotArea area, Runnable whenDone)	Set a region to a biome type.
void	setBiome(CuboidRegion region, int extendBiome, BiomeType biome, String world, Runnable whenDone)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	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.
void	swap(Location pos1, Location pos2, Location swapPos, @Nullable PlotPlayer<?> actor, Runnable whenDone)	Swap two regions within the same world

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

manager

public static RegionManager manager

worldUtil

protected final WorldUtil worldUtil

Constructor Details

RegionManager

@Inject
public RegionManager(@NonNull WorldUtil worldUtil,
 @NonNull GlobalBlockQueue blockQueue,
 @NonNull ProgressSubscriberFactory subscriberFactory)

Method Details

getRegion

public static BlockVector2 getRegion(Location location)

countEntities

public abstract int[] countEntities(Plot plot)

0 = Entity 1 = Animal 2 = Monster 3 = Mob 4 = Boat 5 = Misc

Parameters:

plot - plot

Returns:

array of counts of entity types

deleteRegionFiles

public void deleteRegionFiles(String world,
 Collection<BlockVector2> chunks,
 Runnable whenDone)

setCuboids

public boolean 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.

Parameters:

area - plot area

regions - cuboid regions

blocks - pattern

minY - y to set from

maxY - y to set to

actor - the actor associated with the cuboid set

queue - Nullable QueueCoordinator. If null, creates own queue and enqueues, otherwise writes to the queue but does not enqueue.

Returns:

true if not enqueued, otherwise whether the created queue enqueued.

notifyClear

public boolean notifyClear(PlotManager manager)

Notify any plugins that may want to modify clear behaviour that a clear is occuring

Parameters:

manager - plot manager

Returns:

true if the notified will accept the clear task

handleClear

public abstract boolean handleClear(@NonNull Plot plot,
 @Nullable Runnable whenDone,
 @NonNull PlotManager manager,
 @Nullable PlotPlayer<?> actor)

Only called when notifyClear(PlotManager) returns true in specific PlotManagers

Parameters:

plot - plot

whenDone - task to run when complete

manager - plot manager

actor - the player running the clear

Returns:

true if the clear worked. false if someone went wrong so PlotSquared can then handle the clear

copyRegion

public boolean 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)

Parameters:

pos1 - position 1

pos2 - position 2

newPos - position to move pos1 to

actor - the actor associated with the region copy

whenDone - task to run when complete

Returns:

success or not

regenerateRegion

public abstract boolean 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

Parameters:

pos1 - position 1

pos2 - position 2

ignoreAugment - if to bypass synchronisation ish thing

whenDone - task to run when regeneration completed

Returns:

success or not

clearAllEntities

public abstract void clearAllEntities(Location pos1,
 Location pos2)

swap

public void swap(Location pos1,
 Location pos2,
 Location swapPos,
 @Nullable PlotPlayer<?> actor,
 Runnable whenDone)

Swap two regions within the same world

Parameters:

pos1 - position 1

pos2 - position 2

swapPos - position to swap with

actor - the actor associated with the region copy

whenDone - task to run when complete

setBiome

@Deprecated(forRemoval=true,
            since="6.6.0")
public void setBiome(CuboidRegion region,
 int extendBiome,
 BiomeType biome,
 String world,
 Runnable whenDone)

Deprecated, for removal: This API element is subject to removal in a future version.

setBiome

public void setBiome(CuboidRegion region,
 int extendBiome,
 BiomeType biome,
 PlotArea area,
 Runnable whenDone)

Set a region to a biome type.

Parameters:

region - region to set

extendBiome - how far outside the region to extent setting the biome too account for 3D biomes being 4x4

biome - biome to set

area - PlotArea in which the biome is being set

whenDone - task to run when complete

Since:

6.6.0