Class PlayerDeathEvent

    • Constructor Detail

      • PlayerDeathEvent

        public PlayerDeathEvent​(@NotNull
                                Player player,
                                @NotNull
                                List<ItemStack> drops,
                                int droppedExp,
                                @Nullable
                                String deathMessage)
      • PlayerDeathEvent

        public PlayerDeathEvent​(@NotNull
                                Player player,
                                @NotNull
                                List<ItemStack> drops,
                                int droppedExp,
                                int newExp,
                                @Nullable
                                String deathMessage)
      • PlayerDeathEvent

        public PlayerDeathEvent​(@NotNull
                                Player player,
                                @NotNull
                                List<ItemStack> drops,
                                int droppedExp,
                                int newExp,
                                int newTotalExp,
                                int newLevel,
                                @Nullable
                                String deathMessage)
    • Method Detail

      • getEntity

        @NotNull
        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​(@Nullable
                                    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

        @Nullable
        public 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.

        This doesn't prevent prevent the items from dropping. getDrops().clear() should be used stop the items from dropping.

        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