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 final DefaultedRegistryReference<ParticleOption<BlockState>>	BLOCK_STATE	This option will affect the appearance of a particle.
static final DefaultedRegistryReference<ParticleOption<Color>>	COLOR	This option will modify the color of a particle.
static final DefaultedRegistryReference<ParticleOption<Integer>>	DELAY	This option will affect the delay of particles that are spawned.
static final DefaultedRegistryReference<ParticleOption<PositionSource>>	DESTINATION	This option will affect the destination of a particle.
static final DefaultedRegistryReference<ParticleOption<ItemStackSnapshot>>	ITEM_STACK_SNAPSHOT	This option will affect the appearance of a particle.
static final DefaultedRegistryReference<ParticleOption<Vector3d>>	OFFSET	This option will affect how all the particles are spread.
static final DefaultedRegistryReference<ParticleOption<Double>>	OPACITY	This option will affect the opacity of a particle.
static final DefaultedRegistryReference<ParticleOption<Integer>>	QUANTITY	This option will affect the amount of particles that are spawned.
static final DefaultedRegistryReference<ParticleOption<Double>>	ROLL	This option will change the roll of a particle.
static final DefaultedRegistryReference<ParticleOption<Double>>	SCALE	This option will change the scale of a particle.
static final DefaultedRegistryReference<ParticleOption<Color>>	TO_COLOR	This option will change the color the transition particle will change to.
static final DefaultedRegistryReference<ParticleOption<Ticks>>	TRAVEL_TIME	This option will change the travel time of a particle.
static final 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 Details

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.BLOCK_MARKER
• ParticleTypes.DUST_PILLAR
• ParticleTypes.FALLING_DUST

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.ENTITY_EFFECT
• ParticleTypes.DUST
• ParticleTypes.DUST_COLOR_TRANSITION

DELAY

public static final DefaultedRegistryReference<ParticleOption<Integer>> DELAY

This option will affect the delay of particles that are spawned. The only vanilla ParticleType this option is applicable to is:

• ParticleTypes.SHRIEK

DESTINATION

public static final DefaultedRegistryReference<ParticleOption<PositionSource>> DESTINATION

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

• ParticleTypes.VIBRATION

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 is:

• ParticleTypes.ITEM

The item stack snapshot may never be empty, or a IllegalArgumentException will be thrown when applying

OFFSET

public static final DefaultedRegistryReference<ParticleOption<Vector3d>> OFFSET

This option will affect how all the particles are spread.

OPACITY

public static final DefaultedRegistryReference<ParticleOption<Double>> OPACITY

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

• ParticleTypes.ENTITY_EFFECT

The opacity must be between 0 and 1, or a IllegalArgumentException will be thrown when applying.

QUANTITY

public static final DefaultedRegistryReference<ParticleOption<Integer>> QUANTITY

This option will affect the amount of particles that are spawned.

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

ROLL

public static final DefaultedRegistryReference<ParticleOption<Double>> ROLL

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

• ParticleTypes.SCULK_CHARGE

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 are:

• ParticleTypes.DUST
• ParticleTypes.DUST_COLOR_TRANSITION

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

TO_COLOR

public static final DefaultedRegistryReference<ParticleOption<Color>> TO_COLOR

This option will change the color the transition particle will change to. The only vanilla ParticleType this option is applicable to is:

• ParticleTypes.DUST_COLOR_TRANSITION

TRAVEL_TIME

public static final DefaultedRegistryReference<ParticleOption<Ticks>> TRAVEL_TIME

This option will change the travel time of a particle. The only vanilla ParticleType this option is applicable to is:

• ParticleTypes.VIBRATION

VELOCITY

public static final DefaultedRegistryReference<ParticleOption<Vector3d>> VELOCITY

This option will affect how most particles are moving.

Method Details

registry

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