Package org.spongepowered.api.effect.particle

Interface ParticleType

All Superinterfaces:
DefaultedRegistryValue
@CatalogedBy(ParticleTypes.class) public interface ParticleType extends DefaultedRegistryValue
Represents a particle that can be sent on a Minecraft client.

  • Method Details

    • defaultOption

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

    • defaultOption

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

    • defaultOptions

      Map<ParticleOption<?>,Object> defaultOptions()
      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