Package com.griefdefender.api.data

Interface ClaimDataGetter

All Known Subinterfaces:
ClaimData, TownData
public interface ClaimDataGetter

  • Method Details

    • getWorldUniqueId

      @Nullable UUID getWorldUniqueId()
      Gets the claim's world UUID. Note: This will return null if tied to a
      invalid reference 
      ClaimSnapshot
      as it is not locatable.
      Returns:
      The world UUID

    • getLesserBoundaryCorner

      @Nullable com.flowpowered.math.vector.Vector3i getLesserBoundaryCorner()
      Gets the lesser boundary corner of claim. Note: This will return null if tied to a
      invalid reference 
      ClaimSnapshot
      as it is not locatable.
      Returns:
      The lesser boundary corner position, if available

    • getGreaterBoundaryCorner

      @Nullable com.flowpowered.math.vector.Vector3i getGreaterBoundaryCorner()
      Gets the greater boundary corner of claim. Note: This will return null if tied to a
      invalid reference 
      ClaimSnapshot
      as it is not locatable.
      Returns:
      The greater boundary corner position, if available

    • getSpawnPos

      @Nullable com.flowpowered.math.vector.Vector3i getSpawnPos()
      Gets the spawn position of claim. Note: This will return null if tied to a
      invalid reference 
      ClaimSnapshot
      as it is not locatable.
      Returns:
      The spawn position, if available

    • getClaimGroupUniqueId

      @Nullable UUID getClaimGroupUniqueId()
      Gets the claim group uuid this claim is joined to.
      Returns:
      The claim group uuid, or null if not joined to one

    • getDisplayNameComponent

      Optional<net.kyori.adventure.text.Component> getDisplayNameComponent()
      Gets the claim's display name Component.
      Returns:
      The display name component, if available

    • getDisplayName

      @Nullable String getDisplayName()
      Gets the claim's display name.
      Returns:
      The display name, if available

    • getType

      ClaimType getType()
      Gets the ClaimType of claim.
      Returns:
      The claim type

    • getAttributes

      Set<ClaimAttribute> getAttributes()
      Gets all ClaimAttribute's associated with claim.
      Returns:
      An unmodifiable set of claim attributes.

    • getParentUniqueId

      @Nullable UUID getParentUniqueId()
      Gets the parent claim UUID.
      Returns:
      The parent claim UUID, if available

    • getOwnerUniqueId

      @Nullable UUID getOwnerUniqueId()
      Gets the claim owner's UUID. Note:
      invalid reference 
      ClaimType#ADMIN
      and
      invalid reference 
      ClaimType#WILDERNESS
      claims do not have owners.
      Returns:
      The UUID of this claim

    • getGreeting

      Optional<net.kyori.adventure.text.Component> getGreeting()
      Gets the claim's greeting message.
      Returns:
      The greeting message, if available

    • getFarewell

      Optional<net.kyori.adventure.text.Component> getFarewell()
      Gets the claim's farewell message.
      Returns:
      The farewell message, if available

    • getEnterActionBar

      Optional<net.kyori.adventure.text.Component> getEnterActionBar()
      Gets the claim's enter action bar message.
      Returns:
      The enter action bar message, if available

    • getExitActionBar

      Optional<net.kyori.adventure.text.Component> getExitActionBar()
      Gets the claim's exit action bar message.
      Returns:
      The exit action bar message, if available

    • getEnterTitle

      Optional<net.kyori.adventure.title.Title> getEnterTitle()
      Gets the claim's enter Title.
      Returns:
      The claim's enter title, if available.

    • getExitTitle

      Optional<net.kyori.adventure.title.Title> getExitTitle()
      Gets the claim's exit Title.
      Returns:
      The claim's exit title, if available.

    • getDateCreated

      Instant getDateCreated()
      Gets the creation date of claim.
      Returns:
      The date created

    • getDateLastActive

      Instant getDateLastActive()
      Gets the last active date of claim.
      Returns:
      The last active date

    • allowDenyMessages

      boolean allowDenyMessages()
      Gets whether the claim allows sending deny messages to players.
      Returns:
      Whether deny messages are being sent to players

    • allowExpiration

      boolean allowExpiration()
      Gets whether claim can expire.
      Returns:
      If claim can expire

    • isCuboid

      boolean isCuboid()
      Gets whether claim is a 3D cuboid.
      Returns:
      True if 3D cuboid, false if not

    • doesInheritParent

      boolean doesInheritParent()
      Gets whether this claim is inheriting from parent claim.
      Returns:
      If claim inherits from parent

    • isResizable

      boolean isResizable()
      Gets whether this claim can be resized.
      Returns:
      If resizeable

    • isExpired

      boolean isExpired()
      Gets whether this claim has been expired. Note: All claim actions are denied while in this state.
      Returns:

    • requiresClaimBlocks

      boolean requiresClaimBlocks()
      Gets whether this claim requires claim blocks.
      Returns:
      Whether claim requires claim blocks

    • hasSizeRestrictions

      boolean hasSizeRestrictions()
      Gets whether this claim has min/max size restrictions.
      Returns:
      Whether claim has size restrictions

    • getClanData

      @Nullable ClanData getClanData()
      Gets the ClanData.
      Returns:
      The clan data, if available

    • getEconomyData

      @Nullable EconomyData getEconomyData()
      Gets the EconomyData The economy data, if available

    • getAccessors

      Set<UUID> getAccessors()
      Gets the trusted accessor set of UUID's.
      Returns:
      The mutable accessor uuid set

    • getBuilders

      Set<UUID> getBuilders()
      Gets the trusted builder set of UUID's.
      Returns:
      The mutable builder uuid set

    • getContainers

      Set<UUID> getContainers()
      Gets the trusted container set of UUID's.
      Returns:
      The mutable container uuid set

    • getManagers

      Set<UUID> getManagers()
      Gets the trusted manager set of UUID's.
      Returns:
      The mutable manager uuid set

    • getResidents

      Set<UUID> getResidents()
      Gets the trusted resident set of UUID's.
      Returns:
      The mutable resident uuid set

    • getAccessorGroups

      Set<String> getAccessorGroups()
      Gets the trusted accessor group set of UUID's.
      Returns:
      The mutable accessor group uuid set

    • getBuilderGroups

      Set<String> getBuilderGroups()
      Gets the trusted builder group set of UUID's.
      Returns:
      The mutable builder group uuid set

    • getContainerGroups

      Set<String> getContainerGroups()
      Gets the trusted container group set of UUID's.
      Returns:
      The mutable container group uuid set

    • getManagerGroups

      Set<String> getManagerGroups()
      Gets the trusted manager group set of UUID's.
      Returns:
      The mutable manager group uuid set

    • getResidentGroups

      Set<String> getResidentGroups()
      Gets the trusted resident group set of UUID's.
      Returns:
      The mutable resident group uuid set