Class ParticlePair

java.lang.Object
dev.esophose.playerparticles.particles.ParticlePair

public class ParticlePair
extends java.lang.Object
  • Constructor Details

  • Method Details

    • setOwner

      public void setOwner​(PPlayer pplayer)
      Updates the particle's owner if it hasn't been set yet
      Parameters:
      pplayer - The new owner
    • setEffect

      public void setEffect​(ParticleEffect effect)
      Sets the player's particle effect
      Parameters:
      effect - The player's new particle effect
    • setStyle

      public void setStyle​(ParticleStyle style)
      Sets the player's particle style
      Parameters:
      style - The player's new particle style
    • setItemMaterial

      public void setItemMaterial​(org.bukkit.Material itemMaterial)
      Sets the player's item material
      Parameters:
      itemMaterial - The player's new item material
    • setBlockMaterial

      public void setBlockMaterial​(org.bukkit.Material blockMaterial)
      Sets the player's block material
      Parameters:
      blockMaterial - The player's new block material
    • setColor

      public void setColor​(OrdinaryColor colorData)
      Sets the player's color data
      Parameters:
      colorData - The player's new color data
    • setNoteColor

      public void setNoteColor​(NoteColor noteColorData)
      Sets the player's note color data
      Parameters:
      noteColorData - The player's new note color data
    • setColorTransition

      public void setColorTransition​(ColorTransition colorTransitionData)
      Sets the player's color transition data
      Parameters:
      colorTransitionData - The player's new color transition data
    • setVibration

      public void setVibration​(Vibration vibrationData)
      Sets the player's vibration data
      Parameters:
      vibrationData - The player's new vibration data
    • getOwnerUniqueId

      public java.util.UUID getOwnerUniqueId()
      Get the UUID of the PPlayer that owns this ParticlePair
      Returns:
      The owner's UUID
    • getId

      public int getId()
      Get the id of this particle
      Returns:
      The id of this particle
    • getEffect

      public ParticleEffect getEffect()
      Get the ParticleEffect that this ParticlePair represents
      Returns:
      The effect
    • getStyle

      public ParticleStyle getStyle()
      Get the ParticleStyle that this ParticlePair represents
      Returns:
      The style
    • getItemMaterial

      public org.bukkit.Material getItemMaterial()
      Get the item Material this particle uses
      Returns:
      The item Material
    • getBlockMaterial

      public org.bukkit.Material getBlockMaterial()
      Get the block Material this particle uses
      Returns:
      The block Material
    • getColor

      public OrdinaryColor getColor()
      Get the color this particle uses
      Returns:
      The color
    • getNoteColor

      public NoteColor getNoteColor()
      Get the note color this particle uses
      Returns:
      The note color
    • getColorTransition

      public ColorTransition getColorTransition()
      Get the color transition this particle uses
      Returns:
      The color transition
    • getVibration

      public Vibration getVibration()
      Get the vibration this particle uses
      Returns:
      The vibration
    • getSpawnColor

      public ParticleColor getSpawnColor()
      Gets the color the current particle effect will spawn with
      Returns:
      The ParticleColor the current particle effect will spawn with
    • getSpawnColorTransition

      public ColorTransition getSpawnColorTransition()
      Gets the color transition the current particle effect will spawn with
      Returns:
      The ColorTransition the current particle effect will spawn with
    • getSpawnMaterial

      public org.bukkit.Material getSpawnMaterial()
      Gets the material the current particle effect will spawn with
      Returns:
      The Material the current particle effect requires
    • getDataString

      public java.lang.String getDataString()
      Gets the current particle data as a string
      Returns:
      The particle data in a human-readable string
    • clone

      public ParticlePair clone()
      Gets a copy of this ParticlePair
      Overrides:
      clone in class java.lang.Object
    • getNextDefault

      public static ParticlePair getNextDefault​(PPlayer pplayer)
      Gets a ParticlePair for a PPlayer with the default values applied
      Parameters:
      pplayer - The PPlayer that will own this ParticlePair
      Returns:
      A ParticlePair with default values