Package org.spongepowered.api.world.volume.archetype.entity

Interface EntityArchetypeVolume.Streamable<B extends EntityArchetypeVolume.Streamable<B>>

All Superinterfaces:

EntityArchetypeVolume, Volume

All Known Subinterfaces:

ArchetypeVolume, EntityArchetypeVolume.Immutable, EntityArchetypeVolume.Modifiable<M>, EntityArchetypeVolume.Mutable, EntityArchetypeVolume.Unmodifiable<U>, Schematic

Enclosing interface:

EntityArchetypeVolume

public static interface EntityArchetypeVolume.Streamable<B extends EntityArchetypeVolume.Streamable<B>>
extends EntityArchetypeVolume

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.world.volume.archetype.entity.EntityArchetypeVolume

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

Method Summary

Modifier and Type	Method	Description
Stream<EntityArchetypeEntry>	entitiesByPosition()	Gets a Stream<EntityArchetypeEntry> from this volume such that possibly multiple EntityArchetypes can exist at the same coordinate position.
VolumeStream<B,EntityArchetype>	entityArchetypeStream(Vector3i min, Vector3i max, StreamOptions options)	Gets a VolumeStream<B, EntityArchetype> from this volume such that the min and max are contained within this volume.

Methods inherited from interface org.spongepowered.api.world.volume.archetype.entity.EntityArchetypeVolume

entityArchetypes, entityArchetypes, entityArchetypesByPosition

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

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

Method Details

entityArchetypeStream

VolumeStream<B,EntityArchetype> entityArchetypeStream(Vector3i min,
 Vector3i max,
 StreamOptions options)

Gets a VolumeStream<B, EntityArchetype> from this volume such that the min and max are contained within this volume.

Parameters:

min - The minimum coordinate set

max - The maximum coordinate set

options - The options to construct the stream

Returns:

The volume stream

entitiesByPosition

Stream<EntityArchetypeEntry> entitiesByPosition()

Gets a Stream<EntityArchetypeEntry> from this volume such that possibly multiple EntityArchetypes can exist at the same coordinate position. A more precise variation of entityArchetypeStream(Vector3i, Vector3i, StreamOptions) that populates the entire stream of existing archetypes, regardless of position.

Note that it may be possible the archetypes are returned as copies in the case of an immutable volume. It is advisable that mutating the returned archetypes are destined for submission to either a EntityArchetypeVolume.Mutable or being applied to an EntityVolume.Mutable directly after the fact.

Returns:

The stream