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
Since:
1.16.5

  • Constructor Details

  • Method Details

    • getPrimary

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

    • 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
      Since:
      1.16.5

    • getSecondary

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

    • 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
      Since:
      1.16.5

    • getBeacon

      public Block getBeacon()
      Returns:
      the beacon block associated with this event
      Since:
      1.16.5

    • 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
      Since:
      1.16.5

    • 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
      Since:
      1.16.5

    • 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
      Since:
      1.16.5

    • 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
      Since:
      1.16.5

    • getHandlers

      public HandlerList getHandlers()
      Specified by:
      getHandlers in class Event
      Since:
      1.16.5

    • getHandlerList

      public static HandlerList getHandlerList()
      Since:
      1.16.5