Package org.spongepowered.api.world.volume.stream

Interface StreamOptions

public interface StreamOptions

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	StreamOptions.Builder
static enum	StreamOptions.LoadingStyle

Method Summary

Modifier and Type	Method	Description
static StreamOptions.Builder	builder()
boolean	carbonCopy()	Whether a carbon copy of the area requested for the stream will be offloaded into a separated Volume such that the stream would be unaffected by other operations being performed in the targeted Volume (like block replacements).
static StreamOptions	forceLoadedAndCopied()
static StreamOptions	lazily()
StreamOptions.LoadingStyle	loadingStyle()	Determines the loading style of sections to populate elements for a Stream, such that the area may be pre-calculated or the elements precalculated based

Method Details

builder

static StreamOptions.Builder builder()

lazily

static StreamOptions lazily()

forceLoadedAndCopied

static StreamOptions forceLoadedAndCopied()

carbonCopy

boolean carbonCopy()

Whether a carbon copy of the area requested for the stream will be offloaded into a separated Volume such that the stream would be unaffected by other operations being performed in the targeted Volume (like block replacements). This may be expensive to perform overall on a larger scale, but effectively can be safer to perform sensitive filtering operations.

Returns:

True if a copy of the volume's stream targets will be made

loadingStyle

StreamOptions.LoadingStyle loadingStyle()

Determines the loading style of sections to populate elements for a Stream, such that the area may be pre-calculated or the elements precalculated based

Returns:

the loading style