java.lang.Object

java.lang.Enum<ParticleEffect>

dev.esophose.playerparticles.particles.ParticleEffect

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<ParticleEffect>, java.lang.constant.Constable

public enum ParticleEffect
extends java.lang.Enum<ParticleEffect>

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class ParticleEffect.ParticleProperty
Represents the property of a particle effect

Nested classes/interfaces inherited from class java.lang.Enum
java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

Enum Constant Summary

Enum Constants
Enum Constant	Description
`AMBIENT_ENTITY_EFFECT`
`ANGRY_VILLAGER`
`ASH`
`BARRIER`
`BLOCK`
`BLOCK_MARKER`
`BUBBLE`
`BUBBLE_COLUMN_UP`
`BUBBLE_POP`
`CAMPFIRE_COSY_SMOKE`
`CAMPFIRE_SIGNAL_SMOKE`
`CLOUD`
`COMPOSTER`
`CRIMSON_SPORE`
`CRIT`
`CURRENT_DOWN`
`DAMAGE_INDICATOR`
`DOLPHIN`
`DRAGON_BREATH`
`DRIPPING_DRIPSTONE_LAVA`
`DRIPPING_DRIPSTONE_WATER`
`DRIPPING_HONEY`
`DRIPPING_LAVA`
`DRIPPING_OBSIDIAN_TEAR`
`DRIPPING_WATER`
`DUST`
`DUST_COLOR_TRANSITION`
`ELDER_GUARDIAN`
`ELECTRIC_SPARK`
`ENCHANT`
`ENCHANTED_HIT`
`END_ROD`
`ENTITY_EFFECT`
`EXPLOSION`
`EXPLOSION_EMITTER`
`FALLING_DRIPSTONE_LAVA`
`FALLING_DRIPSTONE_WATER`
`FALLING_DUST`
`FALLING_HONEY`
`FALLING_LAVA`
`FALLING_NECTAR`
`FALLING_OBSIDIAN_TEAR`
`FALLING_SPORE_BLOSSOM`
`FALLING_WATER`
`FIREWORK`
`FISHING`
`FLAME`
`FLASH`
`FOOTSTEP`
`GLOW`
`GLOW_SQUID_INK`
`HAPPY_VILLAGER`
`HEART`
`INSTANT_EFFECT`
`ITEM`
`ITEM_SLIME`
`ITEM_SNOWBALL`
`LANDING_HONEY`
`LANDING_LAVA`
`LANDING_OBSIDIAN_TEAR`
`LARGE_SMOKE`
`LAVA`
`LIGHT`
`MYCELIUM`
`NAUTILUS`
`NOTE`
`POOF`
`PORTAL`
`RAIN`
`REVERSE_PORTAL`
`SCRAPE`
`SMALL_FLAME`
`SMOKE`
`SNEEZE`
`SNOWFLAKE`
`SOUL`
`SOUL_FIRE_FLAME`
`SPELL`
`SPIT`
`SPLASH`
`SPORE_BLOSSOM_AIR`
`SQUID_INK`
`SWEEP_ATTACK`
`TOTEM_OF_UNDYING`
`UNDERWATER`
`VIBRATION`
`WARPED_SPORE`
`WAX_OFF`
`WAX_ON`
`WHITE_ASH`
`WITCH`

Method Summary

