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

Class VolumeApplicators

java.lang.Object

org.spongepowered.api.world.volume.stream.VolumeApplicators

public final class VolumeApplicators
extends Object

A collection of default implemented VolumeApplicators for various "traditional" use cases.

Method Summary

Modifier and Type	Method	Description
static <M extends BiomeVolume.Modifiable<M>> VolumeApplicator<M,Biome,Boolean>	applyBiomes()	A potentially useful VolumeApplicator that attempts to apply a Biome onto a target BiomeVolume, returning boolean whether the biome was successfully set.
static <M extends BlockEntityVolume.Modifiable<M>> VolumeApplicator<M,BlockEntity,Boolean>	applyBlockEntities()	A generic applicator to add a BlockEntity to a target volume.
static <M extends BlockEntityVolume.Modifiable<M> & LocationCreator<@NonNull ?, ? extends ServerLocation>> VolumeApplicator<M,BlockEntityArchetype,Optional<? extends BlockEntity>>	applyBlockEntityArchetype()	A potentially useful VolumeApplicator that attempts to apply a BlockEntityArchetype onto a target BlockEntityVolume, optionally returning a newly placed BlockEntity.
static <M extends BlockEntityArchetypeVolume.Modifiable<M>> VolumeApplicator<M,BlockEntityArchetype,Boolean>	applyBlockEntityArchetypes()	A potentially useful VolumeApplicator that attempts to apply a BlockEntityArchetype onto a target BlockEntityVolume, optionally returning a newly placed BlockEntity.
static <M extends BlockVolume.Modifiable<M>> VolumeApplicator<M,BlockState,Boolean>	applyBlocks()	A standard VolumeApplicator that applies a BlockState to any BlockVolume.Modifiable.
static <M extends PhysicsAwareMutableBlockVolume<M>> VolumeApplicator<M,BlockState,Boolean>	applyBlocks(BlockChangeFlag flag)	Creates a "physics aware" variation of a VolumeApplicator that applies BlockStates with side effects in accordance with the passed in BlockChangeFlag.
static <M extends EntityVolume.Modifiable<M>> VolumeApplicator<M,Entity,Boolean>	applyEntities()	A potentially useful VolumeApplicator that attempts to apply a Entity onto a target EntityVolume, returning boolean whether the entity was successfully spawned.
static <M extends EntityVolume.Modifiable<M> & LocationCreator<@NonNull ?, ? extends ServerLocation>> VolumeApplicator<M,EntityArchetype,Optional<? extends Entity>>	applyEntityArchetype()
static <M extends EntityArchetypeVolume.Modifiable<M>> VolumeApplicator<M,EntityArchetype,Boolean>	applyEntityArchetypes()
static <M extends BlockEntityVolume.Modifiable<M>> VolumeApplicator<M,Optional<? extends BlockEntity>,Boolean>	applyOrRemoveBlockEntities()	A potentially useful VolumeApplicator that conditionally adds or removes a BlockEntity/BlockState based on the element's Optional state of being Optional.empty() or Optional.isPresent().
static <M extends BlockVolume.Modifiable<M>> VolumeApplicator<M,Optional<BlockState>,Boolean>	applyOrRemoveBlockState()	A potentially useful VolumeApplicator that conditionally adds or removes a BlockState based on the element's Optional state of being Optional.empty() or Optional.isPresent().
static <M extends PhysicsAwareMutableBlockVolume<M>> VolumeApplicator<M,Optional<BlockState>,Boolean>	applyOrRemoveBlockState(BlockChangeFlag flag)	A potentially useful VolumeApplicator that conditionally adds or removes a BlockState based on the element's Optional state of being Optional.empty() or Optional.isPresent().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

applyBlocks

public static <M extends BlockVolume.Modifiable<M>>
VolumeApplicator<M,BlockState,Boolean> applyBlocks()

A standard VolumeApplicator that applies a BlockState to any BlockVolume.Modifiable.

Note that this has a different side effect compared to applyBlocks(BlockChangeFlag) if the target volume is a PhysicsAwareMutableBlockVolume due to the nature of applying blocks with a BlockChangeFlag. It can be expected that applying blocks directly with this applicator will likely result in side effects playing out to their full extent per block changed.

Type Parameters:

M - The type of modifiable block volume

Returns:

A blockstate based VolumeApplicator

applyBlocks

public static <M extends PhysicsAwareMutableBlockVolume<M>>
VolumeApplicator<M,BlockState,Boolean> applyBlocks(BlockChangeFlag flag)

