Enum Class StreamOptions.LoadingStyle
java.lang.Object
java.lang.Enum<StreamOptions.LoadingStyle>
org.spongepowered.api.world.volume.stream.StreamOptions.LoadingStyle
- All Implemented Interfaces:
Serializable
,Comparable<StreamOptions.LoadingStyle>
,Constable
- Enclosing interface:
StreamOptions
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionForces the loading of the entire area to calculate the exact available sections to fetch the predefined stream of elements to populate theVolumeStream
.Forces the loading of the entire area to calculate the exact available sections to fetch the predefined stream of elements to populate theVolumeStream
.Ensures that sections within the area are loaded during stream execution, but unlikeFORCED_GENERATED
, sections will only be loaded duringVolumeStream
execution if and when the section is iterated over, and not pre-loaded beforehand.Ensures that sections within the area are loaded during stream execution, but unlikeFORCED_GENERATED
, sections will only be loaded duringVolumeStream
execution if and when the section is iterated over, and not pre-loaded beforehand.Only requests the available sections of theVolume
without incurring any loading of sections costs, useful for building streams of available elements. -
Method Summary
Modifier and TypeMethodDescriptionabstract boolean
Whether areas are to be requested to be generated prior to streaming over them, somewhat in tandem withStreamOptions.LoadingStyle
, a section can potentially be un-generated and having never been visited before, may be requested to be generated in order for the stream's element type to be operated on.abstract boolean
static StreamOptions.LoadingStyle
Returns the enum constant of this class with the specified name.static StreamOptions.LoadingStyle[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
FORCED_GENERATED
Forces the loading of the entire area to calculate the exact available sections to fetch the predefined stream of elements to populate theVolumeStream
. This will incur an initial cost ofWorld.loadChunk(Vector3i, boolean)
withshouldGenerate =
generateArea()
. -
FORCED_UNGENERATED
Forces the loading of the entire area to calculate the exact available sections to fetch the predefined stream of elements to populate theVolumeStream
. This will incur an initial cost ofWorld.loadChunk(Vector3i, boolean)
withshouldGenerate =
generateArea()
. -
LAZILY_UNGENERATED
Ensures that sections within the area are loaded during stream execution, but unlikeFORCED_GENERATED
, sections will only be loaded duringVolumeStream
execution if and when the section is iterated over, and not pre-loaded beforehand.In the case of a
World
, this will still issue a request for aWorld.loadChunk(int, int, int, boolean)
withshouldGenerate =
generateArea()
. -
LAZILY_GENERATED
Ensures that sections within the area are loaded during stream execution, but unlikeFORCED_GENERATED
, sections will only be loaded duringVolumeStream
execution if and when the section is iterated over, and not pre-loaded beforehand.In the case of a
World
, this will still issue a request for aWorld.loadChunk(int, int, int, boolean)
withshouldGenerate =
generateArea()
. -
NONE
Only requests the available sections of theVolume
without incurring any loading of sections costs, useful for building streams of available elements.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
generateArea
public abstract boolean generateArea()Whether areas are to be requested to be generated prior to streaming over them, somewhat in tandem withStreamOptions.LoadingStyle
, a section can potentially be un-generated and having never been visited before, may be requested to be generated in order for the stream's element type to be operated on. This should incur an additional cost of the stream setup, based on theStreamOptions.LoadingStyle
's request such asFORCED_GENERATED
, orLAZILY_GENERATED
.- Returns:
- Whether sections that are previously empty, should be generated
-
immediateLoading
public abstract boolean immediateLoading()
-