Package 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	Description
static interface	ParticleEffect.Builder	Represents a builder to create a ParticleEffect.

Method Summary

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

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

contentVersion, toContainer

Method Details

builder

static ParticleEffect.Builder builder()

Creates a new ParticleEffect.Builder to build a ParticleEffect.

Returns:

The new builder

type

ParticleType type()

Gets the type of the particle effect.

Returns:

The particle type

option

default <V> Optional<V> option(Supplier<? extends 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()

option

<V> Optional<V> option(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()

optionOrDefault

default <V> Optional<V> optionOrDefault(Supplier<? extends 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()

optionOrDefault

default <V> Optional<V> optionOrDefault(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()

options

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

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

Returns:

The default options