-
Deprecated InterfacesInterfaceDescriptionuse
IPlayerConfigStringableOptionClientStorageAPIinsteaduseIPlayerPartySystemAPIinsteadThe interface to be overridden by addons that wish to implement additional party systems to be used by Open Parties and Claims (just the claiming feature as of writing this).
Player position synchronization is a part of the default party system. Similar functionality should be implemented in other party systems and supported separately by the map mods that display party members. OPAC does not synchronize or provide party member/ally positions from other party systems, even if they're implemented using this interface.
Party system implementations must be registered in
IPlayerPartySystemRegisterAPI.useIPlayerPartySystemRegisterAPIinsteadThe API for registering party system implementations.
Party system implementations must be registered during the xaero.pac.common.event.api.OPACServerAddonRegister.EVENT on Fabric or OPACServerAddonRegisterEvent on Forge.
switch toIPlayerConfigAPIswitch toIPlayerConfigManagerAPIswitch toIPlayerConfigOptionSpecAPI
-
Deprecated Classes
-
Deprecated Enum ClassesEnum ClassDescriptionswitch to
IPlayerConfigAPIAll possible result types when trying to set an option value
-
Deprecated FieldsFieldDescriptionswitch to
PlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsxaero.pac.common.server.player.config.api.PlayerConfigOptions.PROTECT_CLAIMED_CHUNKS_BLOCKS_REDIRECTswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsxaero.pac.common.server.player.config.api.PlayerConfigOptions.PROTECT_CLAIMED_CHUNKS_ITEM_TOSS_OTHERswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptionsswitch toPlayerConfigOptions
-
Deprecated MethodsMethodDescriptionUse
IClientClaimsManagerAPI.getCurrentSubConfigId(IClaimingModeAPI)insteadGets the string ID of the sub-config currently used for new server claims.
UseIClientClaimsManagerAPI.getCurrentSubConfigIndex(IClaimingModeAPI)insteadGets the index of the sub-config currently used for new server claims.
UseIClientClaimsManagerAPI.getClaimingMode()insteadChecks whether the local client player is in server claim mode.
switch toIClientClaimsManagerAPI.requestAreaClaim(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.switch toIClientClaimsManagerAPI.requestAreaForceload(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.switch toIClientClaimsManagerAPI.requestAreaUnclaim(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.switch toIClientClaimsManagerAPI.requestClaim(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.switch toIClientClaimsManagerAPI.requestForceload(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.switch toIClientClaimsManagerAPI.requestUnclaim(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.useIPlayerConfigClientStorageAPI.getOption(IPlayerConfigOptionSpecAPI)insteadGets the config option value storage for a specified config option in this config.
All player config option types are statically accessible in
PlayerConfigOptions.useIPlayerConfigClientStorageAPI.options()insteadGets a stream of all config option value storages for this config.
useIPlayerConfigOptionClientStorageAPIinsteadGets the default comment text for the option.
useIPlayerConfigOptionClientStorageAPIinsteadGets the translation key for the comment of this option.
useIPlayerConfigOptionClientStorageAPIinsteadGets the translation key arguments for the comment of this option.
useIPlayerConfigOptionClientStorageAPIinsteadGets the option string ID.
useIPlayerConfigOptionClientStorageAPIinsteadGets the option spec that this storage holds the value for.
useIPlayerConfigOptionClientStorageAPIinsteadGets the text prefix for the option tooltip on the UI screens.
useIPlayerConfigOptionClientStorageAPIinsteadGets the translation key for the name of the option.
useIPlayerConfigOptionClientStorageAPIinsteadGets the translation key arguments for the name of this option.
useIPlayerConfigOptionClientStorageAPIinsteadGets the type of the option value that this storage holds.
useIPlayerConfigOptionClientStorageAPIinsteadGets the option value validator that checks whether a certain value is valid for the option.
useIPlayerConfigOptionClientStorageAPIinsteadGets the stored option value.
useIPlayerConfigOptionClientStorageAPIinsteadChecks whether this option is forced to its default player config value.
useIPlayerConfigOptionClientStorageAPIinsteadChecks whether the local client player can edit this option's value.
useIPlayerConfigStringableOptionClientStorageAPIinsteadGets the string input parser for this option.
It is the same one that is used for parsing command inputs.
useIPlayerConfigStringableOptionClientStorageAPIinsteadGets the string output writer for this option.
It is the same one that is used for displaying option values in command outputs.
It accepts values of any type but will only work with the right one.
useIPlayerConfigStringableOptionClientStorageAPIinsteadGets the string value input validator for this option.
useOpenPACServerAPI.getPlayerConfigManager()instead!Gets the API for the server-side player config manager.
UseIServerPlayerClaimInfoAPI.resyncPartyName(IPlayerPartySystemAPI)instead.Resyncs the name of the party that owns the claims stored in this player claim info, which is displayed when the mod is in party-owned-claims mode. The party that owns the claims is the party owned by this player.
If the specified party system argument is not the primary system, then nothing will happen, as only the primary party system is used in party-owned-claims mode. So if a party is renamed in any of the party systems, then this method can be safely called, whether it's the primary system or not.
Calling this method is optional because the mod automatically detects party name changes every second, if at least one party member is online. This method can be used to speed it up or to update the name for parties that don't have anyone online. The default built-in party system does so.
useIChunkProtectionAPI.checkPlayerGroupExceptionOption(IPlayerConfigOptionSpecAPI, IPlayerConfigAPI, UUID)instead Checks whether a player/claim config option with multiple exception levels includes the entity with a specified UUID.Please use
IChunkProtectionAPI.checkExceptionLeveledOption(xaero.pac.common.server.player.config.api.IPlayerConfigOptionSpecAPI, xaero.pac.common.server.player.config.api.IPlayerConfigAPI, Entity)when you have an actual entity reference.You most likely don't have to use this method at all. The action-specific protection check methods already use option values. This is meant for things that are not covered by the rest of the API.
useIChunkProtectionAPI.checkPlayerGroupExceptionOption(IPlayerConfigOptionSpecAPI, IPlayerConfigAPI, Entity)instead Checks whether a player/claim config option with multiple exception levels includes a specified entity.You most likely don't have to use this method at all. The action-specific protection check methods already use option values. This is meant for things that are not covered by the rest of the API.
use negatedIChunkProtectionAPI.checkPlayerGroupExceptionOption(IPlayerConfigOptionSpecAPI, IPlayerConfigAPI, UUID)instead Checks whether a player/claim config option with multiple protection levels protects from the entity with a specified UUID.Please use
IChunkProtectionAPI.checkProtectionLeveledOption(xaero.pac.common.server.player.config.api.IPlayerConfigOptionSpecAPI, xaero.pac.common.server.player.config.api.IPlayerConfigAPI, Entity)when you have an actual entity reference.You most likely don't have to use this method at all. The action-specific protection check methods already use option values. This is meant for things that are not covered by the rest of the API.
use negatedIChunkProtectionAPI.checkPlayerGroupExceptionOption(IPlayerConfigOptionSpecAPI, IPlayerConfigAPI, Entity)instead Checks whether a player/claim config option with multiple protection levels protects from a specified entity.You most likely don't have to use this method at all. The action-specific protection check methods already use option values. This is meant for things that are not covered by the rest of the API.
useIChunkProtectionAPI.getConfig(IPlayerChunkClaimAPI)insteadGets the player/claim config used for a specified claim state.
You can fetch claim states of chunks from the
IServerClaimsManagerAPI.UseIChunkProtectionAPI.onBlockInteraction(Entity, InteractionHand, ItemStack, ServerLevel, BlockPos, Direction, boolean, boolean, boolean)instead.Checks whether a specified block interaction should be protected against.
Whenever possible, use the built-in block interaction events provided by the mod loader (Fabric/Forge) instead of this method, unless they aren't specific enough, or the entity has a full protection pass (
IChunkProtectionAPI.giveFullPass(UUID)).UseIChunkProtectionAPI.onEntityInteraction(Entity, Entity, Entity, ItemStack, InteractionHand, boolean, boolean, boolean)instead.Checks whether an entity interaction should be protected against.
Whenever possible, use the built-in entity interaction event provided by Forge instead of this method, unless it isn't specific enough, you're on Fabric, or the interacting entity has a full protection pass (
IChunkProtectionAPI.giveFullPass(UUID)).useIPlayerPartySystemRegisterAPIinsteadRegisters a party system implementation to be available to OPAC under a specified name.
The primary party system used by the mod is configured in the main server config file with the "primaryPartySystem" option.
switch toIPlayerConfigAPICreates a new sub-config for a specified sub-config ID when possible.
The sub-config ID must be unique, at most 16 characters long and consist of A-Z, a-z, 0-9, '-', '_'.
switch toIPlayerConfigAPIGets the default raw value in this config for an option.
This does not redirect to the default player config. It gives you the actual default value for a config option. In the cause of sub-configs, the default raw value is always null.
All player config option types are statically accessible in
PlayerConfigOptions.switch toIPlayerConfigAPIGets the effective value of a config option.
This method calculates the automatic option value if such is used, e.g. the claims color, while
IPlayerConfigAPI.getFromEffectiveConfig(xaero.pac.common.server.player.config.api.IPlayerConfigOptionSpecAPI<T>)just gets the effective raw value.All player config option types are statically accessible in
PlayerConfigOptions.switch toIPlayerConfigAPIGets a sub-config of this config from a specified sub-config index.
Gets this config, if the specified sub-config index is -1 or isn't used.
switch toIPlayerConfigAPIGets a sub-config of this config from a specified sub-config ID.
Gets this config, if the specified sub-config ID is "main" or isn't used.
switch toIPlayerConfigAPIGets the raw config value from the effective config of a config option, e.g. from the default player config for options that cannot be set per player.
This method does not calculate the automatic option value if such is used, e.g. the claims color.
All player config option types are statically accessible in
PlayerConfigOptions.switch toIPlayerConfigAPIGets the UUID of the player that this config is for.
switch toIPlayerConfigAPIGets the raw config value from this config, which can be null in the case of sub-configs.
switch toIPlayerConfigAPIGets a sub-config of this config from a specified sub-config ID.
Gets this config, if the specified sub-config ID is "main".
switch toIPlayerConfigAPIGets a stream of all sub-configs of this player config.
switch toIPlayerConfigAPIGets an unmodifiable list of all string IDs of this config's sub-configs.
This must not be a sub-config in itself!
switch toIPlayerConfigAPIGets the maximum number of sub-configs that this player config is allowed to have.
Returns 0 if this is a sub-config. Returns the maximum int value if this is a server claims config.
switch toIPlayerConfigAPIGets the number of sub-configs that this config has.
switch toIPlayerConfigAPIGets the sub-config ID of this config.
switch toIPlayerConfigAPIGets the sub-config index of this config.
switch toIPlayerConfigAPIGets the type
PlayerConfigTypeof this config.switch toIPlayerConfigAPIGets the server sub-config currently used for new claims.
switch toIPlayerConfigAPIGets the sub-config currently used for new claims.
switch toIPlayerConfigAPIChecks whether this player (sub-)config is in the process of being deleted.
This is typically only ever true for sub-configs.
switch toIPlayerConfigAPIChecks whether an option is allowed in this config.
switch toIPlayerConfigAPIChecks whether a sub-config with a specified index exists.
Does not consider "main" a sub-config.
switch toIPlayerConfigAPIChecks whether a sub-config with a specified string ID exists.
Does not consider "main" a sub-config.
xaero.pac.common.server.player.config.api.IPlayerConfigAPI.tryToReset(IPlayerConfigOptionSpecAPI<T>) switch toIPlayerConfigAPITries to reset the value of a specified config option to the default raw value, as in
IPlayerConfigAPI.getDefaultRawValue(xaero.pac.common.server.player.config.api.IPlayerConfigOptionSpecAPI<T>).You will receive a
IPlayerConfigAPI.SetResult.All player config option types are statically accessible in
PlayerConfigOptions.switch toIPlayerConfigAPITries to set the value of a specified config option to a specified value.
This won't succeed if the specified option is forced to the default config value (by the server mod config) or if the specified value isn't valid for the specified option. In any case, you will receive a
IPlayerConfigAPI.SetResult.All player config option types are statically accessible in
PlayerConfigOptions.switch toIPlayerConfigManagerAPIGets a stream of all player config option types, including the dynamic ones.
switch toIPlayerConfigManagerAPIGets the default player config instance.
switch toIPlayerConfigManagerAPIGets the expired claims config instance.
switch toIPlayerConfigManagerAPIGets or creates the player config for the player with a specified UUID.
Gets the wilderness config if the specified UUID is null, the server claims config if the UUID is
PlayerConfig.SERVER_CLAIM_UUID, the expired claims config if the UUID isPlayerConfig.EXPIRED_CLAIM_UUID.switch toIPlayerConfigManagerAPIGets the option type specification with a specified string option id, including dynamic options.
Returns null if no such option exists.
switch toIPlayerConfigManagerAPIGets the server claims config instance.
switch toIPlayerConfigManagerAPIGets the wilderness config instance.
switch toIPlayerConfigOptionSpecAPIGets the client-side validator for potential values of this option.
switch toIPlayerConfigOptionSpecAPIGets the String->value parser of this option, mainly used for commands.
switch toIPlayerConfigOptionSpecAPIGets the value->String converter of this option, mainly used for commands.
switch toIPlayerConfigOptionSpecAPIGets the default en_us comment for this option.
switch toIPlayerConfigOptionSpecAPIGets the translation key for the comment of this option.
switch toIPlayerConfigOptionSpecAPIGets the translation key arguments for the comment of this option.
switch toIPlayerConfigOptionSpecAPIGets the config type filter of this option.
The filter allows this option to only appear and be configurable on some types of player configs (e.g. just the server claims config).
switch toIPlayerConfigOptionSpecAPIGets the default value that this option is set to in configs.
switch toIPlayerConfigOptionSpecAPIGets the ID of this option.
Use
IPlayerConfigOptionSpecAPI.getPath()if you need it separated into elements.switch toIPlayerConfigOptionSpecAPIGets the path of this option, which is just the ID from
IPlayerConfigOptionSpecAPI.getId()but separated into elements.switch toIPlayerConfigOptionSpecAPIGets the server-side validator for potential values of this option.
switch toIPlayerConfigOptionSpecAPIGets the shortened ID of this option, without the "playerConfig." prefix.
switch toIPlayerConfigOptionSpecAPIGets the prefix applied to the tooltip of this option on the UI.
switch toIPlayerConfigOptionSpecAPIGets the translation key for the name of this option.
switch toIPlayerConfigOptionSpecAPIGets the translation key arguments for the name of this option.
switch toIPlayerConfigOptionSpecAPIGets the type of values that this option can have.
UseIPlayerConfigAPI.getUsedSubConfig(IClaimingModeAPI)insteadGets the server sub-config currently used for new claims.
UseServerPlayerDataAPI.getClaimingMode()insteadChecks if the player is using the server claim mode.
IPlayerConfigOptionClientStorageAPIinstead