Package noppes.npcs.api.handler.data

Interface IAuctionClaim

  • public interface IAuctionClaim
    Represents an auction claim (item or currency to be collected).

    • Method Detail

      • getId

        String getId()
        Get the unique claim ID.
        Returns:
        the unique claim ID

      • getPlayerUUID

        String getPlayerUUID()
        Get the player's UUID who can claim this.
        Returns:
        the UUID of the player who can claim this

      • getPlayerName

        String getPlayerName()
        Get the player's display name.
        Returns:
        the name of the player who can claim this

      • getListingId

        String getListingId()
        Get the related listing ID.
        Returns:
        the ID of the original auction listing

      • getType

        int getType()
        Get the claim type.
        Returns:
        0 = Item, 1 = Currency (sale proceeds), 2 = Refund (outbid)

      • isItemClaim

        boolean isItemClaim()
        Check if this is an item claim.
        Returns:
        true if this claim contains an item to collect

      • isCurrencyClaim

        boolean isCurrencyClaim()
        Check if this is a currency claim (sale proceeds or refund).
        Returns:
        true if this claim contains currency to collect

      • isRefundClaim

        boolean isRefundClaim()
        Check if this is a refund claim (outbid).
        Returns:
        true if this is a refund from an outbid or cancelled auction

      • getItem

        IItemStack getItem()
        Get the item to claim (for item claims only).
        Returns:
        The item, or null for currency claims

      • getItemName

        String getItemName()
        Get the item display name (for currency/refund claims tooltip).
        Returns:
        the display name of the claimed item

      • getCurrency

        long getCurrency()
        Get the currency amount (for currency/refund claims).
        Returns:
        the currency amount to claim

      • getOtherPlayerName

        String getOtherPlayerName()
        Get the other player's name involved. For currency claims: the buyer's name. For refund claims: the player who outbid.
        Returns:
        the name of the other party in the transaction

      • getCreatedTime

        long getCreatedTime()
        Get when this claim was created (Unix timestamp in ms).
        Returns:
        the timestamp when this claim was created

      • isClaimed

        boolean isClaimed()
        Check if this claim has been claimed.
        Returns:
        true if this claim has already been collected

      • isReturnedItem

        boolean isReturnedItem()
        Check if this is a returned item (expired/cancelled listing) vs won item. Only relevant for item claims.
        Returns:
        true if this is a returned unsold item

      • getDaysUntilExpiration

        long getDaysUntilExpiration()
        Get days until this claim expires.
        Returns:
        the number of days until this claim expires

      • isExpired

        boolean isExpired()
        Check if this claim has expired.
        Returns:
        true if this claim has expired