xyz.xenondevs.particle

Enum PropertyType

java.lang.Object

java.lang.Enum<PropertyType>

xyz.xenondevs.particle.PropertyType

All Implemented Interfaces:

Serializable, Comparable<PropertyType>

public enum PropertyType
extends Enum<PropertyType>

Enum to easily define which properties are supported by specific ParticleEffects.

Current Property types

• REQUIRES_WATER
• REQUIRES_BLOCK
• REQUIRES_ITEM
• DIRECTIONAL
• COLORABLE
• RESIZEABLE

Since:

05.06.2019

Author:

ByteZ

Enum Constant Summary

Enum Constants

Enum Constant and Description
COLORABLE Specifies that the color of the given particle can be set.
DIRECTIONAL Directional particles accept a custom vector as the direction.
DUST A dust particle accepts a custom color and a custom size (between 0-4).
REQUIRES_BLOCK Specifies that the given particle needs the data of a block to be functional.
REQUIRES_ITEM Specifies that the given particle needs the data of an item to be functional.
REQUIRES_WATER Specifies that the given particle needs water in order to be displayed correctly.
RESIZEABLE Specifies that the size of the given particle can be changed in the offsetX parameter.

Method Summary

Modifier and Type	Method and Description
static PropertyType	valueOf(String name) Returns the enum constant of this type with the specified name.
static PropertyType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DIRECTIONAL

public static final PropertyType DIRECTIONAL

Directional particles accept a custom vector as the direction. This data is set as the offsetX, offsetY and offsetZ of the particle packet.

COLORABLE

public static final PropertyType COLORABLE

Specifies that the color of the given particle can be set. Before 1.13 the RGB values of the color is simply set as the offsetX, offsetY and offsetZ of the particle packet. But that has changed since 1.13. Redstone particles now have a custom ParticleParam called "ParticleParamRedstone". However, other particles like spell_mob/effect_entity are still handled the old way.

REQUIRES_BLOCK

public static final PropertyType REQUIRES_BLOCK

Specifies that the given particle needs the data of a block to be functional. Before 1.13 this data was saved in an int array that could easily be set in the constructor of the packet. However, because of the major 1.13 particle changes this data can no longer be set in a simple int array. There is now a custom object to set the data of such particles. The class of this object is ParticleParamBlock, and it implements the ParticleParam interface, which is now needed in the constructor.

REQUIRES_ITEM

public static final PropertyType REQUIRES_ITEM

Specifies that the given particle needs the data of an item to be functional. Before 1.13 this data was saved in an int array that could easily be set in the constructor of the packet. However, because of the major 1.13 particle changes this data can no longer be set in a simple int array. There is now a custom object to set the data of such particles. The class of this object is ParticleParamItem, and it implements the ParticleParam interface, which is now needed in the constructor.

REQUIRES_WATER

public static final PropertyType REQUIRES_WATER

Specifies that the given particle needs water in order to be displayed correctly.

RESIZEABLE

public static final PropertyType RESIZEABLE

Specifies that the size of the given particle can be changed in the offsetX parameter.

DUST

public static final PropertyType DUST

A dust particle accepts a custom color and a custom size (between 0-4). Please note that this PropertyType is not supported on pre 1.13 servers.

See Also:

DustData, DustColorTransitionData, RegularColor, ParticleEffect.REDSTONE, ParticleEffect.DUST_COLOR_TRANSITION

Method Detail

values

public static PropertyType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PropertyType c : PropertyType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PropertyType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null