Package dev.esophose.playerparticles.particles.data

Class NoteColor

java.lang.Object
dev.esophose.playerparticles.particles.data.ParticleColor
dev.esophose.playerparticles.particles.data.NoteColor
public final class NoteColor
extends ParticleColor
Represents the color for the ParticleEffect.NOTE effect

This class is part of the ParticleEffect Library and follows the same usage conditions

Since:
1.7

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static NoteColor RAINBOW  
    static NoteColor RANDOM  

  • Constructor Summary

    Constructors 
    Constructor Description
    NoteColor​(int note)
    Construct a new note color

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object other)  
    int getNote()
    Returns the note value
    float getValueX()
    Returns the note value divided by 24
    float getValueY()
    Returns zero because the offsetY value is unused
    float getValueZ()
    Returns zero because the offsetZ value is unused
    int hashCode()  

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • NoteColor

      public NoteColor​(int note) throws java.lang.IllegalArgumentException
      Construct a new note color
      Parameters:
      note - Note id which determines color
      Throws:
      java.lang.IllegalArgumentException - If the note value is lower than 0 or higher than 24

  • Method Details

    • getNote

      public int getNote()
      Returns the note value
      Returns:
      The note value

    • getValueX

      public float getValueX()
      Returns the note value divided by 24
      Specified by:
      getValueX in class ParticleColor
      Returns:
      The offsetX value

    • getValueY

      public float getValueY()
      Returns zero because the offsetY value is unused
      Specified by:
      getValueY in class ParticleColor
      Returns:
      zero

    • getValueZ

      public float getValueZ()
      Returns zero because the offsetZ value is unused
      Specified by:
      getValueZ in class ParticleColor
      Returns:
      zero

    • equals

      public boolean equals​(java.lang.Object other)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object