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:

BlockArrayCacheScopedQueueCoordinator, ChunkQueueCoordinator

@Deprecated(forRemoval=true,
            since="6.8.0")
public class ScopedQueueCoordinator
extends DelegateQueueCoordinator

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

This should be renamed to NormalizedScopedQueueCoordinator or something.

Queue that only sets blocks with a designated X-Z area, will accept any Y values. Requires all blocks be set normalized in the x and z directions, i.e. starting from 0,0. An offset of the minimum point of the region will then be applied to x and z.

Constructor Summary

Constructors

Constructor	Description
ScopedQueueCoordinator(@Nullable QueueCoordinator parent, @NonNull Location min, @NonNull Location max)	Deprecated, for removal: This API element is subject to removal in a future version. Create a new ScopedQueueCoordinator instance that delegates to a given QueueCoordinator.

Method Summary

Modifier and Type	Method	Description
void	fillBiome(BiomeType biome)	Deprecated, for removal: This API element is subject to removal in a future version.
@NonNull Location	getMax()	Deprecated, for removal: This API element is subject to removal in a future version.
@NonNull Location	getMin()	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	setBiome(int x, int y, int z, @NonNull BiomeType biome)	Deprecated, for removal: This API element is subject to removal in a future version. Set a biome in XYZ
boolean	setBiome(int x, int z, @NonNull BiomeType biome)	Deprecated, for removal: This API element is subject to removal in a future version. Set a biome in XZ.
boolean	setBlock(int x, int y, int z, @NonNull Pattern pattern)	Deprecated, for removal: This API element is subject to removal in a future version. Sets the block at the coordinates provided to the given id.
boolean	setBlock(int x, int y, int z, @NonNull BaseBlock id)	Deprecated, for removal: This API element is subject to removal in a future version. Sets the block at the coordinates provided to the given id.
boolean	setBlock(int x, int y, int z, @NonNull BlockState id)	Deprecated, for removal: This API element is subject to removal in a future version. Sets the block at the coordinates provided to the given id.
boolean	setTile(int x, int y, int z, @NonNull CompoundTag tag)	Deprecated, for removal: This API element is subject to removal in a future version. 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, getSideEffectSet, getWorld, isSettingBiomes, isSettingTiles, isUnloadAfter, regenChunk, setBiomesEnabled, setChunkConsumer, setCompleteTask, setEntity, setLightingMode, setModified, setRegenRegion, setSideEffectSet, 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)

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

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)

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

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)

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

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)

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

setBlock

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

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

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)

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

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)

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

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)

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

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()

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

getMax

public @NonNull Location getMax()

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