org.spongepowered.api.effect.particle

Interface ParticleEffect

All Superinterfaces:

DataSerializable

public interface ParticleEffect
extends DataSerializable

Represents a particle effect that can be send to the Minecraft client.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ParticleEffect.Builder Represents a builder to create a ParticleEffect.

Method Summary

Modifier and Type	Method and Description
static ParticleEffect.Builder	builder() Creates a new ParticleEffect.Builder to build a ParticleEffect.
<V> Optional<V>	getOption(ParticleOption<V> option) Gets the value for the specified ParticleOption.
default <V> Optional<V>	getOptionOrDefault(ParticleOption<V> option) Gets the value for the specified ParticleOption or the default value if not present.
Map<ParticleOption<?>,Object>	getOptions() Gets a immutable Map with all the available ParticleOptions and their values.
ParticleType	getType() Gets the type of the particle effect.

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion, toContainer

Method Detail

builder

static ParticleEffect.Builder builder()

Creates a new ParticleEffect.Builder to build a ParticleEffect.

Returns:

The new builder

getType

ParticleType getType()

Gets the type of the particle effect.

Returns:

The particle type

getOption

<V> Optional<V> getOption(ParticleOption<V> option)

Gets the value for the specified ParticleOption.

Type Parameters:

V - The value type

Parameters:

option - The particle option

Returns:

The option value if present, otherwise Optional.empty()

getOptionOrDefault

default <V> Optional<V> getOptionOrDefault(ParticleOption<V> option)

Gets the value for the specified ParticleOption or the default value if not present.

Type Parameters:

V - The value type

Parameters:

option - The particle option

Returns:

The option value if present, otherwise Optional.empty()

getOptions

Map<ParticleOption<?>,Object> getOptions()

Gets a immutable Map with all the available ParticleOptions and their values.

Returns:

The default options