Package noppes.npcs.api.handler.data

Interface IAuctionListing

  • public interface IAuctionListing
    Represents an auction listing.

    • Method Detail

      • getId

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

      • getSellerUUID

        String getSellerUUID()
        Get the seller's UUID as a string.
        Returns:
        the seller's UUID

      • getSellerName

        String getSellerName()
        Get the seller's display name.
        Returns:
        the seller's display name

      • getItem

        IItemStack getItem()
        Get the item being sold.
        Returns:
        the item being auctioned

      • getStartingPrice

        long getStartingPrice()
        Get the starting price.
        Returns:
        the starting bid price in currency

      • getBuyoutPrice

        long getBuyoutPrice()
        Get the buyout price (0 if no buyout).
        Returns:
        the instant buyout price in currency

      • hasBuyout

        boolean hasBuyout()
        Check if this listing has a buyout option.
        Returns:
        true if this listing has a buyout option

      • getCurrentBid

        long getCurrentBid()
        Get the current highest bid.
        Returns:
        the current highest bid amount

      • getHighBidderUUID

        String getHighBidderUUID()
        Get the high bidder's UUID as a string (null if no bids).
        Returns:
        the UUID of the current highest bidder

      • getHighBidderName

        String getHighBidderName()
        Get the high bidder's display name (null if no bids).
        Returns:
        the name of the current highest bidder

      • hasBids

        boolean hasBids()
        Check if there are any bids on this listing.
        Returns:
        true if any bids have been placed

      • getBidCount

        int getBidCount()
        Get the total number of bids placed.
        Returns:
        the total number of bids placed

      • getCreatedTime

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

      • getEndTime

        long getEndTime()
        Get when the auction ends (Unix timestamp in ms).
        Returns:
        the timestamp when this listing ends

      • getRemainingTime

        long getRemainingTime()
        Get the remaining time in milliseconds.
        Returns:
        the remaining time in milliseconds

      • isExpired

        boolean isExpired()
        Check if the auction has expired.
        Returns:
        true if the listing has ended

      • isActive

        boolean isActive()
        Check if the auction is still active (can be bid on).
        Returns:
        true if the listing is still accepting bids

      • getStatus

        int getStatus()
        Get the auction status.
        Returns:
        0 = Active, 1 = Ended, 2 = Cancelled, 3 = Claimed

      • getMinimumBid

        long getMinimumBid()
        Get the minimum bid amount (current bid + increment).
        Returns:
        the minimum bid amount required

      • isSeller

        boolean isSeller​(String playerUUID)
        Check if a player UUID is the seller.
        Parameters:
        playerUUID - the player UUID to check
        Returns:
        true if this player is the seller

      • isHighBidder

        boolean isHighBidder​(String playerUUID)
        Check if a player UUID is the current high bidder.
        Parameters:
        playerUUID - the player UUID to check
        Returns:
        true if this player is the current highest bidder

      • getRemainingTimeFormatted

        String getRemainingTimeFormatted()
        Get the remaining time formatted as a string (e.g., "2h 30m").
        Returns:
        the remaining time as a human-readable string