org.spongepowered.api.event.world

Interface ChunkPreGenerationEvent.Pre

All Superinterfaces:

Cancellable, ChunkPreGenerationEvent, Event, TargetWorldEvent

Enclosing interface:

ChunkPreGenerationEvent

public static interface ChunkPreGenerationEvent.Pre
extends ChunkPreGenerationEvent, Cancellable

Event fired when chunks are about to be generated. Cancelling this task will cancel the entire pre-generation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.event.world.ChunkPreGenerationEvent

ChunkPreGenerationEvent.Cancelled, ChunkPreGenerationEvent.Complete, ChunkPreGenerationEvent.Post, ChunkPreGenerationEvent.Pre

Method Summary

Modifier and Type	Method and Description
boolean	getSkipStep() Returns whether the chunk generator will skip generation this time around.
void	setSkipStep(boolean skipStep) Sets whether the next step should be skipped.

Methods inherited from interface org.spongepowered.api.event.world.ChunkPreGenerationEvent

getChunkPreGenerate

Methods inherited from interface org.spongepowered.api.event.world.TargetWorldEvent

getTargetWorld

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Methods inherited from interface org.spongepowered.api.event.Cancellable

isCancelled, setCancelled

Method Detail

getSkipStep

boolean getSkipStep()

Returns whether the chunk generator will skip generation this time around. This only prevents the next step from being performed.

Use Cancellable.isCancelled() to check for cancellation of the entire generation task.

Returns:

true if the next step will be skipped.

setSkipStep

void setSkipStep(boolean skipStep)

Sets whether the next step should be skipped.

Use Cancellable.setCancelled(boolean) to cancel the entire pre generation task.

Parameters:

skipStep - If set to true, the next step will be skipped.