ParticleOptions (SpongeAPI 7.2.0 API)

java.lang.Object
- org.spongepowered.api.effect.particle.ParticleOptions

```
public final class ParticleOptions
extends Object
```
An enumeration of all possible ParticleOptions in vanilla minecraft.

Field Summary

Fields
Modifier and Type	Field and Description
`static ParticleOption<BlockState>`	`BLOCK_STATE` This option will affect the appearance of a particle.
`static ParticleOption<Color>`	`COLOR` This option will modify the color of a particle.
`static ParticleOption<Direction>`	`DIRECTION` This option will change the direction of a particle.
`static ParticleOption<List<FireworkEffect>>`	`FIREWORK_EFFECTS` This option will modify the color of a particle.
`static ParticleOption<ItemStackSnapshot>`	`ITEM_STACK_SNAPSHOT` This option will affect the appearance of a particle.
`static ParticleOption<NotePitch>`	`NOTE` This option will affect the appearance of a particle.
`static ParticleOption<com.flowpowered.math.vector.Vector3d>`	`OFFSET` This option will affect how all the particles are spread.
`static ParticleOption<PotionEffectType>`	`POTION_EFFECT_TYPE` This option will change the potion type of a particle.
`static ParticleOption<Integer>`	`QUANTITY` This option will affect the amount of particles that are spawned.
`static ParticleOption<Double>`	`SCALE` This option will change the scale of a particle.
`static ParticleOption<Boolean>`	`SLOW_HORIZONTAL_VELOCITY` This option will affect whether a particle type will have a lower velocity in the horizontal plane.
`static ParticleOption<com.flowpowered.math.vector.Vector3d>`	`VELOCITY` This option will affect how all the particles are moving.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BLOCK_STATE
```
public static final ParticleOption<BlockState> BLOCK_STATE
```
    This option will affect the appearance of a particle. The only vanilla ParticleTypes that this option is applicable to are:
  - COLOR
```
public static final ParticleOption<Color> COLOR
```
    This option will modify the color of a particle. The only vanilla ParticleTypes this option is applicable to are:
  - DIRECTION
```
public static final ParticleOption<Direction> DIRECTION
```
    This option will change the direction of a particle.
  - FIREWORK_EFFECTS
```
public static final ParticleOption<List<FireworkEffect>> FIREWORK_EFFECTS
```
    This option will modify the color of a particle. The only vanilla ParticleTypes this option is applicable to is ParticleTypes.FIREWORKS.
    The List may never be empty. Or a IllegalArgumentException will be thrown when applying.
  - ITEM_STACK_SNAPSHOT
```
public static final ParticleOption<ItemStackSnapshot> ITEM_STACK_SNAPSHOT
```
    This option will affect the appearance of a particle. The only vanilla ParticleType this option is applicable to are:
  - NOTE
```
public static final ParticleOption<NotePitch> NOTE
```
    This option will affect the appearance of a particle. The only vanilla ParticleType this option is applicable to is ParticleTypes.NOTE.
  - OFFSET
```
public static final ParticleOption<com.flowpowered.math.vector.Vector3d> OFFSET
```
    This option will affect how all the particles are spread.
  - POTION_EFFECT_TYPE
```
public static final ParticleOption<PotionEffectType> POTION_EFFECT_TYPE
```
    This option will change the potion type of a particle. The only vanilla ParticleTypes this option is applicable to is ParticleTypes.SPLASH_POTION.
  - QUANTITY
```
public static final ParticleOption<Integer> QUANTITY
```
    This option will affect the amount of particles that are spawned. The minimum amount of particles is 1. The only vanilla ParticleTypes this option isn't applicable to are:
    The quantity must be at least 1, or a IllegalArgumentException will be thrown when applying.
  - SCALE
```
public static final ParticleOption<Double> SCALE
```
    This option will change the scale of a particle. The only vanilla ParticleTypes this option is applicable to are:
    - ParticleTypes.LARGE_EXPLOSION
    - ParticleTypes.SWEEP_ATTACK
    The scale may never be negative, or a IllegalArgumentException will be thrown when applying.
  - SLOW_HORIZONTAL_VELOCITY
```
public static final ParticleOption<Boolean> SLOW_HORIZONTAL_VELOCITY
```
    This option will affect whether a particle type will have a lower velocity in the horizontal plane. The only vanilla ParticleTypes that this option will affect are:
    These particle types don't have a configurable velocity (through VELOCITY) in the horizontal plane.
  - VELOCITY
```
public static final ParticleOption<com.flowpowered.math.vector.Vector3d> VELOCITY
```
    This option will affect how all the particles are moving.

Class ParticleOptions

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BLOCK_STATE

COLOR

DIRECTION

FIREWORK_EFFECTS

ITEM_STACK_SNAPSHOT

NOTE

OFFSET

POTION_EFFECT_TYPE

QUANTITY

SCALE

SLOW_HORIZONTAL_VELOCITY

VELOCITY