org.spongepowered.api.effect.particle

Interface ParticleType

All Superinterfaces:

CatalogType

@CatalogedBy(value=ParticleTypes.class)
public interface ParticleType
extends CatalogType

Represents a particle that can be sent on a Minecraft client.

Method Summary

Modifier and Type	Method and Description
<V> Optional<V>	getDefaultOption(ParticleOption<V> option) Gets the default value for the specified ParticleOption, it may return Optional.empty() if the particle option isn't supported by this particle type.
Map<ParticleOption<?>,Object>	getDefaultOptions() Gets a immutable Map with all the available ParticleOptions and their values.

Methods inherited from interface org.spongepowered.api.CatalogType

getId, getName

Method Detail

getDefaultOption

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

Gets the default value for the specified ParticleOption, it may return Optional.empty() if the particle option isn't supported by this particle type.

Type Parameters:

V - The value type

Parameters:

option - The particle option

Returns:

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

getDefaultOptions

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

Gets a immutable Map with all the available ParticleOptions and their values. When a option isn't available inside this Map it's most likely not supported by this particle type.

Returns:

The default options