Package org.bukkit.event.entity

Class PlayerDeathEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.entity.EntityEvent
org.bukkit.event.entity.EntityDeathEvent
org.bukkit.event.entity.PlayerDeathEvent
public class PlayerDeathEvent
extends EntityDeathEvent
Thrown whenever a Player 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

    Constructors 
    Constructor Description
    PlayerDeathEvent​(Player player, java.util.List<ItemStack> drops, int droppedExp, int newExp, int newTotalExp, int newLevel, java.lang.String deathMessage)  
    PlayerDeathEvent​(Player player, java.util.List<ItemStack> drops, int droppedExp, int newExp, java.lang.String deathMessage)  
    PlayerDeathEvent​(Player player, java.util.List<ItemStack> drops, int droppedExp, java.lang.String deathMessage)  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getDeathMessage()
    Get the death message that will appear to everyone on the server.
    Player getEntity()
    Returns the Entity involved in this event
    boolean getKeepInventory()
    Gets if the Player keeps inventory on death.
    boolean getKeepLevel()
    Gets if the Player should keep all EXP at respawn.
    int getNewExp()
    Gets how much EXP the Player should have at respawn.
    int getNewLevel()
    Gets the Level the Player should have at respawn.
    int getNewTotalExp()
    Gets the Total EXP the Player should have at respawn.
    void setDeathMessage​(java.lang.String deathMessage)
    Set the death message that will appear to everyone on the server.
    void setKeepInventory​(boolean keepInventory)
    Sets if the Player keeps inventory on death.
    void setKeepLevel​(boolean keepLevel)
    Sets if the Player should keep all EXP at respawn.
    void setNewExp​(int exp)
    Sets how much EXP the Player should have at respawn.
    void setNewLevel​(int level)
    Sets the Level the Player should have at respawn.
    void setNewTotalExp​(int totalExp)
    Sets the Total EXP the Player should have at respawn.

    Methods inherited from class org.bukkit.event.entity.EntityDeathEvent

    getDroppedExp, getDrops, getHandlerList, getHandlers, setDroppedExp

    Methods inherited from class org.bukkit.event.entity.EntityEvent

    getEntityType

    Methods inherited from class org.bukkit.event.Event

    getEventName, isAsynchronous

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PlayerDeathEvent

      public PlayerDeathEvent​(Player player, java.util.List<ItemStack> drops, int droppedExp, java.lang.String deathMessage)

    • PlayerDeathEvent

      public PlayerDeathEvent​(Player player, java.util.List<ItemStack> drops, int droppedExp, int newExp, java.lang.String deathMessage)

    • PlayerDeathEvent

      public PlayerDeathEvent​(Player player, java.util.List<ItemStack> drops, int droppedExp, int newExp, int newTotalExp, int newLevel, java.lang.String deathMessage)

  • Method Details

    • getEntity

      public Player getEntity()
      Description copied from class: EntityEvent
      Returns the Entity involved in this event
      Overrides:
      getEntity in class EntityDeathEvent
      Returns:
      Entity who is involved in this event

    • setDeathMessage

      public void setDeathMessage​(java.lang.String deathMessage)
      Set the death message that will appear to everyone on the server.
      Parameters:
      deathMessage - Message to appear to other players on the server.

    • getDeathMessage

      public java.lang.String getDeathMessage()
      Get the death message that will appear to everyone on the server.
      Returns:
      Message to appear to other players on the server.

    • getNewExp

      public int getNewExp()
      Gets how much EXP the Player should have at respawn.

      This does not indicate how much EXP should be dropped, please see EntityDeathEvent.getDroppedExp() for that.

      Returns:
      New EXP of the respawned player

    • setNewExp

      public void setNewExp​(int exp)
      Sets how much EXP the Player should have at respawn.

      This does not indicate how much EXP should be dropped, please see EntityDeathEvent.setDroppedExp(int) for that.

      Parameters:
      exp - New EXP of the respawned player

    • getNewLevel

      public int getNewLevel()
      Gets the Level the Player should have at respawn.
      Returns:
      New Level of the respawned player

    • setNewLevel

      public void setNewLevel​(int level)
      Sets the Level the Player should have at respawn.
      Parameters:
      level - New Level of the respawned player

    • getNewTotalExp

      public int getNewTotalExp()
      Gets the Total EXP the Player should have at respawn.
      Returns:
      New Total EXP of the respawned player

    • setNewTotalExp

      public void setNewTotalExp​(int totalExp)
      Sets the Total EXP the Player should have at respawn.
      Parameters:
      totalExp - New Total EXP of the respawned player

    • getKeepLevel

      public boolean getKeepLevel()
      Gets if the Player should keep all EXP at respawn.

      This flag overrides other EXP settings

      Returns:
      True if Player should keep all pre-death exp

    • setKeepLevel

      public void setKeepLevel​(boolean keepLevel)
      Sets if the Player should keep all EXP at respawn.

      This overrides all other EXP settings

      This doesn't prevent prevent the EXP from dropping. EntityDeathEvent.setDroppedExp(int) should be used stop the EXP from dropping.

      Parameters:
      keepLevel - True to keep all current value levels

    • setKeepInventory

      public void setKeepInventory​(boolean keepInventory)
      Sets if the Player keeps inventory on death.
      Parameters:
      keepInventory - True to keep the inventory

    • getKeepInventory

      public boolean getKeepInventory()
      Gets if the Player keeps inventory on death.
      Returns:
      True if the player keeps inventory on death