Package dev.esophose.playerparticles.particles

Class PParticle

java.lang.Object
dev.esophose.playerparticles.particles.PParticle
public class PParticle
extends java.lang.Object

  • Constructor Summary

    Constructors 
    Constructor Description
    PParticle​(org.bukkit.Location location)
    The constructor used if you just want stand-still particles Useful for making shapes with the styles
    PParticle​(org.bukkit.Location location, double xOff, double yOff, double zOff, double speed)
    The constructor with all the fancy parameters for customization
    PParticle​(org.bukkit.Location location, double xOff, double yOff, double zOff, double speed, boolean directional)
    The constructor with all the fancy parameters for customization
    PParticle​(org.bukkit.Location location, double xOff, double yOff, double zOff, double speed, boolean directional, float size)
    The constructor with all the fancy parameters and override data for customization
    PParticle​(org.bukkit.Location location, double xOff, double yOff, double zOff, double speed, boolean directional, java.lang.Object overrideData)
    The constructor with all the fancy parameters and override data for customization

  • Method Summary

    Modifier and Type Method Description
    org.bukkit.Location getLocation​(boolean colorable)
    Gets the location that the particle will be displayed at Offsets must be applied manually if this is a colorable effect
    java.lang.Object getOverrideData()
    Gets the data to override for the particle
    float getSize()
    Gets the size of the particle
    double getSpeed()
    Gets the speed of the particle
    double getXOff()
    Gets the offset on the x-axis for the particle
    double getYOff()
    Gets the offset on the y-axis for the particle
    double getZOff()
    Gets the offset on the z-axis for the particle
    boolean isDirectional()
    Gets if the particle is directional

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PParticle

      public PParticle​(org.bukkit.Location location, double xOff, double yOff, double zOff, double speed, boolean directional, java.lang.Object overrideData)
      The constructor with all the fancy parameters and override data for customization
      Parameters:
      location - The location to display the particle at
      xOff - The offset for the x-axis
      yOff - The offset for the y-axis
      zOff - The offset for the z-axis
      speed - The speed the particle will move at
      directional - If the particle should use the x, y, and z offsets as directions instead
      overrideData - If not null, will override the player's set data on spawn

    • PParticle

      public PParticle​(org.bukkit.Location location, double xOff, double yOff, double zOff, double speed, boolean directional, float size)
      The constructor with all the fancy parameters and override data for customization
      Parameters:
      location - The location to display the particle at
      xOff - The offset for the x-axis
      yOff - The offset for the y-axis
      zOff - The offset for the z-axis
      speed - The speed the particle will move at
      directional - If the particle should use the x, y, and z offsets as directions instead
      size - Size of the redstone particle

    • PParticle

      public PParticle​(org.bukkit.Location location, double xOff, double yOff, double zOff, double speed, boolean directional)
      The constructor with all the fancy parameters for customization
      Parameters:
      location - The location to display the particle at
      xOff - The offset for the x-axis
      yOff - The offset for the y-axis
      zOff - The offset for the z-axis
      speed - The speed the particle will move at
      directional - If the particle should use the x, y, and z offsets as directions instead

    • PParticle

      public PParticle​(org.bukkit.Location location, double xOff, double yOff, double zOff, double speed)
      The constructor with all the fancy parameters for customization
      Parameters:
      location - The location to display the particle at
      xOff - The offset for the x-axis
      yOff - The offset for the y-axis
      zOff - The offset for the z-axis
      speed - The speed the particle will move at

    • PParticle

      public PParticle​(org.bukkit.Location location)
      The constructor used if you just want stand-still particles Useful for making shapes with the styles
      Parameters:
      location - The location to display the particles at

  • Method Details

    • getLocation

      public org.bukkit.Location getLocation​(boolean colorable)
      Gets the location that the particle will be displayed at Offsets must be applied manually if this is a colorable effect
      Parameters:
      colorable - Whether or not this effect is colorable and we need to manually adjust for the offsets or not
      Returns:
      The location, either as normal or modified with the offsets

    • getSpeed

      public double getSpeed()
      Gets the speed of the particle
      Returns:
      The particle's speed

    • isDirectional

      public boolean isDirectional()
      Gets if the particle is directional
      Returns:
      If the particle is directional

    • getXOff

      public double getXOff()
      Gets the offset on the x-axis for the particle
      Returns:
      The x-axis offset

    • getSize

      public float getSize()
      Gets the size of the particle
      Returns:
      The size

    • getYOff

      public double getYOff()
      Gets the offset on the y-axis for the particle
      Returns:
      The y-axis offset

    • getZOff

      public double getZOff()
      Gets the offset on the z-axis for the particle
      Returns:
      The z-axis offset

    • getOverrideData

      public java.lang.Object getOverrideData()
      Gets the data to override for the particle
      Returns:
      The data to override for the particle, may be null