Package com.griefdefender.api.data

Interface ClaimData

All Superinterfaces:

ClaimDataGetter

All Known Subinterfaces:

TownData

public interface ClaimData
extends ClaimDataGetter

Represents the persisted data of a claim.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ClaimData.Builder

Method Summary

Modifier and Type	Method	Description
static ClaimData.Builder	builder()	Gets a new claim data builder instance for ClaimData.Builder.
void	save()	Saves all changes to storage.
void	setAccessorGroups(Set<String> accessorGroups)	Sets the trusted accessor group set of UUID's.
void	setAccessors(Set<UUID> accessors)	Sets the trusted accessor set of UUID's.
void	setAllowExpiration(boolean allowExpire)	Toggles whether this claim can expire due to no player activity.
void	setAttributes(Set<ClaimAttribute> attributes)	Sets the ClaimAttribute's.
void	setBuilderGroups(Set<String> builderGroups)	Sets the trusted builder group set of UUID's.
void	setBuilders(Set<UUID> builders)	Sets the trusted builder set of UUID's.
boolean	setClaimGroupUniqueId(UUID uuid)	Sets the claim group uuid this claim should be part of.
void	setClanData(ClanData clanData)	Sets the ClanData.
void	setContainerGroups(Set<String> containerGroups)	Sets the trusted container group set of UUID's.
void	setContainers(Set<UUID> containers)	Sets the trusted container set of UUID's.
void	setCuboid(boolean cuboid)	Toggles whether this claim is a cuboid.
void	setDateLastActive(Instant date)	Sets last active date of claim.
void	setDenyMessages(boolean allowDenyMessages)	Toggles whether this claim allows deny messages to be sent to players.
void	setDisplayName(net.kyori.adventure.text.Component name)	Sets the display name of claim.
void	setEconomyData(EconomyData economyData)	Sets the @{link EconomyData}.
void	setEnterActionBar(net.kyori.adventure.text.Component message)	Sets the action bar when player enters the claim.
void	setEnterTitle(net.kyori.adventure.title.Title title)	Sets the Title when a player enters the claim.
void	setExitActionBar(net.kyori.adventure.text.Component message)	Sets the action bar when player exits the claim.
void	setExitTitle(net.kyori.adventure.title.Title title)	Sets the Title when a player exits the claim.
void	setExpired(boolean expired)	Toggles whether this claim is expired.
void	setFarewell(net.kyori.adventure.text.Component farewell)	Sets the farewell message when a player exits the claim.
void	setGreaterBoundaryCorner(int x, int y, int z)	Sets the greater boundary corner position.
void	setGreaterBoundaryCorner(com.flowpowered.math.vector.Vector3i pos)	Sets the greater boundary corner position.
void	setGreeting(net.kyori.adventure.text.Component greeting)	Sets the greeting message when a player enters the claim.
void	setInheritParent(boolean inherit)	Toggles whether this claim is inheriting from parent claim.
void	setLesserBoundaryCorner(int x, int y, int z)	Sets the lesser boundary corner position.
void	setLesserBoundaryCorner(com.flowpowered.math.vector.Vector3i pos)	Sets the lesser boundary corner position.
void	setManagerGroups(Set<String> managerGroups)	Sets the trusted manager group set of UUID's.
void	setManagers(Set<UUID> managers)	Sets the trusted manager set of UUID's.
void	setOwnerUniqueId(UUID ownerUniqueId)	Sets the owner UUID of claim.
void	setParentUniqueId(UUID uniqueId)	Sets the parent UUID.
void	setRequiresClaimBlocks(boolean requiresClaimBlocks)	Sets if this claim requires claim blocks from players.
void	setResidentGroups(Set<String> residentGroups)	Sets the trusted resident group set of UUID's.
void	setResidents(Set<UUID> residents)	Sets the trusted resident set of UUID's.
void	setResizable(boolean allowResize)	Toggles whether this claim is resizable.
void	setSizeRestrictions(boolean sizeRestrictions)	Sets if this claim checks for min/max size restrictions.
void	setSpawnPos(int x, int y, int z)	Sets the spawn position of claim.
void	setSpawnPos(@Nullable com.flowpowered.math.vector.Vector3i pos)	Sets the spawn position of claim.
void	setType(ClaimType type)	Sets the ClaimType.
void	setWorldUniqueId(UUID worldUniqueId)	Sets the world UUID of claim.

