Package com.griefdefender.api.claim

Interface Claim.Builder

Enclosing interface:
Claim
public static interface Claim.Builder

  • Method Details

    • bounds

      default Claim.Builder bounds(com.flowpowered.math.vector.Vector3i p1, com.flowpowered.math.vector.Vector3i p2)
      The position bounds of claim.
      Parameters:
      p1 - The lesser boundary position
      p2 - The greater boundary position
      Returns:
      The builder

    • bounds

      Claim.Builder bounds(int x1, int x2, int y1, int y2, int z1, int z2)
      The position bounds of claim.
      Parameters:
      x1 - The start X-axis position
      x2 - The end X-axis position
      y1 - The start Y-axis position
      y2 - The end Y-axis position
      z1 - The start Z-axis position
      z2 - The end Z-axis position
      Returns:
      The builder

    • cuboid

      Claim.Builder cuboid(boolean cuboid)
      Toggles whether this claim is cuboid
      Parameters:
      cuboid - Whether claim is cuboid
      Returns:
      The builder

    • source

      Claim.Builder source(Object source)
      The source creating this Claim.
      Parameters:
      source - The source creating claim
      Returns:
      The builder

    • owner

      Claim.Builder owner(UUID ownerUniqueId)
      The owner of claim. Note:
      invalid reference 
      ClaimType#ADMIN
      does not use owners.
      Parameters:
      ownerUniqueId - The claim owner UUID, if available
      Returns:
      The builder

    • identifier

      Claim.Builder identifier(String identifier)
      The unique claim identifier. Note: This represents the unique friendly identifier of claim and is different from the display name.
      Parameters:
      identifier - The unique claim identifier
      Returns:
      The builder

    • type

      Claim.Builder type(ClaimType type)
      The claim type.
      Parameters:
      type - The claim type
      Returns:
      The builder

    • attributes

      Claim.Builder attributes(Set<ClaimAttribute> attributes)
      The claim attributes.
      Parameters:
      attributes - The claim attributes
      Returns:
      The builder

    • world

      Claim.Builder world(UUID worldUniqueId)
      The world to add claim into.
      Parameters:
      world - The world
      Returns:
      The builder

    • parent

      Claim.Builder parent(Claim parent)
      The parent claim. Note: This is required when adding a child claim to an existing parent.
      Parameters:
      parent - The parent, if available
      Returns:
      The builder

    • denyMessages

      Claim.Builder denyMessages(boolean allowDeny)
      Toggles whether this claim allows deny messages to be sent to players. If false, no deny messages will be sent.
      Parameters:
      allowDeny - Whether to allow sending deny messages to players
      Returns:
      The builder

    • expire

      Claim.Builder expire(boolean allowExpire)
      Toggles whether this claim can expire due to no activity.
      Parameters:
      allowExpire - Whether this claim can expire
      Returns:
      The builder

    • farewell

      Claim.Builder farewell(net.kyori.adventure.text.Component farewell)
      Sets the farewell message when a player exits the claim.
      Parameters:
      farewell - The farewell message
      Returns:
      The builder

    • greeting

      Claim.Builder greeting(net.kyori.adventure.text.Component greeting)
      Sets the greeting message when a player exits the claim.
      Parameters:
      greeting - The greeting message
      Returns:
      The builder

    • inherit

      Claim.Builder inherit(boolean inherit)
      Toggles whether this claim is inheriting from parent claim.
      Parameters:
      inherit - Whether claim inherits from parent
      Returns:
      The builder

    • requireClaimBlocks

      Claim.Builder requireClaimBlocks(boolean requireClaimBlocks)
      Sets if this claim requires claim blocks from players. Note: This is true by default.
      Parameters:
      requireClaimBlocks - Whether this claim requires claim blocks
      Returns:
      The builder

    • resizable

      Claim.Builder resizable(boolean allowResize)
      Toggles whether this claim is resizable.
      Parameters:
      allowResize - Whether claim can be resized.

    • createLimitRestrictions

      Claim.Builder createLimitRestrictions(boolean checkLimit)
      Whether to check
      invalid reference 
      PlayerData#getCreateClaimLimit()
      .
      Parameters:
      checkLimit - Whether to check for claim creation restrictions.
      Returns:
      The builder

    • levelRestrictions

      Claim.Builder levelRestrictions(boolean checkLevel)
      Whether to check PlayerData.getMinClaimLevel() and PlayerData.getMaxClaimLevel().
      Parameters:
      checkLevel - Whether to check for level restrictions.
      Returns:
      The builder

    • sizeRestrictions

      Claim.Builder sizeRestrictions(boolean checkSize)
      Whether to check for min/max size restrictions.
      Parameters:
      checkSize - Whether to check for size restrictions.
      Returns:
      The builder

    • spawnPos

      default Claim.Builder spawnPos(com.flowpowered.math.vector.Vector3i pos)
      The spawn position of this claim.
      Parameters:
      pos - The spawn position
      Returns:
      The builder

    • spawnPos

      Claim.Builder spawnPos(int x, int y, int z)
      The spawn position of this claim.
      Parameters:
      x - X coordinate
      y - Y coordinate
      z - Z coordinate
      Returns:
      The builder

    • reset

      Claim.Builder reset()
      Resets the builder to default settings.
      Returns:
      The builder

    • build

      ClaimResult build()
      Returns the ClaimResult.
      Returns:
      The claim result