Package xaero.pac.common.claims.player.api

Interface IPlayerChunkClaimAPI

public interface IPlayerChunkClaimAPI
API for a chunk claim state

  • Method Summary

    Modifier and Type
    Method
    Description
    UUID
    getPlayerId()
    Gets the UUID of the owner of this claim.
    int
    getSubConfigIndex()
    Gets the sub-config index of this claim.
    boolean
    isForceloadable()
    Checks whether this claim is marked for forceloading.
    boolean
    isSameClaimType(IPlayerChunkClaimAPI other)
    Checks if another claim state is of the same type as this, which ignores whether the claim states are forceloadable.

  • Method Details

    • isForceloadable

      boolean isForceloadable()
      Checks whether this claim is marked for forceloading.

      It doesn't mean that it's actually currently forceloaded.

      Returns:
      true if the claim is marked for forceloading, otherwise false

    • getPlayerId

      @Nonnull UUID getPlayerId()
      Gets the UUID of the owner of this claim.
      Returns:
      the UUID of this claim's owner, not null

    • getSubConfigIndex

      int getSubConfigIndex()
      Gets the sub-config index of this claim.
      Returns:
      the index corresponding to the sub-config used by this claim

    • isSameClaimType

      boolean isSameClaimType(@Nullable IPlayerChunkClaimAPI other)
      Checks if another claim state is of the same type as this, which ignores whether the claim states are forceloadable.
      Parameters:
      other - the other claim state, can be null
      Returns:
      true if the specified claim state is of the same type as this, otherwise false