Methods inherited from interface com.griefdefender.api.data.ClaimDataGetter

allowDenyMessages, allowExpiration, doesInheritParent, getAccessorGroups, getAccessors, getAttributes, getBuilderGroups, getBuilders, getClaimGroupUniqueId, getClanData, getContainerGroups, getContainers, getDateCreated, getDateLastActive, getDisplayName, getDisplayNameComponent, getEconomyData, getEnterActionBar, getEnterTitle, getExitActionBar, getExitTitle, getFarewell, getGreaterBoundaryCorner, getGreeting, getLesserBoundaryCorner, getManagerGroups, getManagers, getOwnerUniqueId, getParentUniqueId, getResidentGroups, getResidents, getSpawnPos, getType, getWorldUniqueId, hasSizeRestrictions, isCuboid, isExpired, isResizable, requiresClaimBlocks

Method Details

setClaimGroupUniqueId

boolean setClaimGroupUniqueId(UUID uuid)

Sets the claim group uuid this claim should be part of.

Note: If joined to a group, all permissions and options will be taken from group instead of claim.

Parameters:

uuid - The claim group uuid

Returns:

true if the group was set, false if the group does not exist

setLesserBoundaryCorner

void setLesserBoundaryCorner(com.flowpowered.math.vector.Vector3i pos)

Sets the lesser boundary corner position.

Parameters:

pos - The lesser boundary

setLesserBoundaryCorner

void setLesserBoundaryCorner(int x,
 int y,
 int z)

Sets the lesser boundary corner position.

Parameters:

x - X coordinate

y - Y coordinate

z - Z coordinate

setGreaterBoundaryCorner

void setGreaterBoundaryCorner(com.flowpowered.math.vector.Vector3i pos)

Sets the greater boundary corner position.

Parameters:

pos - The greater boundary

setGreaterBoundaryCorner

void setGreaterBoundaryCorner(int x,
 int y,
 int z)

Sets the greater boundary corner position.

Parameters:

x - X coordinate

y - Y coordinate

z - Z coordinate

setSpawnPos

void setSpawnPos(@Nullable com.flowpowered.math.vector.Vector3i pos)

Sets the spawn position of claim.

Parameters:

pos - The new spawn position

setSpawnPos

void setSpawnPos(int x,
 int y,
 int z)

Sets the spawn position of claim.

Parameters:

x - X coordinate

y - Y coordinate

z - Z coordinate

setWorldUniqueId

void setWorldUniqueId(UUID worldUniqueId)

Sets the world UUID of claim.

Parameters:

worldUniqueId - The world uuid

setDisplayName

void setDisplayName(net.kyori.adventure.text.Component name)

Sets the display name of claim.

Parameters:

name - The claim display name

setOwnerUniqueId

void setOwnerUniqueId(UUID ownerUniqueId)

Sets the owner UUID of claim.

Parameters:

ownerUniqueId - The owner uuid

setType

void setType(ClaimType type)

Sets the ClaimType.

Parameters:

type - The claim type

setAttributes

void setAttributes(Set<ClaimAttribute> attributes)

Sets the ClaimAttribute's.

Parameters:

attributes - The set of claim attributes

setFarewell

void setFarewell(net.kyori.adventure.text.Component farewell)

Sets the farewell message when a player exits the claim.

Parameters:

farewell - The farewell message

setGreeting

void setGreeting(net.kyori.adventure.text.Component greeting)

Sets the greeting message when a player enters the claim.

Parameters:

greeting - The greeting message

setEnterActionBar

void setEnterActionBar(net.kyori.adventure.text.Component message)

Sets the action bar when player enters the claim.

Parameters:

message - The enter action bar message

setExitActionBar

void setExitActionBar(net.kyori.adventure.text.Component message)

