Class PlayerLaunchProjectileEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
com.destroystokyo.paper.event.player.PlayerLaunchProjectileEvent
All Implemented Interfaces:
Cancellable

public class PlayerLaunchProjectileEvent extends PlayerEvent implements Cancellable
Called when a player shoots a projectile.

Notably this event is not called for arrows as the player does not launch them, rather shoots them with the help of a bow or crossbow. A plugin may listen to EntityShootBowEvent for these actions instead.

  • Constructor Details

  • Method Details

    • getProjectile

      @NotNull public @NotNull Projectile getProjectile()
      Gets the projectile which will be launched by this event
      Returns:
      the launched projectile
    • getItemStack

      @NotNull public @NotNull ItemStack getItemStack()
      Get the ItemStack used to fire the projectile
      Returns:
      The ItemStack used
    • shouldConsume

      public boolean shouldConsume()
      Get whether to consume the ItemStack or not
      Returns:
      true to consume
    • setShouldConsume

      public void setShouldConsume(boolean consumeItem)
      Set whether to consume the ItemStack or not
      Parameters:
      consumeItem - true to consume
    • 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()