Package org.spongepowered.api.world.volume.virtual

Interface Virtualized<T,R extends Volume>

All Superinterfaces:

Volume

All Known Subinterfaces:

UnrealizedBiomeVolume<B>, UnrealizedBiomeVolume.Immutable, UnrealizedBiomeVolume.Modifiable<B,MB>, UnrealizedBiomeVolume.Mutable, UnrealizedBiomeVolume.Streamable<B,BU>, UnrealizedBiomeVolume.Unmodifiable<U,BU>, Virtualized.Mutable<T,M,MU>, Virtualized.Streamable<T,B,S>, Virtualized.Unmodifiable<T,U,RU>

public interface Virtualized<T,R extends Volume>
extends Volume

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Virtualized.Immutable
static interface	Virtualized.Mutable<T,M extends Virtualized.Mutable<T,M,MU>,MU extends Volume>
static interface	Virtualized.Streamable<T,B extends Virtualized.Streamable<T,B,S>,S extends Volume>
static interface	Virtualized.Unmodifiable<T,U extends Virtualized.Unmodifiable<T,U,RU>,RU extends Volume>	Like a BlockVolume except in the case that while the parent volume can potentially be a MutableVolume, this volume returned will not be.

Method Summary

Modifier and Type	Method	Description
ResourceKey	at(int x, int y, int z)	Gets the Biome at the given location.
default Optional<T>	at(int x, int y, int z, Registry<T> registry)
default ResourceKey	at(Vector3i position)	Gets an object representing the biome at the given position.
default Optional<T>	at(Vector3i position, Registry<T> registry)
R	realize(Registry<T> registry)

Methods inherited from interface org.spongepowered.api.world.volume.Volume

available, contains, contains, isAreaAvailable, max, min, size

Method Detail

realize

R realize(Registry<T> registry)

at

default ResourceKey at(Vector3i position)

Gets an object representing the biome at the given position.

Parameters:

position - The position

Returns:

The biome

Throws:

PositionOutOfBoundsException - If the position is outside of the bounds of the volume

at

ResourceKey at(int x,
               int y,
               int z)

Gets the Biome at the given location.

Parameters:

x - The X position

y - The Y position

z - The Z position

Returns:

The biome

Throws:

PositionOutOfBoundsException - If the position is outside of the bounds of the volume

at

default Optional<T> at(Vector3i position,
                       Registry<T> registry)

at

default Optional<T> at(int x,
                       int y,
                       int z,
                       Registry<T> registry)