Package org.bukkit.event.entity

Class ProjectileHitEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.entity.EntityEvent
org.bukkit.event.entity.ProjectileHitEvent
All Implemented Interfaces:
Cancellable
Direct Known Subclasses:
ExpBottleEvent, LingeringPotionSplashEvent, PotionSplashEvent, TargetHitEvent
public class ProjectileHitEvent extends EntityEvent implements Cancellable
Called when a projectile hits an object

  • Constructor Details

    • ProjectileHitEvent

      @Internal @Deprecated(forRemoval=true) public ProjectileHitEvent(@NotNull @NotNull Projectile projectile)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • ProjectileHitEvent

      @Internal @Deprecated(forRemoval=true) public ProjectileHitEvent(@NotNull @NotNull Projectile projectile, @Nullable @Nullable Entity hitEntity)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • ProjectileHitEvent

      @Internal @Deprecated(forRemoval=true) public ProjectileHitEvent(@NotNull @NotNull Projectile projectile, @Nullable @Nullable Block hitBlock)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • ProjectileHitEvent

      @Internal @Deprecated(forRemoval=true) public ProjectileHitEvent(@NotNull @NotNull Projectile projectile, @Nullable @Nullable Entity hitEntity, @Nullable @Nullable Block hitBlock)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • ProjectileHitEvent

      @Internal public ProjectileHitEvent(@NotNull @NotNull Projectile projectile, @Nullable @Nullable Entity hitEntity, @Nullable @Nullable Block hitBlock, @Nullable @Nullable BlockFace hitFace)

  • Method Details

    • getEntity

      @NotNull public @NotNull Projectile getEntity()
      Description copied from class: EntityEvent
      Returns the Entity involved in this event
      Overrides:
      getEntity in class EntityEvent
      Returns:
      Entity who is involved in this event

    • getHitEntity

      @Nullable public @Nullable Entity getHitEntity()
      Gets the entity that was hit, if it was an entity that was hit.
      Returns:
      hit entity or else null

    • getHitBlock

      @Nullable public @Nullable Block getHitBlock()
      Gets the block that was hit, if it was a block that was hit.
      Returns:
      hit block or else null

    • getHitBlockFace

      @Nullable public @Nullable BlockFace getHitBlockFace()
      Gets the block face that was hit, if it was a block that was hit and the face was provided in the event.
      Returns:
      hit face or else null

    • 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)
      Whether to cancel the action that occurs when the projectile hits.

      In the case of an entity, it will not collide (unless it's a firework, then use FireworkExplodeEvent).
      In the case of a block, some blocks (e.g. target block, bell) will not perform the action associated.

      This does NOT prevent block collisions, and explosions will still occur unless their respective events are cancelled.

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