Class BeaconEffectEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.block.BlockEvent
com.destroystokyo.paper.event.block.BeaconEffectEvent
All Implemented Interfaces:
Cancellable

@NullMarked public class BeaconEffectEvent extends BlockEvent implements Cancellable
Called when a beacon effect is being applied to a player.
  • Constructor Details

  • Method Details

    • getEffect

      public PotionEffect getEffect()
      Gets the potion effect being applied.
      Returns:
      Potion effect
    • setEffect

      public void setEffect(PotionEffect effect)
      Sets the potion effect that will be applied.
      Parameters:
      effect - Potion effect
    • getPlayer

      public Player getPlayer()
      Gets the player who the potion effect is being applied to.
      Returns:
      Affected player
    • isPrimary

      public boolean isPrimary()
      Gets whether the effect is a primary beacon effect.
      Returns:
      true if this event represents a primary effect
    • 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

      public HandlerList getHandlers()
      Specified by:
      getHandlers in class Event
    • getHandlerList

      public static HandlerList getHandlerList()