xyz.xenondevs.particle.data.color

Class DustColorTransitionData

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

xyz.xenondevs.particle.data.color.DustColorTransitionData

public final class DustColorTransitionData
extends DustData

This DustData implementation is solely built for the ParticleEffect.DUST_COLOR_TRANSITION effect. It supports 2 colors and a custom size. The resulting particle will show a color fade between those 2 colors.

Author:

ByteZ

See Also:

DustData, PropertyType.DUST, ParticleEffect.DUST_COLOR_TRANSITION

Constructor Summary

Constructors

Constructor and Description
DustColorTransitionData(Color color, Color fadeColor, float size) Creates a new DustColorTransitionData instance.
DustColorTransitionData(int red, int green, int blue, int fadeRed, int fadeGreen, int fadeBlue, float size) Creates a new DustColorTransitionData instance.

Method Summary

Modifier and Type	Method and Description
float	getFadeBlue() Gets the blue value of the color the particle will fade to.
float	getFadeGreen() Gets the green value of the color the particle will fade to.
float	getFadeRed() Gets the red value of the color the particle will fade to.
Object	toNMSData() Creates a new instance of the nms counterpart of this class.

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

getSize

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

DustColorTransitionData

public DustColorTransitionData(Color color,
                               Color fadeColor,
                               float size)

Creates a new DustColorTransitionData instance.

Parameters:

color - the start color of the particle.

fadeColor - the color the particle will fade to.

size - the size of the particle.

DustColorTransitionData

public DustColorTransitionData(int red,
                               int green,
                               int blue,
                               int fadeRed,
                               int fadeGreen,
                               int fadeBlue,
                               float size)

Creates a new DustColorTransitionData instance.

Parameters:

red - the red value of the start color.

green - the green value of the start color.

blue - the blue value of the start color.

fadeRed - the red value of the second color.

fadeGreen - the green value of the second color.

fadeBlue - the blue value of the second color.

size - the size of the particle.

Method Detail

getFadeRed

public float getFadeRed()

Gets the red value of the color the particle will fade to. (Value range is 0f-1f)

Returns:

the red value of the second color.

getFadeGreen

public float getFadeGreen()

Gets the green value of the color the particle will fade to. (Value range is 0f-1f)

Returns:

the red value of the second color.

getFadeBlue

public float getFadeBlue()

Gets the blue value of the color the particle will fade to. (Value range is 0f-1f)

Returns:

the red value of the second color.

toNMSData

public Object toNMSData()

Creates a new instance of the nms counterpart of this class.

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

Overrides:

toNMSData in class DustData

Returns:

the nms counterpart of this class.