org.spongepowered.api.world

Interface ChunkPreGenerate

public interface ChunkPreGenerate

Represents an ongoing chunk pre-generation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ChunkPreGenerate.Builder A builder for submitting a task to pre-generate chunks.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels this pre-generation if it is still running.
int	getTargetTotalChunks() The target number of chunks that will be generated or skipped during this generation.
int	getTotalGeneratedChunks() The total number of chunks generated during this generation.
int	getTotalSkippedChunks() The total number of chunks skipped during this generation.
Duration	getTotalTime() Gets the total wall clock time it has taken (so far) to generate chunks.
WorldProperties	getWorldProperties() The WorldProperties of the world that this task is operating on.
boolean	isCancelled() Gets whether the task for this world has been cancelled (or completed).

Method Detail

getWorldProperties

WorldProperties getWorldProperties()

The WorldProperties of the world that this task is operating on.

Returns:

The WorldProperties

getTotalGeneratedChunks

int getTotalGeneratedChunks()

The total number of chunks generated during this generation.

Returns:

The number of chunks.

getTotalSkippedChunks

int getTotalSkippedChunks()

The total number of chunks skipped during this generation.

Returns:

The number of chunks.

getTargetTotalChunks

int getTargetTotalChunks()

The target number of chunks that will be generated or skipped during this generation. This includes chunks already generated or skipped.

Returns:

The total number of chunks to be generated.

getTotalTime

Duration getTotalTime()

Gets the total wall clock time it has taken (so far) to generate chunks.

Returns:

A Duration representing the amount of time taken so far.

isCancelled

boolean isCancelled()

Gets whether the task for this world has been cancelled (or completed).

Returns:

True if cancelled.

cancel

void cancel()

Cancels this pre-generation if it is still running.