Package org.spongepowered.api.world.volume.game

Interface Region<R extends Region<R>>

All Superinterfaces:

BiomeVolume, BiomeVolume.Streamable<R>, BlockEntityVolume, BlockEntityVolume.Streamable<R>, BlockVolume, BlockVolume.Streamable<R>, ChunkVolume, EnvironmentalVolume, HeightAwareVolume, LocationBaseDataHolder, PrimitiveGameVolume, RandomProvider, Volume

All Known Subinterfaces:

ClientWorld, GenerationRegion, ServerWorld, World<W,L>, WorldLike<P>

public interface Region<R extends Region<R>>
extends EnvironmentalVolume, BiomeVolume.Streamable<R>, BlockVolume.Streamable<R>, BlockEntityVolume.Streamable<R>, ChunkVolume, HeightAwareVolume, RandomProvider

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.world.volume.biome.BiomeVolume

BiomeVolume.Immutable, BiomeVolume.Modifiable<M extends BiomeVolume.Modifiable<M>>, BiomeVolume.Mutable, BiomeVolume.Streamable<B extends BiomeVolume.Streamable<B>>, BiomeVolume.Unmodifiable<U extends BiomeVolume.Unmodifiable<U>>

Nested classes/interfaces inherited from interface org.spongepowered.api.world.volume.block.entity.BlockEntityVolume

BlockEntityVolume.Modifiable<M extends BlockEntityVolume.Modifiable<M>>, BlockEntityVolume.Mutable, BlockEntityVolume.Streamable<T extends BlockEntityVolume.Streamable<T>>, BlockEntityVolume.Unmodifiable<U extends BlockEntityVolume.Unmodifiable<U>>

Nested classes/interfaces inherited from interface org.spongepowered.api.world.volume.block.BlockVolume

BlockVolume.Immutable, BlockVolume.Modifiable<M extends BlockVolume.Modifiable<M>>, BlockVolume.Mutable, BlockVolume.Streamable<B extends BlockVolume.Streamable<B>>, BlockVolume.Unmodifiable<U extends BlockVolume.Unmodifiable<U>>

Nested classes/interfaces inherited from interface org.spongepowered.api.world.volume.game.LocationBaseDataHolder

LocationBaseDataHolder.Mutable

Method Summary

Modifier and Type	Method	Description
WorldBorder	border()	Gets the WorldBorder for this Region.
boolean	canSeeSky(int x, int y, int z)
default boolean	canSeeSky(Vector3i position)
boolean	containsAnyLiquids(AABB aabb)
boolean	hasLiquid(int x, int y, int z)
default boolean	hasLiquid(Vector3i position)
boolean	isAreaLoaded(int xStart, int yStart, int zStart, int xEnd, int yEnd, int zEnd, boolean allowEmpty)
default boolean	isAreaLoaded(Vector3i position, int radius)
default boolean	isAreaLoaded(Vector3i center, int radius, boolean allowEmpty)
default boolean	isAreaLoaded(Vector3i from, Vector3i to)
default boolean	isAreaLoaded(Vector3i from, Vector3i to, boolean allowEmpty)
default boolean	isBlockLoaded(int x, int y, int z)
default boolean	isBlockLoaded(int x, int y, int z, boolean allowEmpty)
default boolean	isBlockLoaded(Vector3i position)
default boolean	isBlockLoaded(Vector3i position, boolean allowEmpty)
boolean	isCollisionBoxesEmpty(@Nullable Entity entity, AABB aabb)
boolean	isInBorder(Entity entity)
int	seaLevel()	Gets the sea level of the world.
WorldBorder	setBorder(WorldBorder worldBorder)	Sets ths WorldBorder for this Region.
int	skylightSubtracted()
WorldType	worldType()

Methods inherited from interface org.spongepowered.api.world.volume.biome.BiomeVolume

biome, biome

Methods inherited from interface org.spongepowered.api.world.volume.biome.BiomeVolume.Streamable

biomeStream

