Package com.griefdefender.api.event

Interface BorderClaimEvent

All Superinterfaces:
net.kyori.event.Cancellable, ClaimEvent, Event
public interface BorderClaimEvent extends ClaimEvent, net.kyori.event.Cancellable
An event that is fired when a User or entity crosses a Claim border.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<net.kyori.adventure.text.Component>
    getEnterActionBar()
    Gets the event enter action bar message, if available.
    Optional<net.kyori.adventure.text.Component>
    getEnterChatMessage()
    Gets the event enter message, if available.
    default Claim
    getEnterClaim()
    Gets the claim the entity is attempting to enter.
    Optional<net.kyori.adventure.title.Title>
    getEnterTitle()
    Gets the event enter message, if available.
    UUID
    getEntityUniqueId()
    Gets the target UUID of entity that entered Claim.
    Optional<net.kyori.adventure.text.Component>
    getExitActionBar()
    Gets the event exit action bar, if available.
    Optional<net.kyori.adventure.text.Component>
    getExitChatMessage()
    Gets the event exit message, if available.
    Claim
    getExitClaim()
    Gets the claim the entity is attempting to exit.
    Optional<net.kyori.adventure.title.Title>
    getExitTitle()
    Gets the event exit message, if available.
    @Nullable User
    getUser()
    Gets the target User
    void
    setEnterActionBar(@Nullable net.kyori.adventure.text.Component message)
    Sets the enter action bar message for this event only.
    void
    setEnterChatMessage(@Nullable net.kyori.adventure.text.Component message)
    Sets the enter message for this event only.
    void
    setEnterTitle(@Nullable net.kyori.adventure.title.Title title)
    Sets the enter title for this event only.
    void
    setExitActionBar(@Nullable net.kyori.adventure.text.Component message)
    Sets the exit action bar message for this event only.
    void
    setExitChatMessage(@Nullable net.kyori.adventure.text.Component message)
    Sets the exit message for this event only.
    void
    setExitTitle(@Nullable net.kyori.adventure.title.Title title)
    Sets the exit title for this event only.

    Methods inherited from interface net.kyori.event.Cancellable

    cancelled, cancelled

    Methods inherited from interface com.griefdefender.api.event.ClaimEvent

    getClaim, getClaims, getMessage, getSource, getSourceUser, setMessage

    Methods inherited from interface com.griefdefender.api.event.Event

    getCause

  • Method Details

    • getExitClaim

      Claim getExitClaim()
      Gets the claim the entity is attempting to exit.
      Returns:
      The source claim

    • getEnterClaim

      default Claim getEnterClaim()
      Gets the claim the entity is attempting to enter.
      Returns:
      The destination claim

    • getEntityUniqueId

      UUID getEntityUniqueId()
      Gets the target UUID of entity that entered Claim.
      Returns:
      The target uuid of entity

    • getUser

      @Nullable User getUser()
      Gets the target User
      Returns:
      The target user if available

    • getEnterChatMessage

      Optional<net.kyori.adventure.text.Component> getEnterChatMessage()
      Gets the event enter message, if available.

    • getExitChatMessage

      Optional<net.kyori.adventure.text.Component> getExitChatMessage()
      Gets the event exit message, if available.

    • getEnterActionBar

      Optional<net.kyori.adventure.text.Component> getEnterActionBar()
      Gets the event enter action bar message, if available.

    • getExitActionBar

      Optional<net.kyori.adventure.text.Component> getExitActionBar()
      Gets the event exit action bar, if available.

    • getEnterTitle

      Optional<net.kyori.adventure.title.Title> getEnterTitle()
      Gets the event enter message, if available.

    • getExitTitle

      Optional<net.kyori.adventure.title.Title> getExitTitle()
      Gets the event exit message, if available.

    • setEnterChatMessage

      void setEnterChatMessage(@Nullable net.kyori.adventure.text.Component message)
      Sets the enter message for this event only.
      Parameters:
      message - The message to set

    • setExitChatMessage

      void setExitChatMessage(@Nullable net.kyori.adventure.text.Component message)
      Sets the exit message for this event only.
      Parameters:
      message - The message to set

    • setEnterActionBar

      void setEnterActionBar(@Nullable net.kyori.adventure.text.Component message)
      Sets the enter action bar message for this event only. Note: Setting message to null will hide any message set.
      Parameters:
      message - The message to set

    • setExitActionBar

      void setExitActionBar(@Nullable net.kyori.adventure.text.Component message)
      Sets the exit action bar message for this event only. Note: Setting message to null will hide any message set.
      Parameters:
      message - The message to set

    • setEnterTitle

      void setEnterTitle(@Nullable net.kyori.adventure.title.Title title)
      Sets the enter title for this event only.
      Parameters:
      message - The message to set

    • setExitTitle

      void setExitTitle(@Nullable net.kyori.adventure.title.Title title)
      Sets the exit title for this event only.
      Parameters:
      message - The message to set