Sets the action bar when player exits the claim.

Parameters:

message - The exit action bar message

setEnterTitle

void setEnterTitle(net.kyori.adventure.title.Title title)

Sets the Title when a player enters the claim.

Parameters:

title - The enter title

setExitTitle

void setExitTitle(net.kyori.adventure.title.Title title)

Sets the Title when a player exits the claim.

Parameters:

title - The exit title

setExpired

void setExpired(boolean expired)

Toggles whether this claim is expired.

Parameters:

expired - true if expired, false if not

setDateLastActive

void setDateLastActive(Instant date)

Sets last active date of claim. Note: The date is used to determine whether the claim expires based on expiration settings.

Parameters:

date - The last active date

setInheritParent

void setInheritParent(boolean inherit)

Toggles whether this claim is inheriting from parent claim.

Parameters:

inherit - Whether claim inherits from parent

setResizable

void setResizable(boolean allowResize)

Toggles whether this claim is resizable.

Parameters:

allowResize - Whether claim can be resized.

setCuboid

void setCuboid(boolean cuboid)

Toggles whether this claim is a cuboid.

Parameters:

cuboid - Whether claim is a cuboid

setDenyMessages

void setDenyMessages(boolean allowDenyMessages)

Toggles whether this claim allows deny messages to be sent to players. If false, no deny messages will be sent.

Parameters:

allowDenyMessages - Whether to allow sending deny messages to players

setAllowExpiration

void setAllowExpiration(boolean allowExpire)

Toggles whether this claim can expire due to no player activity.

Parameters:

allowExpire - Whether this claim allows expirations

setParentUniqueId

void setParentUniqueId(UUID uniqueId)

Sets the parent UUID.

Parameters:

uniqueId - The parent uuid

setRequiresClaimBlocks

void setRequiresClaimBlocks(boolean requiresClaimBlocks)

Sets if this claim requires claim blocks from players. Note: This is true by default.

Parameters:

requiresClaimBlocks - Whether this claim requires claim blocks

setSizeRestrictions

void setSizeRestrictions(boolean sizeRestrictions)

Sets if this 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.

setAccessors

void setAccessors(Set<UUID> accessors)

Sets the trusted accessor set of UUID's.

Parameters:

The - set of accessor uuid's

setBuilders

void setBuilders(Set<UUID> builders)

Sets the trusted builder set of UUID's.

Parameters:

The - set of builder uuid's

setContainers

void setContainers(Set<UUID> containers)

Sets the trusted container set of UUID's.

Parameters:

The - set of container uuid's

setManagers

void setManagers(Set<UUID> managers)

Sets the trusted manager set of UUID's.

Parameters:

The - set of manager uuid's

setResidents

void setResidents(Set<UUID> residents)

Sets the trusted resident set of UUID's.

Parameters:

The - set of resident uuid's

setAccessorGroups

void setAccessorGroups(Set<String> accessorGroups)

Sets the trusted accessor group set of UUID's.

Parameters:

The - set of accessor group uuid's

setBuilderGroups

void setBuilderGroups(Set<String> builderGroups)

Sets the trusted builder group set of UUID's.

Parameters:

The - set of builder group uuid's

setContainerGroups

void setContainerGroups(Set<String> containerGroups)

Sets the trusted container group set of UUID's.

Parameters:

The - set of container group uuid's

setManagerGroups

void setManagerGroups(Set<String> managerGroups)

Sets the trusted manager group set of UUID's.

Parameters:

The - set of manager group uuid's

setResidentGroups

void setResidentGroups(Set<String> residentGroups)

Sets the trusted resident group set of UUID's.

Parameters:

The - set of resident group uuid's

setClanData

void setClanData(ClanData clanData)

Sets the ClanData.

Parameters:

clanData - The clan data

setEconomyData

void setEconomyData(EconomyData economyData)

Sets the @{link EconomyData}.

Parameters:

economyData - The economy data

save

void save()

Saves all changes to storage.

builder

static ClaimData.Builder builder()

Gets a new claim data builder instance for ClaimData.Builder.

Returns:

A new claim data builder instance