Interface IClientClaimsManagerAPI
- All Superinterfaces:
IClaimsManagerAPI
Special claim owners can be found at SpecialClaimOwners, such as for server claims.
-
Method Summary
Modifier and TypeMethodDescriptionget(net.minecraft.resources.ResourceLocation dimension, int x, int z) Gets the claim state for a specified chunk.get(net.minecraft.resources.ResourceLocation dimension, net.minecraft.core.BlockPos blockPos) Gets the claim state for a specified chunk.get(net.minecraft.resources.ResourceLocation dimension, net.minecraft.world.level.ChunkPos chunkPos) Gets the claim state for a specified chunk.intGets the claiming anchor count in the current dimension for a specified claiming mode.intGets the claiming anchor limit in the current dimension for a specified claiming mode.intGets the claiming anchor range in the current dimension for a specified claiming mode.intGets the claim count of the local client player.intGets the claim count for a specified claiming mode.Gets the currently enabled effective claiming mode.intGets the local client player's chunk claim limit.intGets the claim limit for a specified claiming mode.Gets the claim action result tracker that lets you register claim action result listeners.intgetColor(IPlayerChunkClaimAPI claimState, net.minecraft.resources.ResourceLocation dimension) Gets the color that would be used for a provided claim state and dimension.Gets the UUID of the owner of the primary party that the local player is in.Deprecated.intDeprecated.UsegetCurrentSubConfigIndex(IClaimingModeAPI)insteadGets the string ID of the sub-config currently used for new claims.getCurrentSubConfigId(IClaimingModeAPI claimingMode) Gets the string ID of the sub-config currently used for a specified claiming mode.intGets the index of the sub-config currently used for new claims.intgetCurrentSubConfigIndex(IClaimingModeAPI claimingMode) Gets the index of the sub-config currently used for a specified claiming mode.net.minecraft.network.chat.ComponentgetDefaultName(UUID claimId, boolean forceloadable) Gets the default display name that would be used for a provided claim UUID.net.minecraft.network.chat.ComponentgetDefaultName(UUID claimId, boolean forceloadable, boolean allowPartyNames) Gets the default display name that would be used for a provided claim UUID.net.minecraft.network.chat.ComponentgetDefaultName(IPlayerChunkClaimAPI claimState) Gets the default display name that would be used for a provided claim state.net.minecraft.network.chat.ComponentgetDefaultName(IPlayerChunkClaimAPI claimState, boolean allowPartyNames) Gets the default display name that would be used for a provided claim state.getDimension(net.minecraft.resources.ResourceLocation dimension) Gets the read-only claims manager for a specified dimension ID.Gets a stream of all read-only dimension claims managers.intGets the forceload count of the local client player.intGets the forceload count for a specified claiming mode.intGets the local client player's chunk claim forceload limit.intGets the forceload limit for a specified claiming mode.net.minecraft.network.chat.ComponentgetFullName(IPlayerChunkClaimAPI claimState) Gets the full display name, with sub-claim names applied, that would be used for a provided claim state.net.minecraft.network.chat.ComponentgetFullName(IPlayerChunkClaimAPI claimState, boolean allowPartyNames) Gets the full display name, with sub-claim names applied, that would be used for a provided claim state.net.minecraft.network.chat.ComponentgetFullName(IPlayerChunkClaimAPI claimState, net.minecraft.resources.ResourceLocation dimension, boolean allowPartyNames) Gets the full display name, with sub-claim names applied, that would be used for a provided claim state and dimension.intGets the maximum distance for claiming/forceloading a chunk allowed by the server.Gets the API for the player claim impersonation info for the local player.getPlayerInfo(UUID playerId) Gets or creates the claim info instance for a player UUID.Gets a stream of all player claim info.Gets a claim state of the same type (seeIPlayerChunkClaimAPI.isSameClaimType(IPlayerChunkClaimAPI)) as would be placed in the world when the player requests a new claim.Gets the currently enabled claiming mode without automatically determining the effective one if none is set.Gets the claim change tracker that lets you register claim change listeners.booleanhasPlayerInfo(UUID playerId) Checks whether a player has claim info.booleanChecks whether the local client player is in admin mode.booleanChecks whether the initial server chunk claim sync is in progress.booleanChecks whether the local client player is in moderator or admin mode.booleanDeprecated.UsegetClaimingMode()insteaddefault voidrequestAreaClaim(int left, int top, int right, int bottom, boolean byServer) Deprecated.default voidrequestAreaClaim(int left, int top, int right, int bottom, IClaimingModeAPI claimingMode) Deprecated.UserequestAreaClaim(ResourceLocation, int, int, int, int, IClaimingModeAPI)instead Requests new chunks claims over a specified area by the local client player using a specified claiming mode.voidrequestAreaClaim(net.minecraft.resources.ResourceLocation dimension, int left, int top, int right, int bottom, IClaimingModeAPI claimingMode) Requests new chunks claims over a specified area by the local client player using a specified claiming mode.default voidrequestAreaForceload(int left, int top, int right, int bottom, boolean enable, boolean byServer) Deprecated.default voidrequestAreaForceload(int left, int top, int right, int bottom, boolean enable, IClaimingModeAPI claimingMode) Deprecated.UserequestAreaForceload(ResourceLocation, int, int, int, int, boolean, IClaimingModeAPI)instead Requests chunk (un)forceloads over a specified area by the local client player using a specified claiming mode.voidrequestAreaForceload(net.minecraft.resources.ResourceLocation dimension, int left, int top, int right, int bottom, boolean enable, IClaimingModeAPI claimingMode) Requests chunk (un)forceloads over a specified area by the local client player using a specified claiming mode.default voidrequestAreaUnclaim(int left, int top, int right, int bottom, boolean byServer) Deprecated.default voidrequestAreaUnclaim(int left, int top, int right, int bottom, IClaimingModeAPI claimingMode) Deprecated.UserequestAreaUnclaim(ResourceLocation, int, int, int, int, IClaimingModeAPI)instead Requests chunk unclaims over a specified area by the local client player using a specified claiming mode.voidrequestAreaUnclaim(net.minecraft.resources.ResourceLocation dimension, int left, int top, int right, int bottom, IClaimingModeAPI claimingMode) Requests chunk unclaims over a specified area by the local client player using a specified claiming mode.default voidrequestClaim(int x, int z, boolean byServer) Deprecated.default voidrequestClaim(int x, int z, IClaimingModeAPI claimingMode) Deprecated.UserequestClaim(ResourceLocation, int, int, IClaimingModeAPI)instead Requests a new chunk claim by the local client player using a specified claiming mode.voidrequestClaim(net.minecraft.resources.ResourceLocation dimension, int x, int z, IClaimingModeAPI claimingMode) Requests a new chunk claim by the local client player using a specified claiming mode.default voidrequestForceload(int x, int z, boolean enable, boolean byServer) Deprecated.default voidrequestForceload(int x, int z, boolean enable, IClaimingModeAPI claimingMode) Deprecated.UserequestForceload(ResourceLocation, int, int, boolean, IClaimingModeAPI)instead Requests a chunk (un)forceload by the local client player using a specified claiming mode.voidrequestForceload(net.minecraft.resources.ResourceLocation dimension, int x, int z, boolean enable, IClaimingModeAPI claimingMode) Requests a chunk (un)forceload by the local client player using a specified claiming mode.voidrequestToAddAnchor(net.minecraft.resources.ResourceLocation dimension, int x, int z, IClaimingModeAPI claimingMode) Requests a new chunk claiming anchor by the local client player using a specified claiming mode.voidrequestToRemoveAnchor(net.minecraft.resources.ResourceLocation dimension, int x, int z, IClaimingModeAPI claimingMode) Requests a chunk claiming anchor removal by the local client player using a specified claiming mode.default voidrequestUnclaim(int x, int z, boolean byServer) Deprecated.default voidrequestUnclaim(int x, int z, IClaimingModeAPI claimingMode) Deprecated.UserequestUnclaim(ResourceLocation, int, int, IClaimingModeAPI)instead Requests a chunk unclaim by the local client player using a specified claiming mode.voidrequestUnclaim(net.minecraft.resources.ResourceLocation dimension, int x, int z, IClaimingModeAPI claimingMode) Requests a chunk unclaim by the local client player using a specified claiming mode.booleanChecks whether anchor-based claiming is used.Methods inherited from interface xaero.pac.common.claims.api.IClaimsManagerAPI
getCustomName
-
Method Details
-
hasPlayerInfo
Description copied from interface:IClaimsManagerAPIChecks whether a player has claim info.- Specified by:
hasPlayerInfoin interfaceIClaimsManagerAPI- Parameters:
playerId- UUID of the player, not null- Returns:
- true if the player with UUID
playerIdhas claims info, otherwise false
-
getPlayerInfo
Description copied from interface:IClaimsManagerAPIGets or creates the claim info instance for a player UUID.- Specified by:
getPlayerInfoin interfaceIClaimsManagerAPI- Parameters:
playerId- UUID of a player, not null- Returns:
- the player claim info, not null
-
getPlayerInfoStream
Gets a stream of all player claim info.- Returns:
- a
Streamof all player claim info
-
get
@Nullable IPlayerChunkClaimAPI get(@Nonnull net.minecraft.resources.ResourceLocation dimension, int x, int z) Description copied from interface:IClaimsManagerAPIGets the claim state for a specified chunk.- Specified by:
getin interfaceIClaimsManagerAPI- Parameters:
dimension- the dimension ID of the chunk, not nullx- the X coordinate of the chunkz- the Z coordinate of the chunk- Returns:
- the current claim state at the specified location, null if wilderness
-
get
@Nullable IPlayerChunkClaimAPI get(@Nonnull net.minecraft.resources.ResourceLocation dimension, @Nonnull net.minecraft.world.level.ChunkPos chunkPos) Description copied from interface:IClaimsManagerAPIGets the claim state for a specified chunk.- Specified by:
getin interfaceIClaimsManagerAPI- Parameters:
dimension- the dimension ID of the chunk, not nullchunkPos- the coordinates of the chunk, not null- Returns:
- the current claim state at the specified location, null if wilderness
-
get
@Nullable IPlayerChunkClaimAPI get(@Nonnull net.minecraft.resources.ResourceLocation dimension, @Nonnull net.minecraft.core.BlockPos blockPos) Description copied from interface:IClaimsManagerAPIGets the claim state for a specified chunk.- Specified by:
getin interfaceIClaimsManagerAPI- Parameters:
dimension- the dimension ID of the chunk, not nullblockPos- the block coordinates of the chunk, not null- Returns:
- the current claim state at the specified location, null if wilderness
-
getDimension
@Nullable IClientDimensionClaimsManagerAPI getDimension(@Nonnull net.minecraft.resources.ResourceLocation dimension) Description copied from interface:IClaimsManagerAPIGets the read-only claims manager for a specified dimension ID.- Specified by:
getDimensionin interfaceIClaimsManagerAPI- Parameters:
dimension- the dimension ID, not null- Returns:
- the dimension claims manager, null if no claim data exists for the specified dimension
-
getDimensionStream
Gets a stream of all read-only dimension claims managers.- Returns:
- a
Streamof all read-only dimension claims managers
-
getTracker
Description copied from interface:IClaimsManagerAPIGets the claim change tracker that lets you register claim change listeners.The tracker notifies the registered listeners when claim changes occur.
- Specified by:
getTrackerin interfaceIClaimsManagerAPI- Returns:
- the claim change tracker
-
getDefaultName
@Nonnull net.minecraft.network.chat.Component getDefaultName(@Nullable IPlayerChunkClaimAPI claimState) Description copied from interface:IClaimsManagerAPIGets the default display name that would be used for a provided claim state.Calling this method is the equivalent of calling
IClaimsManagerAPI.getDefaultName(IPlayerChunkClaimAPI, boolean)with allowPartyNames as true.- Specified by:
getDefaultNamein interfaceIClaimsManagerAPI- Parameters:
claimState- the claim state, can be null for wilderness- Returns:
- the default display name, not null
-
getDefaultName
@Nonnull net.minecraft.network.chat.Component getDefaultName(@Nullable IPlayerChunkClaimAPI claimState, boolean allowPartyNames) Description copied from interface:IClaimsManagerAPIGets the default display name that would be used for a provided claim state.With this method you can specify whether you want party names applied to party-owned claims or to always use player names.
- Specified by:
getDefaultNamein interfaceIClaimsManagerAPI- Parameters:
claimState- the claim state, can be null for wildernessallowPartyNames- whether to apply party names to party-owned claims- Returns:
- the default display name, not null
-
getDefaultName
@Nonnull net.minecraft.network.chat.Component getDefaultName(@Nullable UUID claimId, boolean forceloadable) Description copied from interface:IClaimsManagerAPIGets the default display name that would be used for a provided claim UUID.Calling this method is the equivalent of calling
IClaimsManagerAPI.getDefaultName(UUID, boolean, boolean)with allowPartyNames as true.- Specified by:
getDefaultNamein interfaceIClaimsManagerAPI- Parameters:
claimId- the UUID of the claimer owner, null for wildernessforceloadable- whether to get the default name for a forceloaded claim- Returns:
- the default display name, not null
-
getDefaultName
@Nonnull net.minecraft.network.chat.Component getDefaultName(@Nullable UUID claimId, boolean forceloadable, boolean allowPartyNames) Description copied from interface:IClaimsManagerAPIGets the default display name that would be used for a provided claim UUID.With this method you can specify whether you want party names applied to party-owned claims or to always use player names.
- Specified by:
getDefaultNamein interfaceIClaimsManagerAPI- Parameters:
claimId- the UUID of the claimer owner, null for wildernessforceloadable- whether to get the default name for a forceloaded claimallowPartyNames- whether to apply party names to party-owned claims- Returns:
- the default display name, not null
-
getFullName
@Nonnull net.minecraft.network.chat.Component getFullName(@Nullable IPlayerChunkClaimAPI claimState) Description copied from interface:IClaimsManagerAPIGets the full display name, with sub-claim names applied, that would be used for a provided claim state.Calling this method is the equivalent of calling
IClaimsManagerAPI.getFullName(IPlayerChunkClaimAPI, boolean)with allowPartyNames as true.- Specified by:
getFullNamein interfaceIClaimsManagerAPI- Parameters:
claimState- the claim state, can be null for wilderness- Returns:
- the full display name, not null
-
getFullName
@Nonnull net.minecraft.network.chat.Component getFullName(@Nullable IPlayerChunkClaimAPI claimState, boolean allowPartyNames) Description copied from interface:IClaimsManagerAPIGets the full display name, with sub-claim names applied, that would be used for a provided claim state.With this method you can specify whether you want party names applied to party-owned claims or to always use player names.
This method does not apply dimension-specific names to wilderness or expired claims. Use
IClaimsManagerAPI.getFullName(IPlayerChunkClaimAPI, ResourceLocation, boolean)instead for that.- Specified by:
getFullNamein interfaceIClaimsManagerAPI- Parameters:
claimState- the claim state, can be null for wildernessallowPartyNames- whether to apply party names to party-owned claims- Returns:
- the full display name, not null
-
getFullName
@Nonnull net.minecraft.network.chat.Component getFullName(@Nullable IPlayerChunkClaimAPI claimState, @Nullable net.minecraft.resources.ResourceLocation dimension, boolean allowPartyNames) Description copied from interface:IClaimsManagerAPIGets the full display name, with sub-claim names applied, that would be used for a provided claim state and dimension.The dimension argument only matters when claimState is null (wilderness) or an expired claim.
With this method you can specify whether you want party names applied to party-owned claims or to always use player names.
- Specified by:
getFullNamein interfaceIClaimsManagerAPI- Parameters:
claimState- the claim state, can be null for wildernessdimension- the dimension the claim is in, null when doesn't matterallowPartyNames- whether to apply party names to party-owned claims- Returns:
- the full display name, not null
-
getColor
int getColor(@Nullable IPlayerChunkClaimAPI claimState, @Nullable net.minecraft.resources.ResourceLocation dimension) Description copied from interface:IClaimsManagerAPIGets the color that would be used for a provided claim state and dimension.The dimension argument only matters when claimState is null (wilderness) or an expired claim.
The returned value on the client side is the default color (0 for actual players) before the color is synced from the server. The returned color may also not correspond to the dimension before the dimension-specific color is synced.
- Specified by:
getColorin interfaceIClaimsManagerAPI- Parameters:
claimState- the claim state, can be null for wildernessdimension- the dimension the claim is in, null when doesn't matter- Returns:
- the color of the claim state
-
usingAnchorBasedClaiming
boolean usingAnchorBasedClaiming()Description copied from interface:IClaimsManagerAPIChecks whether anchor-based claiming is used.The returned value is false on the client side before the real one is synced from the server.
- Specified by:
usingAnchorBasedClaimingin interfaceIClaimsManagerAPI- Returns:
- true if anchor-based claiming is enabled on the server, otherwise false
-
isLoading
boolean isLoading()Checks whether the initial server chunk claim sync is in progress.Chunk claims start loading in the background when you join the server.
- Returns:
- true if the initial chunk claim sync is in progress, otherwise false
-
getClaimCount
int getClaimCount()Gets the claim count of the local client player.This is not necessarily up-to-date with the actual synced claim data at the time of calling.
- Returns:
- the claim count of the player
-
getForceloadCount
int getForceloadCount()Gets the forceload count of the local client player.This is not necessarily up-to-date with the actual synced claim data at the time of calling.
- Returns:
- the forceload count of the player
-
getClaimLimit
int getClaimLimit()Gets the local client player's chunk claim limit.- Returns:
- the claim limit
-
getForceloadLimit
int getForceloadLimit()Gets the local client player's chunk claim forceload limit.- Returns:
- the forceload limit
-
getClaimCount
Gets the claim count for a specified claiming mode.This is not necessarily up-to-date with the actual synced claim data at the time of calling.
- Parameters:
mode- the claiming mode, not null- Returns:
- the claim count for the mode
-
getForceloadCount
Gets the forceload count for a specified claiming mode.This is not necessarily up-to-date with the actual synced claim data at the time of calling.
- Parameters:
mode- the claiming mode, not null- Returns:
- the forceload count for the mode
-
getAnchorCount
Gets the claiming anchor count in the current dimension for a specified claiming mode.This is not necessarily up-to-date with the actual synced claim data at the time of calling.
- Parameters:
mode- the claiming mode, not null- Returns:
- the claiming anchor count for the mode
-
getClaimLimit
Gets the claim limit for a specified claiming mode.- Parameters:
mode- the claiming mode, not null- Returns:
- the claim limit for the mode
-
getForceloadLimit
Gets the forceload limit for a specified claiming mode.- Parameters:
mode- the claiming mode, not null- Returns:
- the forceload limit for the mode
-
getAnchorLimit
Gets the claiming anchor limit in the current dimension for a specified claiming mode.This is not necessarily up-to-date.
- Parameters:
mode- the claiming mode, not null- Returns:
- the claiming anchor limit for the mode
-
getAnchorRange
Gets the claiming anchor range in the current dimension for a specified claiming mode.This is not necessarily up-to-date.
- Parameters:
mode- the claiming mode, not null- Returns:
- the claiming anchor range for the mode
-
getMaxClaimDistance
int getMaxClaimDistance()Gets the maximum distance for claiming/forceloading a chunk allowed by the server.- Returns:
- the maximum claim distance
-
isModeratorMode
boolean isModeratorMode()Checks whether the local client player is in moderator or admin mode.- Returns:
- true if the player is effectively in moderator mode, otherwise false
-
isAdminMode
boolean isAdminMode()Checks whether the local client player is in admin mode.- Returns:
- true if the player is in admin mode, otherwise false
-
isServerMode
Deprecated.UsegetClaimingMode()insteadChecks whether the local client player is in server claim mode.
- Returns:
- true if the player is in server claim mode, otherwise false
-
getClaimingMode
Gets the currently enabled effective claiming mode.- Returns:
- the current effective claiming mode, not null
-
getRawClaimingMode
Gets the currently enabled claiming mode without automatically determining the effective one if none is set.- Returns:
- the current claiming mode, null if none is set
-
getClaimResultTracker
Gets the claim action result tracker that lets you register claim action result listeners.The tracker notifies the registered listeners when the client receives a claim result from the server. This happens after the player requests a claim action, e.g. to (un)claim some chunks.
- Returns:
- the claim action result tracker, not null
-
requestClaim
Deprecated.switch torequestClaim(ResourceLocation, int, int, IClaimingModeAPI)Requests a new chunk claim by the local client player, party or by the server.
Only OPs can request claims by the server.
Register a claim result listener with
IClaimsManagerClaimResultTrackerAPIto receive the result of this request.- Parameters:
x- the X coordinate of the chunkz- the Z coordinate of the chunkbyServer- whether the claim should be made by the server
-
requestUnclaim
Deprecated.switch torequestUnclaim(ResourceLocation, int, int, IClaimingModeAPI)Requests a chunk unclaim by the local client player or by the server.
Only OPs can request unclaims by the server.
Register a claim result listener with
IClaimsManagerClaimResultTrackerAPIto receive the result of this request.- Parameters:
x- the X coordinate of the chunkz- the Z coordinate of the chunkbyServer- whether the unclaim should be made by the server
-
requestForceload
Deprecated.switch torequestForceload(ResourceLocation, int, int, boolean, IClaimingModeAPI)Requests a chunk (un)forceload by the local client player or by the server.
Only OPs can request (un)forceloads by the server.
Register a claim result listener with
IClaimsManagerClaimResultTrackerAPIto receive the result of this request.- Parameters:
x- the X coordinate of the chunkz- the Z coordinate of the chunkenable- true to forceload the chunk, false to unforceloadbyServer- whether the (un)forceload should be made by the server
-
requestAreaClaim
@Deprecated default void requestAreaClaim(int left, int top, int right, int bottom, boolean byServer) Deprecated.switch torequestAreaClaim(ResourceLocation, int, int, int, int, IClaimingModeAPI)Requests new chunks claims over a specified area by the local client player or by the server.
Only OPs can request claims by the server.
Register a claim result listener with
IClaimsManagerClaimResultTrackerAPIto receive the result of this request.- Parameters:
left- the lowest X coordinate of the areatop- the lowest Z coordinate of the arearight- the highest X coordinate of the areabottom- the highest Z coordinate of the areabyServer- whether the claim should be made by the server
-
requestAreaUnclaim
@Deprecated default void requestAreaUnclaim(int left, int top, int right, int bottom, boolean byServer) Deprecated.switch torequestAreaUnclaim(ResourceLocation, int, int, int, int, IClaimingModeAPI)Requests chunk unclaims over a specified area by the local client player or by the server.
Only OPs can request unclaims by the server.
Register a claim result listener with
IClaimsManagerClaimResultTrackerAPIto receive the result of this request.- Parameters:
left- the lowest X coordinate of the areatop- the lowest Z coordinate of the arearight- the highest X coordinate of the areabottom- the highest Z coordinate of the areabyServer- whether the unclaim should be made by the server
-
requestAreaForceload
@Deprecated default void requestAreaForceload(int left, int top, int right, int bottom, boolean enable, boolean byServer) Deprecated.switch torequestAreaForceload(ResourceLocation, int, int, int, int, boolean, IClaimingModeAPI)Requests chunk (un)forceloads over a specified area by the local client player or by the server.
Only OPs can request (un)forceloads by the server.
Register a claim result listener with
IClaimsManagerClaimResultTrackerAPIto receive the result of this request.- Parameters:
left- the lowest X coordinate of the areatop- the lowest Z coordinate of the arearight- the highest X coordinate of the areabottom- the highest Z coordinate of the areaenable- true to forceload the chunks, false to unforceloadbyServer- whether the (un)forceload should be made by the server
-
requestClaim
Deprecated.UserequestClaim(ResourceLocation, int, int, IClaimingModeAPI)instead Requests a new chunk claim by the local client player using a specified claiming mode.Register a claim result listener with
IClaimsManagerClaimResultTrackerAPIto receive the result of this request.You can get all claiming modes from
ClaimingModes.- Parameters:
x- the X coordinate of the chunkz- the Z coordinate of the chunkclaimingMode- the claiming mode to use, null for current
-
requestUnclaim
Deprecated.UserequestUnclaim(ResourceLocation, int, int, IClaimingModeAPI)instead Requests a chunk unclaim by the local client player using a specified claiming mode.Register a claim result listener with
IClaimsManagerClaimResultTrackerAPIto receive the result of this request.You can get all claiming modes from
ClaimingModes.- Parameters:
x- the X coordinate of the chunkz- the Z coordinate of the chunkclaimingMode- the claiming mode to use, null for current
-
requestForceload
@Deprecated default void requestForceload(int x, int z, boolean enable, @Nullable IClaimingModeAPI claimingMode) Deprecated.UserequestForceload(ResourceLocation, int, int, boolean, IClaimingModeAPI)instead Requests a chunk (un)forceload by the local client player using a specified claiming mode.Register a claim result listener with
IClaimsManagerClaimResultTrackerAPIto receive the result of this request.You can get all claiming modes from
ClaimingModes.- Parameters:
x- the X coordinate of the chunkz- the Z coordinate of the chunkenable- true to forceload the chunk, false to unforceloadclaimingMode- the claiming mode to use, null for current
-
requestAreaClaim
@Deprecated default void requestAreaClaim(int left, int top, int right, int bottom, @Nullable IClaimingModeAPI claimingMode) Deprecated.UserequestAreaClaim(ResourceLocation, int, int, int, int, IClaimingModeAPI)instead Requests new chunks claims over a specified area by the local client player using a specified claiming mode.Register a claim result listener with
IClaimsManagerClaimResultTrackerAPIto receive the result of this request.You can get all claiming modes from
ClaimingModes.- Parameters:
left- the lowest X coordinate of the areatop- the lowest Z coordinate of the arearight- the highest X coordinate of the areabottom- the highest Z coordinate of the areaclaimingMode- the claiming mode to use, null for current
-
requestAreaUnclaim
@Deprecated default void requestAreaUnclaim(int left, int top, int right, int bottom, @Nullable IClaimingModeAPI claimingMode) Deprecated.UserequestAreaUnclaim(ResourceLocation, int, int, int, int, IClaimingModeAPI)instead Requests chunk unclaims over a specified area by the local client player using a specified claiming mode.Register a claim result listener with
IClaimsManagerClaimResultTrackerAPIto receive the result of this request.You can get all claiming modes from
ClaimingModes.- Parameters:
left- the lowest X coordinate of the areatop- the lowest Z coordinate of the arearight- the highest X coordinate of the areabottom- the highest Z coordinate of the areaclaimingMode- the claiming mode to use, null for current
-
requestAreaForceload
@Deprecated default void requestAreaForceload(int left, int top, int right, int bottom, boolean enable, @Nullable IClaimingModeAPI claimingMode) Deprecated.UserequestAreaForceload(ResourceLocation, int, int, int, int, boolean, IClaimingModeAPI)instead Requests chunk (un)forceloads over a specified area by the local client player using a specified claiming mode.Register a claim result listener with
IClaimsManagerClaimResultTrackerAPIto receive the result of this request.You can get all claiming modes from
ClaimingModes.- Parameters:
left- the lowest X coordinate of the areatop- the lowest Z coordinate of the arearight- the highest X coordinate of the areabottom- the highest Z coordinate of the areaenable- true to forceload the chunks, false to unforceloadclaimingMode- the claiming mode to use, null for current
-
requestClaim
void requestClaim(@Nonnull net.minecraft.resources.ResourceLocation dimension, int x, int z, @Nullable IClaimingModeAPI claimingMode) Requests a new chunk claim by the local client player using a specified claiming mode.Register a claim result listener with
IClaimsManagerClaimResultTrackerAPIto receive the result of this request.You can get all claiming modes from
ClaimingModes.- Parameters:
dimension- the dimension ID of the chunk, not nullx- the X coordinate of the chunkz- the Z coordinate of the chunkclaimingMode- the claiming mode to use, null for current
-
requestUnclaim
void requestUnclaim(@Nonnull net.minecraft.resources.ResourceLocation dimension, int x, int z, @Nullable IClaimingModeAPI claimingMode) Requests a chunk unclaim by the local client player using a specified claiming mode.Register a claim result listener with
IClaimsManagerClaimResultTrackerAPIto receive the result of this request.You can get all claiming modes from
ClaimingModes.- Parameters:
dimension- the dimension ID of the chunk, not nullx- the X coordinate of the chunkz- the Z coordinate of the chunkclaimingMode- the claiming mode to use, null for current
-
requestForceload
void requestForceload(@Nonnull net.minecraft.resources.ResourceLocation dimension, int x, int z, boolean enable, @Nullable IClaimingModeAPI claimingMode) Requests a chunk (un)forceload by the local client player using a specified claiming mode.Register a claim result listener with
IClaimsManagerClaimResultTrackerAPIto receive the result of this request.You can get all claiming modes from
ClaimingModes.- Parameters:
dimension- the dimension ID of the chunk, not nullx- the X coordinate of the chunkz- the Z coordinate of the chunkenable- true to forceload the chunk, false to unforceloadclaimingMode- the claiming mode to use, null for current
-
requestToAddAnchor
void requestToAddAnchor(@Nonnull net.minecraft.resources.ResourceLocation dimension, int x, int z, @Nullable IClaimingModeAPI claimingMode) Requests a new chunk claiming anchor by the local client player using a specified claiming mode.Register a claim result listener with
IClaimsManagerClaimResultTrackerAPIto receive the result of this request.You can get all claiming modes from
ClaimingModes.- Parameters:
dimension- the dimension ID of the chunk, not nullx- the X coordinate of the chunkz- the Z coordinate of the chunkclaimingMode- the claiming mode to use, null for current
-
requestToRemoveAnchor
void requestToRemoveAnchor(@Nonnull net.minecraft.resources.ResourceLocation dimension, int x, int z, @Nullable IClaimingModeAPI claimingMode) Requests a chunk claiming anchor removal by the local client player using a specified claiming mode.Register a claim result listener with
IClaimsManagerClaimResultTrackerAPIto receive the result of this request.You can get all claiming modes from
ClaimingModes.- Parameters:
dimension- the dimension ID of the chunk, not nullx- the X coordinate of the chunkz- the Z coordinate of the chunkclaimingMode- the claiming mode to use, null for current
-
requestAreaClaim
void requestAreaClaim(@Nonnull net.minecraft.resources.ResourceLocation dimension, int left, int top, int right, int bottom, @Nullable IClaimingModeAPI claimingMode) Requests new chunks claims over a specified area by the local client player using a specified claiming mode.Register a claim result listener with
IClaimsManagerClaimResultTrackerAPIto receive the result of this request.You can get all claiming modes from
ClaimingModes.- Parameters:
dimension- the dimension ID of the area, not nullleft- the lowest X coordinate of the areatop- the lowest Z coordinate of the arearight- the highest X coordinate of the areabottom- the highest Z coordinate of the areaclaimingMode- the claiming mode to use, null for current
-
requestAreaUnclaim
void requestAreaUnclaim(@Nonnull net.minecraft.resources.ResourceLocation dimension, int left, int top, int right, int bottom, @Nullable IClaimingModeAPI claimingMode) Requests chunk unclaims over a specified area by the local client player using a specified claiming mode.Register a claim result listener with
IClaimsManagerClaimResultTrackerAPIto receive the result of this request.You can get all claiming modes from
ClaimingModes.- Parameters:
dimension- the dimension ID of the area, not nullleft- the lowest X coordinate of the areatop- the lowest Z coordinate of the arearight- the highest X coordinate of the areabottom- the highest Z coordinate of the areaclaimingMode- the claiming mode to use, null for current
-
requestAreaForceload
void requestAreaForceload(@Nonnull net.minecraft.resources.ResourceLocation dimension, int left, int top, int right, int bottom, boolean enable, @Nullable IClaimingModeAPI claimingMode) Requests chunk (un)forceloads over a specified area by the local client player using a specified claiming mode.Register a claim result listener with
IClaimsManagerClaimResultTrackerAPIto receive the result of this request.You can get all claiming modes from
ClaimingModes.- Parameters:
dimension- the dimension ID of the area, not nullleft- the lowest X coordinate of the areatop- the lowest Z coordinate of the arearight- the highest X coordinate of the areabottom- the highest Z coordinate of the areaenable- true to forceload the chunks, false to unforceloadclaimingMode- the claiming mode to use, null for current
-
getPotentialClaimStateReflection
Gets a claim state of the same type (seeIPlayerChunkClaimAPI.isSameClaimType(IPlayerChunkClaimAPI)) as would be placed in the world when the player requests a new claim.It's not the actual instance of the claim state that would be placed in the world but it's good enough for comparisons against actual existing claim states.
- Returns:
- a claim state reflection of the same type as a new claim, null if unknown
-
getCurrentSubConfigIndex
int getCurrentSubConfigIndex()Gets the index of the sub-config currently used for new claims.- Returns:
- the current sub-config index
-
getCurrentServerSubConfigIndex
Deprecated.UsegetCurrentSubConfigIndex(IClaimingModeAPI)insteadGets the index of the sub-config currently used for new server claims.
- Returns:
- the current server sub-config index
-
getCurrentSubConfigIndex
Gets the index of the sub-config currently used for a specified claiming mode.You can get all claiming modes from
ClaimingModes.- Parameters:
claimingMode- the claiming mode, not null- Returns:
- the current sub-config index for the claiming mode
-
getCurrentSubConfigId
Gets the string ID of the sub-config currently used for new claims.- Returns:
- the current sub-config ID, not null
-
getCurrentServerSubConfigId
Deprecated.UsegetCurrentSubConfigId(IClaimingModeAPI)insteadGets the string ID of the sub-config currently used for new server claims.
- Returns:
- the current server sub-config ID, not null
-
getCurrentSubConfigId
Gets the string ID of the sub-config currently used for a specified claiming mode.You can get all claiming modes from
ClaimingModes.- Parameters:
claimingMode- the claiming mode, not null- Returns:
- the current sub-config ID for the claiming mode, not null
-
getCurrentPartyOwner
Gets the UUID of the owner of the primary party that the local player is in.- Returns:
- the UUID of the local player's party owner, null before synced or when not in party
-
getPlayerImpersonationInfo
Gets the API for the player claim impersonation info for the local player.- Returns:
- API for getting info about player claim impersonation by the local player, not null
-
getCurrentSubConfigId(IClaimingModeAPI)instead