Package dev.esophose.playerparticles.particles

Class ParticleGroup

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

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static java.lang.String DEFAULT_NAME  

  • Constructor Summary

    Constructors 
    Constructor Description
    ParticleGroup​(java.lang.String name, java.util.Map<java.lang.Integer,​ParticlePair> particles)  

  • Method Summary

    Modifier and Type Method Description
    boolean canPlayerUse​(PPlayer player)
    Checks if a player has permission to use this particle group
    static ParticleGroup getDefaultGroup()
    Gets an empty ParticleGroup
    java.lang.String getName()
    Get the player-given name of this ParticleGroup This will be null if it's the player's active ParticleGroup
    java.util.Map<java.lang.Integer,​ParticlePair> getParticles()
    Get the map of ParticlePairs in this group

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • ParticleGroup

      public ParticleGroup​(java.lang.String name, java.util.Map<java.lang.Integer,​ParticlePair> particles)

  • Method Details

    • getName

      public java.lang.String getName()
      Get the player-given name of this ParticleGroup This will be null if it's the player's active ParticleGroup
      Returns:
      The name of this group

    • getParticles

      public java.util.Map<java.lang.Integer,​ParticlePair> getParticles()
      Get the map of ParticlePairs in this group
      Returns:
      The particles in this group

    • getDefaultGroup

      public static ParticleGroup getDefaultGroup()
      Gets an empty ParticleGroup
      Returns:
      The default empty active ParticleGroup

    • canPlayerUse

      public boolean canPlayerUse​(PPlayer player)
      Checks if a player has permission to use this particle group
      Parameters:
      player - The player to check
      Returns:
      True if the player has permission