Package com.griefdefender.api.data

Interface ClaimData.Builder

Enclosing interface:
ClaimData
public static interface ClaimData.Builder

  • Method Details

    • getWorldUniqueId

      UUID getWorldUniqueId()

    • getLesserBoundaryPos

      com.flowpowered.math.vector.Vector3i getLesserBoundaryPos()

    • getGreaterBoundaryPos

      com.flowpowered.math.vector.Vector3i getGreaterBoundaryPos()

    • getSpawnPos

      @Nullable com.flowpowered.math.vector.Vector3i getSpawnPos()

    • getClanData

      @Nullable ClanDataGetter getClanData()

    • getEconomyData

      @Nullable EconomyDataGetter getEconomyData()

    • getDisplayNameComponent

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

    • getType

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

    • getGreeting

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

    • getFarewell

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

    • getEnterActionBar

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

    • getExitActionBar

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

    • getEnterTitle

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

    • getExitTitle

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

    • getInherit

      boolean getInherit()
      Gets whether the snapshot is inheriting from parent claim.
      Returns:
      If snapshot is set to inherit from parent

    • getResizable

      boolean getResizable()
      Gets whether the snapshot allows resize.
      Returns:
      If resizeable

    • getDenyMessages

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

    • getAllowExpiration

      boolean getAllowExpiration()
      Gets whether snapshot can expire.
      Returns:
      If snapshot can expire

    • getIsCuboid

      boolean getIsCuboid()
      Gets if claim is cuboid.
      Returns:
      true if cuboid, false if not

    • getIsExpired

      boolean getIsExpired()
      Gets whether this claim is expired.
      Returns:
      true if expired, false if not

    • getClaimBlocks

      boolean getClaimBlocks()
      Gets whether this snapshot requires claim blocks.
      Returns:
      true if claim blocks are required, false if not

    • getSizeRestrictions

      boolean getSizeRestrictions()
      Gets whether this snapshot has min/max size restrictions.
      Returns:
      true if claim has size restrictions, false if not

    • getAttributes

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

    • getDateCreated

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

    • getDateLastActive

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

    • 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

    • lesserBoundaryPos

      ClaimData.Builder lesserBoundaryPos(int x, int y, int z)

    • greaterBoundaryPos

      ClaimData.Builder greaterBoundaryPos(int x, int y, int z)

    • spawnPos

      ClaimData.Builder spawnPos(int x, int y, int z)

    • clanData

      ClaimData.Builder clanData(ClanDataGetter data)

    • economyData

      ClaimData.Builder economyData(EconomyDataGetter data)

    • worldUniqueId

      ClaimData.Builder worldUniqueId(UUID worldUniqueId)

    • from

      ClaimData.Builder from(Claim claim)
      The claim to use for snapshot.
      Parameters:
      claim - The claim
      Returns:
      The builder

    • cuboid

      ClaimData.Builder cuboid(boolean cuboid)
      Whether claim is a cuboid or not.
      Parameters:
      cuboid - whether claim is cuboid
      Returns:
      The builder

    • displayName

      ClaimData.Builder displayName(net.kyori.adventure.text.Component name)
      The claim display name.
      Parameters:
      name - The claim display name
      Returns:
      The builder

    • claimType

      ClaimData.Builder claimType(ClaimType type)
      The claim ClaimType the snapshot is based on.
      Parameters:
      type - The claim type
      Returns:
      The builder

    • greeting

      ClaimData.Builder greeting(net.kyori.adventure.text.Component greeting)
      The greeting message.
      Parameters:
      greeting -
      Returns:
      The builder

    • farewell

      ClaimData.Builder farewell(net.kyori.adventure.text.Component farewell)
      The farewell message.
      Parameters:
      farewell -
      Returns:
      The builder

    • enterActionBar

      ClaimData.Builder enterActionBar(net.kyori.adventure.text.Component message)
      The enter action bar message.
      Parameters:
      message - The message
      Returns:
      The builder

    • exitActionBar

      ClaimData.Builder exitActionBar(net.kyori.adventure.text.Component message)
      The exit action bar message.
      Parameters:
      message - The message
      Returns:
      The builder

    • enterTitle

      ClaimData.Builder enterTitle(net.kyori.adventure.title.Title title)
      The enter title.
      Parameters:
      title - The title
      Returns:
      The builder

    • exitTitle

      ClaimData.Builder exitTitle(net.kyori.adventure.title.Title title)
      The exit title.
      Parameters:
      title - Te title
      Returns:
      The builder

    • inherit

      ClaimData.Builder inherit(boolean inherit)
      Whether claim should inherit from parent
      Parameters:
      inherit - Whether claim inherits from parent
      Returns:
      The builder

    • resizable

      ClaimData.Builder resizable(boolean resizable)
      Whether claim should be resizable
      Parameters:
      resizable - Whether claim can be resized.
      Returns:
      The builder

    • denyMessages

      ClaimData.Builder denyMessages(boolean denyMessages)
      Whether claim allows deny messages to be sent to players.
      Parameters:
      denyMessages - Whether to allow sending deny messages to players
      Returns:
      The builder

    • allowExpiration

      ClaimData.Builder allowExpiration(boolean expiration)
      Whether claim can expire due to no player activity.
      Parameters:
      expiration - Whether claim allows expirations
      Returns:
      The builder

    • dateCreated

      ClaimData.Builder dateCreated(Instant dateCreated)
      The claim creation date.
      Parameters:
      dateCreated - The claim creation date
      Returns:
      The builder

    • dateLastActive

      ClaimData.Builder dateLastActive(Instant dateLastActive)
      The last active claim date.
      Parameters:
      dateLastActive - The last active claim date
      Returns:
      The builder

    • isExpired

      ClaimData.Builder isExpired(boolean isExpired)
      Whether claim is expired.
      Parameters:
      isExpired - whether claim is expired
      Returns:
      The builder

    • claimBlocks

      ClaimData.Builder claimBlocks(boolean claimBlocks)
      Whether claim requires claim blocks from players.
      Parameters:
      claimBlocks - Whether this claim requires claim blocks
      Returns:
      The builder

    • sizeRestrictions

      ClaimData.Builder sizeRestrictions(boolean sizeRestrictions)
      Whether claim checks for min/max size restrictions. Note:
      invalid reference 
      ClaimType#ADMIN
      and
      invalid reference 
      ClaimType#WILDERNESS
      can not have restrictions.
      Parameters:
      sizeRestrictions - Whether this claim checks size restrictions.
      Returns:
      The builder

    • attributes

      ClaimData.Builder attributes(Set<ClaimAttribute> attributes)
      The ClaimAttribute's associated with claim.
      Parameters:
      attributes - The set of claim attributes
      Returns:
      The builder

    • accessors

      ClaimData.Builder accessors(Set<UUID> accessors)
      The trusted accessor set of UUID's.
      Parameters:
      The - set of accessor uuid's
      Returns:
      The builder

    • builders

      ClaimData.Builder builders(Set<UUID> builders)
      The trusted builder set of UUID's.
      Parameters:
      The - set of builder uuid's
      Returns:
      The builder

    • containers

      ClaimData.Builder containers(Set<UUID> containers)
      The trusted container set of UUID's.
      Parameters:
      The - set of container uuid's
      Returns:
      The builder

    • managers

      ClaimData.Builder managers(Set<UUID> managers)
      The trusted manager set of UUID's.
      Parameters:
      The - set of manager uuid's
      Returns:
      The builder

    • residents

      ClaimData.Builder residents(Set<UUID> managers)
      The trusted resident set of UUID's.
      Parameters:
      The - set of resident uuid's
      Returns:
      The builder

    • accessorGroups

      ClaimData.Builder accessorGroups(Set<String> accessorGroups)
      The trusted accessor group set of UUID's.
      Parameters:
      The - set of accessor group uuid's
      Returns:
      The builder

    • builderGroups

      ClaimData.Builder builderGroups(Set<String> builderGroups)
      The trusted builder group set of UUID's.
      Parameters:
      The - set of builder group uuid's
      Returns:
      The builder

    • containerGroups

      ClaimData.Builder containerGroups(Set<String> containerGroups)
      The trusted container group set of UUID's.
      Parameters:
      The - set of container group uuid's
      Returns:
      The builder

    • managerGroups

      ClaimData.Builder managerGroups(Set<String> managerGroups)
      The trusted manager group set of UUID's.
      Parameters:
      The - set of manager group uuid's
      Returns:
      The builder

    • residentGroups

      ClaimData.Builder residentGroups(Set<String> residentGroups)
      The trusted resident group set of UUID's.
      Parameters:
      The - set of resident group uuid's
      Returns:
      The builder

    • reset

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

    • build

      ClaimData build()
      Returns the ClaimData.
      Returns:
      The created claim data