xyz.xenondevs.particle.data.color

Class DustData

java.lang.Object

xyz.xenondevs.particle.data.ParticleData

xyz.xenondevs.particle.data.color.ParticleColor

xyz.xenondevs.particle.data.color.RegularColor

xyz.xenondevs.particle.data.color.DustData

Direct Known Subclasses:

DustColorTransitionData

public class DustData
extends RegularColor

The DustData class holds information on the colors and size of various dust particles. The standard implementation below supports a custom color and size. If you're looking for Transitioning colors check out DustColorTransitionData for more information. The size of these particles has to lie between 0-4. Every size above 4 is displayed as size 4.

Please note that the size also influences the display time of the particle.

Author:

ByteZ

See Also:

PropertyType.DUST, RegularColor, ParticleEffect.REDSTONE, ParticleEffect.DUST_COLOR_TRANSITION

Constructor Summary

Constructors

Constructor and Description
DustData(Color color, float size) Creates a new DustData instance.
DustData(int red, int green, int blue, float size) Creates a new DustData instance.

Method Summary

Modifier and Type	Method and Description
float	getSize() Gets the size of the particle.
Object	toNMSData() Converts the underlying DustData into it's nms counterparts.

Methods inherited from class xyz.xenondevs.particle.data.color.RegularColor

fromHSVHue, getBlue, getGreen, getRed, random, random

Methods inherited from class xyz.xenondevs.particle.data.ParticleData

getEffect, setEffect

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DustData

public DustData(Color color,
                float size)

Creates a new DustData instance.

Parameters:

color - the color of the dust particle.

size - the size of the particle.

DustData

public DustData(int red,
                int green,
                int blue,
                float size)

Creates a new DustData instance.

Parameters:

red - the red value of the color.

green - the green value of the color.

blue - the blue value of the color.

size - the size of the particle.

Method Detail

getSize

public float getSize()

Gets the size of the particle.

Returns:

the size of the particle.

toNMSData

public Object toNMSData()

Converts the underlying DustData into it's nms counterparts. The return type is dependent on the value of the ParticleData.getEffect(). If the getter returns neither ParticleEffect.REDSTONE or ParticleEffect.DUST_COLOR_TRANSITION, then null is returned.

Please note that this class is not supported in any versions before 1.13 and could lead to errors if used in legacy versions.

Overrides:

toNMSData in class RegularColor

Returns:

the nms counterpart of this DustData