Class PlayerDamageByPlayerEvent

  • All Implemented Interfaces:
    org.bukkit.event.Cancellable

    public class PlayerDamageByPlayerEvent
    extends org.bukkit.event.entity.EntityEvent
    implements org.bukkit.event.Cancellable
    This event is called when a Player damages another Player
    • Field Summary

      • Fields inherited from class org.bukkit.event.entity.EntityEvent

        entity
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.bukkit.event.entity.EntityDamageEvent.DamageCause getCause()
      Returns the EntityDamageEvent.DamageCause of the damage
      double getDamage()
      Returns the amount of damage dealt
      @NotNull org.bukkit.entity.Player getDamagee()
      Same as getEntity(), this is just an alias
      @NotNull org.bukkit.entity.Player getDamager()
      Returns the Player that damaged the defender
      @NotNull org.bukkit.entity.Player getEntity()
      Returns the Player who was damaged
      @NotNull org.bukkit.entity.EntityType getEntityType()
      Will always return EntityType.PLAYER
      static @NotNull org.bukkit.event.HandlerList getHandlerList()
      Returns the HandlerList for this event
      @NotNull org.bukkit.event.HandlerList getHandlers()
      Returns the HandlerList for this event
      boolean isCancelled()  
      void setCancelled​(boolean cancel)  
      void setDamage​(double damage)
      Sets the amount of damage dealt
      @NotNull java.lang.String toString()  
      • Methods inherited from class org.bukkit.event.Event

        getEventName, isAsynchronous
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • PlayerDamageByPlayerEvent

        public PlayerDamageByPlayerEvent​(@NotNull
                                         @NotNull org.bukkit.entity.Player damager,
                                         @NotNull
                                         @NotNull org.bukkit.entity.Player damagee,
                                         @NotNull
                                         org.bukkit.event.entity.EntityDamageEvent.DamageCause cause,
                                         double damage)
        Instantiates a new PlayerDamageByPlayerEvent
        Parameters:
        damager - damager
        damagee - the Player who was damaged by the damager
        cause - cause
        damage - damage
      • PlayerDamageByPlayerEvent

        public PlayerDamageByPlayerEvent​(@NotNull
                                         @NotNull org.bukkit.event.entity.EntityDamageByEntityEvent event)
        Instantiates a new PlayerDamageByPlayerEvent from an EntityDamageByEntityEvent
        Parameters:
        event - the event to instantiate from
    • Method Detail

      • toString

        @NotNull
        public @NotNull java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • getHandlerList

        @NotNull
        public static @NotNull org.bukkit.event.HandlerList getHandlerList()
        Returns the HandlerList for this event
        Returns:
        HANDLERS
      • getHandlers

        @NotNull
        public @NotNull org.bukkit.event.HandlerList getHandlers()
        Returns the HandlerList for this event
        Specified by:
        getHandlers in class org.bukkit.event.Event
        Returns:
        HANDLERS
      • isCancelled

        public boolean isCancelled()
        Specified by:
        isCancelled in interface org.bukkit.event.Cancellable
      • setCancelled

        public void setCancelled​(boolean cancel)
        Specified by:
        setCancelled in interface org.bukkit.event.Cancellable
      • getDamager

        @NotNull
        public @NotNull org.bukkit.entity.Player getDamager()
        Returns the Player that damaged the defender
        Returns:
        Player that damaged the defender
      • getEntity

        @NotNull
        public @NotNull org.bukkit.entity.Player getEntity()
        Returns the Player who was damaged
        Overrides:
        getEntity in class org.bukkit.event.entity.EntityEvent
        Returns:
        Player who was damaged
      • getEntityType

        @NotNull
        public @NotNull org.bukkit.entity.EntityType getEntityType()
        Will always return EntityType.PLAYER
        Overrides:
        getEntityType in class org.bukkit.event.entity.EntityEvent
        Returns:
        EntityType.PLAYER
      • getCause

        @NotNull
        public org.bukkit.event.entity.EntityDamageEvent.DamageCause getCause()
        Returns the EntityDamageEvent.DamageCause of the damage
        Returns:
        EntityDamageEvent.DamageCause of the damage
      • getDamage

        public double getDamage()
        Returns the amount of damage dealt
        Returns:
        the amount of damage dealt
      • setDamage

        public void setDamage​(double damage)
        Sets the amount of damage dealt
        Parameters:
        damage - the amount of damage dealt