mirror of
https://github.com/KAMKEEL/CustomNPC-Plus.git
synced 2026-11-12 18:57:32 +00:00
674 lines
30 KiB
HTML
674 lines
30 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc -->
|
|
<title>IAuctionHandler (CustomNPC-Plus 1.11.1 API)</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<link rel="stylesheet" type="text/css" href="../../../../javadoc-theme.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
|
|
<script type="text/javascript" src="../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
|
|
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
|
|
<!--[if IE]>
|
|
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
|
|
<![endif]-->
|
|
<script type="text/javascript" src="../../../../jquery/jquery-3.7.1.min.js"></script>
|
|
<script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
try {
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="IAuctionHandler (CustomNPC-Plus 1.11.1 API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
var pathtoroot = "../../../../";
|
|
var useModuleDirectories = true;
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<header role="banner">
|
|
<nav role="navigation">
|
|
<div class="fixedNav">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a id="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
<div class="aboutLanguage"><div id="javadoc-header"> <a href="/CustomNPC-Plus/" class="header-brand"> <div class="header-title"> CustomNPC+ <span>Javadoc Reference</span> </div> </a> <a href="/CustomNPC-Plus/" class="header-back"> Back to Index </a> </div></div>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../allclasses.html">All Classes</a></li>
|
|
</ul>
|
|
<ul class="navListSearch">
|
|
<li><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a id="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
</div>
|
|
<div class="navPadding"> </div>
|
|
<script type="text/javascript"><!--
|
|
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
|
|
//-->
|
|
</script>
|
|
</nav>
|
|
</header>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<main role="main">
|
|
<div class="header">
|
|
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">noppes.npcs.api.handler</a></div>
|
|
<h2 title="Interface IAuctionHandler" class="title">Interface IAuctionHandler</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<pre>public interface <span class="typeNameLabel">IAuctionHandler</span></pre>
|
|
<div class="block">Handler for the Auction system.
|
|
Access via API.getAuctions()</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<section>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="memberSummary">
|
|
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Method</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr id="i0" class="altColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buyout(java.lang.String,noppes.npcs.api.entity.IPlayer)">buyout</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> listingId,
|
|
<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a><?> player)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Buyout a listing instantly.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cancelListing(java.lang.String,noppes.npcs.api.entity.IPlayer,boolean)">cancelListing</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> listingId,
|
|
<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a><?> player,
|
|
boolean isAdmin)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Cancel a listing (seller only, unless admin).</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code><a href="data/IAuctionListing.html" title="interface in noppes.npcs.api.handler.data">IAuctionListing</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createListing(noppes.npcs.api.entity.IPlayer,noppes.npcs.api.item.IItemStack,long,long)">createListing</a></span>​(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a><?> player,
|
|
<a href="../item/IItemStack.html" title="interface in noppes.npcs.api.item">IItemStack</a> item,
|
|
long startingPrice,
|
|
long buyoutPrice)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create a new listing.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getActiveListingCount()">getActiveListingCount</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get total count of active listings.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code><a href="data/IAuctionListing.html" title="interface in noppes.npcs.api.handler.data">IAuctionListing</a>[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getActiveListings()">getActiveListings</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get all active listings.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAuctionDurationHours()">getAuctionDurationHours</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get the auction duration in hours.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurrencyName()">getCurrencyName</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get the currency name used by the auction system.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code><a href="data/IAuctionListing.html" title="interface in noppes.npcs.api.handler.data">IAuctionListing</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getListing(java.lang.String)">getListing</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> listingId)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get a specific listing by ID.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getListingFee()">getListingFee</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get the listing fee amount.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code><a href="data/IAuctionListing.html" title="interface in noppes.npcs.api.handler.data">IAuctionListing</a>[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getListingsByBidder(java.lang.String)">getListingsByBidder</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> bidderUUID)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get all listings where a player is the current high bidder.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i10" class="altColor">
|
|
<td class="colFirst"><code><a href="data/IAuctionListing.html" title="interface in noppes.npcs.api.handler.data">IAuctionListing</a>[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getListingsBySeller(java.lang.String)">getListingsBySeller</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sellerUUID)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get all active listings by a specific seller.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMinBidIncrementPercent()">getMinBidIncrementPercent</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get the minimum bid increment percentage (0.0 to 1.0).</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMinimumListingPrice()">getMinimumListingPrice</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get the minimum listing price.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i13" class="rowColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSalesTaxPercent()">getSalesTaxPercent</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get the sales tax percentage (0.0 to 1.0).</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i14" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSnipeProtectionMinutes()">getSnipeProtectionMinutes</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get the snipe protection time in minutes.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i15" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEnabled()">isEnabled</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Check if the auction system is enabled.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i16" class="altColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#placeBid(java.lang.String,noppes.npcs.api.entity.IPlayer,long)">placeBid</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> listingId,
|
|
<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a><?> player,
|
|
long amount)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Place a bid on a listing.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i17" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#save()">save</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Force save auction data.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i18" class="altColor">
|
|
<td class="colFirst"><code><a href="data/IAuctionListing.html" title="interface in noppes.npcs.api.handler.data">IAuctionListing</a>[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#searchListings(java.lang.String)">searchListings</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> searchText)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Search listings by item name or seller name.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<section>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a id="isEnabled()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isEnabled</h4>
|
|
<pre class="methodSignature">boolean isEnabled()</pre>
|
|
<div class="block">Check if the auction system is enabled.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if the auction system is enabled</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getActiveListings()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getActiveListings</h4>
|
|
<pre class="methodSignature"><a href="data/IAuctionListing.html" title="interface in noppes.npcs.api.handler.data">IAuctionListing</a>[] getActiveListings()</pre>
|
|
<div class="block">Get all active listings.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>array of all currently active auction listings</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getListing(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getListing</h4>
|
|
<pre class="methodSignature"><a href="data/IAuctionListing.html" title="interface in noppes.npcs.api.handler.data">IAuctionListing</a> getListing​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> listingId)</pre>
|
|
<div class="block">Get a specific listing by ID.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>listingId</code> - The listing ID</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The listing, or null if not found</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getListingsBySeller(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getListingsBySeller</h4>
|
|
<pre class="methodSignature"><a href="data/IAuctionListing.html" title="interface in noppes.npcs.api.handler.data">IAuctionListing</a>[] getListingsBySeller​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sellerUUID)</pre>
|
|
<div class="block">Get all active listings by a specific seller.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sellerUUID</code> - The seller's UUID as a string</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>array of listings created by this seller</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getListingsByBidder(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getListingsByBidder</h4>
|
|
<pre class="methodSignature"><a href="data/IAuctionListing.html" title="interface in noppes.npcs.api.handler.data">IAuctionListing</a>[] getListingsByBidder​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> bidderUUID)</pre>
|
|
<div class="block">Get all listings where a player is the current high bidder.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>bidderUUID</code> - The bidder's UUID as a string</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>array of listings this player has bid on</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getActiveListingCount()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getActiveListingCount</h4>
|
|
<pre class="methodSignature">int getActiveListingCount()</pre>
|
|
<div class="block">Get total count of active listings.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the number of currently active listings</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="createListing(noppes.npcs.api.entity.IPlayer,noppes.npcs.api.item.IItemStack,long,long)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createListing</h4>
|
|
<pre class="methodSignature"><a href="data/IAuctionListing.html" title="interface in noppes.npcs.api.handler.data">IAuctionListing</a> createListing​(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a><?> player,
|
|
<a href="../item/IItemStack.html" title="interface in noppes.npcs.api.item">IItemStack</a> item,
|
|
long startingPrice,
|
|
long buyoutPrice)</pre>
|
|
<div class="block">Create a new listing.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>player</code> - The seller</dd>
|
|
<dd><code>item</code> - The item to sell</dd>
|
|
<dd><code>startingPrice</code> - The starting bid price</dd>
|
|
<dd><code>buyoutPrice</code> - The buyout price (0 for no buyout)</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The created listing, or null if failed</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="placeBid(java.lang.String,noppes.npcs.api.entity.IPlayer,long)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>placeBid</h4>
|
|
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> placeBid​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> listingId,
|
|
<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a><?> player,
|
|
long amount)</pre>
|
|
<div class="block">Place a bid on a listing.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>listingId</code> - The listing ID</dd>
|
|
<dd><code>player</code> - The bidder</dd>
|
|
<dd><code>amount</code> - The bid amount</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>null on success, error message on failure</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="buyout(java.lang.String,noppes.npcs.api.entity.IPlayer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>buyout</h4>
|
|
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> buyout​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> listingId,
|
|
<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a><?> player)</pre>
|
|
<div class="block">Buyout a listing instantly.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>listingId</code> - The listing ID</dd>
|
|
<dd><code>player</code> - The buyer</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>null on success, error message on failure</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="cancelListing(java.lang.String,noppes.npcs.api.entity.IPlayer,boolean)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>cancelListing</h4>
|
|
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> cancelListing​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> listingId,
|
|
<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a><?> player,
|
|
boolean isAdmin)</pre>
|
|
<div class="block">Cancel a listing (seller only, unless admin).</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>listingId</code> - The listing ID</dd>
|
|
<dd><code>player</code> - The player cancelling</dd>
|
|
<dd><code>isAdmin</code> - Whether to bypass ownership check</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>null on success, error message on failure</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getListingFee()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getListingFee</h4>
|
|
<pre class="methodSignature">long getListingFee()</pre>
|
|
<div class="block">Get the listing fee amount.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the currency fee charged when creating a listing</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getSalesTaxPercent()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSalesTaxPercent</h4>
|
|
<pre class="methodSignature">double getSalesTaxPercent()</pre>
|
|
<div class="block">Get the sales tax percentage (0.0 to 1.0).</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the sales tax percentage applied to completed sales</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getMinBidIncrementPercent()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMinBidIncrementPercent</h4>
|
|
<pre class="methodSignature">double getMinBidIncrementPercent()</pre>
|
|
<div class="block">Get the minimum bid increment percentage (0.0 to 1.0).</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the minimum bid increment as a percentage of current bid</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getAuctionDurationHours()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getAuctionDurationHours</h4>
|
|
<pre class="methodSignature">int getAuctionDurationHours()</pre>
|
|
<div class="block">Get the auction duration in hours.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the default auction duration in hours</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getSnipeProtectionMinutes()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSnipeProtectionMinutes</h4>
|
|
<pre class="methodSignature">int getSnipeProtectionMinutes()</pre>
|
|
<div class="block">Get the snipe protection time in minutes.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the snipe protection window in minutes</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getCurrencyName()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCurrencyName</h4>
|
|
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getCurrencyName()</pre>
|
|
<div class="block">Get the currency name used by the auction system.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the display name of the auction currency</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getMinimumListingPrice()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMinimumListingPrice</h4>
|
|
<pre class="methodSignature">long getMinimumListingPrice()</pre>
|
|
<div class="block">Get the minimum listing price.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the minimum starting price for new listings</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="searchListings(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>searchListings</h4>
|
|
<pre class="methodSignature"><a href="data/IAuctionListing.html" title="interface in noppes.npcs.api.handler.data">IAuctionListing</a>[] searchListings​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> searchText)</pre>
|
|
<div class="block">Search listings by item name or seller name.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>searchText</code> - The search text</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Matching active listings</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="save()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>save</h4>
|
|
<pre class="methodSignature">void save()</pre>
|
|
<div class="block">Force save auction data.</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<footer role="contentinfo">
|
|
<nav role="navigation">
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a id="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
<div class="aboutLanguage"><script> (function() { // Fix uppercase text in table cells // Javadoc 11: method names are in th[scope="row"] a, not td a function fixCase() { document.querySelectorAll("th[scope='row'] a, td a, .memberNameLink a").forEach(function(el) { var t = el.textContent.trim(); if (t.length > 2 && t === t.toUpperCase() && t.indexOf(" ") === -1) { el.textContent = t.toLowerCase(); } }); } // Correct navPadding = topNav height + subNav height // Uses !important to override jQuery's inline style function fixPadding() { var topNav = document.querySelector(".topNav"); var subNav = document.querySelector(".subNav"); var pad = document.querySelector(".navPadding"); if (!pad) return; var h = (topNav ? topNav.offsetHeight : 0) + (subNav ? subNav.offsetHeight : 0); if (h > 0) { pad.style.setProperty("padding-top", h + "px", "important"); } } document.addEventListener("DOMContentLoaded", function() { fixCase(); // Run fixPadding after jQuery has had its chance setTimeout(fixPadding, 0); setTimeout(fixPadding, 50); setTimeout(fixPadding, 200); // Use MutationObserver to permanently override any further jQuery writes var pad = document.querySelector(".navPadding"); if (pad) { var observer = new MutationObserver(function() { fixPadding(); }); observer.observe(pad, { attributes: true, attributeFilter: ["style"] }); } }); })(); </script></div>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../allclasses.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</nav>
|
|
</footer>
|
|
</body>
|
|
</html>
|