Creates a "physics aware" variation of a VolumeApplicator that applies BlockStates with side effects in accordance with the passed in BlockChangeFlag.

Type Parameters:

M - The target volume type that accepts a BlockChangeFlag

Parameters:

flag - The respective change flag to signal what side effects to play out on application

Returns:

A blockstate based VolumeApplicator

applyBlockEntities

public static <M extends BlockEntityVolume.Modifiable<M>>
VolumeApplicator<M,BlockEntity,Boolean> applyBlockEntities()

A generic applicator to add a BlockEntity to a target volume. This does have the best intention of attempting to set the target's container BlockState prior to adding the BlockEntity.

Type Parameters:

M - The type of modifiable volume

Returns:

An applicator to add block entities

applyOrRemoveBlockEntities

public static <M extends BlockEntityVolume.Modifiable<M>>
VolumeApplicator<M,Optional<? extends BlockEntity>,Boolean> applyOrRemoveBlockEntities()

A potentially useful VolumeApplicator that conditionally adds or removes a BlockEntity/BlockState based on the element's Optional state of being Optional.empty() or Optional.isPresent().

Type Parameters:

M - The type of modifiable block entity volume

Returns:

An applicator that conditionally adds block entities or removes blocks

applyOrRemoveBlockState

public static <M extends BlockVolume.Modifiable<M>>
VolumeApplicator<M,Optional<BlockState>,Boolean> applyOrRemoveBlockState()

A potentially useful VolumeApplicator that conditionally adds or removes a BlockState based on the element's Optional state of being Optional.empty() or Optional.isPresent().

Type Parameters:

M - The type of modifiable block volume

Returns:

An applicator that conditionally sets a block or removes a block

applyOrRemoveBlockState

public static <M extends PhysicsAwareMutableBlockVolume<M>>
VolumeApplicator<M,Optional<BlockState>,Boolean> applyOrRemoveBlockState(BlockChangeFlag flag)

A potentially useful VolumeApplicator that conditionally adds or removes a BlockState based on the element's Optional state of being Optional.empty() or Optional.isPresent(). The added change being the flag

Type Parameters:

M - The type of modifiable block volume

Returns:

An applicator that conditionally sets a block or removes a block

applyBlockEntityArchetype

public static <M extends BlockEntityVolume.Modifiable<M> & LocationCreator<@NonNull ?,
? extends ServerLocation>>
VolumeApplicator<M,BlockEntityArchetype,Optional<? extends BlockEntity>> applyBlockEntityArchetype()

A potentially useful VolumeApplicator that attempts to apply a BlockEntityArchetype onto a target BlockEntityVolume, optionally returning a newly placed BlockEntity.

Type Parameters:

M - The type of block entity

Returns:

A volume applicator that applies block entity archetypes

applyBlockEntityArchetypes

public static <M extends BlockEntityArchetypeVolume.Modifiable<M>>
VolumeApplicator<M,BlockEntityArchetype,Boolean> applyBlockEntityArchetypes()

A potentially useful VolumeApplicator that attempts to apply a BlockEntityArchetype onto a target BlockEntityVolume, optionally returning a newly placed BlockEntity.

Type Parameters:

M - The type of block entity

Returns:

A volume applicator that applies block entity archetypes

applyEntities

public static <M extends EntityVolume.Modifiable<M>>
VolumeApplicator<M,Entity,Boolean> applyEntities()

A potentially useful VolumeApplicator that attempts to apply a Entity onto a target EntityVolume, returning boolean whether the entity was successfully spawned.

Type Parameters:

M - The type of entity volume

Returns:

A volume applicator that applies entities to volumes

applyBiomes

public static <M extends BiomeVolume.Modifiable<M>>
VolumeApplicator<M,Biome,Boolean> applyBiomes()

A potentially useful VolumeApplicator that attempts to apply a Biome onto a target BiomeVolume, returning boolean whether the biome was successfully set.

Type Parameters:

M - The type of biome volume

Returns:

A volume applicator that applies biomes to volumes

applyEntityArchetype

public static <M extends EntityVolume.Modifiable<M> & LocationCreator<@NonNull ?,
? extends ServerLocation>>
VolumeApplicator<M,EntityArchetype,Optional<? extends Entity>> applyEntityArchetype()

applyEntityArchetypes

public static <M extends EntityArchetypeVolume.Modifiable<M>>
VolumeApplicator<M,EntityArchetype,Boolean> applyEntityArchetypes()