Class GraveObituaryAddEvent

java.lang.Object
org.bukkit.event.Event
dev.cwhead.GravesX.event.graveevent.GraveEvent
dev.cwhead.GravesX.event.GraveObituaryAddEvent
All Implemented Interfaces:
Addon, org.bukkit.event.Cancellable
Direct Known Subclasses:
GraveObituaryAddEvent

public class GraveObituaryAddEvent extends GraveEvent
Represents an event that occurs when an Obituary is added to a grave.

This event extends GraveEvent and is cancellable, allowing event listeners to prevent obituaries from being included in graves.

  • Field Details

    • HANDLERS

      private static final org.bukkit.event.HandlerList HANDLERS
      A static final instance of HandlerList used to manage event handlers.

      This HandlerList is used to register and manage the handlers for events of this type. It provides the mechanism for adding, removing, and invoking event handlers.

    • entity

      @Nullable private final @Nullable org.bukkit.entity.Entity entity
      The entity for which the grave is being created
  • Constructor Details

    • GraveObituaryAddEvent

      public GraveObituaryAddEvent(@NotNull @NotNull Grave grave, @NotNull @NotNull org.bukkit.Location location, @Nullable @Nullable org.bukkit.entity.Entity entity)
      Constructs a new GraveObituaryAddEvent.
      Parameters:
      grave - The grave associated with the event.
      location - The location associated with this obituary addition.
      entity - The entity for which the grave is being created (nullable).
  • Method Details

    • hasEntity

      public boolean hasEntity()
      Checks if there is an entity.
      Returns:
      true if an entity is present on this event.
    • getEntity

      @NotNull public @NotNull org.bukkit.entity.Entity getEntity()
      Gets the entity for which the grave is being created.
      Returns:
      The entity.
      Throws:
      GravesXEventMethodNotSupportedException - if no entity is present.
    • hasPlayer

      public boolean hasPlayer()
      Checks if the grave is a player.
      Returns:
      true if player, false otherwise
    • getPlayer

      @NotNull public @NotNull org.bukkit.entity.Player getPlayer()
      Gets the entity for which the grave is being created.
      Returns:
      The entity.
      Throws:
      GravesXEventNullPointerException - if player is null
      GravesXEventIllegalArgumentException - if entity pulled was not a player
    • getHandlers

      @NotNull public @NotNull org.bukkit.event.HandlerList getHandlers()
      Gets the list of handlers for this event.
      Overrides:
      getHandlers in class GraveEvent
      Returns:
      The handler list for this event.
    • getHandlerList

      @NotNull public static @NotNull org.bukkit.event.HandlerList getHandlerList()
      Gets the static list of handlers for this event.
      Returns:
      The static handler list for this event.