xyz.xenondevs.particle.data.color

Class NoteColor

java.lang.Object

xyz.xenondevs.particle.data.ParticleData

xyz.xenondevs.particle.data.color.ParticleColor

xyz.xenondevs.particle.data.color.NoteColor

public final class NoteColor
extends ParticleColor

An implementation of the ParticleColor class to support note colors.

Since:

10.06.2019

Author:

ByteZ

See Also:

ParticleEffect.NOTE

Constructor Summary

Constructors

Constructor and Description
NoteColor(int note) Initializes a new ParticleData object.

Method Summary

Modifier and Type	Method and Description
float	getBlue() Returns 0 because the offsetZ isn't used by the color of notes.
float	getGreen() Returns 0 because the offsetY isn't used by the color of notes.
float	getRed() Gets the red value of the color.
static NoteColor	random() Generates a random NoteColor instance to support rainbow trails, cloaks and other effects that can be constructed using the note particle.
void	setEffect(ParticleEffect effect) Sets the ParticleEffect.
Object	toNMSData() Converts the current ParticleData instance into nms data.

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

getEffect

Methods inherited from class java.lang.Object

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

Constructor Detail

NoteColor

public NoteColor(int note)

Initializes a new ParticleData object.

Parameters:

note - the note that should be displayed.

Method Detail

setEffect

public void setEffect(ParticleEffect effect)

Sets the ParticleEffect.

Overrides:

setEffect in class ParticleData

Parameters:

effect - the ParticleEffect that should be displayed.

getRed

public float getRed()

Gets the red value of the color.

Overrides:

getRed in class ParticleColor

Returns:

the red value.

getGreen

public float getGreen()

Returns 0 because the offsetY isn't used by the color of notes.

Overrides:

getGreen in class ParticleColor

Returns:

0.

getBlue

public float getBlue()

Returns 0 because the offsetZ isn't used by the color of notes.

Overrides:

getBlue in class ParticleColor

Returns:

0.

toNMSData

public Object toNMSData()

Converts the current ParticleData instance into nms data. If the current minecraft version was released before 1.13 an int array should be returned. If the version was released after 1.12 a nms "ParticleParam" has to be returned.

Specified by:

toNMSData in class ParticleColor

Returns:

the nms data.

random

public static NoteColor random()

Generates a random NoteColor instance to support rainbow trails, cloaks and other effects that can be constructed using the note particle.

Returns:

a random NoteColor instance.