Package org.spongepowered.api.effect.particle

Class ParticleOptions

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	Description
static DefaultedRegistryReference<ParticleOption<BlockState>>	BLOCK_STATE	This option will affect the appearance of a particle.
static DefaultedRegistryReference<ParticleOption<Color>>	COLOR	This option will modify the color of a particle.
static DefaultedRegistryReference<ParticleOption<Direction>>	DIRECTION	This option will change the direction of a particle.
static DefaultedRegistryReference<ParticleOption<ItemStackSnapshot>>	ITEM_STACK_SNAPSHOT	This option will affect the appearance of a particle.
static DefaultedRegistryReference<ParticleOption<Vector3d>>	OFFSET	This option will affect how all the particles are spread.
static DefaultedRegistryReference<ParticleOption<PotionEffectType>>	POTION_EFFECT_TYPE	This option will change the potion type of a particle.
static DefaultedRegistryReference<ParticleOption<Integer>>	QUANTITY	This option will affect the amount of particles that are spawned.
static DefaultedRegistryReference<ParticleOption<Double>>	SCALE	This option will change the scale of a particle.
static DefaultedRegistryReference<ParticleOption<Vector3d>>	VELOCITY	This option will affect how most particles are moving.

Method Summary

Modifier and Type	Method	Description
static Registry<ParticleOption<?>>	registry()

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 DefaultedRegistryReference<ParticleOption<BlockState>> BLOCK_STATE

This option will affect the appearance of a particle. The only vanilla ParticleTypes that this option is applicable to are:

• ParticleTypes.BLOCK
• ParticleTypes.FALLING_DUST
• ParticleTypes.ITEM

COLOR

public static final DefaultedRegistryReference<ParticleOption<Color>> COLOR

This option will modify the color of a particle. The only vanilla ParticleTypes this option is applicable to are:

• ParticleTypes.AMBIENT_ENTITY_EFFECT
• ParticleTypes.ENTITY_EFFECT
• ParticleTypes.DUST

DIRECTION

public static final DefaultedRegistryReference<ParticleOption<Direction>> DIRECTION

This option will change the direction of a particle.

ITEM_STACK_SNAPSHOT

public static final DefaultedRegistryReference<ParticleOption<ItemStackSnapshot>> ITEM_STACK_SNAPSHOT

This option will affect the appearance of a particle. The only vanilla ParticleType this option is applicable to are:

• ParticleTypes.BLOCK
• ParticleTypes.FALLING_DUST
• ParticleTypes.ITEM

OFFSET

public static final DefaultedRegistryReference<ParticleOption<Vector3d>> OFFSET

This option will affect how all the particles are spread.

POTION_EFFECT_TYPE

public static final DefaultedRegistryReference<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

QUANTITY

public static final DefaultedRegistryReference<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:

• ParticleTypes.BLOCK
• ParticleTypes.FIREWORK

The quantity must be at least 1, or a IllegalArgumentException will be thrown when applying.

SCALE

public static final DefaultedRegistryReference<ParticleOption<Double>> SCALE

This option will change the scale of a particle. The only vanilla ParticleTypes this option is applicable to is:

• ParticleTypes.DUST

The scale may never be negative, or a IllegalArgumentException will be thrown when applying.

VELOCITY

public static final DefaultedRegistryReference<ParticleOption<Vector3d>> VELOCITY

This option will affect how most particles are moving.

Method Detail

registry

public static Registry<ParticleOption<?>> registry()