Class AbsoluteBlockBatch

java.lang.Object

net.minestom.server.instance.batch.AbsoluteBlockBatch

All Implemented Interfaces:

Batch<Consumer<AbsoluteBlockBatch>>, Block.Setter

public class AbsoluteBlockBatch
extends Object
implements Batch<Consumer<AbsoluteBlockBatch>>

A Batch which can be used when changes are required across chunk borders, but the changes do not need any translation. If translation is required, use a RelativeBlockBatch instead.

Coordinates are relative to the world origin.

See Also:

• Batch
• RelativeBlockBatch

Field Summary

Fields

Modifier and Type	Field	Description
protected final CountDownLatch	readyLatch

Fields inherited from interface Batch

BLOCK_BATCH_POOL

Constructor Summary

Constructors

Constructor	Description
AbsoluteBlockBatch()
AbsoluteBlockBatch(BatchOption options)

Method Summary

Modifier and Type	Method	Description
@UnknownNullability AbsoluteBlockBatch	apply(Instance instance, @Nullable Consumer<@UnknownNullability AbsoluteBlockBatch> callback)	Applies this batch to the given instance.
protected @UnknownNullability AbsoluteBlockBatch	apply(Instance instance, @Nullable Consumer<@UnknownNullability AbsoluteBlockBatch> callback, boolean safeCallback)	Applies this batch to the given instance, and execute the callback depending on safeCallback.
void	awaitReady()	Blocks the current thread until the batch is ready to be applied.
void	clear()	Removes all block data from this batch.
BatchOption	getInverseOption()
boolean	isReady()	Gets if the batch is ready to be applied to an instance.
void	setBlock(int x, int y, int z, Block block)
void	setInverseOption(BatchOption inverseOption)
@UnknownNullability AbsoluteBlockBatch	unsafeApply(Instance instance, @Nullable Consumer<@UnknownNullability AbsoluteBlockBatch> callback)	Applies this batch to the given instance, and execute the callback immediately when the blocks have been applied, in an unknown thread.

Methods inherited from class Object

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

Methods inherited from interface Block.Setter

setBlock, setBlockArea

Field Details

readyLatch

protected final CountDownLatch readyLatch

Constructor Details

AbsoluteBlockBatch

public AbsoluteBlockBatch()

AbsoluteBlockBatch

public AbsoluteBlockBatch(BatchOption options)

Method Details

setBlock

public void setBlock(int x,
 int y,
 int z,
 Block block)

Specified by:

setBlock in interface Block.Setter

clear

public void clear()

Description copied from interface: Batch

Removes all block data from this batch.

Specified by:

clear in interface Batch<Consumer<AbsoluteBlockBatch>>

isReady

public boolean isReady()

Description copied from interface: Batch

Gets if the batch is ready to be applied to an instance.

Specified by:

isReady in interface Batch<Consumer<AbsoluteBlockBatch>>

Returns:

true if the batch is ready to apply

awaitReady

public void awaitReady()

Description copied from interface: Batch

Blocks the current thread until the batch is ready to be applied.

Specified by:

awaitReady in interface Batch<Consumer<AbsoluteBlockBatch>>

See Also:

• for a non-blocking way to determine if the batch is ready

apply

public @UnknownNullability AbsoluteBlockBatch apply(Instance instance,
 @Nullable
 @Nullable Consumer<@UnknownNullability AbsoluteBlockBatch> callback)

Applies this batch to the given instance.

Specified by:

apply in interface Batch<Consumer<AbsoluteBlockBatch>>

Parameters:

instance - The instance in which the batch should be applied

callback - The callback to be executed when the batch is applied

Returns:

The inverse of this batch, if inverse is enabled in the BatchOption

unsafeApply

public @UnknownNullability AbsoluteBlockBatch unsafeApply(Instance instance,
 @Nullable
 @Nullable Consumer<@UnknownNullability AbsoluteBlockBatch> callback)

Applies this batch to the given instance, and execute the callback immediately when the blocks have been applied, in an unknown thread.

Parameters:

instance - The instance in which the batch should be applied

callback - The callback to be executed when the batch is applied

Returns:

The inverse of this batch, if inverse is enabled in the BatchOption

apply

protected @UnknownNullability AbsoluteBlockBatch apply(Instance instance,
 @Nullable
 @Nullable Consumer<@UnknownNullability AbsoluteBlockBatch> callback,
 boolean safeCallback)

Applies this batch to the given instance, and execute the callback depending on safeCallback.

Parameters:

instance - The instance in which the batch should be applied

callback - The callback to be executed when the batch is applied

safeCallback - If true, the callback will be executed in the next instance update. Otherwise it will be executed immediately upon completion

Returns:

The inverse of this batch, if inverse is enabled in the BatchOption

getInverseOption

public BatchOption getInverseOption()

setInverseOption

public void setInverseOption(BatchOption inverseOption)