Class PlayerChangeBeaconEffectEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
io.papermc.paper.event.player.PlayerChangeBeaconEffectEvent
All Implemented Interfaces:
Cancellable
@NullMarked public class PlayerChangeBeaconEffectEvent extends PlayerEvent implements Cancellable
Called when a player sets the effect for a beacon

  • Constructor Details

  • Method Details

    • getPrimary

      public @Nullable PotionEffectType getPrimary()
      Returns:
      the primary effect

    • setPrimary

      public void setPrimary(@Nullable PotionEffectType primary)
      Sets the primary effect

      NOTE: The primary effect still has to be one of the valid effects for a beacon.

      Parameters:
      primary - the primary effect

    • getSecondary

      public @Nullable PotionEffectType getSecondary()
      Returns:
      the secondary effect

    • setSecondary

      public void setSecondary(@Nullable PotionEffectType secondary)
      Sets the secondary effect

      This only has an effect when the beacon is able to accept a secondary effect. NOTE: The secondary effect still has to be a valid effect for a beacon.

      Parameters:
      secondary - the secondary effect

    • getBeacon

      public Block getBeacon()
      Gets the block at the location associated with the beacon menu. This block may not be a beacon, for example when the menu is virtual.
      Returns:
      the block at the menu's location

    • willConsumeItem

      public boolean willConsumeItem()
      Gets if the item used to change the beacon will be consumed.

      Independent of isCancelled(). If the event is cancelled the item will NOT be consumed.

      Returns:
      true if item will be consumed

    • setConsumeItem

      public void setConsumeItem(boolean consumeItem)
      Sets if the item used to change the beacon should be consumed.

      Independent of isCancelled(). If the event is cancelled the item will NOT be consumed.

      Parameters:
      consumeItem - true if item should be consumed

    • isCancelled

      public boolean isCancelled()
      Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins

      If a PlayerChangeBeaconEffectEvent is cancelled, the changes will not take effect

      Specified by:
      isCancelled in interface Cancellable
      Returns:
      true if this event is cancelled

    • setCancelled

      public void setCancelled(boolean cancel)
      Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

      If cancelled, the item will NOT be consumed regardless of what willConsumeItem() says

      If a PlayerChangeBeaconEffectEvent is cancelled, the changes will not be applied or saved.

      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()