Effect (Paper-API 1.16.1-R0.1-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<Effect>
- - org.bukkit.Effect

All Implemented Interfaces:

Serializable, Comparable<Effect>
```
public enum Effect
extends Enum<Effect>
```
A list of effects that the server is able to send to players.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Effect.Type
Represents the type of an effect.

Nested Classes
Modifier and Type	Class	Description
`static class`	`Effect.Type`	Represents the type of an effect.

Enum Constant Summary

Enum Constants
Enum Constant	Description
`ANVIL_BREAK`	The sound played when an anvil breaks
`ANVIL_LAND`	The sound played when an anvil lands after falling
`ANVIL_USE`	The sound played when an anvil is used
`BAT_TAKEOFF`	Sound played by a bat taking off
`BLAZE_SHOOT`	Sound of blaze firing.
`BOW_FIRE`	Sound of a bow firing.
`BREWING_STAND_BREW`	The sound played by brewing stands when brewing
`CHORUS_FLOWER_DEATH`	The sound played when a chorus flower dies
`CHORUS_FLOWER_GROW`	The sound played when a chorus flower grows
`CLICK1`	A click sound.
`CLICK2`	An alternate click sound.
`DOOR_CLOSE`	Sound of a door closing.
`DOOR_TOGGLE`	Sound of a door opening.
`DRAGON_BREATH`	The sound/particles used by the enderdragon's breath attack.
`END_GATEWAY_SPAWN`	The sound/particles caused by a end gateway spawning
`ENDER_SIGNAL`	An ender eye signal; a visual effect.
`ENDERDRAGON_GROWL`	The sound of an enderdragon growling
`ENDERDRAGON_SHOOT`	Sound of an enderdragon firing
`ENDEREYE_LAUNCH`	The sound played when launching an endereye
`EXTINGUISH`	Sound of fire being extinguished.
`FENCE_GATE_CLOSE`	Sound of a door closing.
`FENCE_GATE_TOGGLE`	Sound of a door opening.
`FIREWORK_SHOOT`	The sound played when launching a firework
`GHAST_SHOOT`	Sound of ghast firing.
`GHAST_SHRIEK`	Sound of ghast shrieking.
`INSTANT_POTION_BREAK`	Visual effect of an instant splash potion breaking.
`IRON_DOOR_CLOSE`	Sound of a door closing.
`IRON_DOOR_TOGGLE`	Sound of a door opening.
`IRON_TRAPDOOR_CLOSE`	Sound of a door closing.
`IRON_TRAPDOOR_TOGGLE`	Sound of a door opening.
`MOBSPAWNER_FLAMES`	The flames seen on a mobspawner; a visual effect.
`PORTAL_TRAVEL`	The sound played when traveling through a portal
`POTION_BREAK`	Visual effect of a splash potion breaking.
`RECORD_PLAY`	A song from a record.
`SMOKE`	A visual smoke effect.
`STEP_SOUND`	Sound of a block breaking.
`TRAPDOOR_CLOSE`	Sound of a trapdoor closing.
`TRAPDOOR_TOGGLE`	Sound of a trapdoor opening.
`VILLAGER_PLANT_GROW`	Particles displayed when a villager grows a plant, data is the number of particles
`WITHER_BREAK_BLOCK`	The sound played when a wither breaks a block
`WITHER_SHOOT`	Sound of a wither shooting
`ZOMBIE_CHEW_IRON_DOOR`	Sound of zombies chewing on iron doors.
`ZOMBIE_CHEW_WOODEN_DOOR`	Sound of zombies chewing on wooden doors.
`ZOMBIE_CONVERTED_VILLAGER`	The sound played when a villager is converted by a zombie
`ZOMBIE_DESTROY_DOOR`	Sound of zombies destroying a door.
`ZOMBIE_INFECT`	The sound played when a zombie infects a target

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static Effect`	`getById(int id)`	Deprecated. Magic value
`Class<?>`	`getData()`
`int`	`getId()`	Deprecated. Magic value
`Effect.Type`	`getType()`
`static Effect`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static Effect[]`	`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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - CLICK2
```
public static final Effect CLICK2
```
    An alternate click sound.
  - CLICK1
```
public static final Effect CLICK1
```
    A click sound.
  - BOW_FIRE
```
public static final Effect BOW_FIRE
```
    Sound of a bow firing.
  - DOOR_TOGGLE
```
public static final Effect DOOR_TOGGLE
```
    Sound of a door opening.
  - IRON_DOOR_TOGGLE
```
public static final Effect IRON_DOOR_TOGGLE
```
    Sound of a door opening.
  - TRAPDOOR_TOGGLE
```
public static final Effect TRAPDOOR_TOGGLE
```
    Sound of a trapdoor opening.
  - IRON_TRAPDOOR_TOGGLE
```
public static final Effect IRON_TRAPDOOR_TOGGLE
```
    Sound of a door opening.
  - FENCE_GATE_TOGGLE
```
public static final Effect FENCE_GATE_TOGGLE
```
    Sound of a door opening.
  - DOOR_CLOSE
```
public static final Effect DOOR_CLOSE
```
    Sound of a door closing.
  - IRON_DOOR_CLOSE
```
public static final Effect IRON_DOOR_CLOSE
```
    Sound of a door closing.
  - TRAPDOOR_CLOSE
```
public static final Effect TRAPDOOR_CLOSE
```
    Sound of a trapdoor closing.
  - IRON_TRAPDOOR_CLOSE
```
public static final Effect IRON_TRAPDOOR_CLOSE
```
    Sound of a door closing.
  - FENCE_GATE_CLOSE
```
public static final Effect FENCE_GATE_CLOSE
```
    Sound of a door closing.
  - EXTINGUISH
```
public static final Effect EXTINGUISH
```
    Sound of fire being extinguished.
  - RECORD_PLAY
```
public static final Effect RECORD_PLAY
```
    A song from a record. Needs the record item ID as additional info
  - GHAST_SHRIEK
```
public static final Effect GHAST_SHRIEK
```
    Sound of ghast shrieking.
  - GHAST_SHOOT
```
public static final Effect GHAST_SHOOT
```
    Sound of ghast firing.
  - BLAZE_SHOOT
```
public static final Effect BLAZE_SHOOT
```
    Sound of blaze firing.
  - ZOMBIE_CHEW_WOODEN_DOOR
```
public static final Effect ZOMBIE_CHEW_WOODEN_DOOR
```
    Sound of zombies chewing on wooden doors.
  - ZOMBIE_CHEW_IRON_DOOR
```
public static final Effect ZOMBIE_CHEW_IRON_DOOR
```
    Sound of zombies chewing on iron doors.
  - ZOMBIE_DESTROY_DOOR
```
public static final Effect ZOMBIE_DESTROY_DOOR
```
    Sound of zombies destroying a door.
  - SMOKE
```
public static final Effect SMOKE
```
    A visual smoke effect. Needs direction as additional info.
  - STEP_SOUND
```
public static final Effect STEP_SOUND
```
    Sound of a block breaking. Needs block ID as additional info.
  - POTION_BREAK
```
public static final Effect POTION_BREAK
```
    Visual effect of a splash potion breaking. Needs potion data value as additional info.
  - INSTANT_POTION_BREAK
```
public static final Effect INSTANT_POTION_BREAK
```
    Visual effect of an instant splash potion breaking. Needs color data value as additional info.
  - ENDER_SIGNAL
```
public static final Effect ENDER_SIGNAL
```
    An ender eye signal; a visual effect.
  - MOBSPAWNER_FLAMES
```
public static final Effect MOBSPAWNER_FLAMES
```
    The flames seen on a mobspawner; a visual effect.
  - BREWING_STAND_BREW
```
public static final Effect BREWING_STAND_BREW
```
    The sound played by brewing stands when brewing
  - CHORUS_FLOWER_GROW
```
public static final Effect CHORUS_FLOWER_GROW
```
    The sound played when a chorus flower grows
  - CHORUS_FLOWER_DEATH
```
public static final Effect CHORUS_FLOWER_DEATH
```
    The sound played when a chorus flower dies
  - PORTAL_TRAVEL
```
public static final Effect PORTAL_TRAVEL
```
    The sound played when traveling through a portal
  - ENDEREYE_LAUNCH
```
public static final Effect ENDEREYE_LAUNCH
```
    The sound played when launching an endereye
  - FIREWORK_SHOOT
```
public static final Effect FIREWORK_SHOOT
```
    The sound played when launching a firework
  - VILLAGER_PLANT_GROW
```
public static final Effect VILLAGER_PLANT_GROW
```
    Particles displayed when a villager grows a plant, data is the number of particles
  - DRAGON_BREATH
```
public static final Effect DRAGON_BREATH
```
    The sound/particles used by the enderdragon's breath attack.
  - ANVIL_BREAK
```
public static final Effect ANVIL_BREAK
```
    The sound played when an anvil breaks
  - ANVIL_USE
```
public static final Effect ANVIL_USE
```
    The sound played when an anvil is used
  - ANVIL_LAND
```
public static final Effect ANVIL_LAND
```
    The sound played when an anvil lands after falling
  - ENDERDRAGON_SHOOT
```
public static final Effect ENDERDRAGON_SHOOT
```
    Sound of an enderdragon firing
  - WITHER_BREAK_BLOCK
```
public static final Effect WITHER_BREAK_BLOCK
```
    The sound played when a wither breaks a block
  - WITHER_SHOOT
```
public static final Effect WITHER_SHOOT
```
    Sound of a wither shooting
  - ZOMBIE_INFECT
```
public static final Effect ZOMBIE_INFECT
```
    The sound played when a zombie infects a target
  - ZOMBIE_CONVERTED_VILLAGER
```
public static final Effect ZOMBIE_CONVERTED_VILLAGER
```
    The sound played when a villager is converted by a zombie
  - BAT_TAKEOFF
```
public static final Effect BAT_TAKEOFF
```
    Sound played by a bat taking off
  - END_GATEWAY_SPAWN
```
public static final Effect END_GATEWAY_SPAWN
```
    The sound/particles caused by a end gateway spawning
  - ENDERDRAGON_GROWL
```
public static final Effect ENDERDRAGON_GROWL
```
    The sound of an enderdragon growling
- Method Detail
  - values
```
public static Effect[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Effect c : Effect.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Effect valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getId
```
@Deprecated
public int getId()
```
    Deprecated.
    Magic value
    
    Gets the ID for this effect.
    
    Returns:
    
    ID of this effect
  - getType
```
@NotNull
public Effect.Type getType()
```
    Returns:
    
    The type of the effect.
  - getData
```
@Nullable
public Class<?> getData()
```
    Returns:
    
    The class which represents data for this effect, or null if none
  - getById
```
@Deprecated
@Nullable
public static Effect getById(int id)
```
    Deprecated.
    Magic value
    
    Gets the Effect associated with the given ID.
    
    Parameters:
    
    id - ID of the Effect to return
    
    Returns:
    
    Effect with the given ID

Enum Effect

Nested Class Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

CLICK2

CLICK1

BOW_FIRE

DOOR_TOGGLE

IRON_DOOR_TOGGLE

TRAPDOOR_TOGGLE

IRON_TRAPDOOR_TOGGLE

FENCE_GATE_TOGGLE

DOOR_CLOSE

IRON_DOOR_CLOSE

TRAPDOOR_CLOSE

IRON_TRAPDOOR_CLOSE

FENCE_GATE_CLOSE

EXTINGUISH

RECORD_PLAY

GHAST_SHRIEK

GHAST_SHOOT

BLAZE_SHOOT

ZOMBIE_CHEW_WOODEN_DOOR

ZOMBIE_CHEW_IRON_DOOR

ZOMBIE_DESTROY_DOOR

SMOKE

STEP_SOUND

POTION_BREAK

INSTANT_POTION_BREAK

ENDER_SIGNAL

MOBSPAWNER_FLAMES

BREWING_STAND_BREW

CHORUS_FLOWER_GROW

CHORUS_FLOWER_DEATH

PORTAL_TRAVEL

ENDEREYE_LAUNCH

FIREWORK_SHOOT

VILLAGER_PLANT_GROW

DRAGON_BREATH

ANVIL_BREAK

ANVIL_USE

ANVIL_LAND

ENDERDRAGON_SHOOT

WITHER_BREAK_BLOCK

WITHER_SHOOT

ZOMBIE_INFECT

ZOMBIE_CONVERTED_VILLAGER

BAT_TAKEOFF

END_GATEWAY_SPAWN

ENDERDRAGON_GROWL

Method Detail

values

valueOf

getId

getType

getData

getById