mirror of
https://github.com/KAMKEEL/CustomNPC-Plus-API.git
synced 2026-11-16 18:54:54 +00:00
A lot of GOOD API DOCUMENTATION
This commit is contained in:
1 parent
a6c55ca331
commit
319e774518
131 files changed
+3363
-175
No files matched your search
@@ -9,21 +9,25 @@ public interface IAuctionClaim {
|
||||
|
||||
/**
|
||||
* Get the unique claim ID.
|
||||
* @return the unique claim ID
|
||||
*/
|
||||
String getId();
|
||||
|
||||
/**
|
||||
* Get the player's UUID who can claim this.
|
||||
* @return the UUID of the player who can claim this
|
||||
*/
|
||||
String getPlayerUUID();
|
||||
|
||||
/**
|
||||
* Get the player's display name.
|
||||
* @return the name of the player who can claim this
|
||||
*/
|
||||
String getPlayerName();
|
||||
|
||||
/**
|
||||
* Get the related listing ID.
|
||||
* @return the ID of the original auction listing
|
||||
*/
|
||||
String getListingId();
|
||||
|
||||
@@ -36,16 +40,19 @@ public interface IAuctionClaim {
|
||||
|
||||
/**
|
||||
* Check if this is an item claim.
|
||||
* @return true if this claim contains an item to collect
|
||||
*/
|
||||
boolean isItemClaim();
|
||||
|
||||
/**
|
||||
* Check if this is a currency claim (sale proceeds or refund).
|
||||
* @return true if this claim contains currency to collect
|
||||
*/
|
||||
boolean isCurrencyClaim();
|
||||
|
||||
/**
|
||||
* Check if this is a refund claim (outbid).
|
||||
* @return true if this is a refund from an outbid or cancelled auction
|
||||
*/
|
||||
boolean isRefundClaim();
|
||||
|
||||
@@ -58,11 +65,13 @@ public interface IAuctionClaim {
|
||||
|
||||
/**
|
||||
* Get the item display name (for currency/refund claims tooltip).
|
||||
* @return the display name of the claimed item
|
||||
*/
|
||||
String getItemName();
|
||||
|
||||
/**
|
||||
* Get the currency amount (for currency/refund claims).
|
||||
* @return the currency amount to claim
|
||||
*/
|
||||
long getCurrency();
|
||||
|
||||
@@ -70,32 +79,38 @@ public interface IAuctionClaim {
|
||||
* Get the other player's name involved.
|
||||
* For currency claims: the buyer's name.
|
||||
* For refund claims: the player who outbid.
|
||||
* @return the name of the other party in the transaction
|
||||
*/
|
||||
String getOtherPlayerName();
|
||||
|
||||
/**
|
||||
* Get when this claim was created (Unix timestamp in ms).
|
||||
* @return the timestamp when this claim was created
|
||||
*/
|
||||
long getCreatedTime();
|
||||
|
||||
/**
|
||||
* Check if this claim has been claimed.
|
||||
* @return true if this claim has already been collected
|
||||
*/
|
||||
boolean isClaimed();
|
||||
|
||||
/**
|
||||
* Check if this is a returned item (expired/cancelled listing) vs won item.
|
||||
* Only relevant for item claims.
|
||||
* @return true if this is a returned unsold item
|
||||
*/
|
||||
boolean isReturnedItem();
|
||||
|
||||
/**
|
||||
* Get days until this claim expires.
|
||||
* @return the number of days until this claim expires
|
||||
*/
|
||||
long getDaysUntilExpiration();
|
||||
|
||||
/**
|
||||
* Check if this claim has expired.
|
||||
* @return true if this claim has expired
|
||||
*/
|
||||
boolean isExpired();
|
||||
}
|
||||
Reference in new issue
Block a user