Package xaero.pac.common.claims.api

Interface IClaimsManagerAPI

All Known Subinterfaces:
IClientClaimsManagerAPI, IServerClaimsManagerAPI
public interface IClaimsManagerAPI
API for a claims manager

  • Method Summary

    Modifier and Type
    Method
    Description
    IPlayerChunkClaimAPI
    get(net.minecraft.resources.ResourceLocation dimension, int x, int z)
    Gets the claim state for a specified chunk.
    IPlayerChunkClaimAPI
    get(net.minecraft.resources.ResourceLocation dimension, net.minecraft.core.BlockPos blockPos)
    Gets the claim state for a specified chunk.
    IPlayerChunkClaimAPI
    get(net.minecraft.resources.ResourceLocation dimension, net.minecraft.world.level.ChunkPos chunkPos)
    Gets the claim state for a specified chunk.
    IDimensionClaimsManagerAPI
    getDimension(net.minecraft.resources.ResourceLocation dimension)
    Gets the read-only claims manager for a specified dimension ID.
    IPlayerClaimInfoAPI
    getPlayerInfo(UUID playerId)
    Gets or creates the claim info instance for a player UUID.
    IClaimsManagerTrackerAPI
    getTracker()
    Gets the claim change tracker that lets you register claim change listeners.
    boolean
    hasPlayerInfo(UUID playerId)
    Checks whether a player has claim info.

  • Method Details

    • hasPlayerInfo

      boolean hasPlayerInfo(@Nonnull UUID playerId)
      Checks whether a player has claim info.
      Parameters:
      playerId - UUID of the player, not null
      Returns:
      true if the player with UUID playerId has claims info, otherwise false

    • getPlayerInfo

      @Nonnull IPlayerClaimInfoAPI getPlayerInfo(@Nonnull UUID playerId)
      Gets or creates the claim info instance for a player UUID.
      Parameters:
      playerId - UUID of a player, not null
      Returns:
      the player claim info, not null

    • get

      @Nullable IPlayerChunkClaimAPI get(@Nonnull net.minecraft.resources.ResourceLocation dimension, int x, int z)
      Gets the claim state for a specified chunk.
      Parameters:
      dimension - the dimension ID of the chunk, not null
      x - the X coordinate of the chunk
      z - 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)
      Gets the claim state for a specified chunk.
      Parameters:
      dimension - the dimension ID of the chunk, not null
      chunkPos - 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)
      Gets the claim state for a specified chunk.
      Parameters:
      dimension - the dimension ID of the chunk, not null
      blockPos - the block coordinates of the chunk, not null
      Returns:
      the current claim state at the specified location, null if wilderness

    • getDimension

      @Nullable IDimensionClaimsManagerAPI getDimension(@Nonnull net.minecraft.resources.ResourceLocation dimension)
      Gets the read-only claims manager for a specified dimension ID.
      Parameters:
      dimension - the dimension ID, not null
      Returns:
      the dimension claims manager, null if no claim data exists for the specified dimension

    • getTracker

      @Nonnull IClaimsManagerTrackerAPI getTracker()
      Gets the claim change tracker that lets you register claim change listeners.

      The tracker notifies the registered listeners when claim changes occur.

      Returns:
      the claim change tracker