Modifier and Type	Method	Description
`void`	`display(double offsetX, double offsetY, double offsetZ, double speed, int amount, org.bukkit.Location center, boolean isLongRange, org.bukkit.entity.Player owner)`	Displays a particle effect
`void`	`display(ColorTransition colorTransition, double offsetX, double offsetY, double offsetZ, int amount, org.bukkit.Location center, boolean isLongRange, org.bukkit.entity.Player owner, float size)`	Displays a particle effect which requires additional data and is only visible for all players within a certain range in the world of @param center
`void`	`display(ParticleColor color, org.bukkit.Location center, boolean isLongRange, org.bukkit.entity.Player owner, float size)`	Displays a single particle which is colored
`void`	`display(Vibration vibration, double offsetX, double offsetY, double offsetZ, int amount, org.bukkit.Location center, boolean isLongRange, org.bukkit.entity.Player owner)`	Displays a particle effect which requires additional data and is only visible for all players within a certain range in the world of @param center
`static void`	`display(ParticlePair particle, PParticle pparticle, boolean isLongRange, org.bukkit.entity.Player owner)`	Invokes the correct spawn method for the particle information given
`void`	`display(org.bukkit.Material spawnMaterial, double offsetX, double offsetY, double offsetZ, double speed, int amount, org.bukkit.Location center, boolean isLongRange, org.bukkit.entity.Player owner)`	Displays a particle effect which requires additional data and is only visible for all players within a certain range in the world of @param center
`static ParticleEffect`	`fromInternalName(java.lang.String internalName)`	Returns the particle effect with the given name
`static ParticleEffect`	`fromName(java.lang.String name)`	Returns the particle effect with the given name
`static java.util.List<ParticleEffect>`	`getEnabledEffects()`	Returns a ParticleEffect List of all enabled effects for the server version
`org.bukkit.Material`	`getGuiIconMaterial()`
`java.lang.String`	`getInternalName()`
`java.lang.String`	`getName()`
`org.bukkit.Particle`	`getSpigotEnum()`
`boolean`	`hasProperties()`
`boolean`	`hasProperty(ParticleEffect.ParticleProperty property)`	Determine if this particle effect has a specific property
`boolean`	`isEnabled()`
`boolean`	`isSupported()`	Determine if this particle effect is supported by the current server version
`void`	`loadSettings(boolean reloadConfig)`	Loads the settings shared for each style then calls loadSettings(CommentedFileConfiguration)
`static void`	`reloadSettings()`	Reloads the settings for all ParticleEffects
`static ParticleEffect`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static ParticleEffect[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details
- AMBIENT_ENTITY_EFFECT
  
  public static final ParticleEffect AMBIENT_ENTITY_EFFECT
- ANGRY_VILLAGER
  
  public static final ParticleEffect ANGRY_VILLAGER
- ASH
  
  public static final ParticleEffect ASH
- BARRIER
  
  public static final ParticleEffect BARRIER
- BLOCK
  
  public static final ParticleEffect BLOCK
- BLOCK_MARKER
  
  public static final ParticleEffect BLOCK_MARKER
- BUBBLE
  
  public static final ParticleEffect BUBBLE
- BUBBLE_COLUMN_UP
  
  public static final ParticleEffect BUBBLE_COLUMN_UP
- BUBBLE_POP
  
  public static final ParticleEffect BUBBLE_POP
- CAMPFIRE_COSY_SMOKE
  
  public static final ParticleEffect CAMPFIRE_COSY_SMOKE
- CAMPFIRE_SIGNAL_SMOKE
  
  public static final ParticleEffect CAMPFIRE_SIGNAL_SMOKE
- CLOUD
  
  public static final ParticleEffect CLOUD
- COMPOSTER
  
  public static final ParticleEffect COMPOSTER
- CRIMSON_SPORE
  
  public static final ParticleEffect CRIMSON_SPORE
- CRIT
  
  public static final ParticleEffect CRIT
- CURRENT_DOWN
  
  public static final ParticleEffect CURRENT_DOWN
- DAMAGE_INDICATOR
  
  public static final ParticleEffect DAMAGE_INDICATOR
- DOLPHIN
  
  public static final ParticleEffect DOLPHIN
- DRAGON_BREATH
  
  public static final ParticleEffect DRAGON_BREATH
- DRIPPING_DRIPSTONE_LAVA
  
  public static final ParticleEffect DRIPPING_DRIPSTONE_LAVA
- DRIPPING_DRIPSTONE_WATER
  
  public static final ParticleEffect DRIPPING_DRIPSTONE_WATER
- DRIPPING_HONEY
  
  public static final ParticleEffect DRIPPING_HONEY
- DRIPPING_LAVA
  
  public static final ParticleEffect DRIPPING_LAVA
- DRIPPING_OBSIDIAN_TEAR
  
  public static final ParticleEffect DRIPPING_OBSIDIAN_TEAR
- DRIPPING_WATER
  
  public static final ParticleEffect DRIPPING_WATER
- DUST
  
  public static final ParticleEffect DUST
- DUST_COLOR_TRANSITION
  
  public static final ParticleEffect DUST_COLOR_TRANSITION
- ELDER_GUARDIAN
  
  public static final ParticleEffect ELDER_GUARDIAN
- ELECTRIC_SPARK
  
  public static final ParticleEffect ELECTRIC_SPARK
- ENCHANT
  
  public static final ParticleEffect ENCHANT
- ENCHANTED_HIT
  
  public static final ParticleEffect ENCHANTED_HIT
- END_ROD
  
  public static final ParticleEffect END_ROD
- ENTITY_EFFECT
  
  public static final ParticleEffect ENTITY_EFFECT
- EXPLOSION
  
  public static final ParticleEffect EXPLOSION
- EXPLOSION_EMITTER
  
  public static final ParticleEffect EXPLOSION_EMITTER
- FALLING_DRIPSTONE_LAVA
  
  public static final ParticleEffect FALLING_DRIPSTONE_LAVA
- FALLING_DRIPSTONE_WATER
  
  public static final ParticleEffect FALLING_DRIPSTONE_WATER
- FALLING_DUST
  
  public static final ParticleEffect FALLING_DUST
- FALLING_HONEY
  
  public static final ParticleEffect FALLING_HONEY
- FALLING_LAVA
  
  public static final ParticleEffect FALLING_LAVA
- FALLING_NECTAR
  
  public static final ParticleEffect FALLING_NECTAR
- FALLING_OBSIDIAN_TEAR
  
  public static final ParticleEffect FALLING_OBSIDIAN_TEAR
- FALLING_SPORE_BLOSSOM
  
  public static final ParticleEffect FALLING_SPORE_BLOSSOM
- FALLING_WATER
  
  public static final ParticleEffect FALLING_WATER
- FIREWORK
  
  public static final ParticleEffect FIREWORK
- FISHING
  
  public static final ParticleEffect FISHING
- FLAME
  
  public static final ParticleEffect FLAME
- FLASH
  
  public static final ParticleEffect FLASH
- GLOW
  
  public static final ParticleEffect GLOW
- GLOW_SQUID_INK
  
  public static final ParticleEffect GLOW_SQUID_INK
- FOOTSTEP
  
  public static final ParticleEffect FOOTSTEP
- HAPPY_VILLAGER
  
  public static final ParticleEffect HAPPY_VILLAGER
- HEART
  
  public static final ParticleEffect HEART
- INSTANT_EFFECT
  
  public static final ParticleEffect INSTANT_EFFECT
- ITEM
  
  public static final ParticleEffect ITEM
- ITEM_SLIME
  
  public static final ParticleEffect ITEM_SLIME
- ITEM_SNOWBALL
  
  public static final ParticleEffect ITEM_SNOWBALL
- LANDING_HONEY
  
  public static final ParticleEffect LANDING_HONEY
- LANDING_LAVA
  
  public static final ParticleEffect LANDING_LAVA
- LANDING_OBSIDIAN_TEAR
  
  public static final ParticleEffect LANDING_OBSIDIAN_TEAR
- LARGE_SMOKE
  
  public static final ParticleEffect LARGE_SMOKE
- LAVA
  
  public static final ParticleEffect LAVA
- LIGHT
  
  public static final ParticleEffect LIGHT
- MYCELIUM
  
  public static final ParticleEffect MYCELIUM
- NAUTILUS
  
  public static final ParticleEffect NAUTILUS
- NOTE
  
  public static final ParticleEffect NOTE
- POOF
  
  public static final ParticleEffect POOF
- PORTAL
  
  public static final ParticleEffect PORTAL
- RAIN
  
  public static final ParticleEffect RAIN
- REVERSE_PORTAL
  
  public static final ParticleEffect REVERSE_PORTAL
- SCRAPE
  
  public static final ParticleEffect SCRAPE
- SMALL_FLAME
  
  public static final ParticleEffect SMALL_FLAME
- SMOKE
  
  public static final ParticleEffect SMOKE
- SNEEZE
  
  public static final ParticleEffect SNEEZE
- SNOWFLAKE
  
  public static final ParticleEffect SNOWFLAKE
- SOUL
  
  public static final ParticleEffect SOUL
- SOUL_FIRE_FLAME
  
  public static final ParticleEffect SOUL_FIRE_FLAME
- SPELL
  
  public static final ParticleEffect SPELL
- SPIT
  
  public static final ParticleEffect SPIT
- SPLASH
  
  public static final ParticleEffect SPLASH
- SPORE_BLOSSOM_AIR
  
  public static final ParticleEffect SPORE_BLOSSOM_AIR
- SQUID_INK
  
  public static final ParticleEffect SQUID_INK
- SWEEP_ATTACK
  
  public static final ParticleEffect SWEEP_ATTACK
- TOTEM_OF_UNDYING
  
  public static final ParticleEffect TOTEM_OF_UNDYING
- UNDERWATER
  
  public static final ParticleEffect UNDERWATER
- VIBRATION
  
  public static final ParticleEffect VIBRATION
- WARPED_SPORE
  
  public static final ParticleEffect WARPED_SPORE
- WAX_OFF
  
  public static final ParticleEffect WAX_OFF
- WAX_ON
  
  public static final ParticleEffect WAX_ON
- WHITE_ASH
  
  public static final ParticleEffect WHITE_ASH
- WITCH
  
  public static final ParticleEffect WITCH
Method Details
- values
  
  public static ParticleEffect[] values()
  
  Returns an array containing the constants of this enum type, in the order they are declared.
  
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
  
  public static ParticleEffect valueOf(java.lang.String name)
  
  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
  
  Parameters:
  
  name - the name of the enum constant to be returned.
  
  Returns:
  
  the enum constant with the specified name
  
  Throws:
  
  java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
  
  java.lang.NullPointerException - if the argument is null
- loadSettings
  
  public void loadSettings(boolean reloadConfig)
  
  Loads the settings shared for each style then calls loadSettings(CommentedFileConfiguration)
  
  Parameters:
  
  reloadConfig - If the settings should be reloaded or not
- reloadSettings
  
  public static void reloadSettings()
  
  Reloads the settings for all ParticleEffects
- getInternalName
  
  public java.lang.String getInternalName()
  
  Returns:
  
  the internal name of this particle effect that will never change
- getName
  
  public java.lang.String getName()
  
  Returns:
  
  the name that the style will display to the users as
- getSpigotEnum
  
  public org.bukkit.Particle getSpigotEnum()
  
  Returns:
  
  the Spigot enum this represents
- getGuiIconMaterial
  
  public org.bukkit.Material getGuiIconMaterial()
  
  Returns:
  
  The Material icon that represents this style in the GUI
- hasProperty
  
  public boolean hasProperty(ParticleEffect.ParticleProperty property)
  
  Determine if this particle effect has a specific property
  
  Parameters:
  
  property - The property to check
  
  Returns:
  
  Whether it has the property or not
- hasProperties
  
  public boolean hasProperties()
  
  Returns:
  
  true if this effect has any properties
- isSupported
  
  public boolean isSupported()
  
  Determine if this particle effect is supported by the current server version
  
  Returns:
  
  Whether the particle effect is supported or not
- isEnabled
  
  public boolean isEnabled()
  
  Returns:
  
  true if this effect is enabled, otherwise false
- getEnabledEffects
  
  public static java.util.List<ParticleEffect> getEnabledEffects()
  
  Returns a ParticleEffect List of all enabled effects for the server version
  
  Returns:
  
  Enabled effects
- fromName
  
  public static ParticleEffect fromName(java.lang.String name)
  
  Returns the particle effect with the given name
  
  Parameters:
  
  name - Name of the particle effect
  
  Returns:
  
  The particle effect
- fromInternalName
  
  public static ParticleEffect fromInternalName(java.lang.String internalName)
  
  Returns the particle effect with the given name
  
  Parameters:
  
  internalName - Internal name of the particle effect
  
  Returns:
  
  The particle effect
- display
  
  public static void display(ParticlePair particle, PParticle pparticle, boolean isLongRange, org.bukkit.entity.Player owner)
  
  Invokes the correct spawn method for the particle information given
  
  Parameters:
  
  particle - The ParticlePair, given the effect/style/data
  
  pparticle - The particle spawn information
  
  isLongRange - If the particle can be viewed from long range
  
  owner - The player that owns the particles
- display
  
  public void display(double offsetX, double offsetY, double offsetZ, double speed, int amount, org.bukkit.Location center, boolean isLongRange, org.bukkit.entity.Player owner)
  
  Displays a particle effect
  
  Parameters:
  
  offsetX - Maximum distance particles can fly away from the center on the x-axis
  
  offsetY - Maximum distance particles can fly away from the center on the y-axis
  
  offsetZ - Maximum distance particles can fly away from the center on the z-axis
  
  speed - Display speed of the particles
  
  amount - Amount of particles
  
  center - Center location of the effect
  
  isLongRange - If the particle can be viewed from long range
  
  owner - The player that owns the particles
  
  Throws:
  
  ParticleSpawner.ParticleDataException - If the particle effect requires additional data
- display
  
  public void display(ParticleColor color, org.bukkit.Location center, boolean isLongRange, org.bukkit.entity.Player owner, float size)
  
  Displays a single particle which is colored
  
  Parameters:
  
  color - Color of the particle
  
  center - Center location of the effect
  
  isLongRange - If the particle can be viewed from long range
  
  owner - The player that owns the particles
  
  size - The size of the particles
  
  Throws:
  
  ParticleSpawner.ParticleColorException - If the particle effect is not colorable or the color type is incorrect
- display
  
  public void display(org.bukkit.Material spawnMaterial, double offsetX, double offsetY, double offsetZ, double speed, int amount, org.bukkit.Location center, boolean isLongRange, org.bukkit.entity.Player owner)
  
  Displays a particle effect which requires additional data and is only visible for all players within a certain range in the world of @param center
  
  Parameters:
  
  spawnMaterial - Material of the effect
  
  offsetX - Maximum distance particles can fly away from the center on the x-axis
  
  offsetY - Maximum distance particles can fly away from the center on the y-axis
  
  offsetZ - Maximum distance particles can fly away from the center on the z-axis
  
  speed - Display speed of the particles
  
  amount - Amount of particles
  
  center - Center location of the effect
  
  isLongRange - If the particle can be viewed from long range
  
  owner - The player that owns the particles
  
  Throws:
  
  ParticleSpawner.ParticleDataException - If the particle effect does not require additional data or if the data type is incorrect
- display
  
  public void display(ColorTransition colorTransition, double offsetX, double offsetY, double offsetZ, int amount, org.bukkit.Location center, boolean isLongRange, org.bukkit.entity.Player owner, float size)
  
  Displays a particle effect which requires additional data and is only visible for all players within a certain range in the world of @param center
  
  Parameters:
  
  colorTransition - Color transition of the effect
  
  offsetX - Maximum distance particles can fly away from the center on the x-axis
  
  offsetY - Maximum distance particles can fly away from the center on the y-axis
  
  offsetZ - Maximum distance particles can fly away from the center on the z-axis
  
  amount - Amount of particles
  
  center - Center location of the effect
  
  isLongRange - If the particle can be viewed from long range
  
  owner - The player that owns the particles
  
  size - The size of the particles
  
  Throws:
  
  ParticleSpawner.ParticleDataException - If the particle effect does not require additional data or if the data type is incorrect
- display
  
  public void display(Vibration vibration, double offsetX, double offsetY, double offsetZ, int amount, org.bukkit.Location center, boolean isLongRange, org.bukkit.entity.Player owner)
  
  Displays a particle effect which requires additional data and is only visible for all players within a certain range in the world of @param center
  
  Parameters:
  
  vibration - Vibration of the effect
  
  offsetX - Maximum distance particles can fly away from the center on the x-axis
  
  offsetY - Maximum distance particles can fly away from the center on the y-axis
  
  offsetZ - Maximum distance particles can fly away from the center on the z-axis
  
  amount - Amount of particles
  
  center - Center location of the effect
  
  isLongRange - If the particle can be viewed from long range
  
  owner - The player that owns the particles
  
  Throws:
  
  ParticleSpawner.ParticleDataException - If the particle effect does not require additional data or if the data type is incorrect

Enum ParticleEffect

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Details

Method Details