Package com.plotsquared.core.queue

Class ScopedQueueCoordinator

java.lang.Object

com.plotsquared.core.queue.QueueCoordinator

com.plotsquared.core.queue.DelegateQueueCoordinator

com.plotsquared.core.queue.ScopedQueueCoordinator

Direct Known Subclasses:

ChunkQueueCoordinator

public class ScopedQueueCoordinator
extends DelegateQueueCoordinator

Queue that only sets blocks with a designated area

Constructor Summary

Constructors

Constructor	Description
ScopedQueueCoordinator(@Nullable QueueCoordinator parent, @NonNull Location min, @NonNull Location max)	Create a new ScopedQueueCoordinator instance that delegates to a given QueueCoordinator.

Method Summary

Modifier and Type	Method	Description
void	fillBiome(BiomeType biome)
@NonNull Location	getMax()
@NonNull Location	getMin()
boolean	setBiome(int x, int y, int z, @NonNull BiomeType biome)	Set a biome in XYZ
boolean	setBiome(int x, int z, @NonNull BiomeType biome)	Set a biome in XZ.
boolean	setBlock(int x, int y, int z, @NonNull Pattern pattern)	Sets the block at the coordinates provided to the given id.
boolean	setBlock(int x, int y, int z, @NonNull BaseBlock id)	Sets the block at the coordinates provided to the given id.
boolean	setBlock(int x, int y, int z, @NonNull BlockState id)	Sets the block at the coordinates provided to the given id.
boolean	setTile(int x, int y, int z, @NonNull CompoundTag tag)	Sets a tile entity at the coordinates provided to the given CompoundTag

Methods inherited from class com.plotsquared.core.queue.DelegateQueueCoordinator

addProgressSubscriber, addReadChunk, addReadChunks, cancel, enqueue, getBlock, getChunkConsumer, getCompleteTask, getLightingMode, getParent, getReadChunks, getRegenRegion, getWorld, isSettingBiomes, isSettingTiles, isUnloadAfter, regenChunk, setChunkConsumer, setCompleteTask, setEntity, setLightingMode, setModified, setRegenRegion, setUnloadAfter, size, start

Methods inherited from class com.plotsquared.core.queue.QueueCoordinator

addEntities, getChunkObject, getForChunk, getForChunk, getMaxLayer, getMaxY, getMinLayer, getMinY, isForceSync, setBiomeCuboid, setChunkObject, setCuboid, setCuboid, setForceSync, setModified

Methods inherited from class java.lang.Object

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

Constructor Details

ScopedQueueCoordinator

public ScopedQueueCoordinator(@Nullable QueueCoordinator parent,
 @NonNull Location min,
 @NonNull Location max)

Create a new ScopedQueueCoordinator instance that delegates to a given QueueCoordinator. Locations are inclusive.

Method Details

setBiome

public boolean setBiome(int x,
 int z,
 @NonNull BiomeType biome)

Description copied from class: QueueCoordinator

Set a biome in XZ. This will likely set to the whole column

Overrides:

setBiome in class DelegateQueueCoordinator

Parameters:

x - x coordinate

z - z coordinate

biome - biome

Returns:

success or not

setBiome

public boolean setBiome(int x,
 int y,
 int z,
 @NonNull BiomeType biome)

Description copied from class: QueueCoordinator

Set a biome in XYZ

Overrides:

setBiome in class DelegateQueueCoordinator

Parameters:

x - x coordinate

y - y coordinate

z - z coordinate

biome - biome

Returns:

success or not

fillBiome

public void fillBiome(BiomeType biome)

setBlock

public boolean setBlock(int x,
 int y,
 int z,
 @NonNull BaseBlock id)

Description copied from class: QueueCoordinator

Sets the block at the coordinates provided to the given id.

Overrides:

setBlock in class DelegateQueueCoordinator

Parameters:

x - the x coordinate from from 0 to 15 inclusive

y - the y coordinate from from 0 (inclusive) - maxHeight(exclusive)

z - the z coordinate from 0 to 15 inclusive

id - the BaseBlock to set the block to

Returns:

success or not

setBlock

public boolean setBlock(int x,
 int y,
 int z,
 @NonNull BlockState id)

Description copied from class: QueueCoordinator

Sets the block at the coordinates provided to the given id.

Overrides:

setBlock in class DelegateQueueCoordinator

Parameters:

x - the x coordinate from from 0 to 15 inclusive

y - the y coordinate from from 0 (inclusive) - maxHeight(exclusive)

z - the z coordinate from 0 to 15 inclusive

id - the BlockState to set the block to

Returns:

success or not

setBlock

public boolean setBlock(int x,
 int y,
 int z,
 @NonNull Pattern pattern)

Description copied from class: QueueCoordinator

Sets the block at the coordinates provided to the given id.

Overrides:

setBlock in class DelegateQueueCoordinator

Parameters:

x - the x coordinate from from 0 to 15 inclusive

y - the y coordinate from from 0 (inclusive) - maxHeight(exclusive)

z - the z coordinate from 0 to 15 inclusive

pattern - the pattern to set the block to

Returns:

success or not

setTile

public boolean setTile(int x,
 int y,
 int z,
 @NonNull CompoundTag tag)

Description copied from class: QueueCoordinator

Sets a tile entity at the coordinates provided to the given CompoundTag

Overrides:

setTile in class DelegateQueueCoordinator

Parameters:

x - the x coordinate from from 0 to 15 inclusive

y - the y coordinate from from 0 (inclusive) - maxHeight(exclusive)

z - the z coordinate from 0 to 15 inclusive

tag - the CompoundTag to set the tile to

Returns:

success or not

getMin

public @NonNull Location getMin()

getMax

public @NonNull Location getMax()