Package com.griefdefender.api.claim

Interface ClaimManager

public interface ClaimManager
Used to manage one or more Claim's in a world.

  • Method Details

    • getWildernessClaim

      Claim getWildernessClaim()
      Gets the wilderness claim of this manager's world.
      Returns:
      The wilderness claim

    • getClaimAt

      Claim getClaimAt(com.flowpowered.math.vector.Vector3i pos)
      Gets the Claim at specified position.
      Parameters:
      pos - The pos to check
      Returns:
      The claim if available, otherwise returns the wilderness claim if none were found.

    • getClaimAt

      Claim getClaimAt(int x, int y, int z)
      Gets the Claim at specified position.
      Parameters:
      x - X coordinate
      y - Y coordinate
      z - Z coordinate
      Returns:
      The claim if available, otherwise returns the wilderness claim if none were found.

    • getClaimByUUID

      @Nullable Claim getClaimByUUID(UUID claimUniqueId)
      Gets the Claim with specified UUID.
      Parameters:
      claimUniqueId - The claim UUID to search for
      Returns:
      The claim, if available

    • getClaimsByDisplayName

      List<Claim> getClaimsByDisplayName(String name)
      Gets a list of Claim's with specified name.
      Parameters:
      name - The claim name to search for
      Returns:
      The list of claims, empty list if none were found

    • getPlayerClaims

      Set<Claim> getPlayerClaims(UUID playerUniqueId)
      Gets a set view of player Claim's for specified UUID. Note: This will return an empty list if player has no claims.
      Parameters:
      playerUniqueId - The player UUID
      Returns:
      An unmodifiable set view of claims, empty list if none were found

    • getWorldClaims

      Set<Claim> getWorldClaims()
      Gets a set view all world Claim's for specified UUID. Note: This will return an empty list if no world claims are found.
      Returns:
      An unmodifiable set view of world claims, empty list if none were found

    • getChunksToClaimsMap

      Map<Long,Set<Claim>> getChunksToClaimsMap()
      Gets an unmodifiable map view of chunk hashes to Claim's.
      Returns:
      An unmodifiable map view of chunk hashes to claims, empty map if none exist.

    • deleteClaim

      default ClaimResult deleteClaim(Claim claim)
      Deletes a Claim from the managed world.
      Parameters:
      claim - The claim to delete
      Returns:
      The claim result

    • deleteClaim

      ClaimResult deleteClaim(Claim claim, boolean deleteChildren)
      Deletes a Claim from the managed world. Note: If children are not deleted, they will be moved to parent claim if one exists. If no parent exists, they will simply be moved to wilderness.
      Parameters:
      claim - The claim to delete
      deleteChildren - Whether to delete children
      Returns:
      The claim result

    • getWorldId

      UUID getWorldId()
      Gets the managed UUID.
      Returns:
      The managed world uuid