Package io.papermc.paper.event.player

Class PlayerShieldDisableEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
io.papermc.paper.event.player.PlayerShieldDisableEvent
All Implemented Interfaces:
Cancellable
public class PlayerShieldDisableEvent extends PlayerEvent implements Cancellable
Called whenever a players shield is disabled due to an attack from another entity that was capable of disabling the shield. This, most commonly, may be another player attacking with an axe.

Notably, this even is distinct from a PlayerItemCooldownEvent and will fire prior to the item going on cooldown. It follows that, if this event is cancelled, no PlayerItemCooldownEvent is called as the shield is never disabled in the first place.

  • Constructor Details

  • Method Details

    • getDamager

      @NotNull public @NotNull Entity getDamager()
      Provides the damager that disabled the shield.
      Returns:
      the entity instance that damaged the player in a way that caused the shield to be disabled.

    • getCooldown

      public int getCooldown()
      Gets the cooldown the disabled shield will be disabled for in ticks.

      Notably, this value is not final as it might be changed by a PlayerItemCooldownEvent down the line, as said event is called if this event is not cancelled.

      Returns:
      cooldown in ticks

    • setCooldown

      public void setCooldown(int cooldown)
      Sets the cooldown of the shield in ticks.

      Notably, this value is not final as it might be changed by a PlayerItemCooldownEvent down the line, as said event is called if this event is not cancelled.

      Parameters:
      cooldown - cooldown in ticks, has to be a positive number

    • isCancelled

      public boolean isCancelled()
      Description copied from interface: Cancellable
      Gets 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:
      isCancelled in interface Cancellable
      Returns:
      true if this event is cancelled

    • setCancelled

      public void setCancelled(boolean cancel)
      Description copied from interface: Cancellable
      Sets 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:
      setCancelled in interface Cancellable
      Parameters:
      cancel - true if you wish to cancel this event

    • getHandlers

      @NotNull public @NotNull HandlerList getHandlers()
      Specified by:
      getHandlers in class Event

    • getHandlerList

      @NotNull public static @NotNull HandlerList getHandlerList()