Package org.bukkit.event.entity
Class EntityDeathEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.entity.EntityEvent
org.bukkit.event.entity.EntityDeathEvent
- All Implemented Interfaces:
Cancellable
- Direct Known Subclasses:
PlayerDeathEvent
Thrown whenever a LivingEntity dies
-
Nested Class Summary
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result -
Field Summary
Fields inherited from class org.bukkit.event.entity.EntityEvent
entity -
Constructor Summary
ConstructorsConstructorDescriptionEntityDeathEvent(@NotNull LivingEntity livingEntity, @NotNull DamageSource damageSource, @NotNull List<ItemStack> drops) EntityDeathEvent(@NotNull LivingEntity livingEntity, @NotNull DamageSource damageSource, @NotNull List<ItemStack> drops, int droppedExp) -
Method Summary
Modifier and TypeMethodDescriptionGets the source of damage which caused the death.Get the sound that the entity makes when dyingGet the sound category that the death sound should play infloatGet the pitch that the death sound will play with.floatGet the volume that the death sound will play at.intGets how much EXP should be dropped from this death.getDrops()Gets all the items which will drop when the entity diesReturns the Entity involved in this eventstatic @NotNull HandlerListdoubleGet the amount of health that the entity should revive with after cancelling the event.booleanGets the cancellation state of this event.voidsetCancelled(boolean cancel) Sets the cancellation state of this event.voidsetDeathSound(Sound sound) Set the sound that the entity makes when dyingvoidsetDeathSoundCategory(SoundCategory soundCategory) Set the sound category that the death sound should play in.voidsetDeathSoundPitch(float pitch) Set the pitch that the death sound should play with.voidsetDeathSoundVolume(float volume) Set the volume the death sound should play at.voidsetDroppedExp(int exp) Sets how much EXP should be dropped from this death.voidsetReviveHealth(double reviveHealth) Set the amount of health that the entity should revive with after cancelling the event.voidsetShouldPlayDeathSound(boolean playDeathSound) Set whether the death sound should play when the entity dies.booleanWhether the death sound should play when the entity dies.Methods inherited from class org.bukkit.event.entity.EntityEvent
getEntityTypeMethods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
EntityDeathEvent
-
EntityDeathEvent
-
-
Method Details
-
getEntity
Description copied from class:EntityEventReturns the Entity involved in this event- Overrides:
getEntityin classEntityEvent- Returns:
- Entity who is involved in this event
-
getDamageSource
Gets the source of damage which caused the death.- Returns:
- a DamageSource detailing the source of the damage for the death.
-
getDroppedExp
public int getDroppedExp()Gets how much EXP should be dropped from this death.This does not indicate how much EXP should be taken from the entity in question, merely how much should be created after its death.
- Returns:
- Amount of EXP to drop.
-
setDroppedExp
public void setDroppedExp(int exp) Sets how much EXP should be dropped from this death.This does not indicate how much EXP should be taken from the entity in question, merely how much should be created after its death.
- Parameters:
exp- Amount of EXP to drop.
-
getDrops
Gets all the items which will drop when the entity dies- Returns:
- Items to drop when the entity dies
-
getReviveHealth
public double getReviveHealth()Get the amount of health that the entity should revive with after cancelling the event. Set to the entity's max health by default.- Returns:
- The amount of health
-
setReviveHealth
Set the amount of health that the entity should revive with after cancelling the event. Revive health value must be between 0 (exclusive) and the entity's max health (inclusive).- Parameters:
reviveHealth- The amount of health- Throws:
IllegalArgumentException- Thrown if the health is <= 0 or > max health
-
shouldPlayDeathSound
public boolean shouldPlayDeathSound()Whether the death sound should play when the entity dies. If the event is cancelled it does not play!- Returns:
- Whether the death sound should play. Event is called with this set to
falseif the entity is silent.
-
setShouldPlayDeathSound
public void setShouldPlayDeathSound(boolean playDeathSound) Set whether the death sound should play when the entity dies. If the event is cancelled it does not play!- Parameters:
playDeathSound- Enable or disable the death sound
-
getDeathSound
Get the sound that the entity makes when dying- Returns:
- The sound that the entity makes
-
setDeathSound
Set the sound that the entity makes when dying- Parameters:
sound- The sound that the entity should make when dying
-
getDeathSoundCategory
Get the sound category that the death sound should play in- Returns:
- The sound category
-
setDeathSoundCategory
Set the sound category that the death sound should play in.- Parameters:
soundCategory- The sound category
-
getDeathSoundVolume
public float getDeathSoundVolume()Get the volume that the death sound will play at.- Returns:
- The volume the death sound will play at
-
setDeathSoundVolume
public void setDeathSoundVolume(float volume) Set the volume the death sound should play at. If the event is cancelled this will not play the sound!- Parameters:
volume- The volume the death sound should play at
-
getDeathSoundPitch
public float getDeathSoundPitch()Get the pitch that the death sound will play with.- Returns:
- The pitch the death sound will play with
-
setDeathSoundPitch
public void setDeathSoundPitch(float pitch) Set the pitch that the death sound should play with.- Parameters:
pitch- The pitch the death sound should play with
-
isCancelled
public boolean isCancelled()Description copied from interface:CancellableGets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins- Specified by:
isCancelledin interfaceCancellable- Returns:
trueif this event is cancelled
-
setCancelled
public void setCancelled(boolean cancel) Description copied from interface:CancellableSets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.- Specified by:
setCancelledin interfaceCancellable- Parameters:
cancel-trueif you wish to cancel this event
-
getHandlers
- Specified by:
getHandlersin classEvent
-
getHandlerList
-