Methods inherited from interface org.spongepowered.api.world.volume.block.entity.BlockEntityVolume

blockEntities, blockEntities, blockEntity, blockEntity

Methods inherited from interface org.spongepowered.api.world.volume.block.entity.BlockEntityVolume.Streamable

blockEntityStream

Methods inherited from interface org.spongepowered.api.world.volume.block.BlockVolume

block, block, fluid, fluid, highestPositionAt, highestYAt, highestYAt

Methods inherited from interface org.spongepowered.api.world.volume.block.BlockVolume.Streamable

blockStateStream

Methods inherited from interface org.spongepowered.api.world.volume.game.ChunkVolume

chunk, chunk, chunkAtBlock, chunkAtBlock, chunkLayout, hasChunk, hasChunk, hasChunkAtBlock, hasChunkAtBlock, isChunkLoaded, isChunkLoaded, isChunkLoadedAtBlock, isChunkLoadedAtBlock

Methods inherited from interface org.spongepowered.api.world.volume.game.EnvironmentalVolume

isSkylightMax, light, light, light, light, light, light

Methods inherited from interface org.spongepowered.api.world.volume.game.HeightAwareVolume

height, height

Methods inherited from interface org.spongepowered.api.world.volume.game.LocationBaseDataHolder

get, get, get, get, getDouble, getDouble, getDouble, getDouble, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getValue, getValue, getValue, getValue, getValues, getValues, keys, keys, orElse, orElse, orElse, orElse, orElse, orElse, orElse, orElse, orNull, orNull, orNull, orNull, require, require, require, require, supports, supports, supports, supports, supports, supports

Methods inherited from interface org.spongepowered.api.world.volume.game.PrimitiveGameVolume

emittedLight, emittedLight, height, maximumLight

Methods inherited from interface org.spongepowered.api.util.RandomProvider

random

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

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

Method Detail

worldType

WorldType worldType()

border

WorldBorder border()

Gets the WorldBorder for this Region.

Returns:

The border.

setBorder

WorldBorder setBorder(WorldBorder worldBorder)

Sets ths WorldBorder for this Region.

As events may alter the final border set to the

Parameters:

worldBorder - The border to set.

Returns:

The WorldBorder that was set, which may not be the border that was provided.

isInBorder

boolean isInBorder(Entity entity)

canSeeSky

default boolean canSeeSky(Vector3i position)

canSeeSky

boolean canSeeSky(int x,
                  int y,
                  int z)

hasLiquid

default boolean hasLiquid(Vector3i position)

hasLiquid

boolean hasLiquid(int x,
                  int y,
                  int z)

containsAnyLiquids

boolean containsAnyLiquids(AABB aabb)

skylightSubtracted

int skylightSubtracted()

seaLevel

int seaLevel()

Gets the sea level of the world.

Returns:

The sea level

isCollisionBoxesEmpty

boolean isCollisionBoxesEmpty(@Nullable Entity entity,
                              AABB aabb)

isBlockLoaded

default boolean isBlockLoaded(int x,
                              int y,
                              int z)

isBlockLoaded

default boolean isBlockLoaded(int x,
                              int y,
                              int z,
                              boolean allowEmpty)

isBlockLoaded

default boolean isBlockLoaded(Vector3i position)

isBlockLoaded

default boolean isBlockLoaded(Vector3i position,
                              boolean allowEmpty)

isAreaLoaded

default boolean isAreaLoaded(Vector3i position,
                             int radius)

isAreaLoaded

default boolean isAreaLoaded(Vector3i center,
                             int radius,
                             boolean allowEmpty)

isAreaLoaded

default boolean isAreaLoaded(Vector3i from,
                             Vector3i to)

isAreaLoaded

default boolean isAreaLoaded(Vector3i from,
                             Vector3i to,
                             boolean allowEmpty)

isAreaLoaded

boolean isAreaLoaded(int xStart,
                     int yStart,
                     int zStart,
                     int xEnd,
                     int yEnd,
                     int zEnd,
                     boolean allowEmpty)